Skip to content

docs: KOF 1.11.0: On-demand upgrade by default #825

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.

Sign up for GitHub

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

Open
denis-ryzhkov wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: KOF 1.11.0: On-demand upgrade by default #825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
077f470
docs: KOF 1.11.0: On-demand upgrade by default
denis-ryzhkov Jul 6, 2026
d6cd701
docs: KOF 1.11.0: autoUpgrade part 2
denis-ryzhkov Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/admin/kof/kof-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ apply this example for AWS, or use it as a reference:
namespace: kcm-system
labels:
k0rdent.mirantis.com/kof-cluster-role: regional
k0rdent.mirantis.com/kof-version: {{{ extra.docsVersionInfo.kofVersions.kofDotVersion }}}
spec:
template: $TEMPLATE
credential: aws-cluster-identity-cred
Expand Down Expand Up @@ -455,6 +456,7 @@ apply this example for AWS, or use it as a reference:
namespace: kcm-system
labels:
k0rdent.mirantis.com/kof-cluster-role: regional
k0rdent.mirantis.com/kof-version: {{{ extra.docsVersionInfo.kofVersions.kofDotVersion }}}
spec:
template: $TEMPLATE
credential: azure-cluster-identity-cred
Expand Down Expand Up @@ -494,6 +496,7 @@ apply this example for AWS, or use it as a reference:
namespace: kcm-system
labels:
k0rdent.mirantis.com/kof-cluster-role: regional
k0rdent.mirantis.com/kof-version: {{{ extra.docsVersionInfo.kofVersions.kofDotVersion }}}
spec:
template: $TEMPLATE
credential: openstack-cluster-identity-cred
Expand Down Expand Up @@ -523,6 +526,9 @@ apply this example for AWS, or use it as a reference:
EOF
```

* For on-demand upgrade: set `k0rdent.mirantis.com/kof-version` label here.
* For auto-upgrade: set `autoUpgrade: true` in `kof-values.yaml`.

4. If you've applied the [DNS auto-config](#dns-auto-config) section,
add it to the `.metadata.labels` in the `regional-cluster.yaml` file.
Examples by cloud provider:
Expand Down Expand Up @@ -750,6 +756,7 @@ apply this example for AWS, or use it as a reference:
namespace: kcm-system
labels:
k0rdent.mirantis.com/kof-cluster-role: child
k0rdent.mirantis.com/kof-version: {{{ extra.docsVersionInfo.kofVersions.kofDotVersion }}}
spec:
template: $TEMPLATE
credential: aws-cluster-identity-cred
Expand Down Expand Up @@ -782,6 +789,7 @@ apply this example for AWS, or use it as a reference:
namespace: kcm-system
labels:
k0rdent.mirantis.com/kof-cluster-role: child
k0rdent.mirantis.com/kof-version: {{{ extra.docsVersionInfo.kofVersions.kofDotVersion }}}
spec:
template: $TEMPLATE
credential: azure-cluster-identity-cred
Expand Down Expand Up @@ -815,6 +823,7 @@ apply this example for AWS, or use it as a reference:
namespace: kcm-system
labels:
k0rdent.mirantis.com/kof-cluster-role: child
k0rdent.mirantis.com/kof-version: {{{ extra.docsVersionInfo.kofVersions.kofDotVersion }}}
spec:
template: $TEMPLATE
credential: openstack-cluster-identity-cred
Expand All @@ -838,6 +847,9 @@ apply this example for AWS, or use it as a reference:
EOF
```

* For on-demand upgrade: set `k0rdent.mirantis.com/kof-version` label here.
* For auto-upgrade: set `autoUpgrade: true` in `kof-values.yaml`.

4. If you've applied the [Istio](#istio) section, update the `child-cluster.yaml` file:

??? note "Istio"
Expand Down
3 changes: 2 additions & 1 deletion includes/kof-install-includes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

<!--install-istio-start-->
```bash
helm upgrade -i --reset-values --wait --create-namespace -n istio-system k0rdent-istio \
helm upgrade -i --reset-values --wait \
--create-namespace -n istio-system k0rdent-istio \
{{{ extra.docsVersionInfo.kofVersions.kofOciRegistryBaseIstio }}}/charts/k0rdent-istio \
--version 0.6.0 \
--set cert-manager-service-template.enabled=false \
Expand Down
21 changes: 21 additions & 0 deletions includes/kof-upgrade-includes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@

<!--upgrade-start-->

## Upgrade to v1.11.0

### On-demand upgrade by default

Earlier, upgrade of `kof` umbrella chart in the management cluster
lead to instant upgrade of **all** regional and child clusters at the same time,
which may be not the best strategy.

For more fine-grained control, starting from KOF 1.11.0
you can upgrade each regional and child cluster on-demand
by labeling it with a new `k0rdent.mirantis.com/kof-version` like this:

```bash
kubectl label --overwrite cld -n kcm-system $CLUSTER_NAME \
k0rdent.mirantis.com/kof-version=1.11.0
```

If you want to keep old behavior,
set `autoUpgrade: true` in your `kof-values.yaml` file
and apply it on upgrade of the management cluster.

## Upgrade to v1.10.0

> WARNING:
Expand Down