Merge "Migration of Service Design from Wiki to Readthedocs User guide"
authorRich Bennett <rb2745@att.com>
Thu, 25 Apr 2019 16:12:34 +0000 (16:12 +0000)
committerGerrit Code Review <gerrit@onap.org>
Thu, 25 Apr 2019 16:12:34 +0000 (16:12 +0000)
64 files changed:
.gitmodules
docs/guides/onap-developer/architecture/media/ONAP-bbs.png [new file with mode: 0644]
docs/guides/onap-developer/architecture/onap-architecture.rst
docs/guides/onap-developer/how-to-use-docs/api-swagger-guide.rst
docs/guides/onap-developer/settingup/nodeports.csv
docs/guides/onap-user/resource-onboarding/index.rst [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png [new file with mode: 0644]
docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png [new file with mode: 0644]
docs/guides/onap-user/service-distribution/index.rst [new file with mode: 0644]
docs/guides/onap-user/service-distribution/media/design_governance_workflow.png [new file with mode: 0644]
docs/guides/onap-user/servicedesigner.rst
docs/release/repolist.rst
docs/submodules/aaf/authz.git
docs/submodules/appc.git
docs/submodules/ccsdk/cds.git
docs/submodules/ccsdk/distribution.git
docs/submodules/clamp.git
docs/submodules/cli.git
docs/submodules/dcaegen2.git
docs/submodules/dmaap/buscontroller.git
docs/submodules/dmaap/datarouter.git
docs/submodules/dmaap/dbcapi.git
docs/submodules/dmaap/messagerouter/messageservice.git
docs/submodules/externalapi/nbi.git
docs/submodules/holmes/engine-management.git
docs/submodules/holmes/rule-management.git
docs/submodules/integration.git
docs/submodules/modeling/modelspec.git
docs/submodules/multicloud/azure.git
docs/submodules/multicloud/framework.git
docs/submodules/multicloud/k8s.git
docs/submodules/oom.git
docs/submodules/oom/offline-installer.git
docs/submodules/optf/cmso.git
docs/submodules/optf/has.git
docs/submodules/optf/osdf.git
docs/submodules/policy/apex-pdp.git
docs/submodules/policy/distribution.git
docs/submodules/policy/engine.git
docs/submodules/policy/parent.git [new submodule]
docs/submodules/portal.git
docs/submodules/sdc.git
docs/submodules/sdc/jtosca.git
docs/submodules/sdc/sdc-tosca.git
docs/submodules/sdnc/oam.git
docs/submodules/so.git
docs/submodules/so/libs.git
docs/submodules/usecase-ui.git
docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git
docs/submodules/vfc/nfvo/lcm.git
docs/submodules/vid.git
docs/submodules/vnfrqts/requirements.git
docs/submodules/vvp/documentation.git
docs/validwords.txt

index 44d1227..f0beb77 100644 (file)
        url = ../ccsdk/features
        branch = .
        ignore = dirty
+[submodule "docs/submodules/policy/parent.git"]
+       path = docs/submodules/policy/parent.git
+       url = ../policy/parent
diff --git a/docs/guides/onap-developer/architecture/media/ONAP-bbs.png b/docs/guides/onap-developer/architecture/media/ONAP-bbs.png
new file mode 100644 (file)
index 0000000..4996a06
Binary files /dev/null and b/docs/guides/onap-developer/architecture/media/ONAP-bbs.png differ
index 21ef5fd..35156b2 100644 (file)
@@ -634,6 +634,33 @@ Policy.
 
 Read the vFW/vDNS with ONAP blueprint to learn more.
 
+BBS (Broadband Service) Blueprint
+---------------------------------
+
+The Broadband Service blueprint uses ONAP for the design, provisioning, life-cycle management and
+assurance of fixed broadband access services. In a first step, BBS blueprint works with multi-Gigabit
+Internet Connectivity services based on PON (Passive Optical Network access technology, and relies
+on the orchestration and automation capabilities provided by the ONAP platform to support new
+scenarios, such as the Nomadic ONT (see Figure 8).
+
+|image8|
+
+**Figure 8. ONAP BBS Nomadic ONT Architecture**
+
+This blueprint shows the extensibility of the ONAP platform in supporting the orchestration of
+services across different location (e.g., Central Office, Core) and technology domains (e.g.,
+Access, Edge).
+
+In a joint collaboration with BBF (Broadband Forum) members, BBS implements and tests some of the
+specifications defined in the architectural framework of CloudCO (Cloud Central Office), Technical
+Report TR-384, among others. CloudCO aims at re-architecting the broadband network using SDN and NFV
+technologies and a cloud-like infrastructure deployed at Central Offices.
+
+The definition of External API capabilities supporting this use case also relies on TM Forum
+OpenAPIs and MEF LSO.
+
+BBS uses the following ONAP key components: ExternalAPI, SDC, SO, SDN-C, APEX policy engine and
+DCAE.
 
 .. |image1| image:: media/ONAP-toplevel.png
    :width: 6.5in
@@ -656,3 +683,5 @@ Read the vFW/vDNS with ONAP blueprint to learn more.
 .. |image7| image:: media/ONAP-ccvpn.png
    :width: 6.5in
    :height: 3.02431in
+.. |image8| image:: media/ONAP-bbs.png
+   :width: 6.5in
index d5e2099..9d3a7f6 100644 (file)
@@ -16,7 +16,8 @@ The API should be described using OpenAPI specifications and available as a
 A Swagger editor is available here `<http://editor.swagger.io/>`_ to generate
 such JSON files.
 
-As a result, you should get one JSON file per API:
+As a result, you should get one JSON file per API. For example the project
+**my** has 2 API: **myAPI1** and **myAPI2**.
 
 - myAPI1.json
 - myAPI2.json
@@ -35,17 +36,28 @@ We propose the following table:
    "myAPI1", ":download:`link <myAPI1.json>`"
    "myAPI12", ":download:`link <myAPI2.json>`"
 
+.. note::
+   During documentation merge/publish at RTD, any file referenced in an RST file with
+   ':download:' and relative path to a contributing project repository is copied, uniquely
+   named, and published with the generated HTML pages.
 
 The code is available here:
 
 .. code:: rst
 
-   ..csv-table::
-     :header: "API name", "Swagger JSON"
-     :widths: 10,5
+   .. csv-table::
+      :header: "API name", "Swagger JSON"
+      :widths: 10,5
 
-     "myAPI1", ":download:`link <myAPI1.json>`"
-     "myAPI2", ":download:`link <myAPI2.json>`"
+      "myAPI1", ":download:`link <myAPI1.json>`"
+      "myAPI2", ":download:`link <myAPI2.json>`"
+
+.. note::
+   The syntax of <myAPI1.json> is to be taken literally. Keep '<' and '>'.
+
+.. note::
+   Note the “v” in  swaggerv2doc!
+   If your JSON file has multiple endpoints, this directive does not preserve the order.
 
 API Swagger
 -----------
index 3d5253a..2e294d2 100644 (file)
@@ -21,6 +21,8 @@ NodePort,Component,Service name,targetPort,Port
 30219,POLICY,pap-8443,8443,8443
 30220,AAI,aai-sparky-be,9517,9517
 30221,POLICY,drools-9696,9696,9696
+30222,DCAE,xdcae-hv-ves-collector,6061,6061
+30223,DCAE,xdcae-datafile-collector,8100,8100
 30224,SO,so-monitor-port,9091,9091
 30225,PORTAL,portal-app4,8443,8443
 30226,DMAAP,message-router-3905,3905,3905
@@ -32,6 +34,7 @@ NodePort,Component,Service name,targetPort,Port
 30232,AAI,aai,8080,8080
 30233,AAI,aai-ssl,8443,8443
 30234,POMBA,pomba-kibana,5601,5601
+30235,DCAE,xdcae-ves-collector,8080,8080
 30236,POLICY,nexus,8081,8081
 30237,POLICY,policy-apex-pdp,12345,12345
 30238,VID,vid-http,8080,8080
@@ -55,6 +58,7 @@ NodePort,Component,Service name,targetPort,Port
 30259,DMAAP,dmaap-dr-prov,8080,8080
 30260,CLI,cli8080,80,80
 30261,MULTICLOUD,multicloud-azure,9008,9008
+30262,DCAE,xdcae-datafile-collector,8433,8443
 30263,DCAE,dcae-fe,8183,8183
 30264,DCAE,dcae-fe2,9444,9444
 30265,DCAE,dcae-dt,8186,8186
@@ -91,3 +95,6 @@ NodePort,Component,Service name,targetPort,Port
 30399,UUI,uui-server,8082,8082
 30420,CONTRIB,netbox-nginx,8080,8080
 30476,DCAE,tomcat,8080,8080
+32010,DCAE,xdcae-tca-analytics,11011,11011
+
+
diff --git a/docs/guides/onap-user/resource-onboarding/index.rst b/docs/guides/onap-user/resource-onboarding/index.rst
new file mode 100644 (file)
index 0000000..4a3cbc1
--- /dev/null
@@ -0,0 +1,250 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2019 ONAP Contributors. All rights reserved.
+
+Resource Onboarding
+===================
+**Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC.
+
+**Tool:** SDC
+
+**SDC user role:** Designer
+
+|image0|
+
+**Steps**
+    * `Create a License Model`_
+    * `Create a License Key Group [Optional]`_
+    * `Create an Entitlement Pool`_
+    * `Create a Feature Group`_
+    * `Create a License Agreement`_
+    * `Create a Vendor Software Product`_
+    * `Update VFCs in a VSP [optional]`_
+    * `Update a VSP [optional]`_
+
+After updating the artifacts in a VSP, also update:
+    * the VF created from the VSP
+    * any services that include the VF
+
+|image1|
+
+Create a License Model
+----------------------
+
+VSPs optionally require a license and entitlements to enable the service provider to track the usage.
+
+Note: For interim saving while creating the license model and its components, click |image2|
+
+**Prerequisites:** To obtain license information, contact the service provider's Supply Chain Management (SCM) group.
+
+|image3|
+
+#. From the SDC HOME page, click *ONBOARD*.
+#. Hover over Add and select New License Model.
+#. Complete all fields.
+#. Click *Save*.
+#. In the ONBOARD header, hover over the arrow after License Agreements to reveal a menu.
+   Select the following options in order:
+
+   #. Create 0 or more license key groups (see `Create a License Key Group [Optional]`_).
+   #. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_).
+   #. Create 1 or more feature groups (see `Create a Feature Group`_).
+   #. Create 1 or more license agreements (see `Create a License Agreement`_).
+
+      Note: Perform all steps above before submitting the license model to the SDC catalog.
+
+#. In the header, click the license model created in steps 1 to 4.
+#. Click *Check In* to save changes.
+#. Click *Submit* to add the license model to the catalog. A success message displays.
+#. After creating a license, complete `Create a Vendor Software Product`_ to add the VSP required for the associated VF.
+
+Create a License Key Group [Optional]
+-------------------------------------
+
+If required by the resource model, create one or more license key groups; otherwise the license key group is optional.
+
+**Prerequisites:** `Create a License Model`_
+
+|image4|
+
+1. From the drop-down menu, select License Key Groups.
+2. Click *Add License Key Group*.
+    The Create New License Key Group box displays.
+3. Complete all fields.
+    Note: Enter the manufacturer reference number in the Name field.
+4. Click *Save*.
+
+Create an Entitlement Pool
+--------------------------
+
+**Prerequisites:** If required by the resource model, create one or more license key groups (see `Create a License Key Group [Optional]`_).
+
+|image5|
+
+1. From the drop-down menu, select Entitlement Pools.
+2. Click *Add Entitlement Pool*.
+    The Create New Entitlement Pool box displays.
+3. Complete required fields (mandatory fields are marked by a red asterisk).
+4. Click *Save*.
+
+Create a Feature Group
+----------------------
+
+**Prerequisites:** Create one or more:
+
+* license key groups if required by the resource model (see `Create a License Key Group [optional]`_)
+* entitlement pools (see `Create an Entitlement Pool`_)
+
+|image6|
+
+1. From the drop-down menu, select Feature Groups.
+2. Click *Add Feature Group*.
+    The Create New Feature Group box displays.
+3. On the General tab, complete all fields.
+4. Click *Entitlement Pools*.
+5. Click *Available Entitlement Pools*.
+6. Select one or more entitlement pools and click the right arrow.
+7. Click *License Key Groups*.
+8. Click *Available License Key Groups*.
+9. Select one or more license key groups and click the right arrow.
+10. Click *Save*.
+
+Create a License Agreement
+--------------------------
+
+**Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_).
+
+|image7|
+
+1. From the drop-down menu, select License Agreements.
+2. Click *Add License Agreement*.
+    The Create New License Agreement box displays.
+3. On the General tab, complete required fields (mandatory fields are marked by a red asterisk).
+4. Click *Feature Groups*.
+5. If not selected, click *Available Feature Groups*.
+6. Select one or more groups and click the right arrow.
+7. Click *Save*.
+8. Return to step 5 of `Create a License Model`_ to complete the license model.
+
+Create a Vendor Software Product
+--------------------------------
+
+Create one or more Vendor Software Products (VSPs) as the building blocks for VFs.
+
+.. note::
+   For interim saving while creating a VSP, click |image2|
+
+**Prerequisites:**
+
+* `Create a License Model`_
+* Generate manifest and package artifacts.
+
+#. From the SDC HOME page, click *ONBOARD*.
+#. Hover over Add and select New Vendor Software Product.
+#. The New Software Product box is displayed.
+    Complete all fields.
+#. Click *Save*.
+    The Overview section is displayed.
+
+   .. note::
+     A warning is displayed under License Agreement if the VSP does not have an associated license.
+
+#. Click *Software Product Details* (left pane).
+
+   |image8|
+
+#. In order, select a licensing version, a license agreement, and one or more feature groups.
+#. [Optional] Complete other fields, such as Availability (high-availability zones) and Storage
+   Data Replication (requirement for storage replication), as required.
+#. In Software Product Attachments (right pane), click *Select file*.
+#. Locate a Heat .zip package and click *Open*.
+   SDC validates the files in the package. After successful validation, SDC displays the files
+   and a success message. If validation fails, SDC displays the errors in the files.
+
+   Example Heat errors:
+
+   |image9|
+
+#. Click *Check In* to save the changes.
+#. Click *Submit* to add the VSP to the catalog.
+#. A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit.
+#. To configure VFCs associated with the VSP, see `Update VFCs in a VSP [optional]`_, below.
+
+
+Update VFCs in a VSP [optional]
+-------------------------------
+
+If required, configure Virtual Function Components (VFCs) associated with a VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed on the Components tab.
+
+.. note::
+  All fields are optional. Answers to questionnaires are stored as metadata only on the SDC platform.
+
+**Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_).
+
+#. From the SDC HOME page, click *ONBOARD* and search for a VSP.
+#. In the Overview section, click *Check Out*.
+#. In Components (bottom pane), click a VFC (VSP component).
+    The component links display in the left pane.
+#. Click *General* to view and edit general parameters such as hypervisor, image format, VM recovery details, and DNS configuration.
+#. Click *Compute* to view and edit VM parameters such as the number of VMs required for a VFC instance and persistent storage/volume size.
+#. Click *High Availability & Load Balancing* to answer questions related to VM availability and load balancing.
+#. Click *Networks* to view or edit parameters related to network capacity and interfaces.
+
+   .. note::
+     Click an interface to view or edit it. A dialog box displays similar to the figure below.
+
+   |image10|
+
+#. Click *Storage* to configure storage information, such as backup type, storage size, and logging.
+#. Click *Process Details*, click *Add Component Process Details*, and complete the Create New Process Details dialog box. Use Process Details to identify the processes and configuration associated with VFCs.
+#. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
+#. Click *Overview* and click *Check In* to save changes.
+#. If updating a VSP, click *Submit*. If this procedure is performed during the workflow to create a VSP, there is no need to click *Submit* now.
+
+Update a VSP [optional]
+-----------------------
+
+Upload a new Heat package to a VSP. Afterward, update the VF and service.
+
+**Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_).
+
+#. From the SDC HOME page, click *ONBOARD* and search for a VSP.
+#. In the Overview section, click *Check Out*.
+#. In Software Product Attachments (right pane), click *Select file*.
+#. Locate a Heat .zip package and click *Open*.
+    SDC warns that uploading a new package erases existing data.
+#. Click *Continue* to upload the new Heat package.
+    SDC validates the files in the package. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files.
+
+   .. note::
+     If the Heat template contains errors, contact the Certification Group for guidance on how to proceed.
+
+#. Click *Check In* to save changes.
+#. Click *Submit* to add the VSP to the catalog.
+    A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit.
+#. After updating the VSP:
+   #. Upload the VSP to the VF (see steps 3 to 5 in (TBD)Update a VF [optional]).
+   #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]).
+
+
+.. |image0| image:: media/sdro-resource-onboarding-workflow.png
+
+.. |image1| image:: media/sdro-vsp-service-workflow.png
+
+.. |image2| image:: media/sdro-sdc_vsp_save.png
+
+.. |image3| image:: media/sdro-license-creation.png
+
+.. |image4| image:: media/sdro-license-keygroup.png
+
+.. |image5| image:: media/sdro-entitlement-pool.png
+
+.. |image6| image:: media/sdro-feature-group.png
+
+.. |image7| image:: media/sdro-license-agreement.png
+
+.. |image8| image:: media/sdro-software-product.png
+
+.. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
+
+.. |image10| image:: media/sdro-edit-nic.png
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png b/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png
new file mode 100644 (file)
index 0000000..27c8986
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png b/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png
new file mode 100644 (file)
index 0000000..94a6743
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png b/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png
new file mode 100644 (file)
index 0000000..2db64c4
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png
new file mode 100644 (file)
index 0000000..20fee24
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png b/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png
new file mode 100644 (file)
index 0000000..9f4f1b4
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png
new file mode 100644 (file)
index 0000000..ef99406
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png
new file mode 100644 (file)
index 0000000..a358d03
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png
new file mode 100644 (file)
index 0000000..c8f2934
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png
new file mode 100644 (file)
index 0000000..dcc3104
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png b/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png
new file mode 100644 (file)
index 0000000..81f1df6
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png b/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png
new file mode 100644 (file)
index 0000000..457baa8
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png differ
diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png
new file mode 100644 (file)
index 0000000..5a5ad94
Binary files /dev/null and b/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png differ
diff --git a/docs/guides/onap-user/service-distribution/index.rst b/docs/guides/onap-user/service-distribution/index.rst
new file mode 100644 (file)
index 0000000..4ed2310
--- /dev/null
@@ -0,0 +1,135 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2019 ONAP Contributors.  All rights reserved.
+
+Governance Approval and Service Distribution
+============================================
+
+Each ONAP platform operator will have a specific set of policies
+and procedures for approving Services and deploying them in the
+operator's ONAP environment. This outline describes the general
+flow of such procedures.
+
+**Goal:** Add all information required to create, instantiate, and
+manage a service.
+
+**Tools:** SDC
+
+**SDC user roles:** Governor, Ops
+
+Steps
+-----
+
+- `Review a Service for Governance Approval`_
+- `Request Service Distribution`_
+- `Distribute a Service`_
+- `Verify that the DCAE Blueprint is Deployed`_
+
+|image1|
+
+**Figure 1. Workflow**
+
+Review a Service for Governance Approval
+----------------------------------------
+
+A member of the Governance Board performs a governance review of a
+certified service and its associated VFs, and then approves (or rejects)
+the artifacts for distribution.
+
+**Prerequisites:** Service is tested.
+
+**Steps**
+
+#. Sign in to SDC as a Governor.
+#. From the HOME page, click CATALOG and select a service that is ready
+   for governance review.
+#. Review the service and its associated resources.
+#. To view deployment artifacts:
+
+   #. Click *Composition* tab (left pane) and then click the Deployment
+      Artifact icon (right pane) to see the list of artifacts.
+   #. Click the download icon adjacent to an artifact to download and
+      view it.
+
+#. When the review is complete, click:
+
+   -  *Accept* if the service passes the governance review. The service is
+      marked Approved for Distribution.
+   -  *Reject* if the service fails the governance review. The service is
+      marked Rejected for Distribution.
+
+After a service receives governance approval, it moves into the Waiting
+to be Distributed section of the Operations Workspace (Ops role)
+
+Request Service Distribution
+----------------------------
+
+Request service distribution to populate all appropriate ONAP
+components with the resources and artifacts ssociated with the service and its
+VFs.
+
+**Prerequisites:**
+
+A service has received governance approval and is
+available in the Waiting to be Distributed section of the SDC Operations
+Workspace (under the Ops Role). For more information, see
+`Review a Service for Governance Approval`_.
+
+The steps shown here are generic; each service provider has a different,
+specific set of instructions. Contact your site IT support for the
+particulars.
+
+**Steps**
+
+#. Open at ticket request at your site
+#. Make a "DISTRIBUTION REQUEST"
+#. Provide the following information in your request:
+
+   -  Environment
+   -  Name of service to be distributed
+   -  Version number
+   -  [Optional] Additional information or instructions (provide special
+      instructions for the request)
+   -  Your user ID
+   -  [Optional] Alternate Contact user ID (provide an alternate contact
+      if the primary contact is unavailable)
+
+Distribute a Service
+--------------------
+
+**Prerequisites:** The service is approved.
+
+**Steps**
+
+
+#. Sign in to SDC as Ops.
+#. In the Active Projects pane (left pane) of the HOME page, select the
+   W*aiting For Distribution* check box.
+#. Select a service that is ready for distribution.
+#. Review the version history to verify that the correct version is
+   selected.
+#. In the header, click *Distribute*.
+
+   The service moves from the Ready For Distribution folder to the
+   Distributed Services folder.
+
+#. From the Workspace pane, click *Distributed Services*.
+   All distributed services display.
+#. Select the service distributed in step 5 and click *Monitor*.
+   The Distribution Report displays.
+#. In the Distribution Report, navigate to the Component ID for the
+   service and click the adjacent down arrow.
+   The report shows all components associated with the service and their
+   distribution statuses, such as DOWNLOAD_OK.
+#. Review the status of each component.
+
+Verify that the DCAE Blueprint is Deployed
+------------------------------------------
+
+The DCAE controller requires a blueprint (or guideline) to be available
+at the site on which the first VNF is deployed. This blueprint is a
+management workflow and configuration description for a given VNF, and
+it must be available after completing the service distribution process
+and before beginning the instantiation process.
+
+.. |image1| image:: media/design_governance_workflow.png
diff --git a/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png b/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png
new file mode 100644 (file)
index 0000000..44d6b70
Binary files /dev/null and b/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png differ
index 823fccd..560cbf4 100644 (file)
@@ -2,6 +2,8 @@
 .. International License. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. _user-guides-service-design:
