From d2cd31b73c0282f7aafd5b4adada00c0f4533d61 Mon Sep 17 00:00:00 2001 From: Ralph Knag Date: Mon, 2 Apr 2018 16:27:46 -0400 Subject: Onboarding documentation update for CLI Change-Id: I1d4d0111063ea62c3759aa9b7232998b70229644 Issue-ID: DCAEGEN2-350 Signed-off-by: Ralph Knag --- docs/sections/components/intro.rst | 52 ++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 22 deletions(-) (limited to 'docs/sections/components/intro.rst') diff --git a/docs/sections/components/intro.rst b/docs/sections/components/intro.rst index 8a31e844..db7175c1 100755 --- a/docs/sections/components/intro.rst +++ b/docs/sections/components/intro.rst @@ -4,29 +4,30 @@ .. _intro: -Component Developer Overview -============================ +Overview +======== DCAE components are services that provide a specific functionality and -are written to be composable with other DCAE service components. The -DCAE platform is responsible for running and managing DCAE service -components reliably. +are generally written to be composable with other DCAE components, +although a component can run independently as well. The DCAE platform is +responsible for running and managing DCAE service components reliably. Currently, the DCAE platform supports two types of components, CDAP applications and Docker containers. For each, there are requirements that must be met for the component to integrate into the DCAE platform -(see :doc:`CDAP ` and :doc:`Docker `. +(see :doc:`CDAP ` and +:doc:`Docker `). -Components requires one or more data formats. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +A Component requires one or more data formats. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Components are software applications that do some function. Components -don’t run independently, they depend upon other components. A +A component is a software application that performs a function. It +doesn’t run independently; it depends upon other components. A component’s function could require connecting to other components to fulfill that function. A component could also be providing its function as a service through an interface for other components to use. -Components cannot connect to or be connected with any other component. +A component cannot connect to or be connected with any other component. The upstream and downstream components must *speak* the same vocabulary or *data format*. The output of an one component must match another component’s input. This is necessary for components to function @@ -42,8 +43,7 @@ Each Component requires a component specification. The component specification is a JSON artifact that fully specifies the component, it’s interfaces, and configuration. It’s standardized for -CDAP and Docker applications and is validated using a :any:`JSON -schema `. +CDAP and Docker applications and is validated using a :doc:`JSON schema <./component-json-schema>`. The component specification fully specifies all the configuration parameters of the component. This is used by the designer and by policy @@ -80,18 +80,26 @@ Onboarding ---------- Onboarding is a process that ensures that the component is compliant -with the DCAE platform rules. A command-line tool called :doc:`dcae-cli ` is provided to help with onboarding. The high level summary of the onboarding process is: +with the DCAE platform rules. A command-line tool called +:doc:`dcae-cli <./dcae-cli/quickstart>` is provided to +help with onboarding. The high level summary of the onboarding process +is: 1. Defining the :doc:`data formats ` if they don’t already exist. -2. Define the :doc:`component specification `. See :doc:`Docker ` and :doc:`CDAP `. -3. Use the dcae_cli tool to :any:`add the data formats ` - and :any:`add the component ` to - the onboarding catalog. This process will validate them as well. -4. Use the dcae_cli tool to :any:`deploy ` - the component. (The component is deployed to the environment - indicated in :any:`profile `). +2. Defining the :doc:`component specification <./component-specification/common-specification>`. + See :doc:`docker <./component-specification/docker-specification>` and + :doc:`CDAP <./component-specification/cdap-specification>`. +3. Use the dcae_cli tool to :any:`add the data formats ` and + :any:`add the component ` to the + onboarding catalog. This process will validate them as well. +4. Use the dcae_cli tool to + :any:`deploy ` the + component. (The component is deployed to the environment indicated in + the :any:`profile ` + section). 5. Test the component. Also do pairwise-test the component with any other components it connects with. 6. Publish the component and data formats into the Service Design and - Creation (SDC) ‘catalog’. (Currently, this is a manual step). + Creation (SDC) ‘catalog’. (Currently, this is a manual step, not done + via the dcae_cli tool). -- cgit 1.2.3-korg