chore(README): update upgrade notes for v1.2.x. to v1.3.x et al (#339)

Release notes for #338
Nextdoor · Oct 25, 2024 · ffb64c5 · ffb64c5
1 parent 5dc5c64
commit ffb64c5
Show file tree

Hide file tree

Showing 9 changed files with 88 additions and 6 deletions.
diff --git a/charts/rollout-app/Chart.yaml b/charts/rollout-app/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: rollout-app
 description: Argo Rollout-based Application Helm Chart
 type: application
-version: 1.3.0
+version: 1.3.1
 appVersion: latest
 maintainers:
   - name: diranged

diff --git a/charts/rollout-app/README.md b/charts/rollout-app/README.md
@@ -2,7 +2,7 @@
 
 Argo Rollout-based Application Helm Chart
 
-![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
+![Version: 1.3.1](https://img.shields.io/badge/Version-1.3.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
 
 [analysistemplate]: https://argoproj.github.io/argo-rollouts/features/analysis/?query=AnalysisTemplate#background-analysis
 [argo_rollouts]: https://argoproj.github.io/argo-rollouts/
@@ -18,6 +18,20 @@ how these work, and the various custom resource definitions.
 
 ## Upgrade Notes
 
+### 1.2.x -> 1.3.x
+
+**NEW: Maintenance Mode and Custom HTTP Fault Injections**
+
+`virtualService.fault` allows you to set custom [HTTP fault injections](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection)
+at the client side (like delays or abort) before proxying to the service.
+
+`virtualService.maintenanceMode.enabled` will set a very specific fault that
+aborts the request with a 5xx (or whatever is set at `httpStatus`) and disable
+scale-down behavior of the HPA.
+
+If maintenanceMode is enabled, fault must be `{}`. If there's a fault configuration,
+then maintenanceMode must be disabled. Otherwise the chart won't render.
+
 ### 1.1.x -> 1.2.x
 
 **NEW: Templated Termination Grace Period**

diff --git a/charts/rollout-app/README.md.gotmpl b/charts/rollout-app/README.md.gotmpl
@@ -17,6 +17,20 @@ how these work, and the various custom resource definitions.
 
 ## Upgrade Notes
 
+### 1.2.x -> 1.3.x
+
+**NEW: Maintenance Mode and Custom HTTP Fault Injections**
+
+`virtualService.fault` allows you to set custom [HTTP fault injections](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection)
+at the client side (like delays or abort) before proxying to the service.
+
+`virtualService.maintenanceMode.enabled` will set a very specific fault that
+aborts the request with a 5xx (or whatever is set at `httpStatus`) and disable
+scale-down behavior of the HPA.
+
+If maintenanceMode is enabled, fault must be `{}`. If there's a fault configuration,
+then maintenanceMode must be disabled. Otherwise the chart won't render.
+
 ### 1.1.x -> 1.2.x
 
 **NEW: Templated Termination Grace Period**

diff --git a/charts/simple-app/Chart.yaml b/charts/simple-app/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: simple-app
 description: Default Microservice Helm Chart
 type: application
-version: 1.11.0
+version: 1.11.1
 appVersion: latest
 maintainers:
   - name: diranged

diff --git a/charts/simple-app/README.md b/charts/simple-app/README.md
@@ -2,7 +2,7 @@
 
 Default Microservice Helm Chart
 
-![Version: 1.11.0](https://img.shields.io/badge/Version-1.11.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
+![Version: 1.11.1](https://img.shields.io/badge/Version-1.11.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
 
 [deployments]: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
 [hpa]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
@@ -13,6 +13,20 @@ defaults for you like the Kubernetes [Horizontal Pod Autoscaler][hpa].
 
 ## Upgrade Notes
 
+### 1.10.x -> 1.11.x
+
+**NEW: Maintenance Mode and Custom HTTP Fault Injections**
+
+`virtualService.fault` allows you to set custom [HTTP fault injections](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection)
+at the client side (like delays or abort) before proxying to the service.
+
+`virtualService.maintenanceMode.enabled` will set a very specific fault that
+aborts the request with a 5xx (or whatever is set at `httpStatus`) and disable
++ scale-down behavior of the HPA.
+
+If maintenanceMode is enabled, fault must be `{}`. If there's a fault configuration,
+then maintenanceMode must be disabled. Otherwise the chart won't render.
+
 ### 1.9.x -> 1.10.x
 
 **NEW: Templated Termination Grace Period**

diff --git a/charts/simple-app/README.md.gotmpl b/charts/simple-app/README.md.gotmpl
@@ -12,6 +12,20 @@ defaults for you like the Kubernetes [Horizontal Pod Autoscaler][hpa].
 
 ## Upgrade Notes
 
+### 1.10.x -> 1.11.x
+
+**NEW: Maintenance Mode and Custom HTTP Fault Injections**
+
+`virtualService.fault` allows you to set custom [HTTP fault injections](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection)
+at the client side (like delays or abort) before proxying to the service.
+
+`virtualService.maintenanceMode.enabled` will set a very specific fault that
+aborts the request with a 5xx (or whatever is set at `httpStatus`) and disable
++ scale-down behavior of the HPA.
+
+If maintenanceMode is enabled, fault must be `{}`. If there's a fault configuration,
+then maintenanceMode must be disabled. Otherwise the chart won't render.
+
 ### 1.9.x -> 1.10.x
 
 **NEW: Templated Termination Grace Period**

diff --git a/charts/stateful-app/Chart.yaml b/charts/stateful-app/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: stateful-app
 description: Default StatefulSet Helm Chart
 type: application
-version: 1.3.0
+version: 1.3.1
 appVersion: latest
 maintainers:
   - name: diranged

diff --git a/charts/stateful-app/README.md b/charts/stateful-app/README.md
@@ -2,7 +2,7 @@
 
 Default StatefulSet Helm Chart
 
-![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
+![Version: 1.3.1](https://img.shields.io/badge/Version-1.3.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
 
 [statefulsets]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
 [hpa]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
@@ -13,6 +13,19 @@ ServiceAccounts, Services, etc.
 
 ## Upgrade Notes
 
+### 1.2.x -> 1.3.x
+
+**NEW: Maintenance Mode and Custom HTTP Fault Injections**
+
+`virtualService.fault` allows you to set custom [HTTP fault injections](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection)
+at the client side (like delays or abort) before proxying to the service.
+
+`virtualService.maintenanceMode.enabled` will set a very specific fault that
+aborts the request with a 5xx (or whatever is set at `httpStatus`).
+
+If maintenanceMode is enabled, fault must be `{}`. If there's a fault configuration,
+then maintenanceMode must be disabled. Otherwise the chart won't render.
+
 ### 1.1.x -> 1.2.x
 
 **NEW: Templated Termination Grace Period**

diff --git a/charts/stateful-app/README.md.gotmpl b/charts/stateful-app/README.md.gotmpl
@@ -12,6 +12,19 @@ ServiceAccounts, Services, etc.
 
 ## Upgrade Notes
 
+### 1.2.x -> 1.3.x
+
+**NEW: Maintenance Mode and Custom HTTP Fault Injections**
+
+`virtualService.fault` allows you to set custom [HTTP fault injections](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection)
+at the client side (like delays or abort) before proxying to the service.
+
+`virtualService.maintenanceMode.enabled` will set a very specific fault that
+aborts the request with a 5xx (or whatever is set at `httpStatus`).
+
+If maintenanceMode is enabled, fault must be `{}`. If there's a fault configuration,
+then maintenanceMode must be disabled. Otherwise the chart won't render.
+
 ### 1.1.x -> 1.2.x
 
 **NEW: Templated Termination Grace Period**