[EDU-474] Studios doc audit #407
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes https://seqera.atlassian.net/browse/EDU-474 Signed-off-by: Justine Geffen <[email protected]>
|
I've merged #404 If you rebase this or merge in master (update branch 🙃 ), the Vale warnings for Xpra ect. will cease. |
Signed-off-by: Justine Geffen <[email protected]>
…/docs into justinegeffen-edu-474
justinegeffen
added
1. Editor review
justinegeffen
requested review from
deepcshah,
christopher-hakkaart and
drewdipalma
justinegeffen
commented
Feb 19, 2025
There was a problem hiding this comment.
Some updates and discussion points.
cc @robnewman, @deepcshah
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Outdated
Show resolved
Hide resolved
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Outdated
Show resolved
Hide resolved
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Show resolved
Hide resolved
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Outdated
Show resolved
Hide resolved
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Outdated
Show resolved
Hide resolved
justinegeffen
commented
Feb 20, 2025
|
|
||
| ``` | ||
| kubectl apply -f secret.yml | ||
| ``` | ||
|
|
||
| 1. Edit the `tower-svc.yml` file and uncomment the `volumes.cert-volume`, `volumeMounts.cert-volume`, and `env.TOWER_OIDC_PEM_PATH` fields so that the public/private key pair is available to Platform. | ||
| 1. Edit the `tower-src.yml` file and uncomment the `volumes.cert-volume`, `volumeMounts.cert-volume`, and `env.TOWER_OIDC_PEM_PATH` fields so that the public/private key pair is available to Platform. |
There was a problem hiding this comment.
@endre-seqera, this relates to https://seqera.atlassian.net/browse/EDU-491. Please could you review and confirm it's the correct fix?
platform_versioned_docs/version-24.3/getting-started/proteinfold.mdx
Outdated
Show resolved
Hide resolved
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Outdated
Show resolved
Hide resolved
platform_versioned_docs/version-24.3/troubleshooting_and_faqs/studios_troubleshooting.mdx
Outdated
Show resolved
Hide resolved
robnewman
reviewed
Feb 20, 2025
Co-authored-by: Chris Hakkaart <[email protected]> Co-authored-by: Rob Newman <[email protected]> Signed-off-by: Justine Geffen <[email protected]>
…studios_troubleshooting.mdx Signed-off-by: Justine Geffen <[email protected]>
Merge branch 'master' into justinegeffen-edu-474
justinegeffen
changed the title
robnewman
requested changes
Feb 25, 2025
| @@ -5,7 +5,7 @@ date: "12 Jun 2024" | |||
| tags: [docker, compose, kubernetes, data, studios, deployment] | |||
| --- | |||
|
|
|||
| Enable Studios as part of your Seqera Platform instance. You must have Data Explorer enabled to use Data Studios. Only the Amazon AWS public cloud is currently supported. | |||
| Enable Studios as part of your Seqera Platform instance. You must have Data Explorer enabled to use Studios. Only the Amazon AWS public cloud is currently supported. | |||
|
|
|||
| :::caution | |||
| You must complete the upgrade of your Platform Enterprise installation to version 24.1.4 before enabling and configuring Data Studios. | |||
There was a problem hiding this comment.
Suggested change
| You must complete the upgrade of your Platform Enterprise installation to version 24.1.4 before enabling and configuring Data Studios. | |
| You must complete the upgrade of your Platform Enterprise installation to version 24.2 before enabling and configuring Studios. |
Let's start requiring to upgrade to v24.2 so we start collecting telemetry data.
| - **stopped**: When a session is stopped, the associated compute resources are deallocated. You can start or delete the data studio when it's in this state. | ||
| - **errored**: This state most often indicates that there has been an error starting the data studio session but it is in a **stopped** state. There might be errors reported by the session itself but these will be overwritten with a **running** status if the data studio session is still running. | ||
| - **stopped**: When a session is stopped, the associated compute resources are deallocated. You can start or delete the Studio when it's in this state. | ||
| - **errored**: This state most often indicates that there has been an error starting the Studio session but it is in a **stopped** state. There might be errors reported by the session itself but these will be overwritten with a **running** status if the session is still running. |
There was a problem hiding this comment.
@robnewman, this doesn't seem correct.
If there's an error that results in a stopped state, what relevance does the second sentence have? Should it be a separate point?
Yes - perhaps move to an admonishment.
|
|
||
| :::note | ||
| By default, data studio sessions only have read permissions to mounted data paths. Write permissions can be added for specific cloud storage buckets during the compute environment configuration by defining additional **Allowed S3 Buckets**. This means that data can be written from the session back to the cloud storage path(s) mounted. To stop potential data loss, only one session per workspace can mount a unique data path. When adding a new session, data paths already mounted to other running sessions are unavailable. If a new file is uploaded to the cloud storage bucket path while a session is running, the file may not be available to the session immediately. | ||
| By default, sessions only have read permissions to mounted data paths. Write permissions can be added for specific cloud storage buckets during the compute environment configuration by defining additional **Allowed S3 Buckets**. This means that data can be written from the session back to the cloud storage path(s) mounted. To stop potential data loss, only one session per workspace can mount a unique data path. When adding a new session, data paths already mounted to other running sessions are unavailable. If a new file is uploaded to the cloud storage bucket path while a session is running, the file may not be available to the session immediately. |
There was a problem hiding this comment.
Ah yes. This is updated. Change to:
By default, sessions only have read permissions to mounted data paths. Write permissions can be added
for specific cloud storage buckets during the compute environment configuration by defining additional
**Allowed S3 Buckets**. This means that data can be written from the session back to the cloud storage
path(s) mounted. If a new file is uploaded to the cloud storage bucket path while a session is running, the
file may not be available to the session immediately.
|
|
||
| :::warning | ||
| An active connection to a session will not prevent administrative actions that might disrupt that connection. For example, a session can be stopped by another workspace user while you are active in the session, the underlying credentials can be changed, or the compute environment can be deleted. These are independent actions and the user in the session won't be alerted to any changes - the only alert will be a server connection error in the active session browser tab. | ||
| ::: | ||
|
|
||
| Once connected, the data studio session will display the status of **running** in the list, and any connected user's avatar will be displayed under the status in both the list of data studios and in each data studio session detail page. | ||
| Once connected, the session will display the status of **running** in the list, and any connected user's avatar will be displayed under the status in both the list of Studios and in each Studio's detail page. |
There was a problem hiding this comment.
Based on the most recent discussion, it's a list of Studios and it's each Studio's detail page.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes https://seqera.atlassian.net/browse/EDU-474 and https://seqera.atlassian.net/browse/EDU-491
Rolled into this: