Skip to content

Commit

Permalink
Upgrade guide (kubeflow#2717)
Browse files Browse the repository at this point in the history
* add upgrade section

Signed-off-by: juliusvonkohout <45896133+juliusvonkohout@users.noreply.github.com>

* refine

Signed-off-by: juliusvonkohout <45896133+juliusvonkohout@users.noreply.github.com>

* change link

Signed-off-by: juliusvonkohout <45896133+juliusvonkohout@users.noreply.github.com>

---------

Signed-off-by: juliusvonkohout <45896133+juliusvonkohout@users.noreply.github.com>
  • Loading branch information
juliusvonkohout authored May 17, 2024
1 parent d2c5275 commit 585458b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [Install individual components](#install-individual-components)
* [Connect to your Kubeflow Cluster](#connect-to-your-kubeflow-cluster)
* [Change default user password](#change-default-user-password)
- [Upgrading and extending](#upgrading-and-extending)
- [Release process](#release-process)
- [Frequently Asked Questions](#frequently-asked-questions)

Expand Down Expand Up @@ -69,6 +70,8 @@ used from the different projects of Kubeflow:

## Installation

This is for the installation from scratch. For the in-place upgrade guide please jump to the upgrading and extending section.

The Manifests WG provides two options for installing Kubeflow official components and common services with kustomize. The aim is to help end users install easily and to help distribution owners build their opinionated distributions from a tested starting point:

1. Single-command installation of all components under `apps` and `common`
Expand Down Expand Up @@ -480,6 +483,18 @@ TODO this changed slightly in https://github.com/kubeflow/manifests/pull/2669 an
hash: <enter the generated hash here>
```
## Upgrading and extending
For modifications and in place upgrades of the Kubeflow platform we provide a rough description for advanced users:
- Never ever edit the manifests directly, use Kustomize overlays and [components](https://github.com/kubernetes-sigs/kustomize/blob/master/examples/components.md) on top of the [example.yaml](https://github.com/kubeflow/manifests/blob/master/example/kustomization.yaml).
- This allows you to upgrade by just referencing the new manifests, building with kustomize and running `kubectl apply` again.
- You might have to adjust your over the top overlays and components if needed.
- You might have to prune old resources. For that you would add [labels](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/labels/) to all your resources from the start.
- With labels you can use `kubectl apply` with `--prune` and `--dry-run` to list prunable resources.
- Sometimes there are major changes, e.g. in the 1.9 release we switch to oauth2-proxy, which need additional attention.
- Nevertheless with a bit of Kubernetes knowledge one should be able to upgrade.

## Release process

The Manifest Working Group releases Kubeflow based on the [release timeline](https://github.com/kubeflow/community/blob/master/releases/handbook.md#timeline).
Expand Down

0 comments on commit 585458b

Please sign in to comment.