Skip to content

Commit

Permalink
Add elasticsearch docs to docs.kansiter.io (#4192)
Browse files Browse the repository at this point in the history
* Add elasticsearch docs to docs.kansiter.io

* address review comment
  • Loading branch information
SupriyaKasten authored and Ilya Kislenko committed Oct 22, 2018
1 parent 7f6fc53 commit 0cbf809
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/helm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ The following application-specific instructions are available:
helm_instructions/mysql_instructions.rst
helm_instructions/pgsql_instructions.rst
helm_instructions/mongodb_instructions.rst
helm_instructions/elasticsearch_instructions.rst
59 changes: 59 additions & 0 deletions docs/helm_instructions/elasticsearch_instructions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Kanister-Enabled Elasticsearch
------------------------------

This section describes the steps for a basic installation of an instance of
Elasticsearch (a stateful set application running master, client and data
nodes with persistent volumes attached to master and data nodes) along with
a Kanister Blueprint and a Profile via a Kanister-enabled Helm chart.

.. code-block:: console
$ helm repo add kanister https://charts.kanister.io/
Then install the sample Elasticsearch application in its own namespace.

.. For some reason using 'console' or 'bash' highlights the snippet weirdly
.. only:: kanister

.. code-block:: rst
# Install Kanister-enabled Elasticsearch
$ helm install kanister/kanister-elasticsearch -n elasticsearch \
--namespace es-test \
--set profile.create='true' \
--set profile.profileName='es-test-profile' \
--set profile.s3.endpoint='https://my-custom-s3-provider:9000' \
--set profile.s3.accessKey='AKIAIOSFODNN7EXAMPLE' \
--set profile.s3.secretKey='wJalrXUtnFEMI%K7MDENG%bPxRfiCYEXAMPLEKEY' \
--set profile.s3.bucket='kanister-bucket'
--set kanister.controller_namespace="kanister"
.. only:: defaultns

.. code-block:: rst
# Install Kanister-enabled Elasticsearch
$ helm install kanister/kanister-elasticsearch -n elasticsearch --namespace es-test
The settings in the command above represent the minimum recommended set for
your installation.

.. only:: kanister

.. include:: ./create_profile.rst

If not creating a Profile CR, it is possible to use an even simpler command.

.. code-block:: rst
# Install Kanister-enabled Elasticsearch
$ helm install kanister/kanister-elasticsearch -n elasticsearch --namespace es-test
.. note:: The above command will attempt to use dynamic storage provisioning
based on the the default storage class for your cluster. You will to need to
`designate a default storage class <https://kubernetes.io/docs/tasks/administer-cluster/change-default-storage-class/#changing-the-default-storageclass>`_
or, use a specific storage class by providing a value with the
``--set master.persistence.storageClass`` and ``--set data.persistence.storageClass`` option.
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ Dockerfile
PersistentVolumeClaim
actionset
objectstore
Elasticsearch

0 comments on commit 0cbf809

Please sign in to comment.