Merge pull request #284 from ruzickap/feature/improve_documentation

Adding kqueen cli examples to docs

docs/conf.py

@@ -147,7 +147,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'kqueen.tex', 'kqueen Documentation',
-     'Tomáš Kukrál', 'manual'),
+     'Mirantis', 'manual'),
 ]
 
 

docs/kqueen.cli_api_examples.rst

@@ -0,0 +1,35 @@
+Kqueen CLI API Examples
+-----------------------
+
+Obtain bearer token and authenticate to kqueen:
+
+.. code-block:: bash
+
+   $ TOKEN=$(curl -s -H "Content-Type: application/json" --data '{ "username": "admin", "password": "default" }' -X POST 127.0.0.1:5000/api/v1/auth | jq -r '.access_token')
+   $ echo $TOKEN
+
+List organizations
+
+.. code-block:: bash
+
+   $ curl -s -H "Authorization: Bearer $TOKEN" 127.0.0.1:5000/api/v1/organizations | jq
+
+Check the clusters:
+
+.. code-block:: bash
+
+   $ curl -s -H "Authorization: Bearer $TOKEN" 127.0.0.1:5000/api/v1/clusters | jq
+
+
+List users
+
+.. code-block:: bash
+
+   $ curl -s -H "Authorization: Bearer $TOKEN" 127.0.0.1:5000/api/v1/users | jq
+
+
+Create new organization "testorg"
+
+.. code-block:: bash
+
+   $ curl -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" --data '{ "name": "testorg", "namespace": "testorg" }' -X POST 127.0.0.1:5000/api/v1/organizations | jq

docs/kqueen.rst

@@ -455,3 +455,5 @@ Example of etcd recovery workflow:
 
          # Start new etcd with these two extra parameters (among the other)
          # for example: etcd --force-new-cluster
+
+.. include:: kqueen.cli_api_examples.rst