-
Notifications
You must be signed in to change notification settings - Fork 0
Expose deploy inputs and pin staging/prod images #87
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
Merged
CodeByNikolas
merged 6 commits into
main
from
codex/expose-execution-mode-clean-install
Mar 25, 2026
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ed83853
Expose deploy inputs and pin staging/prod images
CodeByNikolas 1312aac
Set test conversion webhook images to latest
CodeByNikolas 7df05de
Pin staging/prod IDE images and document release flow
CodeByNikolas ffbd8c4
Split landing page tag from IDE image tags
CodeByNikolas a866ead
Remove appdefinition tag override from env values
CodeByNikolas bcc96f7
Restore spacing before monitoring blocks
CodeByNikolas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # Deployment Workflows | ||
|
|
||
| This repository deploys Theia Cloud through three GitHub Actions entrypoints that all call the reusable [`deploy-theia.yml`](../.github/workflows/deploy-theia.yml) workflow. | ||
|
|
||
| ## Workflow Overview | ||
|
|
||
| ### Pull request deployments | ||
|
|
||
| - Workflow: [`deploy-pr.yml`](../.github/workflows/deploy-pr.yml) | ||
| - Trigger: pull requests (`opened`, `synchronize`, `reopened`) and manual `workflow_dispatch` | ||
| - Targets: `test1`, `test2`, `test3` | ||
| - Manual inputs: | ||
| - `theia_cloud_tag` | ||
| - `landing_page_tag` | ||
| - `ide_images_tag` | ||
| - `execution_mode` | ||
| - `helm_chart_tag` | ||
| - `clean_install` | ||
|
|
||
| `clean_install` now defaults to `true` for manual PR deployments. | ||
|
|
||
| ### Staging deployments | ||
|
|
||
| - Workflow: [`deploy-staging.yml`](../.github/workflows/deploy-staging.yml) | ||
| - Trigger: push to `main` and manual `workflow_dispatch` | ||
| - Target: `theia-staging` | ||
| - Manual inputs: | ||
| - `execution_mode` | ||
| - `clean_install` | ||
|
|
||
| ### Production deployments | ||
|
|
||
| - Workflow: [`deploy-production.yml`](../.github/workflows/deploy-production.yml) | ||
| - Trigger: manual `workflow_dispatch` | ||
| - Target: `theia-prod` | ||
| - Manual inputs: | ||
| - `execution_mode` | ||
| - `clean_install` | ||
|
|
||
| ## Manual Deployment Inputs | ||
|
|
||
| ### `execution_mode` | ||
|
|
||
| Selects which runner backend executes the deployment: | ||
|
|
||
| - `self-hosted-buildkit` | ||
| - `github-runners` | ||
|
|
||
| ### `clean_install` | ||
|
|
||
| When enabled, the reusable deployment workflow performs a namespace-scoped cleanup before Helm install: | ||
|
|
||
| - deletes session and workspace resources | ||
| - deletes AppDefinitions | ||
| - deletes deployments, daemonsets, and statefulsets | ||
| - waits for pods to terminate | ||
| - deletes PVCs | ||
|
|
||
| Use this when you need a clean rollout and are prepared to remove the namespace-local runtime state. | ||
|
|
||
| ## Release Process For Pinned Image Tags | ||
|
|
||
| Staging and production now intentionally pin several images to SHA-suffixed tags instead of floating on plain `latest`. A release therefore requires updating the short SHA suffix in the deployment values files. | ||
|
|
||
| ### Which files to update | ||
|
|
||
| For staging: | ||
|
|
||
| - [`deployments/theia-staging.artemis.cit.tum.de/values.yaml`](../deployments/theia-staging.artemis.cit.tum.de/values.yaml) | ||
| - [`deployments/theia-staging.artemis.cit.tum.de/theia-crds-helm-values.yml`](../deployments/theia-staging.artemis.cit.tum.de/theia-crds-helm-values.yml) | ||
|
|
||
| For production: | ||
|
|
||
| - [`deployments/theia.artemis.cit.tum.de/values.yaml`](../deployments/theia.artemis.cit.tum.de/values.yaml) | ||
| - [`deployments/theia.artemis.cit.tum.de/theia-crds-helm-values.yml`](../deployments/theia.artemis.cit.tum.de/theia-crds-helm-values.yml) | ||
|
|
||
| ### Tags that currently need to be bumped together | ||
|
|
||
| In each environment `values.yaml`: | ||
|
|
||
| - `theia-cloud.operator.image` | ||
| - `theia-cloud.service.image` | ||
| - `theia-cloud.preloading.images[0..10]` | ||
| - `theia-cloud.landingPage.image` | ||
CodeByNikolas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - `theia-appdefinitions.defaultImageTag` | ||
|
|
||
| In each environment `theia-crds-helm-values.yml`: | ||
|
|
||
| - `conversion.image` | ||
|
|
||
| ### Practical rule | ||
|
|
||
| There are currently two image families with separate tag suffixes: | ||
|
|
||
| - Theia Cloud control-plane images: | ||
| - `operator` | ||
| - `service` | ||
| - `conversion-webhook` | ||
| - IDE and landing-page images: | ||
| - landing page | ||
| - preload images | ||
| - app definition default image tag | ||
|
|
||
| If a new release publishes a new short SHA for one of those families, update every field in that family in both staging and production before merging. | ||
|
|
||
| ### Recommended release checklist | ||
|
|
||
| 1. Confirm the published image tags in GHCR. | ||
| 2. Update staging and production values files with the new short SHA suffixes. | ||
| 3. Keep `preloading.images`, `landingPage.image`, and `theia-appdefinitions.defaultImageTag` in sync. | ||
| 4. Keep `operator`, `service`, and `conversion.image` in sync when rolling a new control-plane build. | ||
| 5. If test environments should stop using a PR-specific conversion webhook, update their `theia-crds-helm-values.yml` files as well. | ||
| 6. Validate the edited YAML files before opening the PR. | ||
|
|
||
| Example validation: | ||
|
|
||
| ```bash | ||
| ruby -e 'require "yaml"; %w[ | ||
| .github/workflows/deploy-pr.yml | ||
| .github/workflows/deploy-staging.yml | ||
| .github/workflows/deploy-production.yml | ||
| deployments/theia-staging.artemis.cit.tum.de/values.yaml | ||
| deployments/theia-staging.artemis.cit.tum.de/theia-crds-helm-values.yml | ||
| deployments/theia.artemis.cit.tum.de/values.yaml | ||
| deployments/theia.artemis.cit.tum.de/theia-crds-helm-values.yml | ||
| ].each { |f| YAML.load_file(f); puts "OK #{f}" }' | ||
| ``` | ||
|
|
||
| ## Notes | ||
|
|
||
| - PR workflows can temporarily override image tags with workflow inputs, so you do not need to edit committed values files for preview deployments. | ||
| - Staging and production use committed values files as the source of truth, so release tag bumps must happen in git. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.