diff --git a/README.md b/README.md index 7dc4f21cd..bbc8cf1d0 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) @@ -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 59a380a31..4f72cd488 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -50,14 +50,18 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install the latest 7.7 release: -`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 7.x branch and 7.10.0-SNAPSHOT versions * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name apm-server ./helm-charts/apm-server` +* Install it: + - with Helm 2: `helm install --name apm-server ./helm-charts/apm-server --set imageTag=7.10.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install apm-server ./helm-charts/apm-server --set imageTag=7.10.0-SNAPSHOT` ## Upgrading @@ -159,6 +163,7 @@ about our development and testing process. [examples/oss]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/oss [examples/security]: https://github.com/elastic/helm-charts/tree/7.x/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 5cfab8b38..9070d4f37 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -60,14 +60,18 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install the latest 7.7 release: -`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 7.x branch and 7.10.0-SNAPSHOT versions * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name elasticsearch ./helm-charts/elasticsearch` +* Install it: + - with Helm 2: `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=7.10.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install elasticsearch ./helm-charts/elasticsearch --set imageTag=7.10.0-SNAPSHOT` ## Upgrading @@ -410,6 +414,7 @@ about our development and testing process. [examples/security]: https://github.com/elastic/helm-charts/tree/7.x/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/7.x/elasticsearch/README.md#how-to-install-plugins [how to use the keystore]: https://github.com/elastic/helm-charts/tree/7.x/elasticsearch/README.md#how-to-use-the-keystore diff --git a/filebeat/README.md b/filebeat/README.md index 9ab275859..61699b741 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -47,14 +47,18 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install the latest 7.7 release: -`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 7.x branch and 7.10.0-SNAPSHOT versions * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name filebeat ./helm-charts/filebeat` +* Install it: + - with Helm 2: `helm install --name filebeat ./helm-charts/filebeat --set imageTag=7.10.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install filebeat ./helm-charts/filebeat --set imageTag=7.10.0-SNAPSHOT` ## Upgrading @@ -198,6 +202,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/7.x/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 cad9948bf..e2b7eec84 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -48,14 +48,18 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install the latest 7.7 release: -`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 7.x branch and 7.10.0-SNAPSHOT versions * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name kibana ./helm-charts/kibana` +* Install it: + - with Helm 2: `helm install --name kibana ./helm-charts/kibana --set imageTag=7.10.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install kibana ./helm-charts/kibana --set imageTag=7.10.0-SNAPSHOT` ## Upgrading @@ -214,6 +218,7 @@ about our development and testing process. [examples/security]: https://github.com/elastic/helm-charts/tree/7.x/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 00fb85d37..92cd3a59d 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -50,14 +50,18 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install the latest 7.7 release: -`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 7.x branch and 7.10.0-SNAPSHOT versions * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name logstash ./helm-charts/logstash` +* Install it: + - with Helm 2: `helm install --name logstash ./helm-charts/logstash --set imageTag=7.10.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install logstash ./helm-charts/logstash --set imageTag=7.10.0-SNAPSHOT` ## Upgrading @@ -199,6 +203,7 @@ about our development and testing process. [examples]: https://github.com/elastic/helm-charts/tree/7.x/logstash/examples [examples/oss]: https://github.com/elastic/helm-charts/tree/7.x/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 c1db47f21..e6e73774a 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -47,14 +47,18 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co` -* Install the latest 7.7 release: -`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 7.x branch and 7.10.0-SNAPSHOT versions * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` -* Install it: `helm install --name metricbeat ./helm-charts/metricbeat` +* Install it: + - with Helm 2: `helm install --name metricbeat ./helm-charts/metricbeat --set imageTag=7.10.0-SNAPSHOT` + - with [Helm 3 (beta)][]: `helm install metricbeat ./helm-charts/metricbeat --set imageTag=7.10.0-SNAPSHOT` ## Upgrading @@ -219,6 +223,7 @@ about our development and testing process. [examples/oss]: https://github.com/elastic/helm-charts/tree/7.x/metricbeat/examples/oss [examples/security]: https://github.com/elastic/helm-charts/tree/7.x/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