Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Commit

Permalink
[meta] add toc to markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
jmlrt committed Apr 27, 2020
1 parent 81c7795 commit 607e666
Show file tree
Hide file tree
Showing 9 changed files with 272 additions and 17 deletions.
38 changes: 27 additions & 11 deletions BREAKING_CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# Breaking changes
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [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)

<!-- 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 -->


## 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:
Expand All @@ -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.
Expand All @@ -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:
Expand All @@ -67,20 +83,20 @@ 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
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`.

```
Expand All @@ -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
[kube-state-metrics]: https://github.com/helm/charts/tree/master/stable/kube-state-metrics
80 changes: 80 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,84 @@
# Changelog
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [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)

<!-- 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 -->


## 7.6.2 - 2020/03/31

Expand Down
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
# Contributing to the Elastic helm charts
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [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)

<!-- 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 -->


## Requirements for submiting a pull request

Expand Down Expand Up @@ -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
[requirements.txt]: https://github.com/elastic/helm-charts/blob/master/requirements.txt
22 changes: 21 additions & 1 deletion apm-server/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
# APM Server Helm Chart
<!-- 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)
- [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)

<!-- 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 -->


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
Expand All @@ -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`
Expand Down
39 changes: 38 additions & 1 deletion elasticsearch/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@
# Elasticsearch Helm Chart
<!-- 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)
- [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)

<!-- 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 -->


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
Expand All @@ -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`
Expand Down
22 changes: 21 additions & 1 deletion filebeat/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
# Filebeat Helm Chart
<!-- 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)
- [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)

<!-- 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 -->


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
Expand All @@ -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`
Expand Down
25 changes: 24 additions & 1 deletion kibana/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,27 @@
# Kibana Helm Chart
<!-- 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)
- [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)

<!-- 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 -->


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
Expand All @@ -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`
Expand Down
22 changes: 22 additions & 0 deletions logstash/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# Logstash Helm Chart
<!-- 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)
- [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)

<!-- 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 -->


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
Expand Down
Loading

0 comments on commit 607e666

Please sign in to comment.