diff options
| -rw-r--r-- | .gitignore | 4 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 16 | ||||
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 38 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/components.rst | 13 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/fullonap.rst | 162 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/index.rst | 173 | ||||
| -rw-r--r-- | docs/guides/onap-developer/tutorials/index.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-developer/tutorials/platform/index.rst | 8 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 194 |
9 files changed, 395 insertions, 215 deletions
diff --git a/.gitignore b/.gitignore index 7e6c5ab69..c7f23bb18 100644 --- a/.gitignore +++ b/.gitignore @@ -30,6 +30,10 @@ wheels/ *.manifest *.spec +# aspell +*.new +*.bak + # Installer logs pip-log.txt pip-delete-this-directory.txt diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index 2bd569009..b152795c4 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -92,22 +92,24 @@ SDKs :maxdepth: 1 :titlesonly: - ../../../submodules/ccsdk/dashboard.git/docs/architecture.rst ../../../submodules/ccsdk/distribution.git/docs/architecture.rst - ../../../submodules/ccsdk/parent.git/docs/architecture.rst + ../../../submodules/ccsdk/dashboard.git/docs/architecture.rst ../../../submodules/ccsdk/platform/blueprints.git/docs/architecture.rst ../../../submodules/ccsdk/platform/nbapi.git/docs/architecture.rst - ../../../submodules/ccsdk/platform/plugins.git/docs/architecture.rst - CCSDK SLI Adaptors <../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst> - CCSDK SLI Service Logic Intrepreter <../../../submodules/ccsdk/sli/core.git/docs/architecture.rst> - CCSDK SLI Northbound Interface <../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst> - CCSDK SLI Plugins <../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst> ../../../submodules/ccsdk/storage/esaas.git/docs/architecture.rst ../../../submodules/ccsdk/storage/pgaas.git/docs/architecture.rst ../../../submodules/ccsdk/utils.git/docs/architecture.rst Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst> ../../../submodules/vnfsdk/model.git/docs/architecture.rst +.. CCSDK documentation consolidated under the above distribution repo + ../../../submodules/ccsdk/platform/plugins.git/docs/architecture.rst + ../../../submodules/ccsdk/parent.git/docs/architecture.rst + CCSDK SLI Adaptors <../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst> + CCSDK SLI Service Logic Intrepreter <../../../submodules/ccsdk/sli/core.git/docs/architecture.rst> + CCSDK SLI Northbound Interface <../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst> + CCSDK SLI Plugins <../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst> + Other ----- diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index ec7ecaccb..d78f3f8fd 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -49,19 +49,19 @@ Common Controller Software Development Kit ../../../submodules/ccsdk/distribution.git/docs/index ../../../submodules/ccsdk/dashboard.git/docs/index - ../../../submodules/ccsdk/platform/plugins.git/docs/index -.. Empty Folders for Release - ../../../submodules/ccsdk/parent.git/docs/index +.. Being consolidated in ccsdk distribution ../../../submodules/ccsdk/platform/blueprints.git/docs/index ../../../submodules/ccsdk/platform/nbapi.git/docs/index + ../../../submodules/ccsdk/storage/esaas.git/docs/index + ../../../submodules/ccsdk/storage/pgaas.git/docs/index + ../../../submodules/ccsdk/utils.git/docs/index + ../../../submodules/ccsdk/parent.git/docs/index + ../../../submodules/ccsdk/platform/plugins.git/docs/index ../../../submodules/ccsdk/sli/adaptors.git/docs/index ../../../submodules/ccsdk/sli/core.git/docs/index ../../../submodules/ccsdk/sli/northbound.git/docs/index ../../../submodules/ccsdk/sli/plugins.git/docs/index - ../../../submodules/ccsdk/storage/esaas.git/docs/index - ../../../submodules/ccsdk/storage/pgaas.git/docs/index - ../../../submodules/ccsdk/utils.git/docs/index Data Collection, Analysis, and Events ------------------------------------- @@ -90,13 +90,6 @@ Documentation ../how-to-use-docs/index.rst -External API Framework ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - Holmes ------ @@ -151,7 +144,7 @@ Modeling ../../../submodules/modeling/modelspec.git/docs/index ../../../submodules/modeling/toscaparsers.git/docs/index -MultiVIM CLoud +MultiVIM Cloud -------------- .. toctree:: @@ -171,23 +164,6 @@ ONAP Command Line Interface ../../../submodules/cli.git/docs/index -ONAP Optimization Framework ---------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/optf/has.git/docs/index - -ONAP University ---------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ONAP Use Case User Interface ---------------------------- diff --git a/docs/guides/onap-developer/settingup/components.rst b/docs/guides/onap-developer/settingup/components.rst new file mode 100644 index 000000000..e6aaf5fb7 --- /dev/null +++ b/docs/guides/onap-developer/settingup/components.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + http://creativecommons.org/licenses/by/4.0 + + +========================================= +**Setting Up individual ONAP components** +========================================= +It is possible to deploy individual components. + +The documentation to install the various components is available here: + +TODO Link to installations + diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst new file mode 100644 index 000000000..61921add2 --- /dev/null +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -0,0 +1,162 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + http://creativecommons.org/licenses/by/4.0 + Copyright 2017 ONAP + + +.. contents:: + :depth: 2 +.. + + +======================== +**Setting Up Full ONAP** +======================== + +.. _demo-installing-running-onap: + +**Context** +=========== +ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on Open Stack. + +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 Open Stack tenants or based on top of VMware based infrastructure (cf MultiCloud project). + +Figure 1 + +The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) + + +**Requirements** +================ + +OpenStack +--------- +ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release. + +The following Open Stack components must be deployed in the infrastructure: + - *Cinder* + - *Designate* + - *Glance* + - *Horizon* + - *Keystone* + +To deploy Open Stack, you can use various solutions: + - `OpenStack installer <https://docs.openstack.org/install-guide/>`_ + - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_ + +*Designate* component is usually not deployed using standard OpenStack installers. +Please find a guide to deploy and configure *Designate* + +Footprint +--------- +The ONAP installation requires the following footprint: + - xx VM + - xxx vCPU + - xxx RAM + - xxx Storage + - xxx floating IP + - a public SSH key + - a private SSH key + +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 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: + +.. code-block:: yaml + + --- + aai: + - 8889 + +TODO Generate the YAML file with installation + +TODO Provide a command to create the security groups + +**Deployment** +============== + +Instantiation +------------- +- 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 environment. + +Test the installation +--------------------- +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 + + docker exec -it openecompete_container /var/opt/OpenECOMP_ETE/runTags.sh -i health h -d ./html -V /share/config/integration_robot_properties.py -V /share/config/integration_preload_parameters.py -V /share/config/vm_properties.py + +This testsuite will execute 31 tests towards the various ONAP components. + +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 the Virtual Machine and check that the various containers are running. + +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 + + sudo docker ps -a + sudo docker logs <containerid> + + +**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): + +.. code-block:: bash + + 104.239.249.17 policy.api.simpledemo.onap.org + 104.130.31.25 portal.api.simpledemo.onap.org + 104.239.249.15 sdc.api.simpledemo.onap.org + 104.130.170.142 vid.api.simpledemo.onap.org + 104.239.249.72 aai.api.simpledemo.onap.org + TODO ADD ui.aai + +You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line: + +.. code-block:: bash + + openstack server list + +Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm + +Go to the Portal component user guide. + +Other UI documentation: + - CLAMP + - SDC Portal + - UI Case + + +**Components** +============== + +The following YAML file presents the list of containers for every Virtual Machine + +.. code-block:: yaml + + aai: + - traversal + - be + - fe + appc + - fe + + + diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index ed20d98c2..3dc8e5ce3 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -1,169 +1,14 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2017 ONAP +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. -.. contents:: - :depth: 2 -.. +Setting Up ONAP +=============== -======================== -**Setting Up Full ONAP** -======================== - - -**Context** -=========== -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 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). - -Figure 1 - -The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) - - -**Requirements** -================ - -OpenStack ---------- -ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release. - -The following OpenStack components must be deployed in the infrastructure: - - *Cinder* - - *Designate* - - *Glance* - - *Horizon* - - *Keystone* - -To deploy OpenStack, you can use various solutions: - - `OpenStack installer <https://docs.openstack.org/install-guide/>`_ - - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_ - -*Designate* component is usually not deployed using standard OpenStack installers. -Please find a guide to deploy and configure *Designate* - -Footprint ---------- -The ONAP installation requires the following footprint: - - xx VM - - xxx vCPU - - xxx RAM - - xxx Storage - - xxx floating IP - - a public SSH key - - a private SSH key - -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 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: - -.. code-block:: yaml - - --- - aai: - - 8889 - -TODO Generate the YAML file with installation - -TODO Provide a command to create the security groups - -**Deployment** -============== - -Instantiation -------------- -- 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 environment. - -Test the installation ---------------------- -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 - - docker exec -it openecompete_container /var/opt/OpenECOMP_ETE/runTags.sh -i health h -d ./html -V /share/config/integration_robot_properties.py -V /share/config/integration_preload_parameters.py -V /share/config/vm_properties.py - -This testsuite will execute 31 tests towards the various ONAP components. - -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 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 - - sudo docker ps -a - sudo docker logs <containerid> - - -**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): - -.. code-block:: bash - - 104.239.249.17 policy.api.simpledemo.onap.org - 104.130.31.25 portal.api.simpledemo.onap.org - 104.239.249.15 sdc.api.simpledemo.onap.org - 104.130.170.142 vid.api.simpledemo.onap.org - 104.239.249.72 aai.api.simpledemo.onap.org - TODO ADD ui.aai - -You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line: - -.. code-block:: bash - - openstack server list - -Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm - -Go to the Portal component user guide. - -Other UI documentation: - - CLAMP - - SDC Portal - - UI Case - - -**Components** -============== - -The following YAML file presents the list of containers for every Virtual Machine - -.. code-block:: yaml - - aai: - - traversal - - be - - fe - appc - - fe - - - -======================================== -**Setting Up indiviual ONAP components** -======================================== -It is possible to deploy individual components. - -The documentation to install the various components is available here: - -TODO Link to installations +.. toctree:: + :maxdepth: 1 + :titlesonly: + fullonap.rst + components.rst diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst index 4519eaebc..a4bcbaef2 100644 --- a/docs/guides/onap-developer/tutorials/index.rst +++ b/docs/guides/onap-developer/tutorials/index.rst @@ -7,5 +7,3 @@ Tutorials :maxdepth: 1 :titlesonly: - - platform/index.rst diff --git a/docs/guides/onap-developer/tutorials/platform/index.rst b/docs/guides/onap-developer/tutorials/platform/index.rst deleted file mode 100644 index 75cbadfa0..000000000 --- a/docs/guides/onap-developer/tutorials/platform/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 - International License. http://creativecommons.org/licenses/by/4.0 - Copyright 2017 AT&T Intellectual Property. All rights reserved. - -.. _demo-installing-running-onap: - -Installing & Running ONAP -========================= diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 293de1bb5..55852ba21 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -6,6 +6,10 @@ .. _doc-releaserepos: Project Specific Release Notes +++++++++++++++++++++++++++++++ +Each project is listed below followed by the Gerrit repositories in which there are release notes. + +Active and Available Inventory ------------------------------ .. toctree:: @@ -16,30 +20,158 @@ Project Specific Release Notes aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst> aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst> aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst> + +Application Controller +---------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst> appc<../submodules/appc.git/docs/release-notes.rst> + +Common Controller Software Development Kit +------------------------------------------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst> ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> - ccsdk/platform/plugins<../submodules/ccsdk/platform/plugins.git/docs/release-notes.rst> ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst> +Closed Loop Automation Platform +------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + clamp<../submodules/clamp.git/docs/release-notes.rst> + +ONAP Command Line Interface +--------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + cli<../submodules/cli.git/docs/release-notes.rst> + +Data Collection, Analysis, and Events +------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + dcaegen2<../submodules/dcaegen2.git/docs/sections/release-notes.rst> + +Documentation +------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + doc <../release-notes.rst> + +Data Management as a Platform Message Router +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst> + +Holmes +------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst> holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst> + +Integration +----------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + integration<../submodules/integration.git/docs/release-notes.rst> + + +Logging Enhancements Project +---------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst + +Modeling +-------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + modeling/modelspec<../submodules/modeling/modelspec.git/docs/release-notes.rst> + modeling/toscaparsers<../submodules/modeling/toscaparsers.git/docs/release-notes.rst> + +Micro Services Bus +------------------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst> msb/discovery<../submodules/msb/discovery.git/docs/release-notes.rst> msb/java-sdk<../submodules/msb/java-sdk.git/docs/release-notes.rst> msb/swagger-sdk<../submodules/msb/swagger-sdk.git/docs/release-notes.rst> + +MultiVIM Cloud +-------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + multicloud/framework<../submodules/multicloud/framework.git/docs/Release Notes.rst> - optf/has<../submodules/optf/has.git/docs/release-notes.rst> + +Policy Framework +---------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + policy/engine<../submodules/policy/engine.git/docs/release-notes.rst> + +Portal Platform +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + portal<../submodules/portal.git/docs/release-notes.rst> + +Service Design & Creation +------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + sdc<../submodules/sdc.git/docs/release-notes.rst> sdc/jtosca<../submodules/sdc/jtosca.git/docs/release-notes.rst> sdc/sdc-distribution-client<../submodules/sdc/sdc-distribution-client.git/docs/release-notes.rst> @@ -47,20 +179,76 @@ Project Specific Release Notes sdc/sdc-titan-cassandra<../submodules/sdc/sdc-titan-cassandra.git/docs/release-notes.rst> sdc/sdc-tosca<../submodules/sdc/sdc-tosca.git/docs/release-notes.rst> sdc/sdc-workflow-designer<../submodules/sdc/sdc-workflow-designer.git/docs/release-notes.rst> + +Software Defined Network Controller +----------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + sdnc/oam<../submodules/sdnc/oam.git/docs/release-notes.rst> + +Service Orchestration +--------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + so<../submodules/so.git/docs/release-notes.rst> so/libs<../submodules/so/libs.git/docs/release-notes.rst> + +ONAP Use Case User Interface +---------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst> + +Virtual Function Controller +--------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + vfc/lcm<../submodules/vfc/lcm.git/docs/release-notes.rst> vfc/nfvo/lcm<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst> + +Virtual Infrastructure Deployment +--------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst> vid<../submodules/vid.git/docs/release-notes.rst> + +VNF Requirements +---------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + vnfrqts/guidelines<../submodules/vnfrqts/guidelines.git/docs/release-notes.rst> vnfrqts/requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst> + +VNF Software Development Kit +---------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + vnfsdk/model<../submodules/vnfsdk/model.git/docs/release-notes.rst> -.. Empty folders for this release +.. Not in / not used this release ccsdk/parent<../submodules/ccsdk/parent.git/docs/release-notes.rst> ccsdk/platform/nbapi<../submodules/ccsdk/platform/nbapi.git/docs/release-notes.rst> ccsdk/sli/adaptors<../submodules/ccsdk/sli/adaptors.git/docs/release-notes.rst> |