Merge "DCAE Controller documentation DCAEGEN2-213"

[dcaegen2.git] / docs / sections / components / dcae-cli / quickstart.rst

diff --git a/docs/sections/components/dcae-cli/quickstart.rst b/docs/sections/components/dcae-cli/quickstart.rst
new file mode 100755 (executable)
index 0000000..6037033
--- /dev/null
+++ b/docs/sections/components/dcae-cli/quickstart.rst
@@ -0,0 +1,122 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+\r
+.. _quickstart:\r
+\r
+Quickstart\r
+==========\r
+\r
+The ``dcae-cli`` is a Python command-line tool built to aide component\r
+developers with the development and testing of their micro-service\r
+component for the DCAE platform. It will help developers do functional\r
+and integration testing of their components locally and on remote\r
+environments as simple as possible.\r
+\r
+The tool requires the component developers to create a valid component\r
+specification for their component which is used by the tool. This same\r
+component specification will be published in the :any:`onboarding catalog <glossary-onboarding-catalog>` at the end of development\r
+and testing.\r
+\r
+.. The git repository can be found `here <ONAP%20LINK%20TBD>`__\r
+\r
+Pre-requisite\r
+-------------\r
+\r
+For Docker\r
+~~~~~~~~~~\r
+\r
+There are two options for development with Docker: developing locally on\r
+your machine which requires Docker to be installed and developing\r
+remotely by deploying onto remote infrastructure.\r
+\r
+For local development\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+-  You must install `Docker\r
+   engine <https://docs.docker.com/engine/installation/>`__ locally on\r
+   your machine.\r
+-  You must know the *external ip* of where the Docker engine is\r
+   running. The external ip is needed so that service discovery will\r
+   wire up correctly.\r
+\r
+   -  For OSX users, this means making sure the VirtualBox VM that is\r
+      running your Docker engine has a bridged adapter and getting the\r
+      ip of that adapter.\r
+\r
+For remote development\r
+^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+You need access to a remote host with Docker engine installed with\r
+remote API access. You must have the associated connection information:\r
+domain name or IP and port (should be either 2375 or 2376). This\r
+information should be set in :any:`an active profile <setting-profile>`.\r
+\r
+For CDAP\r
+~~~~~~~~\r
+\r
+TBD\r
+\r
+Install\r
+-------\r
+\r
+::\r
+\r
+    pip install --extra-index-url https://YOUR_NEXUS_PYPI_SERVER/simple dcae-cli\r
+\r
+To do an upgrade, use the ``--upgrade`` flag.\r
+\r
+Configuration\r
+~~~~~~~~~~~~~\r
+\r
+When you run the tool for the first time, the tool will create a\r
+`configuration\r
+directory <http://click.pocoo.org/5/api/#click.get_app_dir>`__ and\r
+generate a configuration file.\r
+\r
+Configuration is first sourced from an remote server that the platform\r
+team manages. This is overlaid with configuration details that you will\r
+be prompted to input particularly your user id.\r
+\r
+``--reinit``\r
+^^^^^^^^^^^^\r
+\r
+Configuration can be re-initialized or reset. There is a ``--reinit``\r
+flag that is to be used to re-initialize your configuration and your\r
+environment profiles.\r
+\r
+To re-initialize:\r
+\r
+::\r
+\r
+    $ dcae_cli --reinit\r
+\r
+Verify\r
+~~~~~~\r
+\r
+Verify that its installed:\r
+\r
+::\r
+\r
+    $ dcae_cli --help\r
+    Usage: dcae_cli [OPTIONS] COMMAND [ARGS]...\r
+\r
+    Options:\r
+      -v, --verbose  Prints INFO-level logs to screen.\r
+      --reinit       Re-initialize dcae-cli configuration\r
+      --version      Show the version and exit.\r
+      --help         Show this message and exit.\r
+\r
+    Commands:\r
+      catalog\r
+      component\r
+      data_format\r
+      profiles\r
+\r
+Version\r
+-------\r
+\r
+You can verify the version of the dcae-cli with the following command:\r
+\r
+::\r
+\r
+    $ dcae_cli --version\r