From 607e666dffec0d0213524ccd1bed002758cf2c4d Mon Sep 17 00:00:00 2001 From: Julien Mailleret Date: Mon, 27 Apr 2020 12:57:35 +0200 Subject: [PATCH] [meta] add toc to markdown files --- BREAKING_CHANGES.md | 38 ++++++++++++++------ CHANGELOG.md | 80 +++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 19 +++++++++- apm-server/README.md | 22 +++++++++++- elasticsearch/README.md | 39 +++++++++++++++++++- filebeat/README.md | 22 +++++++++++- kibana/README.md | 25 ++++++++++++- logstash/README.md | 22 ++++++++++++ metricbeat/README.md | 22 +++++++++++- 9 files changed, 272 insertions(+), 17 deletions(-) diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index c4cd8c1e8..5a9b76475 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -1,14 +1,30 @@ # Breaking changes + + + + +- [7.6.2 - 2020/03/31](#762---20200331) + - [Kibana default resources](#kibana-default-resources) +- [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) +- [7.0.0-alpha1 - 2019/04/17](#700-alpha1---20190417) + - [Elasticsearch upgrade from 6.x](#elasticsearch-upgrade-from-6x) + + + + ## 7.6.2 - 2020/03/31 ### Kibana default resources -Kibana default resources (cpu/memory requests and limits) are increased in +Kibana default resources (cpu/memory requests and limits) are increased in [#540][]. -This change may impact cpu/memory available resources capacity in your +This change may impact cpu/memory available resources capacity in your Kubernetes cluster. To come back to former default values, use the following values: @@ -31,7 +47,7 @@ resources: ### Elasticsearch default resources -Elasticsearch default cpu requests is increased in [#458][] following our +Elasticsearch default cpu requests is increased in [#458][] following our recommendation that resources requests and limits should have the same values. This change may impact available cpu capacity in your Kubernetes cluster. @@ -49,7 +65,7 @@ resources: ### Metricbeat kube-state-metrics upgrade -[kube-state-metrics][] chart dependency is upgraded from 1.6.0 to 2.4.1 in +[kube-state-metrics][] chart dependency is upgraded from 1.6.0 to 2.4.1 in [#352][]. This is causing Metricbeat chart upgrade from versions < 7.5.0 failing with the following error: @@ -67,9 +83,9 @@ will force Metricbeat resources update through delete/recreate. ### Elasticsearch upgrade from 6.x -If you were using the default Elasticsearch version from the previous release -(6.6.2-alpha1) you will first need to upgrade to Elasticsearch 6.7.1 before -being able to upgrade to 7.0.0. You can do this by adding this to your values +If you were using the default Elasticsearch version from the previous release +(6.6.2-alpha1) you will first need to upgrade to Elasticsearch 6.7.1 before +being able to upgrade to 7.0.0. You can do this by adding this to your values file: ```yaml @@ -77,10 +93,10 @@ esMajorVersion: 6 imageTag: 6.7.1 ``` -If you are upgrading an existing cluster that did not override the default -`storageClassName` you will now need to specify the `storageClassName`. This +If you are upgrading an existing cluster that did not override the default +`storageClassName` you will now need to specify the `storageClassName`. This only affects existing clusters and was changed in [#94][]. The advantage of this -is that now the Helm chart will just use the default `storageClassName` rather +is that now the Helm chart will just use the default `storageClassName` rather than needing to override it for any providers where it is not called `standard`. ``` @@ -93,4 +109,4 @@ volumeClaimTemplate: [#352]: https://github.com/elastic/helm-charts/pull/352 [#458]: https://github.com/elastic/helm-charts/pull/458 [#540]: https://github.com/elastic/helm-charts/pull/540 -[kube-state-metrics]: https://github.com/helm/charts/tree/master/stable/kube-state-metrics \ No newline at end of file +[kube-state-metrics]: https://github.com/helm/charts/tree/master/stable/kube-state-metrics diff --git a/CHANGELOG.md b/CHANGELOG.md index bf205bf79..fed81d7a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,84 @@ # Changelog + + + + +- [7.6.2 - 2020/03/31](#762---20200331) + - [APM Server](#apm-server) + - [Elasticsearch](#elasticsearch) + - [Filebeat](#filebeat) + - [Kibana](#kibana) + - [Logstash](#logstash) +- [7.6.1 - 2020/03/04](#761---20200304) + - [APM Server](#apm-server-1) + - [Elasticsearch](#elasticsearch-1) +- [7.6.0 - 2020/02/11](#760---20200211) + - [APM Server](#apm-server-2) + - [Elasticsearch](#elasticsearch-2) + - [Filebeat](#filebeat-1) + - [Kibana](#kibana-1) + - [Logstash](#logstash-1) + - [Metricbeat](#metricbeat) +- [7.5.2 - 2020/01/21](#752---20200121) + - [Elasticsearch](#elasticsearch-3) + - [Filebeat](#filebeat-2) + - [Kibana](#kibana-2) + - [Logstash](#logstash-2) + - [Metricbeat](#metricbeat-1) +- [7.5.1 - 2019/12/18](#751---20191218) + - [Filebeat](#filebeat-3) + - [Kibana](#kibana-3) + - [Metricbeat](#metricbeat-2) +- [7.5.0 - 2019/12/02](#750---20191202) + - [Elasticsearch](#elasticsearch-4) + - [Filebeat](#filebeat-4) + - [Kibana](#kibana-4) + - [Logstash](#logstash-3) + - [Metricbeat](#metricbeat-3) +- [7.4.1 - 2019/10/23](#741---20191023) + - [Elasticsearch](#elasticsearch-5) + - [Kibana](#kibana-5) + - [Metricbeat](#metricbeat-4) +- [7.4.0 - 2019/10/01](#740---20191001) + - [Elasticsearch](#elasticsearch-6) + - [Kibana](#kibana-6) + - [Filebeat](#filebeat-5) + - [Metricbeat](#metricbeat-5) +- [7.3.2 - 2019/09/19](#732---20190919) + - [Elasticsearch](#elasticsearch-7) + - [Kibana](#kibana-7) + - [Filebeat](#filebeat-6) + - [Metricbeat](#metricbeat-6) +- [7.3.0 - 2019/07/31](#730---20190731) + - [Elasticsearch](#elasticsearch-8) + - [Kibana](#kibana-8) +- [7.2.1-0 - 2019/07/18](#721-0---20190718) + - [Elasticsearch](#elasticsearch-9) + - [Kibana](#kibana-9) + - [Filebeat](#filebeat-7) + - [Metricbeat](#metricbeat-7) +- [7.2.0 - 2019/07/01](#720---20190701) + - [Elasticsearch](#elasticsearch-10) + - [Kibana](#kibana-10) + - [Filebeat](#filebeat-8) +- [7.1.1 - 2019/06/07](#711---20190607) + - [Elasticsearch](#elasticsearch-11) + - [Kibana](#kibana-11) + - [Filebeat](#filebeat-9) +- [7.1.0 - 2019/05/21](#710---20190521) + - [Elasticsearch](#elasticsearch-12) + - [Kibana](#kibana-12) + - [Filebeat](#filebeat-10) +- [7.0.1-alpha1 - 2019/05/01](#701-alpha1---20190501) + - [Elasticsearch](#elasticsearch-13) + - [Kibana](#kibana-13) +- [7.0.0-alpha1 - 2019/04/17](#700-alpha1---20190417) + - [Elasticsearch](#elasticsearch-14) + + + + + ## 7.6.2 - 2020/03/31 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31a81ace4..76b7295de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,21 @@ # Contributing to the Elastic helm charts + + + + + - [Requirements for submiting a pull request](#requirements-for-submiting-a-pull-request) + - [CLA (Contributor License Agreement)](#cla-contributor-license-agreement) + - [Branches workflow](#branches-workflow) + - [Releases](#releases) + - [Testing](#testing) + - [Templating tests](#templating-tests) + - [Integration tests](#integration-tests) + - [Adding new features](#adding-new-features) + + + + + ## Requirements for submiting a pull request @@ -118,4 +135,4 @@ lot of time into it. [templating tests section]: #templating-tests [release.md]: https://github.com/elastic/helm-charts/blob/master/helpers/release.md [releases section]: #releases -[requirements.txt]: https://github.com/elastic/helm-charts/blob/master/requirements.txt \ No newline at end of file +[requirements.txt]: https://github.com/elastic/helm-charts/blob/master/requirements.txt diff --git a/apm-server/README.md b/apm-server/README.md index 526aeeaa6..d8cfa4696 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -1,4 +1,24 @@ # APM Server Helm Chart + + + + +- [Requirements](#requirements) +- [Installing](#installing) + - [Using Helm repository](#using-helm-repository) + - [Using master branch](#using-master-branch) +- [Upgrading](#upgrading) +- [Compatibility](#compatibility) +- [Usage notes](#usage-notes) +- [Configuration](#configuration) +- [Examples](#examples) + - [Default](#default) +- [Contributing](#contributing) + + + + + This functionality is in alpha and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no @@ -19,7 +39,7 @@ This Helm chart is a lightweight way to configure and run our official ### Using Helm repository -* Add the Elastic Helm charts repo: +* Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` * Install it: `helm install --name apm-server elastic/apm-server` diff --git a/elasticsearch/README.md b/elasticsearch/README.md index daff5171e..7f356177c 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -1,4 +1,41 @@ # Elasticsearch Helm Chart + + + + +- [Requirements](#requirements) +- [Installing](#installing) + - [Using Helm repository](#using-helm-repository) + - [Using master branch](#using-master-branch) +- [Upgrading](#upgrading) +- [Compatibility](#compatibility) +- [Usage notes](#usage-notes) +- [Migration from helm/charts stable](#migration-from-helmcharts-stable) +- [Configuration](#configuration) + - [Deprecated](#deprecated) +- [Try it out](#try-it-out) + - [Default](#default) + - [Multi](#multi) + - [Security](#security) +- [FAQ](#faq) + - [How to install plugins?](#how-to-install-plugins) + - [How to use the keystore?](#how-to-use-the-keystore) + - [Basic example](#basic-example) + - [Multiple keys](#multiple-keys) + - [Custom paths and keys](#custom-paths-and-keys) + - [How to enable snapshotting?](#how-to-enable-snapshotting) +- [Local development environments](#local-development-environments) + - [Minikube](#minikube) + - [Docker for Mac - Kubernetes](#docker-for-mac---kubernetes) + - [KIND - Kubernetes](#kind---kubernetes) + - [MicroK8S](#microk8s) +- [Clustering and Node Discovery](#clustering-and-node-discovery) +- [Contributing](#contributing) + + + + + This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no @@ -23,7 +60,7 @@ default settings. All of these settings are configurable. ### Using Helm repository -* Add the Elastic Helm charts repo: +* Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` * Install it: `helm install --name elasticsearch elastic/elasticsearch` diff --git a/filebeat/README.md b/filebeat/README.md index a5ed071e0..21dab903b 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -1,4 +1,24 @@ # Filebeat Helm Chart + + + + +- [Requirements](#requirements) +- [Installing](#installing) + - [Using Helm repository](#using-helm-repository) + - [Using master branch](#using-master-branch) +- [Upgrading](#upgrading) +- [Compatibility](#compatibility) +- [Usage notes](#usage-notes) +- [Configuration](#configuration) +- [Examples](#examples) + - [Default](#default) +- [Contributing](#contributing) + + + + + This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no @@ -19,7 +39,7 @@ This Helm chart is a lightweight way to configure and run our official ### Using Helm repository -* Add the Elastic Helm charts repo: +* Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` * Install it: `helm install --name filebeat elastic/filebeat` diff --git a/kibana/README.md b/kibana/README.md index 88e5a24e1..a3f5b14c8 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -1,4 +1,27 @@ # Kibana Helm Chart + + + + +- [Requirements](#requirements) +- [Installing](#installing) + - [Using Helm repository](#using-helm-repository) + - [Using master branch](#using-master-branch) +- [Upgrading](#upgrading) +- [Compatibility](#compatibility) +- [Configuration](#configuration) + - [Deprecated](#deprecated) +- [Examples](#examples) + - [Default](#default) + - [Security](#security) +- [FAQ](#faq) + - [How to install plugins?](#how-to-install-plugins) +- [Contributing](#contributing) + + + + + This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no @@ -19,7 +42,7 @@ This Helm chart is a lightweight way to configure and run our official ### Using Helm repository -* Add the Elastic Helm charts repo: +* Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` * Install it: `helm install --name kibana elastic/kibana` diff --git a/logstash/README.md b/logstash/README.md index 8e4837628..20e3e03a4 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -1,4 +1,26 @@ # Logstash Helm Chart + + + + +- [Requirements](#requirements) +- [Installing](#installing) + - [Using Helm repository](#using-helm-repository) + - [Using master branch](#using-master-branch) +- [Upgrading](#upgrading) +- [Compatibility](#compatibility) +- [Usage notes](#usage-notes) +- [Configuration](#configuration) +- [Try it out](#try-it-out) + - [Default](#default) +- [FAQ](#faq) + - [How to install plugins?](#how-to-install-plugins) +- [Contributing](#contributing) + + + + + This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no diff --git a/metricbeat/README.md b/metricbeat/README.md index 14d3d9495..3094e6f36 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -1,4 +1,24 @@ # Metricbeat Helm Chart + + + + +- [Requirements](#requirements) +- [Installing](#installing) + - [Using Helm repository](#using-helm-repository) + - [Using master branch](#using-master-branch) +- [Upgrading](#upgrading) +- [Compatibility](#compatibility) +- [Configuration](#configuration) + - [Deprecated](#deprecated) +- [Examples](#examples) + - [Default](#default) +- [Contributing](#contributing) + + + + + This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no @@ -19,7 +39,7 @@ This Helm chart is a lightweight way to configure and run our official ### Using Helm repository -* Add the Elastic Helm charts repo: +* Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` * Install it: `helm install --name metricbeat elastic/metricbeat`