Merge pull request #155 from ashwinkumar12345/helm

aetter · web-flow · commit a26f28042f3e · 2019-12-18T09:46:08.000-08:00
Added Helm install section and a few ISM updates
diff --git a/docs/elasticsearch/catapis.md b/docs/elasticsearch/catapis.md
@@ -2,7 +2,7 @@
 layout: default
 title: CAT API
 parent: Elasticsearch
-nav_order: 4
+nav_order:  6
 ---
 
 # cat API
diff --git a/docs/elasticsearch/index-data.md b/docs/elasticsearch/index-data.md
@@ -2,7 +2,7 @@
 layout: default
 title: Index Data
 parent: Elasticsearch
-nav_order: 2
+nav_order: 3
 ---
 
 # Index data
diff --git a/docs/elasticsearch/reindex-data.md b/docs/elasticsearch/reindex-data.md
@@ -2,7 +2,7 @@
 layout: default
 title: Reindex Data
 parent: Elasticsearch
-nav_order: 3
+nav_order: 4
 ---
 
 # Reindex data
diff --git a/docs/im/index.md b/docs/im/index.md
@@ -13,7 +13,7 @@ If you analyze time-series data, you likely prioritize new data over old data. Y
 
 Index Management (IM) is a plugin that lets you automate these periodic, administrative operations by triggering them based on changes in the index age, index size, or number of documents. Using the IM plugin, you can define *policies* that automatically handle index rollovers or deletions to fit your use case.
 
-For example, you can define a policy that moves your index into a `read_only` state after 30 days and then deletes it after a set period of 90 days.
+For example, you can define a policy that moves your index into a `read_only` state after 30 days and then deletes it after a set period of 90 days. You can also set up the policy to send you a notification message when the index is deleted.
 
 You might want to perform an index rollover after a certain amount of time or run a `force_merge` operation on an index during off-peak hours to improve search performance during peak hours.
 
diff --git a/docs/im/policies.md b/docs/im/policies.md
@@ -16,6 +16,8 @@ Policies are JSON documents that define the following:
 
 In other words, a policy defines the *states* that an index can be in, the *actions* to perform when in a state, and the conditions that must be met to *transition* between states.
 
+You have complete flexibility in the way you can design your policies. You can create any state, transition to any other state, and specify any number of actions in each state. 
+
 This table lists the relevant fields of a policy.
 
 Field | Description | Type | Required | Read Only
diff --git a/docs/im/settings.md b/docs/im/settings.md
@@ -20,7 +20,7 @@ Setting | Default | Description
 `opendistro.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.
 `opendistro.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indices).
 `opendistro.index_state_management.coordinator.backoff_count` | 2 | The count of retries for failures in the `ManagedIndexCoordinator`.
-`opendistro.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not.
+`opendistro.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not. The logs from IM are automatically indexed to a logs document.
 `opendistro.index_state_management.history.max_docs` | 2,500,000 | The maximum number of documents before rolling over the audit history index.
 `opendistro.index_state_management.history.max_age` | 24 hours | The maximum age before rolling over the audit history index.
 `opendistro.index_state_management.history.rollover_check_period` | 8 hours | The time between rollover checks for the audit history index.
diff --git a/docs/install/docker-security.md b/docs/install/docker-security.md
@@ -2,7 +2,7 @@
 layout: default
 title: Docker Security Configuration
 parent: Install and Configure
-nav_order: 4
+nav_order: 6
 ---
 
 # Docker security configuration
