Add-on versions
Status: Proposed Issue: https://gitlab.com/gitlab-org/cloud-native/gitlab-operator/-/work_items/2369 Parent: Release versions
Goal
A Siphon and an Orbit run the charts of the release their GitLabCore runs, so an administrator
keeps no add-on version in step with GitLab. An upgrade moves GitLab and its add-ons through each
release together.
Requirements
- A
Siphonor anOrbitwithoutspec.versionfollows the release itsGitLabCorehas deployed: it runs the chart that the record ofstatus.versionof theGitLabCorelists as its module, and upgrades after theGitLabCoredeploys another release. - A
Siphonor anOrbitwithspec.versionruns the chart version thatchartVersionnames orversionRefreads, and reportsFollowsRelease=Falsewith reasonChartVersionOverridden. AversionRefthat does not resolve keeps its current chart and reportsVersionUnresolved, and the add-on does not fall back to the manifest. - An add-on whose module the record of the deployed release lacks keeps its chart and reports
FollowsRelease=Falsewith reasonModuleNotReleased, orInitialized=Falsewith reasonVersionUnresolvedwhen it is not installed yet. - Before each hop of an upgrade, the first included, a
GitLabCorewaits until everySiphonandOrbitthat follows it reports its deployed release instatus.gitlabVersionandAvailable=True. While it waits, it reportsProgressingwith reasonWaitingForAddOns, naming them. The wait has no timeout. - An add-on with a chart version override is not waited for, and neither is one whose module the record of the deployed release lacks.
- The upgrade picker of the web UI shows the chart each add-on gets in the chosen release, and an upgrade that waits for add-ons shows which.
Out of scope
- A GitLab version of its own for a
Siphonor anOrbit.
FAQ
- When does an add-on set
spec.version? For a chart-only fix ahead of the next release, a chart outside the manifest, testing, or while its chart is not yet a module of the manifest. - Why does
versionRefread a GitLab version on aGitLabCoreand a chart version on an add-on? On aGitLabCoreit stands in forversion. An add-on has no GitLab version of its own, so every version it names is an override of the manifest. A platform that owns the versions sets theversionRefof theGitLabCore, and the add-ons follow it. - Why do add-ons follow the deployed release rather than the target? Siphon pins its table definitions to the deployed schema, and Orbit reads the GitLab it is wired to. The target is not running yet, and may never be if its upgrade fails.
- Why does the
GitLabCorewait for its add-ons before each hop? So each add-on steps through every release GitLab does, and each pair of versions that runs together is one a release shipped. An add-on that skipped a hop would jump across schema changes it never ran against. - What if a broken add-on holds a security release? Set a chart version override on the
add-on. It stops following, and the
GitLabCorestops waiting for it.
Was this page helpful?