Skip to content

Commit c9ee74c

Browse files
author
Tore Stendal Lønøy
committed
chore(release-process): update flags and flags link
as part of the release process, it is required to update the flags documentation and also ensuring that the components.md file points to the tagged version of the flags.md file.
1 parent 8251159 commit c9ee74c

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

vertical-pod-autoscaler/RELEASE.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,18 @@ sure nothing we care about will break if we do.
122122
1. [ ] Update information about newest version and K8s compatibility in
123123
[the installation section of README](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/README.md#installation).
124124
125-
1. [ ] Update the yaml files:
125+
1. [ ] Update the yaml and sh files:
126126
127127
```sh
128-
sed -i -s "s|[0-9]\+\.[0-9]\+\.[0-9]\+|[*vpa-version*]|" ./deploy/*-deployment*.yaml ./hack/vpa-process-yaml.sh
128+
sed -i -s "s|[0-9]\+\.[0-9]\+\.[0-9]\+|[*vpa-version*]|g" ./deploy/*-deployment*.yaml
129+
sed -i -s "s|DEFAULT_TAG=\"[0-9]\+\.[0-9]\+\.[0-9]\+\"|DEFAULT_TAG=\"[*vpa-version*]\"|g" ./hack/*.sh
130+
```
131+
132+
1. [ ] Generate the flags files:
133+
134+
```sh
135+
./hack/generate-flags.sh
129136
```
130-
1. [ ] Update the default tag in [vpa-up.sh](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/hack/vpa-up.sh).
131137
132138
1. [ ] Merge these changes into branch vpa-release-1.{$minor} and optionally into master if 1.{$minor} is the latest minor release
133139
(example PR: [#5460](https://github.com/kubernetes/autoscaler/pull/5460)).

vertical-pod-autoscaler/docs/flags.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Vertical Pod Autoscaler Flags
22
This document contains the flags for all VPA components.
33

4+
To view the most recent _release_ of flags for all VPA components, consult the release tag [flags(1.3.0)](/kubernetes/autoscaler/blob/vertical-pod-autoscaler-1.3.0/vertical-pod-autoscaler/docs/flags.md) documentation.
5+
46
> **Note:** This document is auto-generated from the default branch (master) of the VPA repository.
57
68
# What are the parameters to VPA admission-controller?
@@ -34,7 +36,7 @@ This document is auto-generated from the flag definitions in the VPA admission-c
3436
| `--tls-cert-file` | "/etc/tls-certs/serverCert.pem" | Path to server certificate PEM file. |
3537
| `--tls-ciphers` | | A comma-separated or colon-separated list of ciphers to accept. Only works when min-tls-version is set to tls1_2. |
3638
| `--tls-private-key` | "/etc/tls-certs/serverKey.pem" | Path to server certificate key PEM file. |
37-
| `--v` | 4 | Set the log level verbosity |
39+
| `--v` | | Set the log level verbosity |
3840
| `--vmodule` | | comma-separated list of pattern=N settings for file-filtered logging |
3941
| `--vpa-object-namespace` | | Specifies the namespace to search for VPA objects. Leave empty to include all namespaces. If provided, the garbage collector will only clean this namespace. |
4042
| `--webhook-address` | | Address under which webhook is registered. Used when registerByURL is set to true. |
@@ -119,7 +121,7 @@ This document is auto-generated from the flag definitions in the VPA recommender
119121
| `--target-memory-percentile` | 0.9 | Memory usage percentile that will be used as a base for memory target recommendation. Doesn't affect memory lower bound nor memory upper bound. |
120122
| `--use-external-metrics` | | ALPHA. Use an external metrics provider instead of metrics_server. |
121123
| `--username` | | The username used in the prometheus server basic auth |
122-
| `--v` | 4 | Set the log level verbosity |
124+
| `--v` | | Set the log level verbosity |
123125
| `--vmodule` | | comma-separated list of pattern=N settings for file-filtered logging |
124126
| `--vpa-object-namespace` | | Specifies the namespace to search for VPA objects. Leave empty to include all namespaces. If provided, the garbage collector will only clean this namespace. |
125127

@@ -161,7 +163,7 @@ This document is auto-generated from the flag definitions in the VPA updater cod
161163
| `--stderrthreshold` | | set the log level threshold for writing to standard error |
162164
| `--updater-interval` | 1m0s | How often updater should run |
163165
| `--use-admission-controller-status` | true | If true, updater will only evict pods when admission controller status is valid. |
164-
| `--v` | 4 | Set the log level verbosity |
166+
| `--v` | | Set the log level verbosity |
165167
| `--vmodule` | | comma-separated list of pattern=N settings for file-filtered logging |
166168
| `--vpa-object-namespace` | | Specifies the namespace to search for VPA objects. Leave empty to include all namespaces. If provided, the garbage collector will only clean this namespace. |
167169

vertical-pod-autoscaler/hack/generate-flags.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ set -o pipefail
2121
SCRIPT_ROOT=$(realpath $(dirname "${BASH_SOURCE[0]}"))/..
2222
TARGET_FILE="${SCRIPT_ROOT}/docs/flags.md"
2323
COMPONENTS=("admission-controller" "recommender" "updater")
24+
DEFAULT_TAG="1.3.0"
2425

2526
# Function to extract flags from a binary
2627
extract_flags() {
@@ -75,6 +76,8 @@ echo "Generating flags documentation..."
7576
echo "# Vertical Pod Autoscaler Flags"
7677
echo "This document contains the flags for all VPA components."
7778
echo
79+
echo "To view the most recent _release_ of flags for all VPA components, consult the release tag [flags($DEFAULT_TAG)](/kubernetes/autoscaler/blob/vertical-pod-autoscaler-$DEFAULT_TAG/vertical-pod-autoscaler/docs/flags.md) documentation."
80+
echo
7881
echo "> **Note:** This document is auto-generated from the default branch (master) of the VPA repository."
7982
echo
8083

0 commit comments

Comments
 (0)