From 2f1a7658a10eef8c8ec9f20ccc69cc3c39caf86d Mon Sep 17 00:00:00 2001 From: Gavin Williams Date: Wed, 24 Jun 2020 13:33:46 +0100 Subject: [PATCH 1/3] [docs] Add links to '6.x' and '7.x' releases to top-level charts table. --- README.md | 48 +++++++++++++++++++++++++++++++++++++----------- 1 file changed, 37 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 44c93fc99..0cfde6b4d 100644 --- a/README.md +++ b/README.md @@ -18,23 +18,35 @@ ## Charts -Please look in the chart directories for the documentation for each chart. These -Helm charts are designed to be a lightweight way to configure our official +These Helm charts are designed to be a lightweight way to configure our official Docker images. Links to the relevant Docker image documentation has also been added below. -| Chart | Docker documentation | -|--------------------------------------------|---------------------------------------------------------------------------------| -| [APM-Server](./apm-server/README.md) | https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html | -| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html | -| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/current/running-on-docker.html | -| [Kibana](./kibana/README.md) | https://www.elastic.co/guide/en/kibana/current/docker.html | -| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/current/docker.html | -| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html | +We recommend that the Helm chart version is aligned to the version of the product +you want to deploy. This will ensure that you using a chart version that has been +tested against the corresponding production version. +This will also ensure that the documentation and examples for the chart will work +with the version of the product you are installing. + +For example if you want to deploy an Elasticsearch `7.5.1` cluster, use the +corresponding `7.5.1` [tag][elasticsearch-751]. + +The `master` version of these charts are intended to support the latest pre-release +versions of our products, and therefore may or may not work with current released +versions. + +| Chart | Docker documentation |Latest 7 Version|Latest 6 Version| +|--------------------------------------------|---------------------------------------------------------------------------------|-----------|-----------| +| [APM-Server](./apm-server/README.md) | https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html |[`7.8.0`][apm-7] |[`6.8.10`][apm-6] | +| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html |[`7.8.0`][elasticsearch-7] |[`6.8.10`][elasticsearch-6] | +| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/current/running-on-docker.html |[`7.8.0`][filebeat-7] |[`6.8.10`][filebeat-6] | +| [Kibana](./kibana/README.md) | https://www.elastic.co/guide/en/kibana/current/docker.html |[`7.8.0`][kibana-7] |[`6.8.10`][kibana-6] | +| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/current/docker.html |[`7.8.0`][logstash-7] |[`6.8.10`][logstash-6] | +| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html |[`7.8.0`][metricbeat-7] |[`6.8.10`][metricbeat-6] | ## Supported Configurations -Starting with 7.7.0 release, some charts are reaching GA. +Starting with the `7.7.0` and `6.8.9` releases, some charts are reaching GA. Note that only the released charts coming from [Elastic Helm repo][] or [GitHub releases][] are supported. @@ -80,3 +92,17 @@ Kubernetes. [helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/master/helpers/helm-tester/Dockerfile [helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/master/helpers/matrix.yml [operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/ +[elasticsearch-751]: https://github.com/elastic/helm-charts/tree/7.5.1/elasticsearch/ + +[apm-7]: https://github.com/elastic/helm-charts/tree/7.8.0/apm-server/README.md +[apm-6]: https://github.com/elastic/helm-charts/tree/6.8.10/apm-server/README.md +[elasticsearch-7]: https://github.com/elastic/helm-charts/tree/7.8.0/elasticsearch/README.md +[elasticsearch-6]: https://github.com/elastic/helm-charts/tree/6.8.10/elasticsearch/README.md +[filebeat-7]: https://github.com/elastic/helm-charts/tree/7.8.0/filebeat/README.md +[filebeat-6]: https://github.com/elastic/helm-charts/tree/6.8.10/filebeat/README.md +[kibana-7]: https://github.com/elastic/helm-charts/tree/7.8.0/kibana/README.md +[kibana-6]: https://github.com/elastic/helm-charts/tree/6.8.10/kibana/README.md +[logstash-7]: https://github.com/elastic/helm-charts/tree/7.8.0/logstash/README.md +[logstash-6]: https://github.com/elastic/helm-charts/tree/6.8.10/logstash/README.md +[metricbeat-7]: https://github.com/elastic/helm-charts/tree/7.8.0/metricbeat/README.md +[metricbeat-6]: https://github.com/elastic/helm-charts/tree/6.8.10/metricbeat/README.md From 9fc6e8ba34d7fe5ddac7582e28be71a6cad7dd57 Mon Sep 17 00:00:00 2001 From: Gavin Williams Date: Thu, 25 Jun 2020 10:40:34 +0100 Subject: [PATCH 2/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove mention of `6.8` GA Co-authored-by: Maxime Gréau --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cfde6b4d..9ffb41db1 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ versions. ## Supported Configurations -Starting with the `7.7.0` and `6.8.9` releases, some charts are reaching GA. +Starting with the `7.7.0` release, some charts are reaching GA. Note that only the released charts coming from [Elastic Helm repo][] or [GitHub releases][] are supported. From 502cc2d4e63c911d50db72794bf65736c6148497 Mon Sep 17 00:00:00 2001 From: Gavin Williams Date: Thu, 25 Jun 2020 10:42:24 +0100 Subject: [PATCH 3/3] Update README.md Switch example to `7.7.1` chart version. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ffb41db1..5a670968c 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ tested against the corresponding production version. This will also ensure that the documentation and examples for the chart will work with the version of the product you are installing. -For example if you want to deploy an Elasticsearch `7.5.1` cluster, use the -corresponding `7.5.1` [tag][elasticsearch-751]. +For example if you want to deploy an Elasticsearch `7.7.1` cluster, use the +corresponding `7.7.1` [tag][elasticsearch-771]. The `master` version of these charts are intended to support the latest pre-release versions of our products, and therefore may or may not work with current released @@ -92,7 +92,7 @@ Kubernetes. [helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/master/helpers/helm-tester/Dockerfile [helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/master/helpers/matrix.yml [operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/ -[elasticsearch-751]: https://github.com/elastic/helm-charts/tree/7.5.1/elasticsearch/ +[elasticsearch-771]: https://github.com/elastic/helm-charts/tree/7.7.1/elasticsearch/ [apm-7]: https://github.com/elastic/helm-charts/tree/7.8.0/apm-server/README.md [apm-6]: https://github.com/elastic/helm-charts/tree/6.8.10/apm-server/README.md