Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe Data Studios template image versioning #309

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions platform_versioned_docs/version-24.2/data_studios/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@ Currently, Data Studios only supports AWS Batch compute environments that **do n

Data Studios provides four container image templates: JupyterLab, RStudio Server, Visual Studio Code, and Xpra. The image templates install a very limited number of packages when the session container is built. You can install additional packages as needed during a session.

The image template names include the version of the included analysis application and the Seqera image template version itself. The Seqera version string is of the following format:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The image template names include the version of the included analysis application and the Seqera image template version itself. The Seqera version string is of the following format:
The image template names include the version of the analysis application and the Seqera image template version itself. The Seqera version string looks like this:


```ignore title="Image template version"
<tool_version>-<seqera_version>-[u-<update_version>]
```

The following version strings apply:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following version strings apply:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this suggestion comes through but I would leave out the introductory sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@justinegeffen, just a hanging list under the example?


- `<tool_version>`: Analysis application version, such as `4.2.5` for JupyterLab
- `<seqera_version>`: Seqera template image version, such as `0.7.0`
- `<update_version`: Seqera template image update version for instances where a breaking change is introduced

You can also create your own container image templates. For more information, see [Custom environments][custom-envs].

**JupyterLab 4.2.5**
Expand Down
Loading