diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..06a3493 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @rancher/observation-backup \ No newline at end of file diff --git a/README.md b/README.md index 596aaca..fee0522 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ This repo produces a Rancher specific version of the `flavio/kuberlr` image. - This gives us full "Y" and "Z" control on versioning the component to target Rancher minors. - E.x. Rancher 2.8.x releases will get varying versions of 1.Y.Z +### Migration + +See the dedicated [Migration's Doc](/docs/chart-migration.md) for specific details on migrating charts. + ### Compatability The base `flavio/kuberlr` image comes from the upstream repo and is essentially universally compatible like `kuberlr`. diff --git a/docs/chart-migration.md b/docs/chart-migration.md new file mode 100644 index 0000000..2ea207d --- /dev/null +++ b/docs/chart-migration.md @@ -0,0 +1,24 @@ +# Migrating `rancher/charts` packages + +## How To: Migrate charts from `rancher/kubectl` to `rancher/kuberlr-kubectl` + +### Migrating charts based on Rancher version + + +Since the new `kuberlr` based image targets Rancher minor versions, the chart migration process depends on the Rancher minor version the chart targets. + +Refer to the table below (and maintained on the main [README.md](/README.md)) to identify the appropriate `rancher/kuberlr-kubectl` image version when replacing `rancher/kubectl`. + +| `rancher/kuberlr-kubectl` Tag | Rancher Tag (Branch) | +|---------------|----------------------| +| v3.Y.Z | 2.10.Z (main) | +| v2.Y.Z | 2.9.Z (release/v2.9) | +| v1.Y.Z | 2.8.Z (release/v2.8) | + +### Migrating charts from `rancher/shell` + +Previously, some charts required `rancher/shell` instead of `rancher/kubectl` because the older `rancher/kubectl` image only included `kubectl` binary and lacked a full shell environment. + +This isn't the case with `rancher/kuberlr-kubectl`. Unless the chart uses `rancher/shell` for the `helm` binary then it should be safe to switch to `rancher/kuberlr-kubectl`. + +Refer to the table above and use the corresponding `rancher/kuberlr-kubectl` version. Ensure your QA process validates this aspect of the chart(s), usually related to upgrade jobs or similar tasks. \ No newline at end of file