add breaking changes + update all toc instructions

elastic · Mar 8, 2022 · 1f3f8d0 · 1f3f8d0
1 parent 09bac2a
commit 1f3f8d0
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 19 deletions.
diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md
@@ -3,6 +3,8 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 
+  - [7.17.1](#7171)
+    - [Metricbeat kube-state-metrics upgrade](#metricbeat-kube-state-metrics-upgrade)
   - [7.11.1](#7111)
     - [License update for Elasticsearch & Kibana](#license-update-for-elasticsearch--kibana)
   - [6.8.14](#6814)
@@ -40,13 +42,30 @@
   - [7.6.0 - 2020/02/11](#760---20200211)
     - [Elasticsearch default resources](#elasticsearch-default-resources)
   - [7.5.0 - 2019/12/02](#750---20191202)
-    - [Metricbeat kube-state-metrics upgrade](#metricbeat-kube-state-metrics-upgrade)
+    - [Metricbeat kube-state-metrics upgrade](#metricbeat-kube-state-metrics-upgrade-1)
   - [7.0.0-alpha1 - 2019/04/17](#700-alpha1---20190417)
     - [Elasticsearch upgrade from 6.x](#elasticsearch-upgrade-from-6x)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc BREAKING_CHANGES.md --github --no-title -->
+
+## 7.17.1
+
+### Metricbeat kube-state-metrics upgrade
+
+[kube-state-metrics][] chart dependency is upgraded from 2.4.1 to 4.7.0 in
+[#1524][]. This is causing Metricbeat chart upgrade from versions < 7.17.1 failing
+with the following error:
+
+```
+UPGRADE FAILED
+Error: Deployment.apps "metricbeat-kube-state-metrics" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app.kubernetes.io/name":"kube-state-metrics"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable && Deployment.apps "metricbeat-metricbeat-metrics" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app":"metricbeat-metricbeat-metrics", "chart":"metricbeat-7.5.0", "heritage":"Tiller", "release":"metricbeat"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable
+Error: UPGRADE FAILED: Deployment.apps "metricbeat-kube-state-metrics" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app.kubernetes.io/name":"kube-state-metrics"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable && Deployment.apps "metricbeat-metricbeat-metrics" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app":"metricbeat-metricbeat-metrics", "chart":"metricbeat-7.5.0", "heritage":"Tiller", "release":"metricbeat"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable
+```
+
+The workaround is to use `--force` argument for `helm upgrade` command which
+will force Metricbeat resources update through delete/recreate.
 
 ## 7.11.1
 
@@ -414,6 +433,7 @@ volumeClaimTemplate:
 [#807]: https://github.com/elastic/helm-charts/issues/807
 [#839]: https://github.com/elastic/helm-charts/issues/839
 [#916]: https://github.com/elastic/helm-charts/pull/916
+[#1524]: https://github.com/elastic/helm-charts/pull/1524
 [container input]: https://www.elastic.co/guide/en/beats/filebeat/7.7/filebeat-input-container.html
 [docker input]: https://www.elastic.co/guide/en/beats/filebeat/7.7/filebeat-input-docker.html
 [elastic blog post]: https://www.elastic.co/blog/licensing-change

diff --git a/README.md b/README.md
@@ -5,15 +5,17 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Elastic Stack Kubernetes Helm Charts](#elastic-stack-kubernetes-helm-charts)
-  - [Charts](#charts)
-  - [Supported Configurations](#supported-configurations)
-    - [Stack Versions](#stack-versions)
-    - [Kubernetes Versions](#kubernetes-versions)
-    - [Helm Versions](#helm-versions)
-  - [ECK](#eck)
+
+- [Charts](#charts)
+- [Supported Configurations](#supported-configurations)
+  - [Stack Versions](#stack-versions)
+  - [Kubernetes Versions](#kubernetes-versions)
+  - [Helm Versions](#helm-versions)
+- [ECK](#eck)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- Use this to update TOC: -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Charts

diff --git a/apm-server/README.md b/apm-server/README.md
@@ -11,11 +11,12 @@ provided as-is with no warranties. Alpha features are not subject to the support
 SLA of official GA features (see [supported configurations][] for more details).
 
 <!-- development warning placeholder -->
-**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. 
+**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
+
 - [Requirements](#requirements)
 - [Installing](#installing)
   - [Install released version using Helm repository](#install-released-version-using-helm-repository)
@@ -29,7 +30,7 @@ SLA of official GA features (see [supported configurations][] for more details).
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Requirements

diff --git a/elasticsearch/README.md b/elasticsearch/README.md
@@ -38,7 +38,7 @@ This Helm chart is a lightweight way to configure and run our official
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Requirements
@@ -118,7 +118,7 @@ support multiple versions with minimal changes.
 | `envFrom`                          | Templatable string to be passed to the [environment from variables][] which will be appended to the `envFrom:` definition for the container                                                                                                                                                                       | `[]`                                             |
 | `esConfig`                         | Allows you to add any config files in `/usr/share/elasticsearch/config/` such as `elasticsearch.yml` and `log4j2.properties`. See [values.yaml][] for an example of the formatting                                                                                                                                | `{}`                                             |
 | `esJavaOpts`                       | [Java options][] for Elasticsearch. This is where you could configure the [jvm heap size][]                                                                                                                                                                                                                       | `""`                                             |
-| `esJvmOptions`                       | [Java options][] for Elasticsearch. Override the default JVM options by adding custom options files .  See [values.yaml][] for an example of the formatting                                                                                                                                                                                                                        | `{}`                                             |
+| `esJvmOptions`                     | [Java options][] for Elasticsearch. Override the default JVM options by adding custom options files .  See [values.yaml][] for an example of the formatting                                                                                                                                                       | `{}`                                             |
 | `esMajorVersion`                   | Deprecated. Instead, use the version of the chart corresponding to your ES minor version. Used to set major version specific configuration. If you are using a custom image and not running the default Elasticsearch version you will need to set this to the version you are running (e.g. `esMajorVersion: 6`) | `""`                                             |
 | `extraContainers`                  | Templatable string of additional `containers` to be passed to the `tpl` function                                                                                                                                                                                                                                  | `""`                                             |
 | `extraEnvs`                        | Extra [environment variables][] which will be appended to the `env:` definition for the container                                                                                                                                                                                                                 | `[]`                                             |
@@ -161,7 +161,7 @@ support multiple versions with minimal changes.
 | `roles`                            | A list with the specific [roles][] for the `nodeGroup`                                                                                                                                                                                                                                                            | see [values.yaml][]                              |
 | `schedulerName`                    | Name of the [alternate scheduler][]                                                                                                                                                                                                                                                                               | `""`                                             |
 | `secret.enabled`                   | Enable Secret creation for Elasticsearch credentials                                                                                                                                                                                                                                                              | `true`                                           |
-| `secret.password`                  | Initial password for the elastic user                                                                                                                                                                                                                                           | `""` (generated randomly)                        |
+| `secret.password`                  | Initial password for the elastic user                                                                                                                                                                                                                                                                             | `""` (generated randomly)                        |
 | `secretMounts`                     | Allows you easily mount a secret as a file inside the StatefulSet. Useful for mounting certificates and other secrets. See [values.yaml][] for an example                                                                                                                                                         | `[]`                                             |
 | `securityContext`                  | Allows you to set the [securityContext][] for the container                                                                                                                                                                                                                                                       | see [values.yaml][]                              |
 | `service.annotations`              | [LoadBalancer annotations][] that Kubernetes will use for the service. This will configure load balancer if `service.type` is `LoadBalancer`                                                                                                                                                                      | `{}`                                             |
@@ -267,7 +267,7 @@ sufficient.
 ### How to deploy clusters with security (authentication and TLS) enabled?
 
 This Helm chart can generate a [Kubernetes Secret][] or use an existing one to
-setup Elastic credentials. 
+setup Elastic credentials.
 
 This Helm chart can use existing [Kubernetes Secret][] to setup Elastic
 certificates for example. These secrets should be created outside of this chart

diff --git a/filebeat/README.md b/filebeat/README.md
@@ -30,7 +30,7 @@ This Helm chart is a lightweight way to configure and run our official
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Requirements

diff --git a/kibana/README.md b/kibana/README.md
@@ -28,7 +28,7 @@ This Helm chart is a lightweight way to configure and run our official
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Requirements

diff --git a/logstash/README.md b/logstash/README.md
@@ -31,7 +31,7 @@ SLA of official GA features (see [supported configurations][] for more details).
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Requirements

diff --git a/metricbeat/README.md b/metricbeat/README.md
@@ -30,7 +30,7 @@ This Helm chart is a lightweight way to configure and run our official
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- Use this to update TOC: -->
-<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
+<!-- docker run --entrypoint doctoc --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc README.md --github --no-title -->
 
 
 ## Requirements