Skip to content
This repository was archived by the owner on May 28, 2024. It is now read-only.

Commit c1f29c9

Browse files
jmlrtjmlrt
committed
[meta] remove support matrix + nit doc changes (elastic#1337)
This commit removes the existing support matrix and replace it by a mention of the charts status (alpha, beta, ga) in the stack version table. This change will avoid issue where the support matrix isn't updated during a release. Also remove the links to stack product docker image doc which are already present in each chart specific README. Also reorganize informations related to supported configuration under this title and format line length.
1 parent baed17f commit c1f29c9

File tree

1 file changed

+22
-62
lines changed

1 file changed

+22
-62
lines changed

‎README.md‎

Lines changed: 22 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -8,76 +8,48 @@
88

99
- [Charts](#charts)
1010
- [Supported Configurations](#supported-configurations)
11-
- [Support Matrix](#support-matrix)
11+
- [Stack Versions](#stack-versions)
1212
- [Kubernetes Versions](#kubernetes-versions)
13-
- [Helm versions](#helm-versions)
13+
- [Helm Versions](#helm-versions)
1414
- [ECK](#eck)
1515

16-
<!-- END doctoc generated TOC please keep comment here to allow auto-update -->
16+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1717

1818

1919
## Charts
2020

21-
These Helm charts are designed to be a lightweight way to configure our official
22-
Docker images. Links to the relevant Docker image documentation have also been
23-
added below.
21+
These Helm charts are designed to be a lightweight way to configure Elastic
22+
official Docker images.
2423

25-
We recommend that the Helm chart version is aligned to the version of the product
26-
you want to deploy. This will ensure that you using a chart version that has been
27-
tested against the corresponding production version.
28-
This will also ensure that the documentation and examples for the chart will work
29-
with the version of the product, you are installing.
24+
## Supported Configurations
25+
26+
We recommend that the Helm chart version is aligned to the version of the
27+
product you want to deploy. This will ensure that you are using a chart version
28+
that has been tested against the corresponding production version.
29+
This will also ensure that the documentation and examples for the chart will
30+
work with the version of the product, you are installing.
3031

3132
For example, if you want to deploy an Elasticsearch `7.7.1` cluster, use the
3233
corresponding `7.7.1` [tag][elasticsearch-771].
3334

34-
The `master` version of these charts are intended to support the latest pre-release
35-
versions of our products, and therefore may or may not work with current released
36-
versions.
37-
38-
| Chart | Docker documentation | Latest 7 Version | Latest 6 Version |
39-
|--------------------------------------------|---------------------------------------------------------------------------------|-----------------------------|-----------------------------|
40-
| [APM-Server](./apm-server/README.md) | https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html | [`7.13.3`][apm-7] | [`6.8.18`][apm-6] |
41-
| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html | [`7.13.3`][elasticsearch-7] | [`6.8.18`][elasticsearch-6] |
42-
| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/current/running-on-docker.html | [`7.13.3`][filebeat-7] | [`6.8.18`][filebeat-6] |
43-
| [Kibana](./kibana/README.md) | https://www.elastic.co/guide/en/kibana/current/docker.html | [`7.13.3`][kibana-7] | [`6.8.18`][kibana-6] |
44-
| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/current/docker.html | [`7.13.3`][logstash-7] | [`6.8.18`][logstash-6] |
45-
| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html | [`7.13.3`][metricbeat-7] | [`6.8.18`][metricbeat-6] |
46-
47-
## Supported Configurations
48-
49-
Starting with the `7.7.0` release, some charts are reaching GA.
50-
35+
The `master` version of these charts is intended to support the latest
36+
pre-release versions of our products, and therefore may or may not work with
37+
current released versions.
5138
Note that only the released charts coming from [Elastic Helm repo][] or
5239
[GitHub releases][] are supported.
5340

54-
### Support Matrix
55-
56-
| | Elasticsearch | Kibana | Logstash | Filebeat | Metricbeat | APM Server |
57-
|------|---------------|--------|----------|----------|------------|------------|
58-
| 6.8 | Beta | Beta | Beta | Beta | Beta | Alpha |
59-
| 7.0 | Alpha | Alpha | / | / | / | / |
60-
| 7.1 | Beta | Beta | / | Beta | / | / |
61-
| 7.2 | Beta | Beta | / | Beta | Beta | / |
62-
| 7.3 | Beta | Beta | / | Beta | Beta | / |
63-
| 7.4 | Beta | Beta | / | Beta | Beta | / |
64-
| 7.5 | Beta | Beta | Beta | Beta | Beta | Alpha |
65-
| 7.6 | Beta | Beta | Beta | Beta | Beta | Alpha |
66-
| 7.7 | GA | GA | Beta | GA | GA | Beta |
67-
| 7.8 | GA | GA | Beta | GA | GA | Beta |
68-
| 7.9 | GA | GA | Beta | GA | GA | Beta |
69-
| 7.10 | GA | GA | Beta | GA | GA | Beta |
70-
| 7.11 | GA | GA | Beta | GA | GA | Beta |
71-
| 7.12 | GA | GA | Beta | GA | GA | Beta |
72-
| 7.13 | GA | GA | Beta | GA | GA | Beta |
41+
42+
### Stack Versions
43+
44+
Look at [Stack Versions table on master branch][stack-versions-master].
7345

7446
### Kubernetes Versions
7547

7648
The charts are [currently tested][] against all GKE versions available. The
7749
exact versions are defined under `KUBERNETES_VERSIONS` in
7850
[helpers/matrix.yml][].
7951

80-
### Helm versions
52+
### Helm Versions
8153

8254
While we are checking backward compatibility, the charts are only tested with
8355
Helm version mentioned in [helm-tester Dockerfile][] (currently 3.5.3).
@@ -97,21 +69,9 @@ Kubernetes. There is a dedicated Helm chart for ECK which can be found
9769
[eck-chart-doc]: https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-install-helm.html
9870
[elastic cloud on kubernetes]: https://github.com/elastic/cloud-on-k8s
9971
[elastic helm repo]: https://helm.elastic.co
72+
[elasticsearch-771]: https://github.com/elastic/helm-charts/tree/7.7.1/elasticsearch/
10073
[github releases]: https://github.com/elastic/helm-charts/releases
10174
[helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/6.8/helpers/helm-tester/Dockerfile
10275
[helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/6.8/helpers/matrix.yml
10376
[operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
104-
[elasticsearch-771]: https://github.com/elastic/helm-charts/tree/7.7.1/elasticsearch/
105-
106-
[apm-7]: https://github.com/elastic/helm-charts/tree/7.13.3/apm-server/README.md
107-
[apm-6]: https://github.com/elastic/helm-charts/tree/6.8.18/apm-server/README.md
108-
[elasticsearch-7]: https://github.com/elastic/helm-charts/tree/7.13.3/elasticsearch/README.md
109-
[elasticsearch-6]: https://github.com/elastic/helm-charts/tree/6.8.18/elasticsearch/README.md
110-
[filebeat-7]: https://github.com/elastic/helm-charts/tree/7.13.3/filebeat/README.md
111-
[filebeat-6]: https://github.com/elastic/helm-charts/tree/6.8.18/filebeat/README.md
112-
[kibana-7]: https://github.com/elastic/helm-charts/tree/7.13.3/kibana/README.md
113-
[kibana-6]: https://github.com/elastic/helm-charts/tree/6.8.18/kibana/README.md
114-
[logstash-7]: https://github.com/elastic/helm-charts/tree/7.13.3/logstash/README.md
115-
[logstash-6]: https://github.com/elastic/helm-charts/tree/6.8.18/logstash/README.md
116-
[metricbeat-7]: https://github.com/elastic/helm-charts/tree/7.13.3/metricbeat/README.md
117-
[metricbeat-6]: https://github.com/elastic/helm-charts/tree/6.8.18/metricbeat/README.md
77+
[stack-versions-master]: https://github.com/elastic/helm-charts/blob/master/README.md#stack-versions

0 commit comments

Comments
 (0)