docs: promote HelmRelease tutorial to weight 10 (and fix typo)#3233
Open
pipo02mix wants to merge 6 commits into
Open
docs: promote HelmRelease tutorial to weight 10 (and fix typo)#3233pipo02mix wants to merge 6 commits into
pipo02mix wants to merge 6 commits into
Conversation
Creates a new continuous-deployment subsection (tutorials/continuous- deployment/helm-releases/) and its first guide, the HelmRelease equivalent of apps/add-appcr.md. - _index.md scaffolds the section at weight 80 (ahead of the legacy apps section at weight 90). - add-helmrelease.md mirrors the App CR GitOps guide's shape: environment variables, gitops-template directory structure, then rendering OCIRepository + HelmRelease YAML with flux create --export, wiring up valuesFrom (ConfigMap + SOPS-encrypted Secret), and including the new files in kustomization.yaml. - Links to the conceptual overview and to the imperative deploy-app-helmrelease tutorial; references the App CR equivalent for context. Avoids forward-links to the three upcoming companion guides (update / automatic updates / multiple releases) so the Hugo build doesn't break on missing relrefs until those pages land. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Mirrors apps/update-appcr.md for the HelmRelease world. Covers the four edit surfaces that map to "update an existing deployment": - ocirepository.yaml for chart version bumps (the version moves out of the release CR and into the source, vs the App CR model). - helmrelease.yaml for install/upgrade behavior, dependsOn, drift detection, and so on. - configmap.yaml for non-secret values. - secret.enc.yaml for credentials, via the same sops decrypt-edit- re-encrypt cycle used in the App CR guide. Also adds a "Force an immediate reconciliation" section showing flux reconcile source oci / helmrelease for when waiting for the interval isn't acceptable. Page is branched off add-helmrelease-gitops-guide so the section _index.md exists when this PR builds; PR base is migrate-to-hr and should be merged after page 1. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
add-helmrelease.md: - "repo" -> "repository" (singular not in vocab). - "SOPS-encrypted" -> "encrypted with sops" so the bare uppercase acronym no longer triggers Microsoft.Acronyms. update-helmrelease.md: - Splits the SemVer-range note into two sentences to drop a semicolon Microsoft.Semicolon flagged as too complex. - "afterwards" -> "afterward" per Microsoft.Terms. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
… page 3/4) Mirrors apps/automatic-updates-appcr.md but reframes around the two update mechanisms available for HelmRelease: 1. SemVer range on the OCIRepository (recommended). One-line change to ocirepository.yaml; no Git commits, no extra Flux resources. This is the native Flux way to auto-roll chart versions and didn't exist for App CRs. 2. Image automation with Git commits (optional). The ImageRepository + ImagePolicy + ImageUpdateAutomation triad from the App CR guide, adapted to write the new tag into ocirepository.yaml's .spec.ref.tag via a setter comment. For users who want an audit trail of every version bump in Git. Private-registry section is included for both approaches via the ImageRepository secretRef. Stacked on add-update-helmrelease-guide so the section _index.md plus pages 1+2 are present at build time. PR base is migrate-to-hr; merge in order 1 -> 2 -> 3. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replacement for apps/app-sets.md and the conceptual content of app-platform/app-bundle/. Covers three patterns for grouping HelmReleases: 1. Helm umbrella chart: one parent chart with Chart.yaml dependencies, deployed as a single HelmRelease. Strongest coupling, shared values, one Helm history. 2. Kustomize over multiple HelmReleases: the closest 1:1 translation of App Sets. Per-component HelmRelease + OCIRepository, grouped by a Kustomize base with commonLabels, common namespace, and inline patches pinning each OCIRepository's tag. 3. dependsOn: native Flux ordering with no App CR equivalent. For release-A-before-release-B sequencing across namespaces. Calls out that the three patterns compose. Links the App Sets page for users coming from the App CR model. Stacked on add-auto-updates-helmrelease-guide. PR base is migrate-to-hr; merge in order 1 -> 2 -> 3 -> 4 to complete the helm-releases section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Minimal-surgery retry of the previously-reverted tutorial-promotion PR. Two tiny changes only: - weight: 21 -> 10 so the HelmRelease tutorial sorts above the App CR tutorial (which is at weight 20) under App management. - Fix a pre-existing typo "OCIRespository" -> "OCIRepository" in the Background paragraph. NOT in this PR (compared to the earlier reverted attempt): - No edits to deploy-app/ (the App CR tutorial stays at its current weight, no banner added). - No comparison table between App CR and HelmRelease. - No new "GitOps workflow" section. Those can be follow-up PRs if you want them, but kept out of this one since the earlier combined attempt was reverted. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Member
|
PR title and the actual change are not in sync here. The title suggests a small frontmatter change, but the PR actually adds a lot of content. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Towards https://github.com/giantswarm/giantswarm/issues/36892
Minimal-surgery retry of the previously-reverted tutorial-promotion PR.