Skip to content
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

Jump to bottom

update docs/maintenance.md #129

Merged
merged 1 commit into from
Jun 28, 2024
Merged

update docs/maintenance.md #129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/maintenance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ We should also update go.mod by the following commands. Please note that Kuberne

```bash
$ VERSION=<upgrading Kubernetes release version>
$ go get k8s.io/api@v${VERSION} k8s.io/apimachinery@v${VERSION} k8s.io/client-go@v${VERSION}
$ go get k8s.io/api@v${VERSION} k8s.io/apimachinery@v${VERSION} k8s.io/client-go@v${VERSION} k8s.io/component-helpers@v${VERSION}
```

Read the [`controller-runtime`'s release note](https://github.com/kubernetes-sigs/controller-runtime/releases), and update to the newest version that is compatible with all supported kubernetes versions. If there are breaking changes, we should decide how to manage these changes.
Expand All @@ -57,18 +57,27 @@ Edit the following files.
The following tools do not depend on other software, use latest versions.
To change their versions, edit `versions.mk`.
- [kind](https://github.com/kubernetes-sigs/kind/releases)
- Update `KIND_NODE_VERSION` in `versions.mk`, too.
- [helm](https://github.com/helm/helm/releases)
- [kustomize](https://github.com/kubernetes-sigs/kustomize/releases)
- [chart-testing](https://github.com/helm/chart-testing/releases)

#### Depending modules

Read `kubernetes' go.mod`(https://github.com/kubernetes/kubernetes/blob/\<upgrading Kubernetes release version\>/go.mod), and update the `prometheus/*` modules. Here is the example to update `prometheus/client_golang`.
Read `kubernetes' go.mod`(https://github.com/kubernetes/kubernetes/blob/<upgrading Kubernetes release version\>/go.mod), and update the `prometheus/*` modules. Here is the example to update `prometheus/client_golang`.

```
$ VERSION=<upgrading prometheus-related libraries release version>
$ go get github.com/prometheus/client_golang@v${VERSION}
```

The following modules don't depend on other softwares, so use their latest versions:
- [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo/releases)
- [github.com/onsi/gomega](https://github.com/onsi/gomega/releases)
- [github.com/spf13/cobra](https://github.com/spf13/cobra/releases)
- [k8s.io/klog/v2](https://github.com/kubernetes/klog/releases)
- [sigs.k8s.io/yaml](https://github.com/kubernetes-sigs/yaml/releases)

Then, please tidy up the dependencies.

```bash
Expand Down