Skip to content

Commit

Permalink
Squashed 'release-tools/' changes from 17dde9e..a6a1a79
Browse files Browse the repository at this point in the history
kubernetes-csi/csi-release-tools@a6a1a79 Merge kubernetes-csi/csi-release-tools#176 from pohly/go-1.17.3
kubernetes-csi/csi-release-tools@0a2cf63 prow.sh: bump Go to 1.17.3
kubernetes-csi/csi-release-tools@fc29fdd Merge kubernetes-csi/csi-release-tools#141 from pohly/prune-replace-optional
kubernetes-csi/csi-release-tools@5b9a1e0 Merge kubernetes-csi/csi-release-tools#175 from jimdaga/patch-1
kubernetes-csi/csi-release-tools@5eeb602 images: use k8s-staging-test-infra/gcb-docker-gcloud
kubernetes-csi/csi-release-tools@5489de6 Merge kubernetes-csi/csi-release-tools#174 from mauriciopoppe/bump-kind-version
kubernetes-csi/csi-release-tools@0c675d4 Bump kind version to v0.11.1
kubernetes-csi/csi-release-tools@ef69a88 Merge kubernetes-csi/csi-release-tools#173 from nick5616/add-ws2022
kubernetes-csi/csi-release-tools@44c710c added WS2022 to build platforms
kubernetes-csi/csi-release-tools@0883be4 Merge kubernetes-csi/csi-release-tools#171 from pohly/example-commands
kubernetes-csi/csi-release-tools@02cda51 build.make: support binaries outside of cmd, with optional go.mod
kubernetes-csi/csi-release-tools@65922ea Merge kubernetes-csi/csi-release-tools#170 from pohly/canary-snapshot-controller
kubernetes-csi/csi-release-tools@c0bdfb3 prow.sh: deploy canary snapshot-controller in canary jobs
kubernetes-csi/csi-release-tools@0438f15 Merge kubernetes-csi/csi-release-tools#167 from c0va23/feature/release-armv7-image
kubernetes-csi/csi-release-tools@4786f4d Merge kubernetes-csi/csi-release-tools#168 from msau42/update-release-prereq
kubernetes-csi/csi-release-tools@6a2dc64 Remove requirement to be top-level approver. Only maintainers membership is required to do a release
kubernetes-csi/csi-release-tools@30a4f7b Release armv7 image
kubernetes-csi/csi-release-tools@ac8108f Merge kubernetes-csi/csi-release-tools#165 from consideRatio/pr/update-github-links-ref-to-master-to-HEAD
kubernetes-csi/csi-release-tools@999b483 docs: make github links reference HEAD instead of main
kubernetes-csi/csi-release-tools@fd67069 docs: make github links reference HEAD instead of master
kubernetes-csi/csi-release-tools@c0a4fb1 Merge kubernetes-csi/csi-release-tools#164 from anubha-v-ardhan/patch-1
kubernetes-csi/csi-release-tools@9c6a6c0 Master to main cleanup
kubernetes-csi/csi-release-tools@682c686 Merge kubernetes-csi/csi-release-tools#162 from pohly/pod-name-via-shell-command
kubernetes-csi/csi-release-tools@36a29f5 Merge kubernetes-csi/csi-release-tools#163 from pohly/remove-bazel
kubernetes-csi/csi-release-tools@68e43ca prow.sh: remove Bazel build support
kubernetes-csi/csi-release-tools@c5f59c5 prow.sh: allow shell commands in CSI_PROW_SANITY_POD
kubernetes-csi/csi-release-tools@71c810a Merge kubernetes-csi/csi-release-tools#161 from pohly/mock-test-fixes
kubernetes-csi/csi-release-tools@9e438f8 prow.sh: fix mock testing
kubernetes-csi/csi-release-tools@d7146c7 Merge kubernetes-csi/csi-release-tools#160 from pohly/kind-update
kubernetes-csi/csi-release-tools@4b6aa60 prow.sh: update to KinD v0.11.0
kubernetes-csi/csi-release-tools@7cdc76f Merge kubernetes-csi/csi-release-tools#159 from pohly/fix-deployment-selection
kubernetes-csi/csi-release-tools@ef8bd33 prow.sh: more flexible CSI_PROW_DEPLOYMENT, part II
kubernetes-csi/csi-release-tools@204bc89 Merge kubernetes-csi/csi-release-tools#158 from pohly/fix-deployment-selection
kubernetes-csi/csi-release-tools@61538bb prow.sh: more flexible CSI_PROW_DEPLOYMENT
kubernetes-csi/csi-release-tools@2b0e6db Merge kubernetes-csi/csi-release-tools#157 from humblec/csi-release
kubernetes-csi/csi-release-tools@a2fcd6d Adding myself to csi reviewers group
kubernetes-csi/csi-release-tools@f325590 Merge kubernetes-csi/csi-release-tools#149 from pohly/cluster-logs
kubernetes-csi/csi-release-tools@4b03b30 Merge kubernetes-csi/csi-release-tools#155 from pohly/owners
kubernetes-csi/csi-release-tools@a6453c8 owners: introduce aliases
kubernetes-csi/csi-release-tools@ad83def Merge kubernetes-csi/csi-release-tools#153 from pohly/fix-image-builds
kubernetes-csi/csi-release-tools@5561780 build.make: fix image publishng
kubernetes-csi/csi-release-tools@29bd39b Merge kubernetes-csi/csi-release-tools#152 from pohly/bump-csi-test
kubernetes-csi/csi-release-tools@bc42793 prow.sh: use csi-test v4.2.0
kubernetes-csi/csi-release-tools@b546baa Merge kubernetes-csi/csi-release-tools#150 from mauriciopoppe/windows-multiarch-args
kubernetes-csi/csi-release-tools@bfbb6f3 add parameter base_image and addon_image to BUILD_PARAMETERS
kubernetes-csi/csi-release-tools@2d61d3b Merge kubernetes-csi/csi-release-tools#151 from humblec/cm
kubernetes-csi/csi-release-tools@48e71f0 Replace `which` command ( non standard)  with `command -v` builtin
kubernetes-csi/csi-release-tools@feb20e2 prow.sh: collect cluster logs
kubernetes-csi/csi-release-tools@7b96bea Merge kubernetes-csi/csi-release-tools#148 from dobsonj/add-checkpathcmd-to-prow
kubernetes-csi/csi-release-tools@2d2e03b prow.sh: enable -csi.checkpathcmd option in csi-sanity
kubernetes-csi/csi-release-tools@09d4151 Merge kubernetes-csi/csi-release-tools#147 from pohly/mock-testing
kubernetes-csi/csi-release-tools@74cfbc9 prow.sh: support mock tests
kubernetes-csi/csi-release-tools@4a3f110 prow.sh: remove obsolete test suppression
kubernetes-csi/csi-release-tools@6616a6b Merge kubernetes-csi/csi-release-tools#146 from pohly/kubernetes-1.21
kubernetes-csi/csi-release-tools@510fb0f prow.sh: support Kubernetes 1.21
kubernetes-csi/csi-release-tools@c63c61b prow.sh: add CSI_PROW_DEPLOYMENT_SUFFIX
kubernetes-csi/csi-release-tools@51ac11c Merge kubernetes-csi/csi-release-tools#144 from pohly/pull-jobs
kubernetes-csi/csi-release-tools@dd54c92 pull-test.sh: test importing csi-release-tools into other repo
kubernetes-csi/csi-release-tools@7d2643a Merge kubernetes-csi/csi-release-tools#143 from pohly/path-setup
kubernetes-csi/csi-release-tools@6880b0c prow.sh: avoid creating paths unless really running tests
kubernetes-csi/csi-release-tools@b46691a go-get-kubernetes.sh: make replace statement pruning optional
kubernetes-csi/csi-release-tools@bc0504a Merge kubernetes-csi/csi-release-tools#140 from jsafrane/remove-unused-k8s-libs
kubernetes-csi/csi-release-tools@5b1de1a go-get-kubernetes.sh: remove unused k8s libs
kubernetes-csi/csi-release-tools@49b4269 Merge kubernetes-csi/csi-release-tools#120 from pohly/add-kubernetes-release
kubernetes-csi/csi-release-tools@a1e1127 Merge kubernetes-csi/csi-release-tools#139 from pohly/kind-for-kubernetes-latest
kubernetes-csi/csi-release-tools@1c0fb09 prow.sh: use KinD main for latest Kubernetes
kubernetes-csi/csi-release-tools@1d77cfc Merge kubernetes-csi/csi-release-tools#138 from pohly/kind-update-0.10
kubernetes-csi/csi-release-tools@bff2fb7 prow.sh: KinD 0.10.0
kubernetes-csi/csi-release-tools@95eac33 Merge kubernetes-csi/csi-release-tools#137 from pohly/fix-go-version-check
kubernetes-csi/csi-release-tools@437e431 verify-go-version.sh: fix check after removal of travis.yml
kubernetes-csi/csi-release-tools@1748b16 Merge kubernetes-csi/csi-release-tools#136 from pohly/go-1.16
kubernetes-csi/csi-release-tools@ec844ea remove travis.yml, Go 1.16
kubernetes-csi/csi-release-tools@df76aba Merge kubernetes-csi/csi-release-tools#134 from andyzhangx/add-build-arg
kubernetes-csi/csi-release-tools@e314a56 add build-arg ARCH for building multi-arch images, e.g. ARG ARCH FROM k8s.gcr.io/build-image/debian-base-${ARCH}:v2.1.3
kubernetes-csi/csi-release-tools@7bc70e5 Merge kubernetes-csi/csi-release-tools#129 from pohly/squash-documentation
kubernetes-csi/csi-release-tools@e0b02e7 README.md: document usage of --squash
kubernetes-csi/csi-release-tools@316cb95 Merge kubernetes-csi/csi-release-tools#132 from yiyang5055/bugfix/boilerplate
kubernetes-csi/csi-release-tools@26e2ab1 fix: default boilerplate path
kubernetes-csi/csi-release-tools@1add8c1 Merge kubernetes-csi/csi-release-tools#133 from pohly/kubernetes-1.20-tag
kubernetes-csi/csi-release-tools@3e811d6 prow.sh: fix "on-master" prow jobs
kubernetes-csi/csi-release-tools@1d60e77 Merge kubernetes-csi/csi-release-tools#131 from pohly/kubernetes-1.20-tag
kubernetes-csi/csi-release-tools@9f10459 prow.sh: support building Kubernetes for a specific version
kubernetes-csi/csi-release-tools@f7e7ee4 docs: steps for adding testing against new Kubernetes release
kubernetes-csi/csi-release-tools@fe1f284 Merge kubernetes-csi/csi-release-tools#121 from kvaps/namespace-check
kubernetes-csi/csi-release-tools@8fdf0f7 Merge kubernetes-csi/csi-release-tools#128 from fengzixu/master
kubernetes-csi/csi-release-tools@1c94220 fix: fix a bug of csi-sanity
kubernetes-csi/csi-release-tools@a4c41e6 Merge kubernetes-csi/csi-release-tools#127 from pohly/fix-boilerplate
kubernetes-csi/csi-release-tools@ece0f50 check namespace for snapshot-controller
kubernetes-csi/csi-release-tools@dbd8967 verify-boilerplate.sh: fix path to script
kubernetes-csi/csi-release-tools@9289fd1 Merge kubernetes-csi/csi-release-tools#125 from sachinkumarsingh092/optional-spelling-boilerplate-checks
kubernetes-csi/csi-release-tools@ad29307 Make the spelling and boilerplate checks optional
kubernetes-csi/csi-release-tools@5f06d02 Merge kubernetes-csi/csi-release-tools#124 from sachinkumarsingh092/fix-spellcheck-boilerplate-tests
kubernetes-csi/csi-release-tools@48186eb Fix spelling and boilerplate errors
kubernetes-csi/csi-release-tools@71690af Merge kubernetes-csi/csi-release-tools#122 from sachinkumarsingh092/include-spellcheck-boilerplate-tests
kubernetes-csi/csi-release-tools@981be3f Adding spelling and boilerplate checks.
kubernetes-csi/csi-release-tools@2bb7525 Merge kubernetes-csi/csi-release-tools#117 from fengzixu/master
kubernetes-csi/csi-release-tools@3b6d17b Merge kubernetes-csi/csi-release-tools#118 from pohly/cloud-build-timeout
kubernetes-csi/csi-release-tools@9318c6c cloud build: double the timeout, now 1 hour
kubernetes-csi/csi-release-tools@4ab8b15 use the tag to replace commit of csi-test
kubernetes-csi/csi-release-tools@5d74e45 change the csi-test import path to v4
kubernetes-csi/csi-release-tools@7dcd0a9 upgrade csi-test to v4.0.2
kubernetes-csi/csi-release-tools@86ff580 Merge kubernetes-csi/csi-release-tools#116 from andyzhangx/export-image-name
kubernetes-csi/csi-release-tools@c3a9662 allow export image name and registry name
kubernetes-csi/csi-release-tools@c6a88c6 Merge kubernetes-csi/csi-release-tools#113 from xing-yang/install_snapshot_controller
kubernetes-csi/csi-release-tools@45ec4c6 Fix the install of snapshot CRDs and controller
kubernetes-csi/csi-release-tools@5d874cc Merge kubernetes-csi/csi-release-tools#112 from xing-yang/cleanup
kubernetes-csi/csi-release-tools@79bbca7 Cleanup
kubernetes-csi/csi-release-tools@d437673 Merge kubernetes-csi/csi-release-tools#111 from xing-yang/update_snapshot_v1_rc
kubernetes-csi/csi-release-tools@57718f8 Update snapshot CRD version
kubernetes-csi/csi-release-tools@4aff857 Merge kubernetes-csi/csi-release-tools#109 from pohly/alpha-test-defaults
kubernetes-csi/csi-release-tools@0427289 Merge kubernetes-csi/csi-release-tools#110 from pohly/kind-0.9-bazel-build-workaround
kubernetes-csi/csi-release-tools@9a370ab prow.sh: work around "kind build node-image" failure
kubernetes-csi/csi-release-tools@522361e prow.sh: only run alpha tests for latest Kubernetes release
kubernetes-csi/csi-release-tools@22c0395 Merge kubernetes-csi/csi-release-tools#108 from bnrjee/master
kubernetes-csi/csi-release-tools@b5b447b Add go ldflags using LDFLAGS at the time of compilation
kubernetes-csi/csi-release-tools@16f4afb Merge kubernetes-csi/csi-release-tools#107 from pohly/kind-update
kubernetes-csi/csi-release-tools@7bcee13 prow.sh: update to kind 0.9, support Kubernetes 1.19
kubernetes-csi/csi-release-tools@df518fb prow.sh: usage of Bazel optional
kubernetes-csi/csi-release-tools@c3afd42 Merge kubernetes-csi/csi-release-tools#104 from xing-yang/snapshot
kubernetes-csi/csi-release-tools@dde93b2 Update to snapshot-controller v3.0.0
kubernetes-csi/csi-release-tools@a0f195c Merge kubernetes-csi/csi-release-tools#106 from msau42/fix-canary
kubernetes-csi/csi-release-tools@7100c12 Only set staging registry when running canary job
kubernetes-csi/csi-release-tools@b3c65f9 Merge kubernetes-csi/csi-release-tools#99 from msau42/add-release-process
kubernetes-csi/csi-release-tools@e53f3e8 Merge kubernetes-csi/csi-release-tools#103 from msau42/fix-canary
kubernetes-csi/csi-release-tools@d129462 Document new method for adding CI jobs are new K8s versions
kubernetes-csi/csi-release-tools@e73c2ce Use staging registry for canary tests
kubernetes-csi/csi-release-tools@2c09846 Add cleanup instructions to release-notes generation
kubernetes-csi/csi-release-tools@60e1cd3 Merge kubernetes-csi/csi-release-tools#98 from pohly/kubernetes-1-19-fixes
kubernetes-csi/csi-release-tools@0979c09 prow.sh: fix E2E suite for Kubernetes >= 1.18
kubernetes-csi/csi-release-tools@3b4a2f1 prow.sh: fix installing Go for Kubernetes 1.19.0
kubernetes-csi/csi-release-tools@1fbb636 Merge kubernetes-csi/csi-release-tools#97 from pohly/go-1.15
kubernetes-csi/csi-release-tools@82d108a switch to Go 1.15
kubernetes-csi/csi-release-tools@d8a2530 Merge kubernetes-csi/csi-release-tools#95 from msau42/add-release-process
kubernetes-csi/csi-release-tools@843bddc Add steps on promoting release images
kubernetes-csi/csi-release-tools@0345a83 Merge kubernetes-csi/csi-release-tools#94 from linux-on-ibm-z/bump-timeout
kubernetes-csi/csi-release-tools@1fdf2d5 cloud build: bump timeout in Prow job
kubernetes-csi/csi-release-tools@41ec6d1 Merge kubernetes-csi/csi-release-tools#93 from animeshk08/patch-1
kubernetes-csi/csi-release-tools@5a54e67 filter-junit: Fix gofmt error
kubernetes-csi/csi-release-tools@0676fcb Merge kubernetes-csi/csi-release-tools#92 from animeshk08/patch-1
kubernetes-csi/csi-release-tools@36ea4ff filter-junit: Fix golint error
kubernetes-csi/csi-release-tools@f5a4203 Merge kubernetes-csi/csi-release-tools#91 from cyb70289/arm64
kubernetes-csi/csi-release-tools@43e50d6 prow.sh: enable building arm64 image
kubernetes-csi/csi-release-tools@0d5bd84 Merge kubernetes-csi/csi-release-tools#90 from pohly/k8s-staging-sig-storage
kubernetes-csi/csi-release-tools@3df86b7 cloud build: k8s-staging-sig-storage
kubernetes-csi/csi-release-tools@c5fd961 Merge kubernetes-csi/csi-release-tools#89 from pohly/cloud-build-binfmt
kubernetes-csi/csi-release-tools@db0c2a7 cloud build: initialize support for running commands in Dockerfile
kubernetes-csi/csi-release-tools@be902f4 Merge kubernetes-csi/csi-release-tools#88 from pohly/multiarch-windows-fix
kubernetes-csi/csi-release-tools@340e082 build.make: optional inclusion of Windows in multiarch images
kubernetes-csi/csi-release-tools@5231f05 build.make: properly declare push-multiarch
kubernetes-csi/csi-release-tools@4569f27 build.make: fix push-multiarch ambiguity

