diff options
Diffstat (limited to 'docs/sections/components/dcae-cli')
| -rw-r--r-- | docs/sections/components/dcae-cli/commands.rst | 590 | ||||
| -rw-r--r-- | docs/sections/components/dcae-cli/dcae-cli-tool.rst | 13 | ||||
| -rwxr-xr-x | docs/sections/components/dcae-cli/quickstart.rst | 156 | ||||
| -rwxr-xr-x | docs/sections/components/dcae-cli/walkthrough.rst | 385 |
4 files changed, 0 insertions, 1144 deletions
diff --git a/docs/sections/components/dcae-cli/commands.rst b/docs/sections/components/dcae-cli/commands.rst deleted file mode 100644 index d63fb09c..00000000 --- a/docs/sections/components/dcae-cli/commands.rst +++ /dev/null @@ -1,590 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _dcae_cli_commands:
-
-dcae_cli Commands
-=================
-
-The dcae_cli tool has four command groups. Each has several
-sub-commands.
-
-``catalog``
------------
-
-The ``catalog`` command lists and shows resources (components and
-data_formats) in the ‘onboarding’ catalog (regardless of the owner). A
-resource can have a status of ``staged`` or ``published``. By default,
-only ``published`` resources are displayed. To see ``staged`` resources,
-add the –expanded argument.
-
-+------------------------------+----------------------------------------+
-| Catalog Status | Meaning |
-+==============================+========================================+
-| staged | resource has be added |
-| | (and validated), but |
-| | is under development |
-+------------------------------+----------------------------------------+
-| staged | data_formats can only be referenced in |
-| | their owners component specs |
-+------------------------------+----------------------------------------+
-| staged | components can only be deployed by |
-| | their owners |
-+------------------------------+----------------------------------------+
-| published | resource has been |
-| | tested and can be |
-| | shared |
-+------------------------------+----------------------------------------+
-| | published data_formats can be used in |
-| | anyone's component spec |
-+------------------------------+----------------------------------------+
-| | published components and be deployed by|
-| | anyone |
-+------------------------------+----------------------------------------+
-
-::
-
- $ dcae_cli catalog --help
- Usage: dcae_cli catalog [OPTIONS] COMMAND [ARGS]...
-
- Options:
- --help Show this message and exit.
-
- Commands:
- list Lists resources in the onboarding catalog
- show Provides more information about resource
-
-List onboarding catalog contents
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ dcae_cli catalog list
- Components:
- +--------------------------------+---------+--------+---------------------------------------------------------------------+--------+-----------+------------+
- | Name | Version | Type | Description | Owner | Status | Published |
- +--------------------------------+---------+--------+---------------------------------------------------------------------+--------+-----------+------------+
- | DcaeSyslogCollector | 2.0.0 | docker | DCAE Control Plane Syslog Collector | sh1986 | published | 2017-08-04 |
- | cdap.dmaap.spec.example | 0.2.0 | cdap | dmaap spec example. Not a functioning application, only for showing | tc677g | published | 2017-07-24 |
- | | | | how to pub/sub dmaap. Pretend this is like MAP with VES in and ou.. | | | |
- | cdap.event.proc.enrich.app | 1.0.3 | cdap | CDAP Event Processing Enrich application | an4828 | published | 2017-09-20 |
- | cdap.event.proc.map.app | 1.0.3 | cdap | CDAP Event Processing Map application | an4828 | published | 2017-09-20 |
-
- ...
-
- Data formats:
- +--------------------------------------------+---------+-----------------------------------------------------------------------+--------+-----------+------------+
- | Name | Version | Description | Owner | Status | Published |
- +--------------------------------------------+---------+-----------------------------------------------------------------------+--------+-----------+------------+
- | FOI_PM_VHSS_data_format | 1.0.0 | CSV pipe delimited data format for VHSS PM files | sr229c | published | 2017-09-05 |
- | Map_input | 1.0.0 | The input format for Mapper, that in 1707 is the UCSNMP Collector | an4828 | published | 2017-07-18 |
- | | | output format, but will support more formats later | | | |
- | Syslog Collector Parsed Json Message | 1.0.0 | Post processed/parsed collected syslog message | sh1986 | published | 2017-08-04 |
- | Syslog Collector Syslog Message Input | 1.0.0 | The input message for the DCAE syslog collector is free/unstructured | sh1986 | published | 2017-08-04 |
- | | | text | | | |
- | myapp Alert Definition | 1.0.0 | The format of the output event from myapp | an4828 | published | 2017-08-10 |
- | VES_specification | 5.28.4 | VES spec for 5.4 | vv770d | published | 2017-09-19 |
-
- ...
-
-Show the contents of an item in the catalog
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ dcae_cli catalog show FOI_PM_VHSS_data_format
-
- Data format
- -----------
- {
- "dataformatversion": "1.0.0",
- "delimitedschema": {
- "delimiter": "|",
- "fields": [
- {
- "description": "System ID",
- "fieldtype": "string",
- "name": "SYSTEM"
- },
- {
- "description": "Date",
- "fieldtype": "string",
- "name": "DATE"
- },
- {
- "description": "Time",
- "fieldtype": "string",
- "name": "TIME"
- },
-
- ...
-
-.. _dcae_cli_component_commands:
-
---------------
-
-``component``
--------------
-
-The ``component`` command is for validating (adding), listing, showing,
-verifying generated configuration, running, undeploying, and publishing
-components that YOU own.
-
-::
-
- $ dcae_cli component --help
- Usage: dcae_cli component [OPTIONS] COMMAND [ARGS]...
-
- Options:
- --help Show this message and exit.
-
- Commands:
- add
- dev Set up component in development for...
- list Lists components in the onboarding catalog.
- publish Pushes COMPONENT to the onboarding catalog
- run Runs the latest version of COMPONENT.
- show Provides more information about COMPONENT
- undeploy Undeploys the latest version of COMPONENT.
-
---------------
-
-.. _dcae_cli_add_a_component:
-
-Add a Component
-~~~~~~~~~~~~~~~
-
-A component must be added to the onboarding catalog in order to be
-tested by the dcae_cli tool. The process of adding a component also
-validates it’s component specification. In order to add a component, the
-component docker image (or CDAP jar) must exist locally.
-
-Components in the onboarding catalog can be run by others, once they are
-``published.`` ``Published`` components cannot be modified or deleted.
-Rather a new version can be created instead.
-
-Validated component specs are used later to generate Tosca models and
-Cloudify Blueprints for the component, which makes them available for
-use in the SDC Tool for creating services.
-
-::
-
- $ dcae_cli component add --help
- Usage: dcae_cli component add [OPTIONS] COMPONENT-SPECIFICATION
-
- Options:
- --update Updates a previously added component if it has not been already
- published
- --help Show this message and exit.
-
-::
-
- $ dcae_cli component add component-spec.json
-
---------------
-
-List Components
-~~~~~~~~~~~~~~~
-
-List components in the onboarding catalog that owned by YOUR userid..
-
-::
-
- $ dcae_cli component list
- Active profile: solutioning
- +-------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
- | Name | Version | Type | Description | Status | Modified | #Deployed |
- +-------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
- | cdap.helloworld.endnode | 0.8.0 | cdap | cdap test component | staged | 2017-05-23 04:14:35.588075 | 0 |
- | sandbox.platform.yourapp| 0.5.0 | docker | Web service used as a stand-alone test DCAE service compone.. | staged | 2017-05-23 04:07:44.065610 | 0 |
- +-------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
-
-The fields ``Name``, ``Version``, ``Type``, ``Description`` are
-referenced from the component specification’s ``self`` JSON. Use the
-“–deployed” argument to see more details on deployed components
-
---------------
-
-.. _dcae_cli_run_a_component:
-
-Run a Component
-~~~~~~~~~~~~~~~
-
-The ``run`` operation is to be used for running your application in its
-container remotely on the activated environment. Docker containers have
-the additional option to run locally on your development machine. If the
-component uses Dmaap, you can specify the Dmaap Connection Object as
-well. Refer to :doc:`Dmaap Connection Object <../component-specification/dmaap-connection-objects>`.
-
-When you run a component via the dcae_cli Tool, remember the blueprint
-has not been created and is not used for deployment.
-
-In order to run the component, the data formats and component must have
-been added to the onboarding catalog.
-
-**DOCKER NOTE:** Make sure the Docker image has been uploaded to the
-shared registry.
-
-A docker component can be run in either ``attached`` or ``unattached``
-mode. (Default is unattached).
-
-+------------------+---------------------------------------------------+
-| Mode | Description |
-+==================+===================================================+
-| attached | component is run in the ‘foreground’, container |
-| | logs are streamed to stdout. Ctrl-C is used to |
-| | terminate the dcae_cli session. |
-+------------------+---------------------------------------------------+
-| unattached | component is run in the ‘background’, container |
-| | logs are viewed via ``docker logs`` command, |
-| | container runs until undeployed with dcae_cli |
-| | ``undeploy`` command. |
-+------------------+---------------------------------------------------+
-
-Run a component in attached mode:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-::
-
- $ dcae_cli -v component run --attached sandbox.platform.yourapp:0.5.0
-
- DCAE.Docker | INFO | Running image 'registry.proto.server.com/dcae-rework/yourapp:0.4.0' as 'user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp'
- DCAE.Docker.user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp | INFO | Consul host: yourconsulhost.com
-
- DCAE.Docker.user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp | INFO | service name: mh677g.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp
-
- DCAE.Docker.user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp | INFO | Generated config: {'multiplier': 3}
-
- DCAE.Docker.user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp | INFO | * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)
-
- DCAE.Docker.user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp | INFO | 127.0.0.1 - - [24/May/2017 03:37:57] "GET /health HTTP/1.1" 200 -
-
- DCAE.Docker.user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp | INFO | 127.0.0.1 - - [24/May/2017 03:38:12] "GET /health HTTP/1.1" 200 -
-
-Hit Ctrl-C to terminate session.
-
-::
-
- ^CDCAE.Docker | INFO | Stopping container 'user1.b7287639-37f5-4f25-8d54-8a2087f4c8da.0-5-0.sandbox-platform-yourapp' and cleaning up...
-
-Run a component in unattached mode:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-::
-
- $ dcae_cli -v component run sandbox.platform.yourapp:0.5.0
- DCAE.Docker | INFO | Running image 'registry.proto.server.com/dcae-rework/yourapp:0.4.0' as 'user1.4811da0e-08d5-429f-93bf-bf6814924577.0-5-0.sandbox-platform-yourapp'
- DCAE.Run | INFO | Deployed /user1.4811da0e-08d5-429f-93bf-bf6814924577.0-5-0.sandbox-platform-yourapp
-
-**NOTE** You must undeploy this component when finished testing. This is
-important to conserve resources in the environment.
-
-Run a component that subscribes to Dmaap MR or DR
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-::
-
- $ dcae_cli -v component run --attached --dmaap-file $dmaap-connection-file sandbox.platform.yourapp:0.5.0
-
---------------
-
-Undeploy a Component
-~~~~~~~~~~~~~~~~~~~~
-
-The ``undeploy`` command is used to undeploy any instance of a specified
-component/version that you have deployed. This includes cleaning up the
-configuration.
-
-::
-
- $ dcae_cli component undeploy sandbox.platform.yourapp:0.5.0
- DCAE.Undeploy | WARNING | Undeploying components: 1
- DCAE.Undeploy | WARNING | Undeployed components: 1
-
---------------
-
-Publish a component
-~~~~~~~~~~~~~~~~~~~
-
-| Once a component has been tested, it should be published in the
- onboarding catalog using the ``publish`` sub-command .
-| Publishing will change the status of the component (from ``staged`` to
- ``published``), indicating that it has been tested, and making it
- accessible for other developers to use.
-
-**Note** Before a component can be published, all data_formats that it
-references must be published.
-
-::
-
- dcae_cli component publish sandbox.platform.yourapp:0.5.0
-
---------------
-
-Show a Component
-~~~~~~~~~~~~~~~~
-
-This will print out the contents of a component and is useful to copy a
-component spec.
-
-::
-
- $ dcae_cli component show
-
---------------
-
-.. _dcae-cli-run-the-dev-command:
-
-Run the ``dev`` command
-~~~~~~~~~~~~~~~~~~~~~~~
-
-The ``dev`` command is used as part of a process to see the platform
-generated configuration. It established the environment variables and is
-best explained
-:any:`here <dcae-cli-view-the-platform>`.
-
-::
-
- $ dcae_cli component dev component-spec.json
- Ready for component development
-
---------------
-
-.. _dcae_cli_data_format:
-
-``data_format``
----------------
-
-The ``data_format`` command is for validating (adding), listing,
-showing, publishing data_formats that YOU own. data_formats can also be
-generated with this command.
-
-::
-
- $ dcae_cli data_format --help
- Usage: dcae_cli data_format [OPTIONS] COMMAND [ARGS]...
-
- Options:
- --help Show this message and exit.
-
- Commands:
- add Tracks a data format file DATA_FORMAT-SPECIFICATION...
- generate Create schema from a file or directory...
- list Lists all your data formats
- publish Publishes data format to make available to others...
- show Provides more information about FORMAT
-
---------------
-
-.. _dcae_cli_add_a_data_format:
-
-Add a Data Format
-~~~~~~~~~~~~~~~~~
-
-A data_format must be in the onboarding catalog in order to be
-referenced in the component specification. The process of adding a
-data_format also validates it. Data_formats in the onboarding catalog
-can be run by others, once they are ``published.`` ``Published``
-data_formats cannot be modified or deleted. Rather a new version can be
-created instead.
-
-::
-
- $ dcae_cli data_format add --help
- Usage: dcae_cli data_format add [OPTIONS] DATA_FORMAT-SPECIFICATION
-
- Options:
- --update Updates a previously added data_format if it has not been already
- published
- --help Show this message and exit.
-
-::
-
- dcae_cli data_format add health.json
-
---------------
-
-List Data Formats
-~~~~~~~~~~~~~~~~~
-
-Only data_formats owned by YOUR userid will be shown.
-
-::
-
- $ dcae_cli data_format list
-
- Data formats for user1
- +---------------------------------+---------+-------------------------------------------+--------+----------------------------+
- | Name | Version | Description | Status | Modified |
- +---------------------------------+---------+-------------------------------------------+--------+----------------------------+
- | sandbox.platform.yourapp.health | 0.1.0 | Data format used for the /health endpoint | staged | 2017-05-23 04:02:38.952799 |
- +---------------------------------+---------+-------------------------------------------+--------+----------------------------+
-
-The fields ``name``, ``version``, ``description`` are referenced from
-the data format specification’s ``self`` JSON. ``Status`` represents the
-status of the data format in the catalog. See `Publish a Data
-Format <#publish-a-data-format>`__ for more info.
-
---------------
-
-Show a Data Format
-~~~~~~~~~~~~~~~~~~
-
-This will print out the contents of a data_format and is useful for
-copying a data_format.
-
-::
-
- $ dcae_cli data_format show
-
---------------
-
-Publish a Data Format
-~~~~~~~~~~~~~~~~~~~~~
-
-| Once a data_format has been tested (by referencing it in a component
- spec that has been tested), it should be published in the onboarding
- catalog using the ``publish`` sub-command .
-| Publishing will change the status of the data_format (from ``staged``
- to ``published``), indicating that it has been tested, and making it
- accessible for other developers to use.
-
-::
-
- $ dcae_cli data_format publish data_format.json
-
---------------
-
-Generate a Data Format
-~~~~~~~~~~~~~~~~~~~~~~
-
-If you already have a valid input or output file, you can use the
-generate command to create the it’s data format specification.
-
-::
-
- $ dcae_cli data_format generate name:version file-or-dir-path
-
---------------
-
-``profiles``
-------------
-
-The\ ``profiles`` command is for creating, deleting, listing, showing,
-activating, and updating (set) profiles. The profile contains
-environment variables used to connect to different environments. This is
-used in the running and deployment of a component using the
-``dcae_cli component run`` or ``dev`` command.
-
-::
-
- $ dcae_cli profiles --help
- Usage: dcae_cli profiles [OPTIONS] COMMAND [ARGS]...
-
- Options:
- --help Show this message and exit.
-
- Commands:
- activate Sets profile NAME as the active profile
- create Creates a new profile NAME initialized with...
- delete Deletes profile NAME
- list Lists available profiles
- set Updates profile NAME such that KEY=VALUE
- show Prints the profile dictionary
-
---------------
-
-List the available profiles
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ dcae_cli profiles list
- * solutioning
- 1710
- 1802
-
-The \* identifies the active profile. ``dcae-cli`` is currently
-installed with profiles for the ``solutioning``, ``1710``, and ``1802``
-environments. They are intended for the following:
-
-+-----------------------------------+-----------------------------------+
-| Environment | Description |
-+===================================+===================================+
-| solutioning | default environment; used for |
-| | initial component developer |
-| | testing with the dcae_cli tool. |
-+-----------------------------------+-----------------------------------+
-| 1710 | FTL3 (Functional Testing Lab 3) |
-| | environment, which represents the |
-| | 1710 release. |
-+-----------------------------------+-----------------------------------+
-| 1802 | FTL3a (Functional Testing Lab 3a) |
-| | environment, which represents the |
-| | 1802 release. |
-+-----------------------------------+-----------------------------------+
-
---------------
-
-Show the details of a profile
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ dcae_cli profiles show solutioning
- {
- "cdap_broker": "cdap_broker",
- "config_binding_service": "config_binding_service",
- "consul_host": "yourconsulhost.com",
- "docker_host": "yourdockerhost.com:2376"
- }
-
---------------
-
-.. _dcae_cli_activate_profile:
-
-Activate a profile
-~~~~~~~~~~~~~~~~~~
-
-To switch among profiles, use the activate sub-command. A subsequent
-``list`` will reveal the change made.
-
-::
-
- $ dcae_cli profiles activate test
-
---------------
-
-Create a new profile
-~~~~~~~~~~~~~~~~~~~~
-
-If you want to work in a different environment using the dcae_cli tool,
-you can make your own profile. (The environment must be a working DCAE
-Platform environment).
-
-::
-
- $ dcae_cli profiles create new-profile
-
-After creating you would assign the variables with the ``set``
-sub-command. Then activate it to use.
-
---------------
-
-Set variables in a profile
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ dcae_cli profiles set $profile $key $value
-
---------------
-
-Delete a profile
-~~~~~~~~~~~~~~~~
-
-::
-
- $ dcae_cli profiles delete new-profile
-
-
diff --git a/docs/sections/components/dcae-cli/dcae-cli-tool.rst b/docs/sections/components/dcae-cli/dcae-cli-tool.rst deleted file mode 100644 index 477fc341..00000000 --- a/docs/sections/components/dcae-cli/dcae-cli-tool.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -dcae-cli Tool -============= - -.. toctree:: - :maxdepth: 1 - - ./quickstart.rst - ./commands.rst - ./walkthrough.rst - diff --git a/docs/sections/components/dcae-cli/quickstart.rst b/docs/sections/components/dcae-cli/quickstart.rst deleted file mode 100755 index 47b9ac1b..00000000 --- a/docs/sections/components/dcae-cli/quickstart.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _quickstart:
-
-Overview
-========
-
-The ``dcae-cli`` is a Python command-line tool for component developers.
-With it, the developer can :
-
-- validate the data formats and component specifications
-- publish the validated data formats and component specifications into
- the ``onboarding catalog``
-- access the ``onboarding catalog`` to search for existing data formats
- (for possible reuse) and component specs
-- deploy a component onto a local or remote DCAE platform for
- functional and pair-wise testing (This is done without Cloudify)
-
-The git repository for the dcae_cli tool can be found
-`here <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/cli.git>`__
-
-Pre-requisites
---------------
-
-For Docker
-~~~~~~~~~~
-
-There are two options for development with Docker:
-
-For local development
-^^^^^^^^^^^^^^^^^^^^^
-
-- Install `Docker engine <https://docs.docker.com/engine/installation/>`__ locally on
- your machine.
-- Know the *external ip* of where the Docker engine is running. The
- external ip is needed so that service discovery will connect to it.
-
- - *(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
-^^^^^^^^^^^^^^^^^^^^^^
-
-- Have access to a remote host with Docker engine installed and with
- remote API access.
-- Have the associated connection information:
-
- - domain name or IP and port (port should be either 2375 or 2376).
- Use this information to establish an active
- :any:`profile <dcae_cli_activate_profile>`.
-
-For CDAP
-~~~~~~~~
-
-None at this time.
-
-Python, Pip, Virtualenv
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Install python, pip (9.0.1 or higher), and virtualenv if they are not
-installed. Do these when not in a VPN to avoid possible network issues.
-
-::
-
- sudo apt-get -f install python
- sudo apt-get -f install python-pip
- sudo pip install virtualenv
-
-Set up a virtual environment and activate
-
-::
-
- virtualenv cli_tool
- source cli_tool/biin/activate
-
-Install dcae_cli
-----------------
-
-::
-
- pip install onap-dcae-cli
-
-Check dcae_cli version
-----------------------
-
-You can verify the version of the dcae-cli with the following command.
-To get the latest version of the dcae_cli tool,
-
-::
-
- $ dcae_cli --version
-
-Upgrade dcae_cli
-----------------
-
-Periodically, upgrade the dcae_cli to get the latest version
-
-::
-
- pip install --upgrade onap-dcae-cli
-
-Configuration
--------------
-
-When running the tool for the first time, a `configuration
-directory <http://click.pocoo.org/5/api/#click.get_app_dir>`__ and
-configuration file will be created.
-
-The configuration is first sourced from a remote server that is managed
-by the platform team. You will be prompted to enter your ATTUID to
-complete this process.
-
-Re-initializing Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-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. You may be instructed to re-initialize after
-certain updates are made to the dcae_cli tool. When you re-initialize
-the configuration, your configuration will be added to or updated from
-the platform configuration and profiles. No profiles will be deleted via
-the reinit process.
-
-To re-initialize:
-
-::
-
- $ dcae_cli --reinit
-
-Verify Installation
--------------------
-
-To Verify that the dcae_cli tool is installed, run the following command
-and look for the output below.
-
-::
-
- $ 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
-
-Refer to :doc:`dcae_cli Commands <./commands>`.
-
diff --git a/docs/sections/components/dcae-cli/walkthrough.rst b/docs/sections/components/dcae-cli/walkthrough.rst deleted file mode 100755 index fd1efb93..00000000 --- a/docs/sections/components/dcae-cli/walkthrough.rst +++ /dev/null @@ -1,385 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _walkthrough:
-
-Walk-through
-============
-
-This section demonstrates the flow and usage of the dcae_cli tool to
-onboard a typical component to the DCAE platform. The commands are
-explained in more detail in :doc:`dcae_cli Commands <commands>`.
-
-- `Add (and validate) a data format <#add-a-data-format>`__
-- `Add (and validate) the component <#add-the-component>`__
-- `View the platform generated
- configuration <#view-the-platform-generated-configuration>`__
-- `If needed, Create the dmaap file for Dmaap Testing <#create-the-input-file-for-dmaap-testing>`__
-- `If needed, Create the input file for *Sourced at Deployment* Testing <#create-the-input-file-for-sourced-at-deployment-testing>`__
-- `Run the component <#run-the-component>`__
-- :any:`Undeploy the component <dcae_cli_undeploy_the_component>`
-- :any:`Publish the component and data_format <dcae_cli_publish_the_component_and_data_format>` to let others
- know its ready for reuse
-- `List the Catalog Contents <#list-the-catalog-contents>`__ to see
- your published resources
-
-
---------------
-
-Add a Data Format
------------------
-
-::
-
- $ dcae_cli data_format add $HOME/yourapp/data-formats/health.json
-
-Verify that the data_format was added
-
-::
-
- $ dcae_cli data_format list | grep yourapp
- | sandbox.platform.yourapp.health | 0.1.0 | Data format used for the /health endpoint | staged | 2017-11-07 21:48:47.736518 |
-
-(Note: Each of the data formats for your component need to be added,
-unless already existing in the onboarding catalog )
-
---------------
-
-Add the Component
------------------
-
-::
-
- $ dcae_cli component add $HOME/yourapp/component-spec.json
-
-Verify that the component was added
-
-::
-
- $ dcae_cli component list
- Active profile: solutioning
-
- +-------------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
- | Name | Version | Type | Description | Status | Modified | #Deployed |
- +-------------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
- | sandbox.platform.yourapp | 0.7.0 | docker | Web service used as a stand-alone test DCAE service compone.. | staged | 2017-11-08 20:27:34.168854 | 0 |
- +-------------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
-
---------------
-
-.. _dcae-cli-view-the-platform:
-
-View the platform generated configuration
------------------------------------------
-
-The ``component dev`` command is useful during onboarding. Running this
-command is part of a multi-step process that sets up a temporary test
-environment, generates your application configuration, makes it
-available in that environment, and allows you to view that configuration
-to help with debugging.
-
-Here is a step-by-step example based on a component specification called
-``component-spec.json``.
-
-Step 1 - Run the component dev command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-(This creates a file called env_$ENV (in the current directory)- where
-$ENV is the name of the active profile. Note: SERVICE_NAME and HOSTNAME
-always resolve to the same value).
-
-::
-
- $ dcae_cli component dev component-spec.json
- Ready for component development
-
- Setup these environment variables. Run "source env_solutioning":
-
- export DOCKER_HOST=yourdockerhost.com:2376
- export SERVICE_CHECK_INTERVAL=15s
- export CONFIG_BINDING_SERVICE=config_binding_service
- export HOSTNAME=user12.b599cf0e-75e8-484b-b8e2-557576d77036.0-7-0.sandbox-platform-yourapp
- export CONSUL_HOST=yourconsulhost.com
- export CDAP_BROKER=cdap_broker
- export SERVICE_NAME=user12.b599cf0e-75e8-484b-b8e2-557576d77036.0-7-0.sandbox-platform-yourapp
- export SERVICE_CHECK_TIMEOUT=1s
- export SERVICE_CHECK_HTTP=/health
-
- Press any key to stop and to clean up
-
-Step 2 - Setup the environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-In another window, setup the temporary testing environment, by executing
-the environment file created above.
-
-::
-
- $ source env_solutioning
-
-(The application configuration is now available under the SERVICE_NAME
-shown above -
-``user12.b599cf0e-75e8-484b-b8e2-557576d77036.0-7-0.sandbox-platform-yourapp``).
-
-Step 3 - Query CONSUL
-~~~~~~~~~~~~~~~~~~~~~
-
-Query CONSUL to get the IP/PORT of CONFIG BINDING SERVICE
-
-::
-
- $ curl http://$CONSUL_HOST:8500/v1/catalog/service/$CONFIG_BINDING_SERVICE
- [
- {
- "ID": "bfbc220d-4603-7f90-ec2e-611d3c330f20",
- "Node":"docker00",
- "Address": "127.0.0.1",
- "Datacenter":"dcae-central",
- "TaggedAddresses": {
- "lan":"10.226.1.15",
- "wan":"10.226.1.15"
- },
- "NodeMeta": {},
- "ServiceID": "472b116f9035:config_binding_service:10000",
- "ServiceName": "config_binding_service",
- "ServiceTags": [],
- "ServiceAddress":"127.0.0.1",
- "ServicePort":10000,
- "ServiceEnableTagOverride": false,
- "CreateIndex":1078990,
- "ModifyIndex":1078990
- }
- ]
-
-Fetch the generated configuration from CONFIG BINDING SERVICE using the
-‘serviceaddress’ and ‘serviceport’ from above along with $SERVICE_NAME
-from earlier.
-
-::
-
- $ curl http://135.205.226.126:10000/service_component/user12.b599cf0e-75e8-484b-b8e2-557576d77036.0-7-0.sandbox-platform-yourapp
-
- {"streams_subscribes": {}, "services_calls": {}, "multiplier": 3, "streams_publishes": {}}
-
---------------
-
-.. _dcae-cli-walkthrough-dmaap-testing:
-
-Create the input file for Dmaap Testing
----------------------------------------
-
-Currently, the dcae-cli tool does not have the capability to provision
-topics or feeds. Therefore, in order to test with ``message router`` or
-``data router`` feeds, the developer must manually provision the topic
-or feed and then provide the connection details in the form of a DMaap
-JSON file for testing. This file is then passed in on the
-``component run`` or ``component dev`` commands by using the argument
-``--dmaap-file``.
-
-The structure of the DMaaP JSON is an object of config keys with the
-topic or feed connection details. The config keys are the ``config_key``
-values specified in the component specification streams section where
-the streams must be type ``message router`` or ``data router``. This
-file corresponds to the ``Dmaap Connection Object`` which is generated
-by the platform and provided to the component at runtime. The exception
-is that ``delivery_url`` cannot be provided in the dmaap-file because it
-is not created until the component is deployed. Refer to :any:`Dmaap Connection Object <dmaap-connection-objects>`, for details on creating the dmaap-file for testing.
-
---------------
-
-Create the input file for *Sourced at Deployment* Testing
----------------------------------------------------------
-
-Components may have configuration parameters whose values are to be
-sourced at deployment time. This is established in the
-:any:`component specification <common-specification-parameters>`
-by setting the property ``sourced_at_deployment`` to ``true`` for each
-applicable parameter.
-
-Then, use the ``--inputs-file`` command-line argument when running the
-component ``dev`` or ``run`` command for your component. This is to
-simulate providing the dynamic, deployment time values for those
-parameters marked as ``sourced_at_deployment``.
-
-For example, if your component specification has the following
-configuration parameters:
-
-::
-
- "parameters": [{
- "name": "vnf-ip",
- "value": "",
- "sourced_at_deployment": true
- },
- {
- "name": "static-param",
- "value": 5
- }]
-
-Pass in an input file that looks like:
-
-::
-
- {
- "vnf-ip": "10.100.1.100"
- }
-
-The application configuration would look like:
-
-::
-
- {
- "vnf-ip": "10.100.1.100",
- "static-param": 5
- }
-
---------------
-
-Run the component
------------------
-
-The ``run`` operation is to be used for running your application in its
-container remotely on the activated environment. Docker containers have
-the additional option to run locally on your development machine. If the
-component uses Dmaap, you can specify the Dmaap Connection Object as
-well. Refer to :any:`Dmaap Connection Object <dmaap-connection-objects>`.
-
-In order to run the component, the data formats and component must have
-been added to the onboarding catalog.
-
-To verify what’s in the catalog:
-
-::
-
- $ dcae_cli catalog list --expanded
- Active profile: solutioning
- +---------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
- | Name | Version | Type | Description | Status | Modified | #Deployed |
- +---------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
- | sandbox.platform.yourapp | 0.7.0 | docker | Web service used as a stand-alone test DCAE service compone.. | staged | 2017-11-08 20:27:34.168854 | 0 |
- +---------------------------+---------+--------+---------------------------------------------------------------+--------+----------------------------+-----------+
-
-For Docker
-
-**NOTE** Make sure the Docker image has been uploaded to the shared
-registry.
-
-A docker component can be run in either ``attached`` or ``unattached``
-mode. (Default is unattached).
-
-+------------------+-----------------------------------------------------------+
-| Mode | Description |
-+==================+===========================================================+
-| attached | component is run in the foreground, container |
-| | logs are streamed to stdout. Ctrl-C is used to |
-| | terminate the dcae_cli session. |
-+------------------+-----------------------------------------------------------+
-| unattached | component is run in the background container |
-| | logs are viewed via ``docker logs`` command, |
-| | container runs until undeployed with dcae_cli |
-| | ``undeploy`` command. |
-+------------------+-----------------------------------------------------------+
-
-Run a component in attached mode:
----------------------------------
-
-::
-
- $ dcae_cli -v component run --attached sandbox.platform.yourapp:0.7.0
- DCAE.Docker | INFO | Running image 'nexus01.server.com:18443/repository/solutioning01-mte2-docker/dcae-platform/yourapp:0.7.0' as 'user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp'
- DCAE.Docker.user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp | INFO | Consul host: yourconsulhost.com
-
- DCAE.Docker.user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp | INFO | service name: user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp
-
- DCAE.Docker.user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp | INFO | get_config returned the following configuration: {"streams_subscribes": {}, "multiplier": 3, "services_calls": {}, "streams_publishes": {}}
-
- DCAE.Docker.user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp | INFO | * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)
-
- DCAE.Docker.user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp | INFO | 127.0.0.1 - - [08/Nov/2017 23:27:30] "GET /health HTTP/1.1" 200 -
-
-
- Hit Ctrl-C to terminate session.
-
- ^C
- DCAE.Docker | INFO | Stopping container 'user12.dbb13a3c-d870-487e-b584-89929b856b5c.0-7-0.sandbox-platform-yourapp' and cleaning up...
-
-Run a component in unattached mode:
------------------------------------
-
-::
-
- $ dcae_cli -v component run sandbox.platform.yourapp:0.7.0
- DCAE.Docker | INFO | Running image 'nexus01.server.com:18443/repository/solutioning01-mte2-docker/dcae-platform/yourapp:0.7.0' as 'user12.22629ebd-417e-4e61-a9a0-f0cb16d4cef2.0-7-0.sandbox-platform-yourapp'
- DCAE.Run | INFO | Deployed user12.22629ebd-417e-4e61-a9a0-f0cb16d4cef2.0-7-0.sandbox-platform-yourapp. Verifying..
- DCAE.Run | INFO | Container is up and healthy
-
-**NOTE** You must undeploy this component when finished testing. This is
-important to conserve resources in the environment.
-
-Run a component that subscribes to Dmaap Message Router or Data Router
-----------------------------------------------------------------------
-
-::
-
- $ dcae_cli -v component run $component-that-uses-dmamp --dmaap-file $dmaap-connection-object
-
-Run a component that expects input that is ``sourced at deployment``
---------------------------------------------------------------------
-
-::
-
- $ dcae_cli -v component run $component-that-expects-dti --inputs-file $input-file-to-simulate-dti
-
---------------
-
-
-.. _dcae_cli_undeploy_the_component:
-
-Undeploy the component
-----------------------
-
-The ``undeploy`` command is used to undeploy any instance of a specified component/version that you have deployed. This includes cleaning up the configuration.
-Undeploy ``sandbox.platform.yourapp:0.7.0`` that was deployed above:
-``$ dcae_cli -v component undeploy sandbox.platform.yourapp:0.7.0 DCAE.Undeploy | WARNING | Undeploying components: 1 DCAE.Undeploy | WARNING | Undeployed components: 1``
-
-.. _dcae_cli_publish_the_component_and_data_format:
-
-Publish the component and data_format
--------------------------------------
-
-Once a component has been tested, it (and the data_format(s)) should be
-published in the onboarding catalog using the ``publish`` sub-command
-for both the ``data_format`` and ``component`` command.
-
-**Note** Before a component can be published, all data_formats that it
-references must be published.
-
-Publishing will change the status of a component or data_format,
-indicating that it has been tested, make accessible for other developers
-to use.
-
-::
-
- $ dcae_cli data_format publish sandbox.platform.yourapp:0.7.0
- Data format has been published
-
- $dcae_cli component publish sandbox.platform.yourapp:0.7.0
- Component has been published
-
---------------
-
-List the catalog contents
--------------------------
-
-::
-
- $dcae_cli catalog list
-
- $ dcae_cli data_format list | grep sandbox
- | sandbox.platform.yourapp | 0.7.0 | docker | Web service used as a stand-alone test DCAE service compone.. | user12 | published | 2017-11-13 |
- | sandbox.platform.yourapp.health | 0.1.0 | Data format used for the /health endpoint | published | 2017-11-13 17:48:10.121588 |
- | sandbox.platform.any | 0.1.0 | Data format used when no data format is required. | published | 2017-11-13 17:47:51.622607 |
- | sandbox.platform.yourapp.identity.response | 0.1.0 | Data format used for the /identity endpoint response which should | published | 2017-11-13 17:47:43.234715 |
- | sandbox.platform.yourapp.identity.request | 0.1.0 | Data format used for the /identity endpoint request. This is | published | 2017-11-13 17:47:36.693643 |
- | sandbox.platform.yourapp.rollcall.response | 0.1.0 | Data format used for the /rollcall endpoint respon.. | published | 2017-11-13 17:46:30.026846 |
-
|