Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 2.77 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.77 KB

krel — The Kubernetes Release Toolbox

krel is the new golang based tool for managing releases.

Summary

The purpose of krel is to provide a toolkit for managing the different steps needed to create Kubernetes Releases. This includes manually executed tasks like generating the Release Notes during the release cycle and performing automated tasks like pushing the Kubernetes release artifacts to Google Cloud Storage.

Installation

Either download the latest version of krel by using the hack/get-krel script:

./hack/get-krel

Or compile krel by running the compile-release-tools script from the root of this repo:

./compile-release-tools krel

Or run the following command in the terminal:

go install k8s.io/release/cmd/krel@latest

Usage:

krel has several subcommands that perform various tasks during the release lifecycle:

krel [subcommand]

Available Commands:

Subcommand Description
announce Build and announce Kubernetes releases
ci-build Build Kubernetes in CI and push release artifacts to Google Cloud Storage (GCS)
cve Add and edit CVE information
ff Fast forward a Kubernetes release branch
history Run history to build a list of commands that ran when cutting a specific Kubernetes release
push Push Kubernetes release artifacts to Google Cloud Storage (GCS)
release Release a staged Kubernetes version
release-notes The subcommand of choice for the Release Notes subteam of SIG Release
stage Stage a new Kubernetes version
testgridshot Take a screenshot of the testgrid dashboards

Important Notes

Some of the krel subcommands are under development and their usage may already differ from these docs.