diff options
Diffstat (limited to 'docs/sections/components')
5 files changed, 91 insertions, 98 deletions
diff --git a/docs/sections/components/component-development.rst b/docs/sections/components/component-development.rst index 2877822a..14a2d470 100644 --- a/docs/sections/components/component-development.rst +++ b/docs/sections/components/component-development.rst @@ -8,8 +8,11 @@ DCAE Component Development :maxdepth: 1 ./intro.rst + ./architecture/pieces.rst + ./architecture/service-discovery.rst ./requirements-guidelines.rst ./component-specification/component-specification.rst + ./component-json-schema.rst ./data-formats.rst ./dcae-cli/dcae-cli-tool.rst ./glossary.rst diff --git a/docs/sections/components/component-specification/docker-specification.rst b/docs/sections/components/component-specification/docker-specification.rst index 01e11536..7fb66e57 100755 --- a/docs/sections/components/component-specification/docker-specification.rst +++ b/docs/sections/components/component-specification/docker-specification.rst @@ -188,19 +188,20 @@ At the top-level: The ``container`` object contains:
-+-----------------------+-----------------------+-----------------------+
-| Property Name | Type | Description |
-+=======================+=======================+=======================+
-| bind | string | path to the container |
-| | | volume |
-+-----------------------+-----------------------+-----------------------+
-| mode | string | “ro” - indicates |
-| | | read-only volume |
-+-----------------------+-----------------------+-----------------------+
-| | “” - indicates that |
-| | the contain can write |
-| | into the bind mount |
-+-----------------------+-----------------------+-----------------------+
+
++-----------------------+-----------------------+-------------------------------+
+| Property Name | Type | Description |
++=======================+=======================+===============================+
+| bind | string | path to the container |
+| | | volume |
++-----------------------+-----------------------+-------------------------------+
+| mode | string | ro - indicates |
+| | | read-only volume |
++-----------------------+-----------------------+-------------------------------+
+| | | w - indicates that |
+| | | the contain can write |
+| | | into the bind mount |
++-----------------------+-----------------------+-------------------------------+
The ``host`` object contains:
@@ -263,22 +264,20 @@ Example: The docker script interface is as follows: \`/opt/app/reconfigure.sh
$reconfigure_type {“updated policies”: , “application config”: }
-+--------------+--------------+----------------------------------------+
-| Name | Type | Description |
-+==============+==============+========================================+
-| reconfigure_ | string | “policy” |
-| type | | |
-+--------------+--------------+----------------------------------------+
-| updated_poli | json | TBD |
-| cies | | |
-+--------------+--------------+----------------------------------------+
-| updated_appl | json | complete generated app_config, not |
-| _config | | fully-resolved, but ``policy-enabled`` |
-| | | parameters have been updated. In order |
-| | | to get the complete updated |
-| | | app_config, the component would have |
-| | | to call ``config-binding-service``. |
-+--------------+--------------+----------------------------------------+
++---------------------+--------------+----------------------------------------+
+| Name | Type | Description |
++=====================+==============+========================================+
+| reconfigure_type | string | policy |
++---------------------+--------------+----------------------------------------+
+| updated_policies | json | TBD |
++---------------------+--------------+----------------------------------------+
+| updated_appl_config | json | complete generated app_config, not |
+| | | fully-resolved, but ``policy-enabled`` |
+| | | parameters have been updated. In order |
+| | | to get the complete updated |
+| | | app_config, the component would have |
+| | | to call ``config-binding-service``. |
++---------------------+--------------+----------------------------------------+
Docker Component Spec - Complete Example
----------------------------------------
diff --git a/docs/sections/components/component-type-docker.rst b/docs/sections/components/component-type-docker.rst index bb6a5a70..da83a78b 100755 --- a/docs/sections/components/component-type-docker.rst +++ b/docs/sections/components/component-type-docker.rst @@ -12,8 +12,8 @@ Overview Component developers are required to provide artifacts for the platform
to be able to deploy your component including:
-- :any:`Component specification <docker-specification>`
-- :any:`One or more Data Formats <data-formats>` \*unless they already exist
+- `Component specification <docker-specification>`
+- `One or more Data Formats <data-formats>` \*unless they already exist
- `Docker image <#docker-on-the-platform>`__
In addition, components will have to be enhanced to be compliant with
@@ -402,22 +402,22 @@ Envs The platform provides a set of environment variables into each Docker
container:
-+--------------+--------------+----------------------------------------+
-| Name | Type | Description |
-+==============+==============+========================================+
-| ``HOSTNAME`` | string | Unique name of the component instance |
-| | | that is generated |
-+--------------+--------------+----------------------------------------+
-| ``CONSUL_HOS | string | Hostname of the platform’s Consul |
-| T`` | | instance |
-+--------------+--------------+----------------------------------------+
-| ``CONFIG_BIN | string | Hostname of the platform’s config |
-| DING_SERVICE | | binding service instance |
-| `` | | |
-+--------------+--------------+----------------------------------------+
-| ``DOCKER_HOS | string | Host of the target platform Docker |
-| T`` | | host to run the container on |
-+--------------+--------------+----------------------------------------+
++----------------------------+--------------+----------------------------------------+
+| Name | Type | Description |
++============================+==============+========================================+
+| ``HOSTNAME`` | string | Unique name of the component instance |
+| | | that is generated |
++----------------------------+--------------+----------------------------------------+
+| ``CONSUL_HOST`` | string | Hostname of the platform's Consul |
+| | | instance |
++----------------------------+--------------+----------------------------------------+
+| ``CONFIG_BINDING_SERVICE`` | string | Hostname of the platform's config |
+| | | binding service instance |
+| | | |
++----------------------------+--------------+----------------------------------------+
+| ``DOCKER_HOST`` | string | Host of the target platform Docker |
+| | | host to run the container on |
++----------------------------+--------------+----------------------------------------+
Operational Concerns
--------------------
diff --git a/docs/sections/components/dcae-cli/commands.rst b/docs/sections/components/dcae-cli/commands.rst index d34ba43d..4634472d 100644 --- a/docs/sections/components/dcae-cli/commands.rst +++ b/docs/sections/components/dcae-cli/commands.rst @@ -18,29 +18,29 @@ 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 |
-+-----------------------------------------------+-----------------------+
++------------------------------+----------------------------------------+
+| 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 |
++------------------------------+----------------------------------------+
::
diff --git a/docs/sections/components/dcae-cli/walkthrough.rst b/docs/sections/components/dcae-cli/walkthrough.rst index 559ba3ab..56c9e28e 100755 --- a/docs/sections/components/dcae-cli/walkthrough.rst +++ b/docs/sections/components/dcae-cli/walkthrough.rst @@ -267,21 +267,21 @@ 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. |
-+------------------+---------------------------------------------------+
++------------------+-----------------------------------------------------------+
+| 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:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------
::
@@ -304,7 +304,7 @@ Run a component in attached mode: 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:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------------
::
@@ -317,14 +317,14 @@ Run a component in unattached mode: 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``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------------------------------------------------
::
@@ -338,18 +338,9 @@ Run a component that expects input that is ``sourced at deployment`` 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.Undep |
-| loy | WARNING | Undeployed components: 1`` |
-+-----------------------------------------------------------------+
+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:
|