From 1fca6acb2918beef86a5a78dc659683830908cd2 Mon Sep 17 00:00:00 2001 From: Ralph Knag Date: Tue, 5 Dec 2017 12:05:57 -0500 Subject: DCAE Controller documentation DCAEGEN2-213 Issue-ID: DCAEGEN2-213 Change-Id: I7f2023b7f88b73eef852eca0bbf9086e14903cd6 Signed-off-by: Ralph Knag --- docs/sections/components/dcae-cli/quickstart.rst | 122 +++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100755 docs/sections/components/dcae-cli/quickstart.rst (limited to '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 index 00000000..60370330 --- /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. +.. http://creativecommons.org/licenses/by/4.0 + +.. _quickstart: + +Quickstart +========== + +The ``dcae-cli`` is a Python command-line tool built to aide component +developers with the development and testing of their micro-service +component for the DCAE platform. It will help developers do functional +and integration testing of their components locally and on remote +environments as simple as possible. + +The tool requires the component developers to create a valid component +specification for their component which is used by the tool. This same +component specification will be published in the :any:`onboarding catalog ` at the end of development +and testing. + +.. The git repository can be found `here `__ + +Pre-requisite +------------- + +For Docker +~~~~~~~~~~ + +There are two options for development with Docker: developing locally on +your machine which requires Docker to be installed and developing +remotely by deploying onto remote infrastructure. + +For local development +^^^^^^^^^^^^^^^^^^^^^ + +- You must install `Docker + engine `__ locally on + your machine. +- You must know the *external ip* of where the Docker engine is + running. The external ip is needed so that service discovery will + wire up correctly. + + - For OSX users, this means making sure the VirtualBox VM that is + running your Docker engine has a bridged adapter and getting the + ip of that adapter. + +For remote development +^^^^^^^^^^^^^^^^^^^^^^ + +You need access to a remote host with Docker engine installed with +remote API access. You must have the associated connection information: +domain name or IP and port (should be either 2375 or 2376). This +information should be set in :any:`an active profile `. + +For CDAP +~~~~~~~~ + +TBD + +Install +------- + +:: + + pip install --extra-index-url https://YOUR_NEXUS_PYPI_SERVER/simple dcae-cli + +To do an upgrade, use the ``--upgrade`` flag. + +Configuration +~~~~~~~~~~~~~ + +When you run the tool for the first time, the tool will create a +`configuration +directory `__ and +generate a configuration file. + +Configuration is first sourced from an remote server that the platform +team manages. This is overlaid with configuration details that you will +be prompted to input particularly your user id. + +``--reinit`` +^^^^^^^^^^^^ + +Configuration can be re-initialized or reset. There is a ``--reinit`` +flag that is to be used to re-initialize your configuration and your +environment profiles. + +To re-initialize: + +:: + + $ dcae_cli --reinit + +Verify +~~~~~~ + +Verify that its installed: + +:: + + $ dcae_cli --help + Usage: dcae_cli [OPTIONS] COMMAND [ARGS]... + + Options: + -v, --verbose Prints INFO-level logs to screen. + --reinit Re-initialize dcae-cli configuration + --version Show the version and exit. + --help Show this message and exit. + + Commands: + catalog + component + data_format + profiles + +Version +------- + +You can verify the version of the dcae-cli with the following command: + +:: + + $ dcae_cli --version -- cgit 1.2.3-korg