changes for release v1.1.1 (kubernetes#8125)

joomcode · May 17, 2023 · cb8823b · cb8823b
1 parent bed6521
commit cb8823b
Show file tree

Hide file tree

Showing 16 changed files with 545 additions and 377 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,51 @@
 # Changelog
 
+### 1.1.1
+
+**Image:** 
+- k8s.gcr.io/ingress-nginx/controller:v1.1.1@sha256:0bc88eb15f9e7f84e8e56c14fa5735aaa488b840983f87bd79b1054190e660de
+
+This release contains several fixes and improvements. This image is now built using Go v1.17.6 and gRPC v1.43.0. See detailed list below.
+
+_Changes:_
+
+- [8120](https://github.com/kubernetes/ingress-nginx/pull/8120)    Update go in runner and release v1.1.1
+- [8119](https://github.com/kubernetes/ingress-nginx/pull/8119)    Update to go v1.17.6
+- [8118](https://github.com/kubernetes/ingress-nginx/pull/8118)    Remove deprecated libraries, update other libs
+- [8117](https://github.com/kubernetes/ingress-nginx/pull/8117)    Fix codegen errors
+- [8115](https://github.com/kubernetes/ingress-nginx/pull/8115)    chart/ghaction: set the correct permission to have access to push a release
+- [8098](https://github.com/kubernetes/ingress-nginx/pull/8098)    generating SHA for CA only certs in backend_ssl.go + comparision of P…
+- [8088](https://github.com/kubernetes/ingress-nginx/pull/8088)    Fix Edit this page link to use main branch
+- [8072](https://github.com/kubernetes/ingress-nginx/pull/8072)    Expose GeoIP2 Continent code as variable
+- [8061](https://github.com/kubernetes/ingress-nginx/pull/8061)    docs(charts): using helm-docs for chart
+- [8058](https://github.com/kubernetes/ingress-nginx/pull/8058)    Bump github.com/spf13/cobra from 1.2.1 to 1.3.0
+- [8054](https://github.com/kubernetes/ingress-nginx/pull/8054)    Bump google.golang.org/grpc from 1.41.0 to 1.43.0
+- [8051](https://github.com/kubernetes/ingress-nginx/pull/8051)    align bug report with feature request regarding kind documentation
+- [8046](https://github.com/kubernetes/ingress-nginx/pull/8046)    Report expired certificates (#8045)
+- [8044](https://github.com/kubernetes/ingress-nginx/pull/8044)    remove G109 check till gosec resolves issues
+- [8042](https://github.com/kubernetes/ingress-nginx/pull/8042)    docs_multiple_instances_one_cluster_ticket_7543
+- [8041](https://github.com/kubernetes/ingress-nginx/pull/8041)    docs: fix typo'd executible name
+- [8035](https://github.com/kubernetes/ingress-nginx/pull/8035)    Comment busy owners
+- [8029](https://github.com/kubernetes/ingress-nginx/pull/8029)    Add stream-snippet as a ConfigMap and Annotation option
+- [8023](https://github.com/kubernetes/ingress-nginx/pull/8023)    fix nginx compilation flags
+- [8021](https://github.com/kubernetes/ingress-nginx/pull/8021)    Disable default modsecurity_rules_file if modsecurity-snippet is specified
+- [8019](https://github.com/kubernetes/ingress-nginx/pull/8019)    Revise main documentation page
+- [8018](https://github.com/kubernetes/ingress-nginx/pull/8018)    Preserve order of plugin invocation
+- [8015](https://github.com/kubernetes/ingress-nginx/pull/8015)    Add newline indenting to admission webhook annotations
+- [8014](https://github.com/kubernetes/ingress-nginx/pull/8014)    Add link to example error page manifest in docs
+- [8009](https://github.com/kubernetes/ingress-nginx/pull/8009)    Fix spelling in documentation and top-level files
+- [8008](https://github.com/kubernetes/ingress-nginx/pull/8008)    Add relabelings in controller-servicemonitor.yaml
+- [8003](https://github.com/kubernetes/ingress-nginx/pull/8003)    Minor improvements (formatting, consistency) in install guide
+- [8001](https://github.com/kubernetes/ingress-nginx/pull/8001)    fix: go-grpc Dockerfile
+- [7999](https://github.com/kubernetes/ingress-nginx/pull/7999)    images: use k8s-staging-test-infra/gcb-docker-gcloud
+- [7996](https://github.com/kubernetes/ingress-nginx/pull/7996)    doc: improvement
+- [7983](https://github.com/kubernetes/ingress-nginx/pull/7983)    Fix a couple of misspellings in the annotations documentation.
+- [7979](https://github.com/kubernetes/ingress-nginx/pull/7979)    allow set annotations for admission Jobs
+- [7977](https://github.com/kubernetes/ingress-nginx/pull/7977)    Add ssl_reject_handshake to defaul server
+- [7975](https://github.com/kubernetes/ingress-nginx/pull/7975)    add legacy version update v0.50.0 to main changelog
+- [7972](https://github.com/kubernetes/ingress-nginx/pull/7972)    updated service upstream definition
+- [7963](https://github.com/kubernetes/ingress-nginx/pull/7963)    Change sanitization message from error to warning
+
 ### 1.1.0
 
 **Image:**

diff --git a/README.md b/README.md
@@ -28,22 +28,24 @@ For detailed changes on the `ingress-nginx` helm chart, please check the followi
 
 ### Support Versions table 
 
-| Ingress-nginx version | k8s supported version  | Alpine Version | Nginx Version |
-|-----------------------|-------------           |----------------|---------------|
-| v1.1.0                | 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
-| v1.0.5                | 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
-| v1.0.4                | 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
-| v1.0.3                | 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
-| v1.0.2                | 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
-| v1.0.1                | 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
-| v1.0.0                | 1.22, 1.21, 1.20, 1.19 | 3.13.5         |  1.20.1       |
-| v0.49.3               | 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
-| v0.49.2               | 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
-| v0.49.1               | 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
-| v0.49.0               | 1.21, 1.20, 1.19       | 3.13.5         |  1.20.1       |
-| v0.48.1               | 1.21, 1.20, 1.19       | 3.13.5         |  1.20.1       |
-| v0.47.0               | 1.21, 1.20, 1.19       | 3.13.5         |  1.20.1       |
-| v0.46.0               | 1.21, 1.20, 1.19       | 3.13.2         |  1.19.6       |
+| Ingress-nginx version | k8s supported version        | Alpine Version | Nginx Version |
+|-----------------------|------------------------------|----------------|---------------|
+| v1.1.1                | 1.23, 1.22, 1.21, 1.20, 1.19 | 3.14.2         |  1.19.9†      |
+| v1.1.0                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
+| v1.0.5                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
+| v1.0.4                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
+| v1.0.3                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
+| v1.0.2                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
+| v1.0.1                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         |  1.19.9†      |
+| v1.0.0                | 1.22, 1.21, 1.20, 1.19       | 3.13.5         |  1.20.1       |
+| v0.50.0               | 1.21, 1.20, 1.19             | 3.14.2         |  1.19.9†      |
+| v0.49.3               | 1.21, 1.20, 1.19             | 3.14.2         |  1.19.9†      |
+| v0.49.2               | 1.21, 1.20, 1.19             | 3.14.2         |  1.19.9†      |
+| v0.49.1               | 1.21, 1.20, 1.19             | 3.14.2         |  1.19.9†      |
+| v0.49.0               | 1.21, 1.20, 1.19             | 3.13.5         |  1.20.1       |
+| v0.48.1               | 1.21, 1.20, 1.19             | 3.13.5         |  1.20.1       |
+| v0.47.0               | 1.21, 1.20, 1.19             | 3.13.5         |  1.20.1       |
+| v0.46.0               | 1.21, 1.20, 1.19             | 3.13.2         |  1.19.6       |
 
 † _This build is [patched against CVE-2021-23017](https://github.com/openresty/openresty/commit/4b5ec7edd78616f544abc194308e0cf4b788725b#diff-42ef841dc27fe0b5aa2d06bd31308bb63a59cdcddcbcddd917248349d22020a3)._
 

diff --git a/RELEASE.md b/RELEASE.md
@@ -167,14 +167,23 @@ Promoting the images basically means that images, that were pushed to staging co
     - annotations
       - artifacthub.io/prerelease: "true" 
       - artifacthub.io/changes: |
-        - Add the titles of the PRs merged after previous release
+        - Add the titles of the PRs merged after previous release here. I used the github-cli to get that list like so `gh pr list -s merged -L 38 -B main | cut -f1,2`
 
-### d. Edit the values.yaml
+### d. Edit the values.yaml and run helm-docs
   - [Fields to edit in values.yaml](https://github.com/kubernetes/ingress-nginx/blob/main/charts/ingress-nginx/values.yaml)
 
     - tag
     - digest
 
+  - [helm-docs](https://github.com/norwoodj/helm-docs) is a tool that generates the README.md for a helm-chart automatically. In the CI pipeline workflow of github actions (/.github/workflows/ci.yaml), you can see how helm-docs is used. But the CI pipeline is not designed to make commits back into the project. So we need to run helm-docs manually, and check in the resulting autogenerated README.md at the path /charts/ingress-nginx/README.md 
+    ```
+          GOBIN=$PWD GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.6.0
+          ./helm-docs --chart-search-root=${GITHUB_WORKSPACE}/charts
+          git diff --exit-code
+          rm -f ./helm-docs
+    ```
+    Watchout for mistakes like leaving the helm-docs executable in your clone workspace or not not checking the new README.md manually etc.
+
 ### e. Edit the static manifests
 
   - Prepare to use a script to update the edit the static manifests and set the "image", "digest", "version" etc. fields to the desired value.
@@ -207,22 +216,57 @@ Promoting the images basically means that images, that were pushed to staging co
       data:
         http-snippet:|
           server{
-          listen 2443;
-          return 308 https://$host$request_uri;
+            listen 2443;
+            return 308 https://$host$request_uri;
           }
       ```
 
 ### f. Edit the changelog
   [Changelog.md](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md) 
-    - Add the PRs merged after previous release
-    - One useful command to get this list is
-      ```
-      git log controller-v0.48.1..HEAD --pretty=%s
-      ```
+- Add the PRs merged after previous release
+- If you use the github cli https://cli.github.com/, then that is one useful command to get this list of PRs
+- One way of using gh cli and getting the list of PRs for changelog is described below
+  - Install and configure github cli as per the docs of gh-cli
+  - Change dir to your clone, of your fork, of the ingress-nginx project
+  - Run the below command and save the output to a txt file
+
+    ```
+    gh pr list -s merged -L 38 -B main | cut -f1,2 > ~/tmp/prlist.txt
+    ```
+    - The -L 38 was used for 2 reasons.
+      - Default number of results is 30 and there were more than 30 PRs merged while releasing v1.1.1.
+      -  The other reason to use -L 38 was to ommit the 39th, the 40th and the 41st line in the resulting list. These were non-relevant PRs.
+  - Then use some easy automation in bash/python/whathaveyou to get the PR-List that can be used in the changelog
+  - I save output of above command to a file called prlist.txt. It looks somewhat like this ;
+
+    ```
+    % cat ~/Downloads/prlist.txt 
+    8129    fix syntax in docs for multi-tls example
+    8120    Update go in runner and release v1.1.1
+    8119    Update to go v1.17.6
+    8118    Remove deprecated libraries, update other libs
+    8117    Fix codegen errors
+    8115    chart/ghaction: set the correct permission to have access to push a release 
+    ....
+    ```
+  - Then I use the bash scripty way seen below to convert those PR numbers into links. If I saved the below content in a script called prlist_to_changelog.sh, then I run the command `prlist_to_changelog.sh prlist.txt`
+
+    ```
+    #!/usr/bin/bash
+
+    file="$1"
+
+    while read -r line; do
+      pr_num=`echo "$line" | cut -f1`
+      pr_title=`echo "$line" | cut -f2`
+      echo "[$pr_num](https://github.com/kubernetes/ingress-nginx/pull/$pr_num) $pr_title"
+    done <$file
+
+    ```
 
 ### g. Edit the Documentation:
-    - Update the version in [docs/deploy/index.md](docs/deploy/index.md)
-    - Update Supported versions in the Support Versions table in the README.md 
+- Update the version in [docs/deploy/index.md](docs/deploy/index.md)
+- Update Supported versions in the Support Versions table in the README.md 
 
 ### h. Edit stable.txt
 

diff --git a/charts/ingress-nginx/CHANGELOG.md b/charts/ingress-nginx/CHANGELOG.md
@@ -2,6 +2,44 @@
 
 This file documents all notable changes to [ingress-nginx](https://github.com/kubernetes/ingress-nginx) Helm Chart. The release numbering uses [semantic versioning](http://semver.org).
 
+### 4.0.15
+
+- [8120] https://github.com/kubernetes/ingress-nginx/pull/8120    Update go in runner and release v1.1.1
+- [8119] https://github.com/kubernetes/ingress-nginx/pull/8119    Update to go v1.17.6
+- [8118] https://github.com/kubernetes/ingress-nginx/pull/8118    Remove deprecated libraries, update other libs
+- [8117] https://github.com/kubernetes/ingress-nginx/pull/8117    Fix codegen errors
+- [8115] https://github.com/kubernetes/ingress-nginx/pull/8115    chart/ghaction: set the correct permission to have access to push a release
+- [8098] https://github.com/kubernetes/ingress-nginx/pull/8098    generating SHA for CA only certs in backend_ssl.go + comparision of P…
+- [8088] https://github.com/kubernetes/ingress-nginx/pull/8088    Fix Edit this page link to use main branch
+- [8072] https://github.com/kubernetes/ingress-nginx/pull/8072    Expose GeoIP2 Continent code as variable
+- [8061] https://github.com/kubernetes/ingress-nginx/pull/8061    docs(charts): using helm-docs for chart
+- [8058] https://github.com/kubernetes/ingress-nginx/pull/8058    Bump github.com/spf13/cobra from 1.2.1 to 1.3.0
+- [8054] https://github.com/kubernetes/ingress-nginx/pull/8054    Bump google.golang.org/grpc from 1.41.0 to 1.43.0
+- [8051] https://github.com/kubernetes/ingress-nginx/pull/8051    align bug report with feature request regarding kind documentation
+- [8046] https://github.com/kubernetes/ingress-nginx/pull/8046    Report expired certificates (#8045)
+- [8044] https://github.com/kubernetes/ingress-nginx/pull/8044    remove G109 check till gosec resolves issues
+- [8042] https://github.com/kubernetes/ingress-nginx/pull/8042    docs_multiple_instances_one_cluster_ticket_7543
+- [8041] https://github.com/kubernetes/ingress-nginx/pull/8041    docs: fix typo'd executible name
+- [8035] https://github.com/kubernetes/ingress-nginx/pull/8035    Comment busy owners
+- [8029] https://github.com/kubernetes/ingress-nginx/pull/8029    Add stream-snippet as a ConfigMap and Annotation option
+- [8023] https://github.com/kubernetes/ingress-nginx/pull/8023    fix nginx compilation flags
+- [8021] https://github.com/kubernetes/ingress-nginx/pull/8021    Disable default modsecurity_rules_file if modsecurity-snippet is specified
+- [8019] https://github.com/kubernetes/ingress-nginx/pull/8019    Revise main documentation page
+- [8018] https://github.com/kubernetes/ingress-nginx/pull/8018    Preserve order of plugin invocation
+- [8015] https://github.com/kubernetes/ingress-nginx/pull/8015    Add newline indenting to admission webhook annotations
+- [8014] https://github.com/kubernetes/ingress-nginx/pull/8014    Add link to example error page manifest in docs
+- [8009] https://github.com/kubernetes/ingress-nginx/pull/8009    Fix spelling in documentation and top-level files
+- [8008] https://github.com/kubernetes/ingress-nginx/pull/8008    Add relabelings in controller-servicemonitor.yaml
+- [8003] https://github.com/kubernetes/ingress-nginx/pull/8003    Minor improvements (formatting, consistency) in install guide
+- [8001] https://github.com/kubernetes/ingress-nginx/pull/8001    fix: go-grpc Dockerfile
+- [7999] https://github.com/kubernetes/ingress-nginx/pull/7999    images: use k8s-staging-test-infra/gcb-docker-gcloud
+- [7996] https://github.com/kubernetes/ingress-nginx/pull/7996    doc: improvement
+- [7983] https://github.com/kubernetes/ingress-nginx/pull/7983    Fix a couple of misspellings in the annotations documentation.
+- [7979] https://github.com/kubernetes/ingress-nginx/pull/7979    allow set annotations for admission Jobs
+- [7977] https://github.com/kubernetes/ingress-nginx/pull/7977    Add ssl_reject_handshake to defaul server
+- [7975] https://github.com/kubernetes/ingress-nginx/pull/7975    add legacy version update v0.50.0 to main changelog
+- [7972] https://github.com/kubernetes/ingress-nginx/pull/7972    updated service upstream definition
+
 ### 4.0.14
 
 - [8061] https://github.com/kubernetes/ingress-nginx/pull/8061 Using helm-docs to populate values table in README.md

diff --git a/charts/ingress-nginx/Chart.yaml b/charts/ingress-nginx/Chart.yaml
@@ -2,8 +2,8 @@ apiVersion: v2
 name: ingress-nginx
 # When the version is modified, make sure the artifacthub.io/changes list is updated
 # Also update CHANGELOG.md
-version: 4.0.14
-appVersion: 1.1.0
+version: 4.0.15
+appVersion: 1.1.1
 home: https://github.com/kubernetes/ingress-nginx
 description: Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer
 icon: https://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/Nginx_logo.svg/500px-Nginx_logo.svg.png
@@ -24,4 +24,38 @@ annotations:
   # List of changes for the release in artifacthub.io
   # https://artifacthub.io/packages/helm/ingress-nginx/ingress-nginx?modal=changelog
   artifacthub.io/changes: |
-    - using helm-docs to populate values table in README.md
+    - #8120    Update go in runner and release v1.1.1
+    - #8119    Update to go v1.17.6
+    - #8118    Remove deprecated libraries, update other libs
+    - #8117    Fix codegen errors
+    - #8115    chart/ghaction: set the correct permission to have access to push a release
+    - #8098    generating SHA for CA only certs in backend_ssl.go + comparision of P…
+    - #8088    Fix Edit this page link to use main branch
+    - #8072    Expose GeoIP2 Continent code as variable
+    - #8061    docs(charts): using helm-docs for chart
+    - #8058    Bump github.com/spf13/cobra from 1.2.1 to 1.3.0
+    - #8054    Bump google.golang.org/grpc from 1.41.0 to 1.43.0
+    - #8051    align bug report with feature request regarding kind documentation
+    - #8046    Report expired certificates (#8045)
+    - #8044    remove G109 check till gosec resolves issues
+    - #8042    docs_multiple_instances_one_cluster_ticket_7543
+    - #8041    docs: fix typo'd executible name
+    - #8035    Comment busy owners
+    - #8029    Add stream-snippet as a ConfigMap and Annotation option
+    - #8023    fix nginx compilation flags
+    - #8021    Disable default modsecurity_rules_file if modsecurity-snippet is specified
+    - #8019    Revise main documentation page
+    - #8018    Preserve order of plugin invocation
+    - #8015    Add newline indenting to admission webhook annotations
+    - #8014    Add link to example error page manifest in docs
+    - #8009    Fix spelling in documentation and top-level files
+    - #8008    Add relabelings in controller-servicemonitor.yaml
+    - #8003    Minor improvements (formatting, consistency) in install guide
+    - #8001    fix: go-grpc Dockerfile
+    - #7999    images: use k8s-staging-test-infra/gcb-docker-gcloud
+    - #7996    doc: improvement
+    - #7983    Fix a couple of misspellings in the annotations documentation.
+    - #7979    allow set annotations for admission Jobs
+    - #7977    Add ssl_reject_handshake to defaul server
+    - #7975    add legacy version update v0.50.0 to main changelog
+    - #7972    updated service upstream definition