From 3abba7c4f85b58e130d8f2ad43e92c5459658cd6 Mon Sep 17 00:00:00 2001 From: Nassim Kammah Date: Wed, 21 Oct 2020 14:04:34 +0200 Subject: [PATCH 1/2] Streamline charts README doc --- apm-server/README.md | 9 ++++----- elasticsearch/README.md | 8 ++++---- filebeat/README.md | 8 ++++---- kibana/README.md | 8 ++++---- logstash/README.md | 8 ++++---- metricbeat/README.md | 8 ++++---- 6 files changed, 24 insertions(+), 25 deletions(-) diff --git a/apm-server/README.md b/apm-server/README.md index 4f72cd488..ad7050f42 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -8,8 +8,8 @@ The design and code is less mature than official GA features and is being 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). -**Warning**: This branch is used for development, please use [7.7.1][] release -for released version. +**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) +release for released version. @@ -51,8 +51,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. `helm repo add elastic https://helm.elastic.co` * Install it: - - with Helm 2: `helm install --name apm-server elastic/apm-server` - - with [Helm 3 (beta)][]: `helm install apm-server elastic/apm-server` + - with Helm 2: `helm install --name apm-server --version elastic/apm-server` + - with [Helm 3 (beta)][]: `helm install apm-server --version elastic/apm-server` ### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions @@ -148,7 +148,6 @@ Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. -[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/apm-server/README.md [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md diff --git a/elasticsearch/README.md b/elasticsearch/README.md index c0f53da52..32eb463ab 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -3,8 +3,8 @@ This Helm chart is a lightweight way to configure and run our official [Elasticsearch Docker image][]. -**Warning**: This branch is used for development, please use [7.7.1][] release -for released version. +**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) +release for released version. @@ -61,8 +61,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. `helm repo add elastic https://helm.elastic.co` * Install it: - - with Helm 2: `helm install --name elasticsearch elastic/elasticsearch` - - with [Helm 3 (beta)][]: `helm install elasticsearch elastic/elasticsearch` + - with Helm 2: `helm install --name elasticsearch --version elastic/elasticsearch` + - with [Helm 3 (beta)][]: `helm install elasticsearch --version elastic/elasticsearch` ### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions diff --git a/filebeat/README.md b/filebeat/README.md index 05a46adc9..f5ed87616 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -3,8 +3,8 @@ This Helm chart is a lightweight way to configure and run our official [Filebeat Docker image][]. -**Warning**: This branch is used for development, please use [7.7.1][] release -for released version. +**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) +release for released version. @@ -48,8 +48,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. `helm repo add elastic https://helm.elastic.co` * Install it: - - with Helm 2: `helm install --name filebeat elastic/filebeat` - - with [Helm 3 (beta)][]: `helm install filebeat elastic/filebeat` + - with Helm 2: `helm install --name filebeat --version elastic/filebeat` + - with [Helm 3 (beta)][]: `helm install filebeat --version elastic/filebeat` ### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions diff --git a/kibana/README.md b/kibana/README.md index e2b7eec84..e7da55820 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -3,8 +3,8 @@ This Helm chart is a lightweight way to configure and run our official [Kibana Docker image][]. -**Warning**: This branch is used for development, please use [7.7.1][] release -for released version. +**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) +release for released version. @@ -49,8 +49,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. `helm repo add elastic https://helm.elastic.co` * Install it: - - with Helm 2: `helm install --name kibana elastic/kibana` - - with [Helm 3 (beta)][]: `helm install kibana elastic/kibana` + - with Helm 2: `helm install --name kibana --version elastic/kibana` + - with [Helm 3 (beta)][]: `helm install kibana --version elastic/kibana` ### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions diff --git a/logstash/README.md b/logstash/README.md index 20c0814df..b65b69c7c 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -8,8 +8,8 @@ The design and code is less mature than official GA features and is being 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). -**Warning**: This branch is used for development, please use [7.7.1][] release -for released version. +**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) +release for released version. @@ -51,8 +51,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. `helm repo add elastic https://helm.elastic.co` * Install it: - - with Helm 2: `helm install --name logstash elastic/logstash` - - with [Helm 3 (beta)][]: `helm install logstash elastic/logstash` + - with Helm 2: `helm install --name logstash --version elastic/logstash` + - with [Helm 3 (beta)][]: `helm install logstash --version elastic/logstash` ### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions diff --git a/metricbeat/README.md b/metricbeat/README.md index eb01eb7b8..c05fd43ce 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -3,8 +3,8 @@ This Helm chart is a lightweight way to configure and run our official [Metricbeat Docker image][]. -**Warning**: This branch is used for development, please use [7.7.1][] release -for released version. +**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) +release for released version. @@ -48,8 +48,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. `helm repo add elastic https://helm.elastic.co` * Install it: - - with Helm 2: `helm install --name metricbeat elastic/metricbeat` - - with [Helm 3 (beta)][]: `helm install metricbeat elastic/metricbeat` + - with Helm 2: `helm install --name metricbeat --version elastic/metricbeat` + - with [Helm 3 (beta)][]: `helm install metricbeat --version elastic/metricbeat` ### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions From eb81574cea3ecb2eeb9f9a3f235ddf4837da27a0 Mon Sep 17 00:00:00 2001 From: Nassim Kammah Date: Wed, 21 Oct 2020 17:40:16 +0200 Subject: [PATCH 2/2] Reword warning statement --- apm-server/README.md | 6 ++---- elasticsearch/README.md | 6 ++---- filebeat/README.md | 6 ++---- kibana/README.md | 6 ++---- logstash/README.md | 6 ++---- metricbeat/README.md | 6 ++---- 6 files changed, 12 insertions(+), 24 deletions(-) diff --git a/apm-server/README.md b/apm-server/README.md index ad7050f42..769143f37 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -8,9 +8,7 @@ The design and code is less mature than official GA features and is being 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). -**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) -release for released version. - +**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. @@ -147,7 +145,7 @@ An example of APM Server deployment using OSS version can be found in Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. - +[7.x]: https://github.com/elastic/helm-charts/releases [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md diff --git a/elasticsearch/README.md b/elasticsearch/README.md index 32eb463ab..41cd4df01 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -3,9 +3,7 @@ This Helm chart is a lightweight way to configure and run our official [Elasticsearch Docker image][]. -**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) -release for released version. - +**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. @@ -387,7 +385,7 @@ lifecycle: Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. - +[7.x]: https://github.com/elastic/helm-charts/releases [#63]: https://github.com/elastic/helm-charts/issues/63 [7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/elasticsearch/README.md [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md diff --git a/filebeat/README.md b/filebeat/README.md index f5ed87616..25d1b695c 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -3,9 +3,7 @@ This Helm chart is a lightweight way to configure and run our official [Filebeat Docker image][]. -**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) -release for released version. - +**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. @@ -186,7 +184,7 @@ readinessProbe: Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. - +[7.x]: https://github.com/elastic/helm-charts/releases [7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/filebeat/README.md [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md diff --git a/kibana/README.md b/kibana/README.md index e7da55820..73a79885c 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -3,9 +3,7 @@ This Helm chart is a lightweight way to configure and run our official [Kibana Docker image][]. -**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) -release for released version. - +**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. @@ -203,7 +201,7 @@ lifecycle: Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. - +[7.x]: https://github.com/elastic/helm-charts/releases [7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/kibana/README.md [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md diff --git a/logstash/README.md b/logstash/README.md index b65b69c7c..0c3a9a39f 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -8,9 +8,7 @@ The design and code is less mature than official GA features and is being 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). -**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) -release for released version. - +**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. @@ -191,7 +189,7 @@ against best practices of containers and immutable infrastructure. Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. - +[7.x]: https://github.com/elastic/helm-charts/releases [7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/logstash/README.md [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md diff --git a/metricbeat/README.md b/metricbeat/README.md index c05fd43ce..51f1bef1f 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -3,9 +3,7 @@ This Helm chart is a lightweight way to configure and run our official [Metricbeat Docker image][]. -**Warning**: This branch is used for development, please use the latest [7.10](https://github.com/elastic/helm-charts/releases) -release for released version. - +**Warning**: This branch is used for development, please use the latest [7.x][] release for released version. @@ -210,7 +208,7 @@ same node. Please check [CONTRIBUTING.md][] before any contribution or for any questions about our development and testing process. - +[7.x]: https://github.com/elastic/helm-charts/releases [#471]: https://github.com/elastic/helm-charts/pull/471 [7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/metricbeat/README.md [BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md