Upgrading Instruction
Overview
Karmada uses the semver versioning and each version in the format of vMAJOR.MINOR.PATCH:
- The
PATCHrelease does not introduce breaking changes. - The
MINORrelease might introduce minor breaking changes with a workaround. - The
Majorrelease might introduce backward-incompatible behavior changes.
Regular Upgrading Process
Upgrading APIs
For releases that introduce API changes, the Karmada API(CRD) that Karmada components rely on must upgrade to keep consistent.
Karmada CRD is composed of two parts:
- bases: The CRD definition generated via API structs.
- patches: conversion settings for the CRD.
In order to support multiple versions of custom resources, the patches should be injected into bases.
To achieve this we introduced a kustomization.yaml configuration then use kubectl kustomize to build the final CRD.
The bases,patchesand kustomization.yaml now located at charts/_crds directory of the repo.
Manual Upgrade API
Step 1: Get the Webhook CA certificate
The CA certificate will be injected into patches before building the final CRD.
We can retrieve it from the MutatingWebhookConfiguration or ValidatingWebhookConfiguration configurations, e.g:
kubectl get mutatingwebhookconfigurations.admissionregistration.k8s.io mutating-config
Copy the ca_string from the yaml path webhooks.name[x].clientConfig.caBundle, then replace the {{caBundle}} from
the yaml files in patches. e.g:
sed -i'' -e "s/{{caBundle}}/${ca_string}/g" ./"charts/karmada/_crds/patches/webhook_in_resourcebindings.yaml"
sed -i'' -e "s/{{caBundle}}/${ca_string}/g" ./"charts/karmada/_crds/patches/webhook_in_clusterresourcebindings.yaml"
Step2: Build final CRD
Generate the final CRD by kubectl kustomize command, e.g:
kubectl kustomize ./charts/karmada/_crds
Or, you can apply to karmada-apiserver by:
kubectl kustomize ./charts/karmada/_crds | kubectl apply -f -
Upgrading Components
Components upgrading is composed of image version update and possible command args changes.
For the argument changes please refer to
Details Upgrading Instructionbelow.
Details Upgrading Instruction
The following instructions are for minor version upgrades. Cross-version upgrades are not recommended. And it is recommended to use the latest patch version when upgrading, for example, if you are upgrading from v1.1.x to v1.2.x and the available patch versions are v1.2.0, v1.2.1 and v1.2.2, then select v1.2.2.