Update the Kanister Install page (#4503)

* Update Install Kanister page * Apply suggested changes
kanisterio · Dec 4, 2018 · c0e7e0a · c0e7e0a
1 parent 642c5d9
commit c0e7e0a
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/docs/install.rst b/docs/install.rst
@@ -17,6 +17,10 @@ Prerequisites
 
 * `helm <https://helm.sh>`_ installed and initialized using the command `helm init`
 
+* :ref:`kanctl <tooling>` installed
+
+* Access to an S3 compatible bucket and credentials.
+
 * Docker (for source-based installs only)
 
 
@@ -33,6 +37,12 @@ This will install the Kanister controller in the `kanister` namespace
    # Install the Kanister operator controller using helm
    $ helm install --name myrelease --namespace kanister kanister/kanister-operator --set image.tag=0.14.0
 
+   # Create an S3 Compliant Kanister profile using kanctl
+   $ kanctl create profile s3compliant --bucket <bucket> --access-key ${AWS_ACCESS_KEY_ID} \
+                                       --secret-key ${AWS_SECRET_ACCESS_KEY}               \
+                                       --region <region>                                   \
+                                       --namespace kanister
+
 
 Building and Deploying from Source
 ==================================
@@ -63,5 +73,5 @@ namespace.
 
 .. code-block:: bash
 
-   # Deploy controller version 0.10.0 to Kubernetes
-   $ make deploy VERSION="0.10.0"
+   # Deploy controller version 0.14.0 to Kubernetes
+   $ make deploy VERSION="0.14.0"
diff --git a/docs/tooling.rst b/docs/tooling.rst
@@ -223,9 +223,9 @@ A new S3Compliant profile can be created using the s3compliant subcommand
 
 .. code-block:: bash
 
-  $ kanctl create profile s3compliant --bucket <bucket> --access-key $AWS_ACCESS_KEY_ID \
-                                      --secret-key $AWS_SECRET_ACCESS_KEY               \
-                                      --region us-west-1                                \
+  $ kanctl create profile s3compliant --bucket <bucket> --access-key ${AWS_ACCESS_KEY_ID} \
+                                      --secret-key ${AWS_SECRET_ACCESS_KEY}               \
+                                      --region us-west-1                                  \
                                       --namespace kanister
   secret 's3-secret-chst2' created
   profile 's3-profile-5mmkj' created
@@ -377,6 +377,20 @@ The following snippet is an example of using kando from inside a Blueprint.
 
   kando output version 0.14.0
 
+Install the tools
+=================
+
+Installation of the tools requires `Go <https://golang.org/doc/install>`_ to be installed
+
+.. code-block:: bash
+
+  # Installing kanctl
+  $ go install -v github.com/kanisterio/kanister/cmd/kanctl
+
+  # Installing kando
+  $ go install -v github.com/kanisterio/kanister/cmd/kando
+
+
 Docker Image
 ============