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

[docs] Improve visibility of 6.8 and 7.x releases #690

Merged
merged 3 commits into from
Jun 29, 2020
Merged

[docs] Improve visibility of 6.8 and 7.x releases #690

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f1a765
[docs] Add links to '6.x' and '7.x' releases to top-level charts table.
Jun 24, 2020
9fc6e8b
Update README.md
Jun 25, 2020
502cc2d
Update README.md
Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 37 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].
fatmcgav marked this conversation as resolved.
Show resolved Hide resolved

The `master` version of these charts are intended to support the latest pre-release
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should wait for @jmlrt's PR to be merged before merging this one and then update these instructions to clearly explain that:

  • the master branch is used for testing the latest snapshot versions of our products
  • we don't recommend using the master git branch for production deployment but instead either the git tags or the https://helm.elastic.co repository which contain the versions tested and released by Elastic

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.
fatmcgav marked this conversation as resolved.
Show resolved Hide resolved

Note that only the released charts coming from [Elastic Helm repo][] or
[GitHub releases][] are supported.
Expand Down Expand Up @@ -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