diff --git a/README.md b/README.md index f1046b849..a0febaa50 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ - [Support Matrix](#support-matrix) - [Kubernetes Versions](#kubernetes-versions) - [Helm versions](#helm-versions) + - [Helm 3 beta](#helm-3-beta) - [ECK](#eck) @@ -24,8 +25,8 @@ added below. 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 +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 @@ -76,7 +77,12 @@ exact versions are defined under `KUBERNETES_VERSIONS` in While we are checking backward compatibility, the charts are only tested with Helm version mentioned in [helm-tester Dockerfile][] (currently 2.16.9). -Note that we don't support [Helm 3][] version. + +#### Helm 3 beta + +While we don't have automated tests for [Helm 3][] yet, we fixed the main +blockers to use it. We now have enough feedbacks from internal and external +users to add support in beta. ## ECK diff --git a/apm-server/README.md b/apm-server/README.md index 2e0f4042a..4d03b7cb8 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -47,13 +47,18 @@ See [supported configurations][] for more details. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install it: `helm install --name apm-server elastic/apm-server` +* Install it: + - with Helm 2: `helm install --name apm-server elastic/apm-server` + - with [Helm 3 (beta)][]: `helm install apm-server elastic/apm-server` + ### Install development version using master branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name apm-server ./helm-charts/apm-server --set imageTag=8.0.0-SNAPSHOT` +* Install it: + - with Helm 2: `helm install --name apm-server ./helm-charts/apm-server --set imageTag=8.0.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install apm-server ./helm-charts/apm-server --set imageTag=8.0.0-SNAPSHOT` ## Upgrading @@ -155,6 +160,7 @@ about our development and testing process. [examples/oss]: https://github.com/elastic/helm-charts/tree/master/apm-server/examples/oss [examples/security]: https://github.com/elastic/helm-charts/tree/master/apm-server/examples/security [helm]: https://helm.sh +[helm 3 (beta)]: https://github.com/elastic/helm-charts/tree/master/README.md#helm-3-beta [horizontal pod autoscaler]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/ [imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images [imagePullSecrets]: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret diff --git a/elasticsearch/README.md b/elasticsearch/README.md index 374d43d0c..fed689c70 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -58,13 +58,18 @@ See [supported configurations][] for more details. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install it: `helm install --name elasticsearch elastic/elasticsearch` +* Install it: + - with Helm 2: `helm install --name elasticsearch elastic/elasticsearch` + - with [Helm 3 (beta)][]: `helm install elasticsearch elastic/elasticsearch` + ### Install development version using master branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=8.0.0-SNAPSHOT` +* Install it: + - with Helm 2: `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=8.0.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install elasticsearch ./helm-charts/elasticsearch --set imageTag=8.0.0-SNAPSHOT` ## Upgrading @@ -408,6 +413,7 @@ about our development and testing process. [examples/security]: https://github.com/elastic/helm-charts/tree/master/elasticsearch/examples/security [gke]: https://cloud.google.com/kubernetes-engine [helm]: https://helm.sh +[helm 3 (beta)]: https://github.com/elastic/helm-charts/tree/master/README.md#helm-3-beta [helm/charts stable]: https://github.com/helm/charts/tree/master/stable/elasticsearch/ [how to install plugins guide]: https://github.com/elastic/helm-charts/tree/master/elasticsearch/README.md#how-to-install-plugins [how to use the keystore]: https://github.com/elastic/helm-charts/tree/master/elasticsearch/README.md#how-to-use-the-keystore diff --git a/filebeat/README.md b/filebeat/README.md index 609f4eb93..a1ee23663 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -44,13 +44,18 @@ See [supported configurations][] for more details. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install it: `helm install --name filebeat elastic/filebeat` +* Install it: + - with Helm 2: `helm install --name filebeat elastic/filebeat` + - with [Helm 3 (beta)][]: `helm install filebeat elastic/filebeat` + ### Install development version using master branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name filebeat ./helm-charts/filebeat --set imageTag=8.0.0-SNAPSHOT` +* Install it: + - with Helm 2: `helm install --name filebeat ./helm-charts/filebeat --set imageTag=8.0.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install filebeat ./helm-charts/filebeat --set imageTag=8.0.0-SNAPSHOT` ## Upgrading @@ -194,6 +199,7 @@ about our development and testing process. [filebeat oss docker image]: https://www.docker.elastic.co/r/beats/filebeat-oss [filebeat outputs]: https://www.elastic.co/guide/en/beats/filebeat/master/configuring-output.html [helm]: https://helm.sh +[helm 3 (beta)]: https://github.com/elastic/helm-charts/tree/master/README.md#helm-3-beta [hostNetwork]: https://kubernetes.io/docs/concepts/policy/pod-security-policy/#host-namespaces [hostPath]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath [imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images diff --git a/kibana/README.md b/kibana/README.md index ad4f28527..6a077d480 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -46,13 +46,18 @@ See [supported configurations][] for more details. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install it: `helm install --name kibana elastic/kibana` +* Install it: + - with Helm 2: `helm install --name kibana elastic/kibana` + - with [Helm 3 (beta)][]: `helm install kibana elastic/kibana` + ### Install development version using master branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name kibana ./helm-charts/kibana --set imageTag=8.0.0-SNAPSHOT` +* Install it: + - with Helm 2: `helm install --name kibana ./helm-charts/kibana --set imageTag=8.0.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install kibana ./helm-charts/kibana --set imageTag=8.0.0-SNAPSHOT` ## Upgrading @@ -211,6 +216,7 @@ about our development and testing process. [examples/security]: https://github.com/elastic/helm-charts/tree/master/kibana/examples/security [gke]: https://cloud.google.com/kubernetes-engine [helm]: https://helm.sh +[helm 3 (beta)]: https://github.com/elastic/helm-charts/tree/master/README.md#helm-3-beta [imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images [imagePullSecrets]: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret [ingress]: https://kubernetes.io/docs/concepts/services-networking/ingress/ diff --git a/logstash/README.md b/logstash/README.md index e065daaa8..7f95f966f 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -46,13 +46,18 @@ See [supported configurations][] for more details. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install it: `helm install --name logstash elastic/logstash` +* Install it: + - with Helm 2: `helm install --name logstash elastic/logstash` + - with [Helm 3 (beta)][]: `helm install logstash elastic/logstash` + ### Install development version using master branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name logstash ./helm-charts/logstash --set imageTag=8.0.0-SNAPSHOT` +* Install it: + - with Helm 2: `helm install --name logstash ./helm-charts/logstash --set imageTag=8.0.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install logstash ./helm-charts/logstash --set imageTag=8.0.0-SNAPSHOT` ## Upgrading @@ -194,6 +199,7 @@ about our development and testing process. [examples]: https://github.com/elastic/helm-charts/tree/master/logstash/examples [examples/oss]: https://github.com/elastic/helm-charts/tree/master/logstash/examples/oss [helm]: https://helm.sh +[helm 3 (beta)]: https://github.com/elastic/helm-charts/tree/master/README.md#helm-3-beta [imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images [imagePullSecrets]: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret [kubernetes secrets]: https://kubernetes.io/docs/concepts/configuration/secret/ diff --git a/metricbeat/README.md b/metricbeat/README.md index ffd8aaf7a..9057d6df7 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -45,13 +45,18 @@ See [supported configurations][] for more details. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install it: `helm install --name metricbeat elastic/metricbeat` +* Install it: + - with Helm 2: `helm install --name metricbeat elastic/metricbeat` + - with [Helm 3 (beta)][]: `helm install metricbeat elastic/metricbeat` + ### Install development version using master branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name metricbeat ./helm-charts/metricbeat --set imageTag=8.0.0-SNAPSHOT` +* Install it: + - with Helm 2: `helm install --name metricbeat ./helm-charts/metricbeat --set imageTag=8.0.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install metricbeat ./helm-charts/metricbeat --set imageTag=8.0.0-SNAPSHOT` ## Upgrading @@ -216,6 +221,7 @@ about our development and testing process. [examples/oss]: https://github.com/elastic/helm-charts/tree/master/metricbeat/examples/oss [examples/security]: https://github.com/elastic/helm-charts/tree/master/metricbeat/examples/security [helm]: https://helm.sh +[helm 3 (beta)]: https://github.com/elastic/helm-charts/tree/master/README.md#helm-3-beta [hostPath]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath [hostNetwork]: https://kubernetes.io/docs/concepts/policy/pod-security-policy/#host-namespaces [imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images