Skip to content

docs(studios): document AWS Batch → AWS Cloud migration#1500

Open
justinegeffen wants to merge 4 commits into
masterfrom
edu-893-studios-aws-batch-to-aws-cloud-migration
Open

docs(studios): document AWS Batch → AWS Cloud migration#1500
justinegeffen wants to merge 4 commits into
masterfrom
edu-893-studios-aws-batch-to-aws-cloud-migration

Conversation

@justinegeffen
Copy link
Copy Markdown
Contributor

@justinegeffen justinegeffen commented May 29, 2026

Summary

Adds a new H2, Migrate a Studio from AWS Batch to AWS Cloud, to the Studios Manage Studios page across:

  • platform-enterprise_docs/studios/managing.md (next unreleased Enterprise)
  • platform-enterprise_versioned_docs/version-26.1/studios/managing.md
  • platform-cloud/docs/studios/managing.md

The new section sits between Migrate a Studio from an earlier container image template and Studio session statuses, and covers:

  • In-place migration (recommended) — swap the CE from the Edit screen when the new CE shares the same workDir. Preserves checkpoints, installed packages, and session state. Includes how it works, prerequisites, steps, which CEs appear in the selector, and how resource labels are synced.
  • Migration from scratch — copy specific files between the AWS Batch and AWS Cloud Studios through a shared S3 bucket mounted as a data-link.
  • Troubleshooting — three common failure modes (CE missing from dropdown, Studio fails to start after switching, unexpected resource labels).

Two new link references added: [resource-labels] (→ ../troubleshooting_and_faqs/resource-labels) and [credentials] (→ ../credentials/overview). Also added [checkpoints] (→ ./managing#studio-session-checkpoints) for the in-place section. Existing [aws-cloud], [aws-batch], and [add-s] references reused.

Refs

  • Parent story: PLAT-4280 — Allow changing a Studio's CE when the new CE shares the same workDir
  • EDU ticket: PLAT-4281
  • Migration guide ticket: EDU-893
  • Engineering subtasks (Done): PLAT-5222 (BE validation endpoint), PLAT-5236 (BE update-CE endpoint), PLAT-5223 (FE compatible-CE dropdown)

Scope notes

  • Not applied to version-25.3/ — PLAT-4280 is treated as a next-release feature, so it does not appear in already-shipped 25.3 docs. If the feature is back-ported to 25.3, the same H2 should be added there.
  • Scope confirmed with reviewer before drafting: unversioned Enterprise + 26.1 + Cloud.

Open questions (please confirm before merge)

  1. Must the Studio be in a stopped state to swap CEs? The sources don't say explicitly. The surrounding Edit flow only allows editing stopped sessions, so the draft assumes yes — please confirm with @weronika.sosnowska or @georgi.hristov. If running Studios can swap CEs, remove the "Confirm the Studio is stopped" prerequisite/step.
  2. Resource labels link target — pointed at ../troubleshooting_and_faqs/resource-labels. Confirm that's the canonical resource-labels page (the file exists at that path in all three trees).
  3. Confirmation modal on CE swap? If the Edit screen shows a confirmation dialog before applying the new CE, please share the UI copy so it can be quoted in the Steps section.
  4. Apply to version-25.3/ as well? Default assumption is no (feature ships in 26.1+). Flag if PLAT-4280 was back-ported.

Change summary

File Change
platform-enterprise_docs/studios/managing.md +82 lines: new H2 with 2 H3s + Troubleshooting; 3 new link refs; last updated bumped to 2026-05-29
platform-enterprise_versioned_docs/version-26.1/studios/managing.md Same as above (identical content)
platform-cloud/docs/studios/managing.md Same as above (identical content)

Test plan

  • Visual check on Netlify preview: Studios "Manage Studios" page in Enterprise (unversioned), Enterprise 26.1, and Cloud all render the new section between Migrate a Studio from an earlier container image template and Studio session statuses.
  • Click each link in the new section ([aws-cloud], [aws-batch], [credentials], [resource-labels], [checkpoints], [add-s], in-page anchors #resource-labels-on-migration and #studio-session-data-links) on all three doc trees.
  • Confirm the :::tip / :::note admonitions render correctly.
  • Lychee link check passes on the changed files.
  • Product/eng sign-off on the four open questions above.

🤖 Generated with Claude Code

Adds a new "Migrate a Studio from AWS Batch to AWS Cloud" H2 to the
Studios "Manage Studios" page across Platform Enterprise (unversioned
+ version-26.1) and Platform Cloud. Covers the in-place migration path
introduced in PLAT-4280 (same-workDir CE swap from the Edit screen)
and the from-scratch path through a shared S3 bucket.

Refs: PLAT-4280, PLAT-4281, EDU-893

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit f27ff8a
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/6a209ee984b0cb000846da61
😎 Deploy Preview https://deploy-preview-1500--seqera-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@justinegeffen justinegeffen added 1. Editor review Needs a language review 1. Dev/PM/SME Needs a review by a Dev/PM/SME labels May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1. Dev/PM/SME Needs a review by a Dev/PM/SME 1. Editor review Needs a language review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants