\r
.. _quickstart:\r
\r
-Quickstart\r
-==========\r
+Overview\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
+The ``dcae-cli`` is a Python command-line tool for component developers.\r
+With it, the developer can :\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
+- validate the data formats and component specifications\r
+- publish the validated data formats and component specifications into\r
+ the ``onboarding catalog``\r
+- access the ``onboarding catalog`` to search for existing data formats\r
+ (for possible reuse) and component specs\r
+- deploy a component onto a local or remote DCAE platform for\r
+ functional and pair-wise testing (This is done without Cloudify)\r
\r
-.. The git repository can be found `here <ONAP%20LINK%20TBD>`__\r
+The git repository for the dcae_cli tool can be found\r
+`here <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/cli.git>`__\r
\r
-Pre-requisite\r
--------------\r
+Pre-requisites\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
+There are two options for development with Docker:\r
\r
For local development\r
^^^^^^^^^^^^^^^^^^^^^\r
\r
-- You must install `Docker\r
- engine <https://docs.docker.com/engine/installation/>`__ locally on\r
+- Install `Docker 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
+- Know the *external ip* of where the Docker engine is running. The\r
+ external ip is needed so that service discovery will connect to it.\r
\r
- - For OSX users, this means making sure the VirtualBox VM that is\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
+ 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
+- Have access to a remote host with Docker engine installed and with\r
+ remote API access.\r
+- Have the associated connection information:\r
+\r
+ - domain name or IP and port (port should be either 2375 or 2376).\r
+ Use this information to establish an active\r
+ :any:`profile <dcae_cli_activate_profile>`.\r
\r
For CDAP\r
~~~~~~~~\r
\r
-TBD\r
+None at this time.\r
+\r
+Python, Pip, Virtualenv\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Install python, pip (9.0.1 or higher), and virtualenv if they are not\r
+installed. Do these when not in a VPN to avoid possible network issues.\r
+\r
+::\r
+\r
+ sudo apt-get -f install python\r
+ sudo apt-get -f install python-pip\r
+ sudo pip install virtualenv\r
+\r
+Set up a virtual environment and activate\r
+\r
+::\r
+\r
+ virtualenv cli_tool\r
+ source cli_tool/biin/activate \r
+\r
+Install dcae_cli\r
+----------------\r
+\r
+::\r
+\r
+ pip install onap-dcae-cli\r
\r
-Install\r
--------\r
+Check dcae_cli version\r
+----------------------\r
+\r
+You can verify the version of the dcae-cli with the following command.\r
+To get the latest version of the dcae_cli tool,\r
\r
::\r
\r
- pip install --extra-index-url https://YOUR_NEXUS_PYPI_SERVER/simple dcae-cli\r
+ $ dcae_cli --version\r
\r
-To do an upgrade, use the ``--upgrade`` flag.\r
+Upgrade dcae_cli\r
+----------------\r
+\r
+Periodically, upgrade the dcae_cli to get the latest version\r
+\r
+::\r
+\r
+ pip install --upgrade onap-dcae-cli\r
\r
Configuration\r
-~~~~~~~~~~~~~\r
+-------------\r
\r
-When you run the tool for the first time, the tool will create a\r
-`configuration\r
+When running the tool for the first time, a `configuration\r
directory <http://click.pocoo.org/5/api/#click.get_app_dir>`__ and\r
-generate a configuration file.\r
+configuration file will be created.\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
+The configuration is first sourced from a remote server that is managed\r
+by the platform team. You will be prompted to enter your ATTUID to\r
+complete this process.\r
\r
-``--reinit``\r
-^^^^^^^^^^^^\r
+Re-initializing Configuration\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
+environment profiles. You may be instructed to re-initialize after\r
+certain updates are made to the dcae_cli tool. When you re-initialize\r
+the configuration, your configuration will be added to or updated from\r
+the platform configuration and profiles. No profiles will be deleted via\r
+the reinit process.\r
\r
To re-initialize:\r
\r
\r
$ dcae_cli --reinit\r
\r
-Verify\r
-~~~~~~\r
+Verify Installation\r
+-------------------\r
\r
-Verify that its installed:\r
+To Verify that the dcae_cli tool is installed, run the following command\r
+and look for the output below.\r
\r
::\r
\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
+Refer to :doc:`dcae_cli Commands <./commands>`.\r
\r
-::\r
-\r
- $ dcae_cli --version\r
Code Review / dcaegen2.git / blobdiff