diff --git a/docs/install/helm.md b/docs/install/helm.md
@@ -0,0 +1,153 @@
+---
+layout: default
+title: Helm
+parent: Install and Configure
+nav_order: 5
+---
+
+# Helm
+
+Helm is a package manager that allows you easily install and manage Elasticsearch in a Kubernetes cluster. You can define your Elasticsearch configurations in a YAML file and use Helm to deploy your applications in a version-controlled and reproducible way.
+
+The Helm chart contains the following resources:
+
+Resource | Description
+:--- | :---
+`Chart.yaml` |  Information about the chart.
+`values.yaml` |  Default configuration values for the chart.
+`templates` |  Templates that combine with values to generate the Kubernetes manifest files.
+
+The specification in the default Helm chart caters to a number of standard use cases and setups. You can modify the default chart to configure your desired specifications and set Transport Layer Security (TLS) and role-based access control (RBAC).
+
+For information about the default configuration, steps to configure security, and configurable parameters, see the
+[README](https://github.com/opendistro-for-elasticsearch/community/tree/master/open-distro-elasticsearch-kubernetes/helm).
+
+The instructions here assume you have a Kubernetes cluster with Helm preinstalled. See the [Kubernetes documentation](https://kubernetes.io/docs/setup/) for steps to configure a Kubernetes cluster and the [Helm documentation](https://helm.sh/docs/intro/install/) to install Helm. 
+Run the `helm init` command to make sure you also have the Tiller server installed. For more information about Tiller, see the [Tiller documentation](https://tiller.readthedocs.io/en/latest/).
+{: .note }
+
+## Install using Helm
+
+1. Clone the [opendistro-build](https://github.com/opendistro-for-elasticsearch/opendistro-build) repository:
+
+   ```bash
+   git clone https://github.com/opendistro-for-elasticsearch/opendistro-build
+   ```
+
+1. Change to the `opendistro-es` directory:
+
+   ```bash
+   cd helm/opendistro-es/
+   ```
+
+1. Package the Helm chart:
+
+   ```bash
+   helm package .
+   ```
+
+1. Deploy Elasticsearch:
+
+   ```bash
+   helm install --name opendistro-es opendistro-es-1.1.0.tgz
+   ```
+
+If you see a `namespaces "default" is forbidden` error, create a tiller service account and deploy with a cluster binding role.
+See the [Tiller documentation](https://tiller.readthedocs.io/en/latest/) for more information.
+For example:
+
+```bash
+$ kubectl create serviceaccount --namespace kube-system tiller
+$ kubectl create clusterrolebinding tiller-cluster-rule --clusterrole=cluster-admin --serviceaccount=kube-system:tiller
+$ kubectl patch deploy --namespace kube-system tiller-deploy -p'{"spec":{"template":{"spec":{"serviceAccount":"tiller"}}}}'
+```
+
+The output shows you the specifications instantiated from the install.
+To customize the deployment, pass in the values that you want to override with a custom YAML file:
+
+```bash
+helm install --values=customevalues.yaml opendistro-es-1.1.0.tgz
+```
+
+#### Sample output
+
+```yaml
+NAME:   opendistro-es
+LAST DEPLOYED: Tue Dec 17 14:33:48 2019
+NAMESPACE: default
+STATUS: DEPLOYED
+
+RESOURCES:
+==> v1/Pod(related)
+NAME                                   AGE
+opendistro-es-client-77b988f547-ddbvc  1s
+opendistro-es-client-77b988f547-gtgtx  1s
+opendistro-es-data-0                   1s
+opendistro-es-kibana-f785fdb84-8czxb   1s
+opendistro-es-master-0                 1s
+
+==> v1/RoleBinding
+NAME                               AGE
+opendistro-es-elastic-rolebinding  1s
+opendistro-es-kibana-rolebinding   1s
+
+==> v1/Secret
+NAME                     AGE
+opendistro-es-es-config  1s
+
+==> v1/Service
+NAME                          AGE
+opendistro-es-client-service  1s
+opendistro-es-data-svc        1s
+opendistro-es-discovery       1s
+opendistro-es-kibana-svc      1s
+
+==> v1/ServiceAccount
+NAME                  AGE
+opendistro-es-es      1s
+opendistro-es-kibana  1s
+
+==> v1beta1/Deployment
+NAME                  AGE
+opendistro-es-client  1s
+opendistro-es-kibana  1s
+
+==> v1beta1/Ingress
+NAME                          AGE
+opendistro-es-client-service  1s
+
+==> v1beta1/PodSecurityPolicy
+NAME               AGE
+opendistro-es-psp  1s
+
+==> v1beta1/Role
+NAME                  AGE
+opendistro-es-es      1s
+opendistro-es-kibana  1s
+
+==> v1beta1/StatefulSet
+NAME                  AGE
+opendistro-es-data    1s
+opendistro-es-master  1s
+```
+
+To make sure your Elasticsearch cluster is up and running:
+
+```bash
+$ kubectl get pods
+
+NAME                                       READY   STATUS    RESTARTS   AGE
+opendistro-es-13-client-5f87767448-6b6h6   1/1     Running   0          15m
+opendistro-es-13-client-5f87767448-9rvrr   1/1     Running   0          15m
+opendistro-es-data-0                       1/1     Running   0          15m
+opendistro-es-kibana-54d4b996c6-g2rxb      1/1     Running   0          15m
+opendistro-es-master-0                     1/1     Running   0          15m
+```
+
+## Uninstall using Helm
+
+To delete or uninstall this deployment:
+
+```bash
+helm delete --name opendistro-es
+```
