diff --git a/README.md b/README.md index 237b53c55..94eba3860 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/6.8/running-on-docker.html | -| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/6.8/docker.html | -| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/6.8/running-on-docker.html | -| [Kibana](./kibana/README.md) | https://www.elastic.co/guide/en/kibana/6.8/docker.html | -| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/6.8/docker.html | -| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/6.8/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.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 +versions. + +| Chart | Docker documentation | Latest 7 Version | Latest 6 Version | +|--------------------------------------------|-----------------------------------------------------------------------------|----------------------------|-----------------------------| +| [APM-Server](./apm-server/README.md) | https://www.elastic.co/guide/en/apm/server/6.8/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/6.8/docker.html | [`7.8.0`][elasticsearch-7] | [`6.8.10`][elasticsearch-6] | +| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/6.8/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/6.8/docker.html | [`7.8.0`][kibana-7] | [`6.8.10`][kibana-6] | +| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/6.8/docker.html | [`7.8.0`][logstash-7] | [`6.8.10`][logstash-6] | +| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/6.8/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` release, some charts are reaching GA. Note that only the released charts coming from [Elastic Helm repo][] or [GitHub releases][] are supported. @@ -82,3 +94,17 @@ Kubernetes. [helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/6.8/helpers/helm-tester/Dockerfile [helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/6.8/helpers/matrix.yml [operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/ +[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 +[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