+
 Service Design
 ==============
 The goal of the service design process is to create all artifacts
@@ -22,7 +24,11 @@ Design includes the following topics:
 
 * `Pre-Onboarding <https://wiki.onap.org/x/Y4AP>`_
 
-* `Resource Onboarding <https://wiki.onap.org/x/YIAP>`_
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Resourse-Onboarding <./resource-onboarding/index.rst>
 
 * `VF Creation and Testing <https://wiki.onap.org/x/PoAP>`_
 
index 9871c8f..c7e4cd8 100644 (file)
@@ -91,3 +91,4 @@ Project/Components
    cds <../submodules/ccsdk/cds.git/docs/index>
    oom/offline-installer <../submodules/oom/offline-installer.git/docs/index>
    ccsdk/features <../submodules/ccsdk/features.git/docs/index>
+   parent <../submodules/parent.git/docs/index>
index 22d821e..096803c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 22d821ef35b5ddaf76937ab6a4fe82b088a50a26
+Subproject commit 096803ce0a8f4a57cc2f78f7d969cab18cb7a93e
index 0f19fd0..38a4d51 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 0f19fd0521a0e70ec82fc1676d03546ff4dad8a7
+Subproject commit 38a4d515a8414e83a3724bccbb5ab83cd50d7df9
index 569eaa5..6ab49d0 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 569eaa5163b07d153c9b76195ecfd586bc84d7a7
+Subproject commit 6ab49d0f6bedcbc2ccd817df113265d32f421414
index 6c64ce6..c6e85bc 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 6c64ce6d8be0d03ddc9d940cc5caeb7000b1f390
+Subproject commit c6e85bc88f2dd3427360523270c7ed92c12abdc6
index 6aabe34..338c218 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 6aabe34a66cfc4eca0152a873161461322f1adb4
+Subproject commit 338c218458d6a671dd754ee5c151517685376bd9
index 34605c9..26fc3d0 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 34605c95ea7a9af4c4b86a4b5dee81a40d60686f
+Subproject commit 26fc3d01a9be64e10cbeb814559fd98fefbd7ba7
index 09dab76..701110b 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 09dab76658142089c222c7ce200cfbbf378080a2
+Subproject commit 701110ba1719151a20393ced327e4e935d991ad9
index a433b64..0494603 160000 (submodule)
@@ -1 +1 @@
-Subproject commit a433b642cff989aabc4c3f918daaa90377a92453
+Subproject commit 0494603a4624d391af8b5a3918555ea7e47ffa10
index 1c11ab8..bceb18d 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 1c11ab87dd4954903734c8a95a17a56aefea4758
+Subproject commit bceb18df30982e2ace538baf5c49336fe0e45b0a
index e43ce2a..40e1e60 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e43ce2a29d9060da4d7fcea985334a49033c2bdb
+Subproject commit 40e1e60eb8d8cc18d8542dbd7c00f69a9cc3042d
index 8d0511c..c041513 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 8d0511c6da410c29637d11b18e04873eb7539dd4
+Subproject commit c0415134c3d9bfd028fb2bd98291a95d39dcab16
index ff5433e..0095af5 160000 (submodule)
@@ -1 +1 @@
-Subproject commit ff5433e350678f5f45e8b2aa14cdb00f9cecfceb
+Subproject commit 0095af54a51619546e6ab9783adff625b696f4e0
index 7e8d80c..691870a 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 7e8d80c1c033b636c5816fd5e67c661d7ef0a2b8
+Subproject commit 691870a10f5401c9561fbe1494294d5191889410
index d296bb5..e50f6e8 160000 (submodule)
@@ -1 +1 @@
-Subproject commit d296bb5ab9332c53572af7f479f3501fa964d846
+Subproject commit e50f6e8abddad4e2ad7fa83f32ab55af184d951c
index bce23ab..6eaaedc 160000 (submodule)
@@ -1 +1 @@
-Subproject commit bce23ab2e95908624a11e21c8751d7791e15c4ef
+Subproject commit 6eaaedc4d320b4e032beb958123ee00f5cf9a7a1
index 4c4d74a..4c9735f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 4c4d74aefb57554a8353e47a039f8351d13af326
+Subproject commit 4c9735f80c983573c08c708307e1d03c84140d6a
index 658602b..2fbd078 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 658602b4808bd093b75adb6a151982a7b44c7f0a
+Subproject commit 2fbd078605c199e49118037747325e833318ef51
index e8697fa..388ef1f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e8697face7909927a9ddb418f116c76e3c6d8c8f
+Subproject commit 388ef1f2943d5fb581cd6533e1fc225a0309df7f
index bf49d55..63933b0 160000 (submodule)
@@ -1 +1 @@
-Subproject commit bf49d552b003072c6bc64ae838a4699c1f4028bd
+Subproject commit 63933b0cf304cfdd49fc73278d9c64dcb48f90eb
index e6cf974..906595f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e6cf974c4eedc0adf006d7a543ebf4833918b28f
+Subproject commit 906595fd0986f3be0733116edb312a5d7aa4547d
index 45fa003..cb94aef 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 45fa0030abb4c013722f68c1ef23d53ba1d1620e
+Subproject commit cb94aefb4ef22fdf435578e676823a6b9600cbb9
index 58871ba..d4014ab 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 58871ba77f801f4794fed5573feefc3004cc55e9
+Subproject commit d4014abb85d839c14c9a2572098571e7a8523104
index 2ee99cb..d6be402 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 2ee99cbaf0c827ecb02b9c11061750aa675044c5
+Subproject commit d6be402c0765aee388bc5dc64882696a0a23be22
index e1f6d80..0a358ab 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e1f6d80752920a7ef990134f02abb3db9b5a6232
+Subproject commit 0a358ab8f3f546f11c36f913018edef63ff17ed3
index e5f139e..f6da9a3 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e5f139e3c865eb429dc11a987ad7a01b759c6692
+Subproject commit f6da9a3bafb6f4c30e7bb3accd4e17fdaaf5ce92
index e0936d1..39bac7e 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e0936d1bf5b7241eb1543c762b86bf72951870b3
+Subproject commit 39bac7ed034c56eeb2b19a1b274fab35dbc9818f
index 070d3f1..b38e59b 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 070d3f11f482486d89f426a141652b281e067647
+Subproject commit b38e59b1f797b15d0a3e1170e43a0db92216bbd0
diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git
new file mode 160000 (submodule)
index 0000000..541f83b
--- /dev/null
@@ -0,0 +1 @@
+Subproject commit 541f83b8b97f1d3c33401e1cbe9436aa31d7fa76
index 9c152c3..b04f71d 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 9c152c3c93793fb15e7ba9a311de4f3974f712fb
+Subproject commit b04f71de6f585687eb81333ab1fd909df0d8b71f
index 8fa77ad..50552ec 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 8fa77ad4d4c2498e40a4c23e6826d9ad73a1dab8
+Subproject commit 50552ece388dc60d15ed743f06afc477635f7218
index e85cec5..a024458 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e85cec5f2344bbb802ad5ce8085efa9e34d9eaf1
+Subproject commit a0244589b50f80bc510b5d8dd4df02bb5870056e
index e4e4b6f..9c48804 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e4e4b6f8db3d1fade4648cb7ef220759c5b7f2cf
+Subproject commit 9c48804399cb73b135b3f1c7a321b225635caf2c
index 15c6cfe..570153b 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 15c6cfe1990346af373968693fd7c568003bea11
+Subproject commit 570153b334e64246b2eff459d18d6eac6df70e22
index 06602f5..71e617b 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 06602f553f5e6f4edb1ef342973e7132f04ca812
+Subproject commit 71e617b9e2fcd24c05579bf41e65db4273f05e77
index 93f4809..25990a8 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 93f480949c9b0babd4f10d7b0e47f5c23b9b6b88
+Subproject commit 25990a8c079094f906414c4583ec7b0dd81b4d37
index 1d42259..8aff6d8 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 1d4225938f4975fa49d8ed8718f878f682d9b2bd
+Subproject commit 8aff6d8cbc022cbe4db09cabe096f463aa98b00d
index 336380c..1b4498e 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 336380c8decaeb14a3cf6e3a3e19f646437fd997
+Subproject commit 1b4498ef13c935ff94e7d4520bd3dbd0fe71ee81
index 46901da..22631f1 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 46901da51522e44fbac7290e28d72945b5ce47e1
+Subproject commit 22631f12c6029a38be6cb3acdc21e6f8f6400f6c
index 51a12b9..f3b31fe 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 51a12b964a2c5dbfc7df7ee5fb7604af41e3c6b7
+Subproject commit f3b31fe846630953923844ed3ab7defea9ac4447
index a0c6ca7..3422870 160000 (submodule)
@@ -1 +1 @@
-Subproject commit a0c6ca75f1ce52556a89ae21d8491c64107af636
+Subproject commit 3422870a179cdeed4df9631faa08357d28da5c7a
index 1294147..2561254 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 129414776cc0c131d082a15e442f2b642a61683f
+Subproject commit 2561254e2a48bda836f1d42d31660bf6add621ab
index ea1daa9..c860d4a 100644 (file)
@@ -126,7 +126,7 @@ javascript
 Javascript
 jboss
 JBoss
-Jenkin
+Jenkins
 Jira
 jpath
 json
@@ -297,7 +297,7 @@ SDN
 sdnc
 Sdnc
 SDNC
-Seleniunm
+Selenium
 servlet
 Servlet
 Skynet