git-subtree-dir: release-tools
git-subtree-split: a6a1a7979bf3ebc2bb10d0e33dd11ab281d6d39e
  • Loading branch information
pohly committed Nov 30, 2021
1 parent 17dde9e commit 83976be
Show file tree
Hide file tree
Showing 27 changed files with 1,102 additions and 296 deletions.
16 changes: 16 additions & 0 deletions .prow.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
#! /bin/bash -e

# Copyright 2021 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This is for testing csi-release-tools itself in Prow. All other
# repos use prow.sh for that, but as csi-release-tools isn't a normal
# repo with some Go code in it, it has a custom Prow test script.

./verify-shellcheck.sh "$(pwd)"
./verify-spelling.sh "$(pwd)"
./verify-boilerplate.sh "$(pwd)"
45 changes: 45 additions & 0 deletions KUBERNETES_CSI_OWNERS_ALIASES
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md

aliases:

# SIG-Storage chairs and leads should always have approval rights in all repos.
# Others may be added as needed here or in each repo.
kubernetes-csi-approvers:
- jsafrane
- msau42
- saad-ali
- xing-yang

# Reviewers are automatically assigned to new PRs. The following
# reviewers will be active in all repos. Other reviewers can be
# added in each repo.
#
# Reviewers are encouraged to set the "Busy" flag in their GitHub status
# when they are temporarily unable to review PRs.
kubernetes-csi-reviewers:
- andyzhangx
- chrishenzie
- ggriffiths
- gnufied
- humblec
- j-griffith
- Jiawei0227
- jingxu97
- jsafrane
- pohly
- xing-yang

