Skip to content

Commit

Permalink
Add maintenance docs
Browse files Browse the repository at this point in the history
Signed-off-by: zeroalphat <[email protected]>
  • Loading branch information
zeroalphat committed Nov 22, 2023
1 parent 5bf938f commit 92b2279
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 4 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/maintenance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Maintenance

## How to update supported Kubernetes

- Update Kubernetes version in `Makefile.versions`.
- Update `k8s.io/*` packages version in `go.mod`.

## How to update supported Flatcar Container Linux

NecoPerf supports one Flatcar Linux version at a time.
If a new stable version of Flatcar Linux is released, please do the following steps.

- Check the [stable release](https://www.flatcar.org/releases) of Flatcar Linux
- Find the tags for the container image of the [flatcar-sdk-amd64](https://github.com/orgs/flatcar/packages/container/package/flatcar-sdk-amd64) corresponding to the stable version of Flatcar Linux
- Update `FLATCAR_VERSION` in `Makefile.versions`.

If Flatcar Container Linux Container Image has changed, please fix the relevant source code.

## How to update dependencies

- Update `Makefile.versions`.
- Update `Dockerfile.cli` and `Dockerfile.daemon`.
- Update go.mod.
- Update GitHub Actions.
2 changes: 2 additions & 0 deletions Makefile.versions
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
E2ETEST_K8S_VERSION := 1.27.1
# ref to https://github.com/orgs/flatcar/packages/container/package/flatcar-sdk-amd64
FLATCAR_VERSION := 3602.0.0
KIND_VERSION := 0.20.0
KUSTOMIZE_VERSION := 5.1.0
2 changes: 1 addition & 1 deletion e2e/Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include Makefile.versions
include ../Makefile.versions

ARCH ?= amd64
OS ?= linux
Expand Down
3 changes: 0 additions & 3 deletions e2e/Makefile.versions

This file was deleted.

0 comments on commit 92b2279

Please sign in to comment.