diff options
Diffstat (limited to 'docs')
24 files changed, 37 insertions, 19 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 5a72e88c4..a1db2b3d8 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -30,11 +30,11 @@ Platform Components :titlesonly: APPC - Application Controller <../../../submodules/appc.git/docs/index.rst> - DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst> + DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst> Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst> Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst> - SDNC - SDN Controller <../../../submodules/sdnc/northbound.git/docs/offeredapis.rst> - SO - Service Orchestrator <../../../submodules/so.git/docs/offered_consumed_apis.rst> + SDNC - Software Defined Network Controller <../../../submodules/sdnc/northbound.git/docs/offeredapis.rst> + SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst> VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst> Common Services @@ -44,9 +44,17 @@ Common Services :maxdepth: 1 :titlesonly: - AAF - Application Authorization Framework <../../../submodules/aaf/authz.git/docs/AAF-API-Documentation/AAF-API-Documentation.rst> AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst> - DMaaP - Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/message-router/message-router.rst> + DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/message-router/message-router.rst> Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst> - MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> - Multi VIM/Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst> + MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> + MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst> + +SDK +--- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/vnfsdk-apis.rst> diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index c3f028c33..ed20d98c2 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -14,15 +14,15 @@ **Context** =========== -ONAP may be deployed in different contexts depending on the service provider requirements. The official installation for Amsterdam Release is currenly based on OpenStack. +ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currenly based on OpenStack. -Using the Amsterdam Release installer, ONAP components may be deployed in a single tenant or can be distributed in various tenants: one for all the components except the DCAE one and another tenant dedicated to the DCAE components. +Using the Amsterdam Release installer, ONAP components may be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components. -The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of Vmware based infrastructure (cf MultiCloud project). +The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure (cf MultiCloud project). Figure 1 -The current installation is based on the mono-tenant deployment (all the ONAP components will be hosted in a unique tenant) +The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) **Requirements** @@ -62,7 +62,7 @@ Note that floating IP may be private IP. Security -------- The default installation assumes that the Default security group is configured to enable full access between the ONAP components. -Depending on your environment, we may be forced to open some security groups (eg when using the portal from your desktop) +Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop) The following YAML file presents the ports exposed by the various components: @@ -81,14 +81,14 @@ TODO Provide a command to create the security groups Instantiation ------------- -- To deploy ONAP, use the Heat template and follow the described in integration project. +- To deploy ONAP, use the Heat template and follow the described guidelines in integration project. -- The Heat template deployment may take time (up to one hour) depending on your hardware envionment. +- The Heat template deployment may take time (up to one hour) depending on your hardware environment. Test the installation --------------------- -Every ONAP component offers a HealthCheck REST API. The *Robot Virtual Machine* can be used to test that every -Run the following command to +Every ONAP component offers a HealthCheck REST API. The *Robot Virtual Machine* can be used to test that every components run smoothly. +Run the following command to perform the HealthCheck: .. code-block:: bash @@ -100,8 +100,11 @@ Detect problems --------------- If all the tests are not OK, many causes are possible. Here is a simple procedure to detect where the problem occurs: -- Check the OpenStack Virtual Machine logs -- Connect to Virtual Machine and check that the various containers are runnings. The list of containers aer described in the foloqing section. Is some containers are missing, check the docker logs using the following command: + +* Check the OpenStack Virtual Machine logs +* Connect to the Virtual Machine and check that the various containers are runnings. + +The list of containers are described in the following section. In case some containers are missing, check the docker logs using the following command: .. code-block:: bash @@ -112,7 +115,7 @@ Here is a simple procedure to detect where the problem occurs: **Portal configuration** ======================== The current ONAP installation is using the onap.org domain. -To use the portal on your desktop, you must configure the following information in your *host* file (located in /etc/host for Linux or /windows/system32/drivers/etc/hosts for Windows: +To use the portal on your desktop, you must configure the following information in your *host* file (located in /etc/host for Linux or /windows/system32/drivers/etc/hosts for Windows): .. code-block:: bash diff --git a/docs/release/index.rst b/docs/release/index.rst index 8518a7138..8ef20ea0e 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -64,6 +64,13 @@ License How to Report a Bug +++++++++++++++++++ +There are 2 ways to report a bug in ONAP. + +In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_. + +If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org . + +You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list. Download and Use diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git -Subproject 5cfca4245fee3ed0cef854a3028651e2f57bcc5 +Subproject 722f59e75b5e8d6b2f7ade57c00db8c4b9e7507 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject c0101f1b7e98bd39d3b6ba16b7baacb57a4b0e8 +Subproject ea8c76cca7dbc83aff1c73d1b7bf4b00597e42a diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 0b150e19f3a6812fa2973a28048123fd5601f2f +Subproject 12bc08602be497c4cd3b49328a042d28663f9f4 diff --git a/docs/submodules/ccsdk/sli/northbound.git b/docs/submodules/ccsdk/sli/northbound.git -Subproject 2f9282706b2eaca0c271d6da27b3dbc0692accc +Subproject 292cce64a1a610283306a5f2280c787d8edb916 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 06a84f0bc392a6a2845f7512d45af17d86f1d83 +Subproject f2650c8b133ff9569994eed1c6edc88af981d84 diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject 9fd6717a47ffacf5f40447172140521717b3a6f +Subproject 59c0e4f513607e8363b9c9133a5043475d750a9 diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject 0cd31c398821790857c9f4862df35f684eab52f +Subproject ea08755cd8354a8fe6f30a2797cb5bb3ccb63da diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject a3f31bda90356231bd3656da55f00261d6e1cae +Subproject 39a2f2f7910a0d86163ad23fe91c2a11e98ece0 diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject c3ff84a6cc007b8f8aaf98531ee06e8bda199cc +Subproject d650571280c041e0602dd93ff407dd16092a320 diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git -Subproject 84f80b1dcc9a3fabbbe39384e53b8dc9d9f5081 +Subproject ddf80e22433f6e5d49923fd1523ca49369a2f58 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 8a1085087f4a7f117d597d8fa46718899111d54 +Subproject 0cfd9d031bf80a39e6677291b3a407eefc40001 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject c5123229d9631aaf504a420be456ce2578fc894 +Subproject c2c4d76e70b24e9702419864d0ec422eddfae8d diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 15aad8c0f7a7bd5a77898fffc7e98b7d7e8a55d +Subproject 8169b8491fb2512e78764cf3f3b1e2f1ad4a2fb diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 66c1d3145ea007362a6e885bfefc15d99596b4e +Subproject ce889adae3f91a8296bf41ce5804a51483242b2 diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git -Subproject 250bec44553d15dc5dd3772340e2bb18ec004ae +Subproject 29660c673b5a54ea93238cdd94c14f8ee7c7d8c diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject ca2f8ad39af9591a98212a1a1ba77490594e2a1 +Subproject 5afd798760522289162f0681b8dcc09280cb4b4 diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 7131f923020c859da684d16d8af276e17bcec1c +Subproject 104aefb5d0fce75ee5c5ec4f4de1a6954925b5b diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject c78f7ec2de9f0339622a009b32e016f7f3222d0 +Subproject 7cf4fbbe3644624dd5a8c640ab6041ab6a734e3 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 6c6979f0eaab440408c2e1cf9bc27c1996d83bf +Subproject 66e8f0b03e23b28ddefb2d678666ab5f4a813eb diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject 6d223e9f110391e69e09aa733901e85db22dd98 +Subproject 8f612e9dc8b0cccffa5a3629430c61101030aa8 diff --git a/docs/submodules/vnfsdk/model.git b/docs/submodules/vnfsdk/model.git -Subproject 78123d36ca3583fa9ba204cda9724016df63ba6 +Subproject a3adf07306490e9d0e88229c165630124376c86 |