# This documents who previously contributed to Kubernetes-CSI
# as approver.
emeritus_approver:
- lpabon
- sbezverk
- vladimirvivien

# This documents who previously contributed to Kubernetes-CSI
# as reviewer.
emeritus_reviewer:
- lpabon
- saad-ali
- sbezverk
- vladimirvivien
7 changes: 2 additions & 5 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md

approvers:
- saad-ali
- msau42
- kubernetes-csi-approvers
- pohly

reviewers:
- saad-ali
- msau42
- pohly
- kubernetes-csi-reviewers
1 change: 1 addition & 0 deletions OWNERS_ALIASES
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ The expected repository layout is:
Dockerfile in the root when only building a single command
- `Makefile` - includes `release-tools/build.make` and sets
configuration variables
- `.travis.yml` - a symlink to `release-tools/.travis.yml`
- `.prow.sh` script which imports `release-tools/prow.sh`
and may contain further customization
- `.cloudbuild.sh` and `cloudbuild.yaml` as symlinks to
the corresponding files in `release-tools` or (if necessary)
as custom files

To create a release, tag a certain revision with a name that
starts with `v`, for example `v1.0.0`, then `make push`
Expand All @@ -38,16 +42,23 @@ images. Building from master creates the main `canary` image.
Sharing and updating
--------------------

