Merge pull request #364 from jmlrt/helm-master-install-doc

update install doc
elastic · Nov 12, 2019 · 1699350 · 1699350
2 parents e463e7a + 54a3ddf
commit 1699350
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 4 deletions.
diff --git a/elasticsearch/README.md b/elasticsearch/README.md
@@ -27,6 +27,8 @@ If you currently have a cluster deployed with the [helm/charts stable](https://g
 
 ## Installing
 
+### Using Helm repository
+
 * Add the elastic helm charts repo
   ```
   helm repo add elastic https://helm.elastic.co
@@ -36,6 +38,17 @@ If you currently have a cluster deployed with the [helm/charts stable](https://g
   helm install --name elasticsearch elastic/elasticsearch
   ```
 
+### 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
+  ```
+
 ## Compatibility
 
 This chart is tested with the latest supported versions. The currently tested versions are:
@@ -89,7 +102,7 @@ helm install --name elasticsearch elastic/elasticsearch --set imageTag=7.4.1
 | `podManagementPolicy`         | By default Kubernetes [deploys statefulsets serially](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#pod-management-policies). This deploys them in parallel so that they can discover eachother                                                                                                   | `Parallel`                                                                                                                |
 | `protocol`                    | The protocol that will be used for the readinessProbe. Change this to `https` if you have `xpack.security.http.ssl.enabled` set                                                                                                                                                                                            | `http`                                                                                                                    |
 | `httpPort`                    | The http port that Kubernetes will use for the healthchecks and the service. If you change this you will also need to set [http.port](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#_settings) in `extraEnvs`                                                                          | `9200`                                                                                                                    |
-| `transportPort`               | The transport port that Kubernetes will use for the service. If you change this you will also need to set [transport port configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html#_transport_settings) in `extraEnvs`                                                        | `9300`                                                                                                                    |                     
+| `transportPort`               | The transport port that Kubernetes will use for the service. If you change this you will also need to set [transport port configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html#_transport_settings) in `extraEnvs`                                                        | `9300`                                                                                                                    |
 | `service.labels`              | Labels to be added to non-headless service                                                                                                                                                                                                                                                                                 | `{}`                                                                                                                      |
 | `service.labelsHeadless`      | Labels to be added to headless service                                                                                                                                                                                                                                                                                     | `{}`                                                                                                                      |
 | `service.type`                | Type of elasticsearch service. [Service Types](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)                                                                                                                                                                         | `ClusterIP`                                                                                                               |

diff --git a/filebeat/README.md b/filebeat/README.md
@@ -15,6 +15,8 @@ This helm chart is a lightweight way to configure and run our official [Filebeat
 
 ## Installing
 
+### Using Helm repository
+
 * Add the elastic helm charts repo
   ```
   helm repo add elastic https://helm.elastic.co
@@ -24,6 +26,17 @@ This helm chart is a lightweight way to configure and run our official [Filebeat
   helm install --name filebeat elastic/filebeat
   ```
 
+### 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
+  ```
+
 ## Compatibility
 
 This chart is tested with the latest supported versions. The currently tested versions are:

diff --git a/kibana/README.md b/kibana/README.md
@@ -11,6 +11,8 @@ This helm chart is a lightweight way to configure and run our official [Kibana d
 
 ## Installing
 
+### Using Helm repository
+
 * Add the elastic helm charts repo
   ```
   helm repo add elastic https://helm.elastic.co
@@ -20,6 +22,17 @@ This helm chart is a lightweight way to configure and run our official [Kibana d
   helm install --name kibana elastic/kibana
   ```
 
+### 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
+  ```
+
 ## Compatibility
 
 This chart is tested with the latest supported versions. The currently tested versions are:

diff --git a/logstash/README.md b/logstash/README.md
@@ -20,13 +20,15 @@ This helm chart is a lightweight way to configure and run our official [Logstash
 
 ## Installing
 
-* Add the elastic helm charts repo
+### Using master branch
+
+* Clone the git repo
   ```
-  helm repo add elastic https://helm.elastic.co
+  git clone git@github.com:elastic/helm-charts.git
   ```
 * Install it
   ```
-  helm install --name logstash elastic/logstash
+  helm install --name logstash ./helm-charts/logstash
   ```
 
 ## Compatibility

diff --git a/metricbeat/README.md b/metricbeat/README.md
@@ -11,6 +11,8 @@ This helm chart is a lightweight way to configure and run our official [Metricbe
 
 ## Installing
 
+### Using Helm repository
+
 * Add the elastic helm charts repo
   ```
   helm repo add elastic https://helm.elastic.co
@@ -20,6 +22,17 @@ This helm chart is a lightweight way to configure and run our official [Metricbe
   helm install --name metricbeat elastic/metricbeat
   ```
 
+### 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
+  ```
+
 ## Compatibility
 
 This chart is tested with the latest supported versions. The currently tested versions are: