DCAE Controller documentation DCAEGEN2-213
[dcaegen2.git] / docs / sections / components / dcae-cli / quickstart.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
2 .. http://creativecommons.org/licenses/by/4.0\r
3 \r
4 .. _quickstart:\r
5 \r
6 Quickstart\r
7 ==========\r
8 \r
9 The ``dcae-cli`` is a Python command-line tool built to aide component\r
10 developers with the development and testing of their micro-service\r
11 component for the DCAE platform. It will help developers do functional\r
12 and integration testing of their components locally and on remote\r
13 environments as simple as possible.\r
14 \r
15 The tool requires the component developers to create a valid component\r
16 specification for their component which is used by the tool. This same\r
17 component specification will be published in the :any:`onboarding catalog <glossary-onboarding-catalog>` at the end of development\r
18 and testing.\r
19 \r
20 .. The git repository can be found `here <ONAP%20LINK%20TBD>`__\r
21 \r
22 Pre-requisite\r
23 -------------\r
24 \r
25 For Docker\r
26 ~~~~~~~~~~\r
27 \r
28 There are two options for development with Docker: developing locally on\r
29 your machine which requires Docker to be installed and developing\r
30 remotely by deploying onto remote infrastructure.\r
31 \r
32 For local development\r
33 ^^^^^^^^^^^^^^^^^^^^^\r
34 \r
35 -  You must install `Docker\r
36    engine <https://docs.docker.com/engine/installation/>`__ locally on\r
37    your machine.\r
38 -  You must know the *external ip* of where the Docker engine is\r
39    running. The external ip is needed so that service discovery will\r
40    wire up correctly.\r
41 \r
42    -  For OSX users, this means making sure the VirtualBox VM that is\r
43       running your Docker engine has a bridged adapter and getting the\r
44       ip of that adapter.\r
45 \r
46 For remote development\r
47 ^^^^^^^^^^^^^^^^^^^^^^\r
48 \r
49 You need access to a remote host with Docker engine installed with\r
50 remote API access. You must have the associated connection information:\r
51 domain name or IP and port (should be either 2375 or 2376). This\r
52 information should be set in :any:`an active profile <setting-profile>`.\r
53 \r
54 For CDAP\r
55 ~~~~~~~~\r
56 \r
57 TBD\r
58 \r
59 Install\r
60 -------\r
61 \r
62 ::\r
63 \r
64     pip install --extra-index-url https://YOUR_NEXUS_PYPI_SERVER/simple dcae-cli\r
65 \r
66 To do an upgrade, use the ``--upgrade`` flag.\r
67 \r
68 Configuration\r
69 ~~~~~~~~~~~~~\r
70 \r
71 When you run the tool for the first time, the tool will create a\r
72 `configuration\r
73 directory <http://click.pocoo.org/5/api/#click.get_app_dir>`__ and\r
74 generate a configuration file.\r
75 \r
76 Configuration is first sourced from an remote server that the platform\r
77 team manages. This is overlaid with configuration details that you will\r
78 be prompted to input particularly your user id.\r
79 \r
80 ``--reinit``\r
81 ^^^^^^^^^^^^\r
82 \r
83 Configuration can be re-initialized or reset. There is a ``--reinit``\r
84 flag that is to be used to re-initialize your configuration and your\r
85 environment profiles.\r
86 \r
87 To re-initialize:\r
88 \r
89 ::\r
90 \r
91     $ dcae_cli --reinit\r
92 \r
93 Verify\r
94 ~~~~~~\r
95 \r
96 Verify that its installed:\r
97 \r
98 ::\r
99 \r
100     $ dcae_cli --help\r
101     Usage: dcae_cli [OPTIONS] COMMAND [ARGS]...\r
102 \r
103     Options:\r
104       -v, --verbose  Prints INFO-level logs to screen.\r
105       --reinit       Re-initialize dcae-cli configuration\r
106       --version      Show the version and exit.\r
107       --help         Show this message and exit.\r
108 \r
109     Commands:\r
110       catalog\r
111       component\r
112       data_format\r
113       profiles\r
114 \r
115 Version\r
116 -------\r
117 \r
118 You can verify the version of the dcae-cli with the following command:\r
119 \r
120 ::\r
121 \r
122     $ dcae_cli --version\r