[`git subtree`](https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt)
[`git subtree`](https://github.com/git/git/blob/HEAD/contrib/subtree/git-subtree.txt)
is the recommended way of maintaining a copy of the rules inside the
`release-tools` directory of a project. This way, it is possible to make
changes also locally, test them and then push them back to the shared
repository at a later time.

We no longer care about importing the full commit history, so `--squash` should be used
when submitting a `release-tools` update. Also make sure that the PR for that
contains the automatically generated commit message in the PR description.
It contains the list of individual commits that were squashed. The script from
https://github.com/kubernetes-csi/csi-release-tools/issues/7 can create such
PRs automatically.

Cheat sheet:

- `git subtree add --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - add release tools to a repo which does not have them yet (only once)
- `git subtree pull --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - update local copy to latest upstream (whenever upstream changes)
- `git subtree add --squash --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - add release tools to a repo which does not have them yet (only once)
- `git subtree pull --squash --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - update local copy to latest upstream (whenever upstream changes)
- edit, `git commit`, `git subtree push --prefix=release-tools git@github.com:<user>/csi-release-tools.git <my-new-or-existing-branch>` - push to a new branch before submitting a PR

verify-shellcheck.sh
Expand Down Expand Up @@ -78,7 +89,7 @@ main

All Kubernetes-CSI repos are expected to switch to Prow. For details
on what is enabled in Prow, see
https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-csi
https://github.com/kubernetes/test-infra/tree/HEAD/config/jobs/kubernetes-csi

Test results for periodic jobs are visible in
https://testgrid.k8s.io/sig-storage-csi-ci
Expand Down
2 changes: 1 addition & 1 deletion SECURITY_CONTACTS
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# to for triaging and handling of incoming issues.
#
# The below names agree to abide by the
# [Embargo Policy](https://github.com/kubernetes/sig-release/blob/master/security-release-process-documentation/security-release-process.md#embargo-policy)
# [Embargo Policy](https://github.com/kubernetes/sig-release/blob/HEAD/security-release-process-documentation/security-release-process.md#embargo-policy)
# and will be removed and replaced if they violate that agreement.
#
# DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE
Expand Down
89 changes: 70 additions & 19 deletions SIDECAR_RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,8 @@ The release manager must:
* Be a member of the kubernetes-csi organization. Open an
[issue](https://github.com/kubernetes/org/issues/new?assignees=&labels=area%2Fgithub-membership&template=membership.md&title=REQUEST%3A+New+membership+for+%3Cyour-GH-handle%3E) in
kubernetes/org to request membership
* Be a top level approver for the repository. To become a top level approver,
the candidate must demonstrate ownership and deep knowledge of the repository
through active maintainence, responding to and fixing issues, reviewing PRs,
test triage.
* Be part of the maintainers or admin group for the repository. admin is a
superset of maintainers, only maintainers level is required for cutting a
release. Membership can be requested by submitting a PR to kubernetes/org.
* Be part of the maintainers group for the repository.
Membership can be requested by submitting a PR to kubernetes/org.
[Example](https://github.com/kubernetes/org/pull/1467)

## Updating CI Jobs
Expand All @@ -31,18 +26,19 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
1. "-on-master" jobs are the closest reflection to the new Kubernetes version.
1. Fixes to our prow.sh CI script can be tested in the [CSI hostpath
repo](https://github.com/kubernetes-csi/csi-driver-host-path) by modifying
[prow.sh](https://github.com/kubernetes-csi/csi-driver-host-path/blob/master/release-tools/prow.sh)
[prow.sh](https://github.com/kubernetes-csi/csi-driver-host-path/blob/HEAD/release-tools/prow.sh)
along with any overrides in
[.prow.sh](https://github.com/kubernetes-csi/csi-driver-host-path/blob/master/.prow.sh)
[.prow.sh](https://github.com/kubernetes-csi/csi-driver-host-path/blob/HEAD/.prow.sh)
to mirror the failing environment. Once e2e tests are passing (verify-unit tests
will fail), then the prow.sh changes can be submitted to [csi-release-tools](https://github.com/kubernetes-csi/csi-release-tools).
1. Changes can then be updated in all the sidecar repos and hostpath driver repo
by following the [update
instructions](https://github.com/kubernetes-csi/csi-release-tools/blob/master/README.md#sharing-and-updating).
1. New pull and CI jobs are configured by
[gen-jobs.sh](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-csi/gen-jobs.sh).
New pull jobs that have been unverified should be initially made optional.
[Example](https://github.com/kubernetes/test-infra/pull/15055)
instructions](https://github.com/kubernetes-csi/csi-release-tools/blob/HEAD/README.md#sharing-and-updating).
1. New pull and CI jobs are configured by adding new K8s versions to the top of
[gen-jobs.sh](https://github.com/kubernetes/test-infra/blob/HEAD/config/jobs/kubernetes-csi/gen-jobs.sh).
New pull jobs that have been unverified should be initially made optional by
setting the new K8s version as
[experimental](https://github.com/kubernetes/test-infra/blob/a1858f46d6014480b130789df58b230a49203a64/config/jobs/kubernetes-csi/gen-jobs.sh#L40).
1. Once new pull and CI jobs have been verified, and the new Kubernetes version
is released, we can make the optional jobs required, and also remove the
Kubernetes versions that are no longer supported.
Expand All @@ -51,17 +47,22 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
1. Identify all issues and ongoing PRs that should go into the release, and
drive them to resolution.
1. Download v2.8+ [K8s release notes
generator](https://github.com/kubernetes/release/tree/master/cmd/release-notes)
generator](https://github.com/kubernetes/release/tree/HEAD/cmd/release-notes)
1. Generate release notes for the release. Replace arguments with the relevant
information.
* Clean up old cached information (also needed if you are generating release
notes for multiple repos)
```bash
rm -rf /tmp/k8s-repo
```
* For new minor releases on master:
```
```bash
GITHUB_TOKEN=<token> release-notes --discover=mergebase-to-latest
--github-org=kubernetes-csi --github-repo=external-provisioner
--required-author="" --output out.md
```
* For new patch releases on a release branch:
```
```bash
GITHUB_TOKEN=<token> release-notes --discover=patch-to-latest --branch=release-1.1
--github-org=kubernetes-csi --github-repo=external-provisioner
--required-author="" --output out.md
Expand All @@ -86,9 +87,59 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
[external-provisioner example](https://github.com/kubernetes-csi/external-provisioner/releases/new)
1. If release was a new major/minor version, create a new `release-<minor>`
branch at that commit.
1. Check [image build status](https://k8s-testgrid.appspot.com/sig-storage-image-build).
1. Promote images from k8s-staging-sig-storage to k8s.gcr.io/sig-storage. From
the [k8s image
repo](https://github.com/kubernetes/k8s.io/tree/HEAD/k8s.gcr.io/images/k8s-staging-sig-storage),
run `./generate.sh > images.yaml`, and send a PR with the updated images.
Once merged, the image promoter will copy the images from staging to prod.
1. Update [kubernetes-csi/docs](https://github.com/kubernetes-csi/docs) sidecar
and feature pages with the new released version.
1. After all the sidecars have been released, update
CSI hostpath driver with the new sidecars in the [CSI repo](https://github.com/kubernetes-csi/csi-driver-host-path/tree/master/deploy)
CSI hostpath driver with the new sidecars in the [CSI repo](https://github.com/kubernetes-csi/csi-driver-host-path/tree/HEAD/deploy)
and [k/k
in-tree](https://github.com/kubernetes/kubernetes/tree/master/test/e2e/testing-manifests/storage-csi/hostpath/hostpath)
in-tree](https://github.com/kubernetes/kubernetes/tree/HEAD/test/e2e/testing-manifests/storage-csi/hostpath/hostpath)

## Adding support for a new Kubernetes release

1. Add the new release to `k8s_versions` in
https://github.com/kubernetes/test-infra/blob/090dec5dd535d5f61b7ba52e671a810f5fc13dfd/config/jobs/kubernetes-csi/gen-jobs.sh#L25
to enable generating a job for it. Set `experimental_k8s_version`
in
https://github.com/kubernetes/test-infra/blob/090dec5dd535d5f61b7ba52e671a810f5fc13dfd/config/jobs/kubernetes-csi/gen-jobs.sh#L40
to ensure that the new jobs aren't run for PRs unless explicitly
requested. Generate and submit the new jobs.
1. Create a test PR to try out the new job in some repo with `/test
pull-kubernetes-csi-<repo>-<x.y>-on-kubernetes-<x.y>` where x.y
matches the Kubernetes release. Alternatively, run .prow.sh in that
repo locally with `CSI_PROW_KUBERNETES_VERSION=x.y.z`.
1. Optional: update to a [new
release](https://github.com/kubernetes-sigs/kind/tags) of kind with
pre-built images for the new Kubernetes release. This is optional
if the current version of kind is able to build images for the new
Kubernetes release. However, jobs require less resources when they
don't need to build those images from the Kubernetes source code.
This change needs to be tried out in a PR against a component
first, then get submitted against csi-release-tools.
1. Optional: propagate the updated csi-release-tools to all components
with the script from
https://github.com/kubernetes-csi/csi-release-tools/issues/7#issuecomment-707025402
1. Once it is likely to work in all components, unset
`experimental_k8s_version` and submit the updated jobs.
1. Once all sidecars for the new Kubernetes release are released,
either bump the version number of the images in the existing
[csi-driver-host-path
deployments](https://github.com/kubernetes-csi/csi-driver-host-path/tree/HEAD/deploy)
and/or create a new deployment, depending on what Kubernetes
release an updated sidecar is compatible with. If no new deployment
is needed, then add a symlink to document that there intentionally
isn't a separate deployment. This symlink is not needed for Prow
testing because that will use "kubernetes-latest" as fallback.
Update that link when creating a new deployment.
1. Create a new csi-driver-host-path release.
1. Bump `CSI_PROW_DRIVER_VERSION` in prow.sh to that new release and
(eventually) roll that change out to all repos by updating
`release-tools` in them. This is used when testing manually. The
Prow jobs override that value, so also update
`hostpath_driver_version` in
https://github.com/kubernetes/test-infra/blob/91b04e6af3a40a9bcff25aa030850a4721e2dd2b/config/jobs/kubernetes-csi/gen-jobs.sh#L46-L47
13 changes: 13 additions & 0 deletions boilerplate/boilerplate.Dockerfile.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright YEAR The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
13 changes: 13 additions & 0 deletions boilerplate/boilerplate.Makefile.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright YEAR The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
13 changes: 13 additions & 0 deletions boilerplate/boilerplate.bzl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright YEAR The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
15 changes: 15 additions & 0 deletions boilerplate/boilerplate.go.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/*
Copyright YEAR The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
Loading

0 comments on commit 83976be

Please sign in to comment.