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

K3s release documentation #320

Closed
wants to merge 9 commits into from
Closed

K3s release documentation #320

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2d8b2db
add tarballs packaging
tashima42 Nov 14, 2023
bf1a3db
remove standup bin
tashima42 Nov 14, 2023
962ace3
add tarballs packaging
tashima42 Nov 14, 2023
952fd59
add k3s release tui
tashima42 Dec 11, 2023
04abe30
add k3s release documentation
tashima42 Dec 19, 2023
ea404de
remove release command
tashima42 Dec 19, 2023
99240e8
add os to k3s release readme
tashima42 Dec 19, 2023
60272a2
fix typo in readme
tashima42 Dec 19, 2023
aad8681
update k3s versions
tashima42 Dec 21, 2023
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
46 changes: 46 additions & 0 deletions cmd/k3s_release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,52 @@ k3s_release is a utility that performs the bulk of the actions to complete a K3s

Please reference the help menu from the binary.

## Requirements
* OS: Linux
* Docker
* Git
* Go (At least the version used upstream for kubernetes)
* Sed (GNU)
* All commands require a Github token (classic) with the following permissions:
* Be generated on behalf of an account with access to the `k3s-io/k3s` repo
* `repo`
* `write:packages`
* An SSH key is also required, follow the Github [Documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) to generate one.

## Configuration
| Name | Description |
|-----------------|------------------------------------------------------------------------------------------------------------|
| old_k8s_version | Previous k8s patch version |
| new_k8s_version | Latest released k8s patch version |
| old_k8s_client | Previous k8s client patch version, usually the same as the k8s version, but with a major of 0 instead of 1 |
| new_k8s_client | Latest released k8s client patch version |
| old_k3s_version | Previous k3s patch version, including the suffix (`+k3s1`) |
| new_k3s_version | Latest released k3s patch version |
| release_branch | Branch in `k3s-io/k3s` for the minor version e.g: `release-1.28` |
| workspace | Local directory to clone repos and create files |
| handler | Your Github username |
| email | Email to signoff commits |
| token | Github Token described [above](#requirements) |
| ssh_key_path | Path for the local private ssh key |

Example:
```json
{
"old_k8s_version": "v1.28.4",
"new_k8s_version": "v1.28.5",
"old_k8s_client": "v0.28.4",
"new_k8s_client": "v0.28.5",
"old_k3s_version": "v1.28.4+k3s2",
"new_k3s_version": "v1.28.5+k3s1",
"release_branch": "release-1.28",
"workspace": "$GOPATH/src/github.com/kubernetes",
"handler": "YourUsername",
"email": "[email protected]",
"token": "${GITHUB_TOKEN}",
"ssh_key_path": "$HOME/.ssh/github"
}
```

## Contributions

* File Issue with details of the problem, feature request, etc.
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ require (
github.com/xanzy/ssh-agent v0.3.0 // indirect
github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
golang.org/x/net v0.8.0 // indirect
golang.org/x/sys v0.6.0 // indirect
golang.org/x/sys v0.12.0 // indirect
google.golang.org/appengine v1.6.7 // indirect
google.golang.org/protobuf v1.28.1 // indirect
gopkg.in/warnings.v0 v0.1.2 // indirect
Expand Down
3 changes: 2 additions & 1 deletion go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,8 +534,9 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
Expand Down