diff options
Diffstat (limited to 'docs/guides')
19 files changed, 817 insertions, 210 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 277dd1574..db4cd6a51 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -2,14 +2,16 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: API Reference + .. _doc-apiref: -API Reference -============= +REST API Reference +================== .. note:: Some high level groupings are introduced below with references to - API offered by the various components. + REST API offered by the various components. User Interfaces --------------- @@ -20,7 +22,7 @@ User Interfaces CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst> SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst> - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/Virtual Function Controller.rst> + VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/docs-offeredapis.rst> Platform Components ------------------- @@ -30,11 +32,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,8 +46,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> - MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> - Multi VIM/Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.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 - 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/files/vnfsdk-apis.rst> diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index bc392893c..d4f38d9cf 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -3,120 +3,15 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Platform Architecture + .. _doc-architecture: Architecture ============ -.. note:: - Some high level groupings are introduced below with references to - project/repo/docs/architecture.rst or similar architecture references. - As more information is provided by each project in a docs/architecture.rst - file, it will appear here. Show source to see the references in each grouping. - -Models ------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - Model Specifications <../../../submodules/modeling/modelspec.git/docs/ONAP release 1 spec/index> - -User Interfaces ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst> - CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst> - SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst> - ../../../submodules/sdc/jtosca.git/docs/architecture.rst - ../../../submodules/sdc/sdc-distribution-client.git/docs/architecture.rst - ../../../submodules/sdc/sdc-docker-base.git/docs/architecture.rst - ../../../submodules/sdc/sdc-titan-cassandra.git/docs/architecture.rst - ../../../submodules/sdc/sdc-tosca.git/docs/architecture.rst - ../../../submodules/sdc/sdc-workflow-designer.git/docs/architecture.rst - ../../../submodules/usecase-ui.git/docs/architecture.rst - ../../../submodules/vid/asdcclient.git/docs/architecture.rst - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/intro/index> - -Platform Components -------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../submodules/appc/deployment.git/docs/architecture.rst - ../../../submodules/appc.git/docs/architecture.rst - DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst> - ../../../submodules/holmes/engine-management.git/docs/architecture.rst - Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst> - ../../../submodules/policy/engine.git/docs/architecture.rst - ../../../submodules/sdnc/adaptors.git/docs/architecture.rst - ../../../submodules/sdnc/architecture.git/docs/architecture.rst - ../../../submodules/sdnc/core.git/docs/architecture.rst - ../../../submodules/sdnc/features.git/docs/architecture.rst - SDN Northbound <../../../submodules/sdnc/northbound.git/docs/architecture.rst - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst> - ../../../submodules/sdnc/parent.git/docs/architecture.rst - ../../../submodules/sdnc/plugins.git/docs/architecture.rst - ../../../submodules/so/libs.git/docs/architecture.rst - ../../../submodules/so.git/docs/architecture.rst - ../../../submodules/vfc/lcm.git/docs/architecture.rst - ../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst - -Common Services ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst> - AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst> - AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst> - ../../../submodules/aai/sparky-be.git/docs/architecture.rst - ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst - MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst> - ../../../submodules/msb/discovery.git/docs/architecture.rst - ../../../submodules/msb/java-sdk.git/docs/architecture.rst - ../../../submodules/msb/swagger-sdk.git/docs/architecture.rst - -SDKs ----- - -.. toctree:: - :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/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 - -Other ------ - .. toctree:: - :maxdepth: 1 - :titlesonly: + :maxdepth: 2 - ../../../submodules/integration.git/docs/architecture.rst - ../../../submodules/optf/has.git/docs/architecture.rst - ../../../submodules/vnfrqts/guidelines.git/docs/architecture.rst - ../../../submodules/vnfrqts/requirements.git/docs/architecture.rst + onap-architecture.rst + references.rst diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index 54ba6b728..95b91b2d9 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -1,11 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. -**Introducing the ONAP Architecture (Amsterdam Release)** -========================================================= -**Introduction ** ------------------ +Introducing the ONAP Architecture (Amsterdam Release) +===================================================== + +Introduction +------------- The ONAP project was formed in March, 2017 in response to a rising need for a common platform for telecommunication, cable, and cloud @@ -83,11 +84,11 @@ following foundational principles: services - Carrier-grade scalability including horizontal scaling (linear - scale-out) and distribution to support large number of services - and large networks + scale-out) and distribution to support large number of services + and large networks - Metadata-driven and policy-driven architecture to ensure flexible - ways in which capabilities are used and delivered + ways in which capabilities are used and delivered - The architecture shall enable sourcing best-in-class components @@ -96,14 +97,14 @@ following foundational principles: - Core capabilities shall support many diverse services - The architecture shall support elastic scaling as needs grow or - shrink + shrink |image0|\ **Figure 1:** ONAP Platform -**ONAP Architecture** -===================== +ONAP Architecture +----------------- Figure 2 provides a high-level view of the ONAP architecture and microservices-based platform components. The platform provides the @@ -114,9 +115,12 @@ necessary to develop service/operations-specific collection, analytics, and policies (including recipes for corrective/remedial action) using the ONAP Design Framework Portal. -|image1|\ **Figure 2:** ONAP Platform components (Amsterdam Release) +|image1|\ + +**Figure 2:** ONAP Platform components (Amsterdam Release) -1. **Portal** +Portal +++++++ ONAP delivers a single, consistent user experience to both design time and run time environments, based on the user’s role; role changes to be @@ -138,8 +142,8 @@ vendors and consultants), and other experts to continually define/refine new collection, analytics, and policies (including recipes for corrective/remedial action) using the ONAP Design Framework Portal. -**Design time Framework** -========================= +Design time Framework ++++++++++++++++++++++ The design time framework is a comprehensive development environment with tools, techniques, and repositories for defining/describing @@ -194,8 +198,8 @@ network service, then deploy and decommission it. Once deployed, a user can also update the loop with new parameters during runtime, as well as suspend and restart it. -**Runtime Framework** -===================== +Runtime Framework ++++++++++++++++++ The runtime execution framework executes the rules and policies distributed by the design and creation environment. This allows us to @@ -206,7 +210,8 @@ a Security Framework. These components use common services that support logging, access control, and data management. Orchestration -------------- ++++++++++++++ + The Service Orchestrator (SO) component executes the specified processes and automates sequences of activities, tasks, rules and policies needed for on-demand creation, modification or removal of @@ -215,7 +220,8 @@ provides orchestration at a very high level, with an end to end view of the infrastructure, network, and applications. Controllers ------------ ++++++++++++ + Controllers are applications which are coupled with cloud and network services and execute the configuration, real-time policies, and control the state of distributed components and services. Rather than using a @@ -230,7 +236,8 @@ infrastructure. While it provides a generic VNFM, it also integrates with external VNFMs and VIMs as part of a NFV MANO stack. Inventory ---------- ++++++++++ + Active and Available Inventory (A&AI) provides real-time views of a system’s resources, services, products and their relationships with each other. The views provided by A&AI relate data managed by multiple ONAP @@ -247,21 +254,21 @@ is metadata-driven, allowing new inventory types to be added dynamically and quickly via SDC catalog definitions, eliminating the need for lengthy development cycles. -**Closed-Loop Automation** -========================== +Closed-Loop Automation +---------------------- The following sections describe the ONAP frameworks designed to address these major requirements. The key pattern that these frameworks help -automate is +automate is: -***Design -> Create -> Collect -> Analyze -> Detect -> Publish -> -Respond.*** +**Design -> Create -> Collect -> Analyze -> Detect -> Publish -> +Respond** We refer to this automation pattern as “closed-loop automation” in that it provides the necessary automation to proactively respond to network and service conditions without human intervention. A high-level schematic of the “closed-loop automation” and the various phases within -the service lifecycle using the automation is depicted in Figure 4. +the service lifecycle using the automation is depicted in Figure 3. Closed-loop control is provided by Data Collection, Analytics and Events (DCAE) and other ONAP components. Collectively, they provide FCAPS @@ -283,8 +290,8 @@ human intervention before executing the change. \ **Figure 3:** ONAP Closed Loop Automation -**Common Services** -=================== +Common Services +--------------- ONAP provides common operational services for all ONAP components including activity logging, reporting, common data layer, access @@ -298,8 +305,8 @@ and opportunities. ONAP provides increased security by embedding access controls in each ONAP platform component, augmented by analytics and policy components specifically designed for the detection and mitigation of security violations. -**Amsterdam Use Cases** -======================= +Amsterdam Use Cases +------------------- The ONAP project uses real-world use cases to help focus our releases. For the first release of ONAP (“Amsterdam”), we introduce two use cases: @@ -317,7 +324,7 @@ providers to offer new value-added services to their customers with less dependency on the underlying hardware. In this use case, the customer has a physical CPE (pCPE) attached to a -traditional broadband network such as DSL (Figure 1). On top of this +traditional broadband network such as DSL (Figure 4). On top of this service, a tunnel is established to a data center hosting various VNFs. In addition, depending on the capabilities of the pCPE, some functions can be deployed on the customer site. @@ -363,7 +370,7 @@ To connect the different data centers, ONAP will also have to interface with legacy systems and physical function to establish VPN connectivity in a brown field deployment. -The VoLTE use case, shown in Figure 6, demonstrates the use of the VF-C +The VoLTE use case, shown in Figure 5, demonstrates the use of the VF-C component and TOSCA-based data models to manage the virtualization infrastructure. @@ -383,15 +390,15 @@ By unifying member resources, ONAP will accelerate the development of a vibrant .. |image0| image:: media/ONAP-DTRT.png :width: 6in :height: 2.6in -.. |image1| image:: media/toplevel.png +.. |image1| image:: media/ONAP-toplevel.png :width: 6.5in :height: 3.13548in -.. |image2| image:: media/closedloop.jpeg +.. |image2| image:: media/ONAP-closedloop.png :width: 6in :height: 2.6in -.. |image3| image:: media/vcpe.png +.. |image3| image:: media/ONAP-vcpe.png :width: 6.5in :height: 3.28271in -.. |image4| image:: media/volte.png +.. |image4| image:: media/ONAP-volte.png :width: 6.5in :height: 3.02431in diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst new file mode 100644 index 000000000..b152795c4 --- /dev/null +++ b/docs/guides/onap-developer/architecture/references.rst @@ -0,0 +1,123 @@ +.. 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. + + +.. note:: + Some high level groupings are introduced below with references to + project/repo/docs/architecture.rst or similar architecture references. + As more information is provided by each project in a docs/architecture.rst + file, it will appear here. Show source to see the references in each grouping. + +References +========== + +Models +------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Model Specifications <../../../submodules/modeling/modelspec.git/docs/ONAP release 1 spec/index> + +User Interfaces +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst> + CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst> + SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst> + ../../../submodules/sdc/jtosca.git/docs/architecture.rst + ../../../submodules/sdc/sdc-distribution-client.git/docs/architecture.rst + ../../../submodules/sdc/sdc-docker-base.git/docs/architecture.rst + ../../../submodules/sdc/sdc-titan-cassandra.git/docs/architecture.rst + ../../../submodules/sdc/sdc-tosca.git/docs/architecture.rst + ../../../submodules/sdc/sdc-workflow-designer.git/docs/architecture.rst + ../../../submodules/usecase-ui.git/docs/architecture.rst + ../../../submodules/vid/asdcclient.git/docs/architecture.rst + VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/intro/index> + +Platform Components +------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/appc/deployment.git/docs/architecture.rst + ../../../submodules/appc.git/docs/architecture.rst + DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst> + ../../../submodules/holmes/engine-management.git/docs/architecture.rst + Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst> + ../../../submodules/policy/engine.git/docs/architecture.rst + ../../../submodules/sdnc/adaptors.git/docs/architecture.rst + ../../../submodules/sdnc/architecture.git/docs/architecture.rst + ../../../submodules/sdnc/core.git/docs/architecture.rst + ../../../submodules/sdnc/features.git/docs/architecture.rst + SDN Northbound <../../../submodules/sdnc/northbound.git/docs/architecture.rst + SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst> + ../../../submodules/sdnc/parent.git/docs/architecture.rst + ../../../submodules/sdnc/plugins.git/docs/architecture.rst + ../../../submodules/so/libs.git/docs/architecture.rst + ../../../submodules/so.git/docs/architecture.rst + ../../../submodules/vfc/lcm.git/docs/architecture.rst + ../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst + +Common Services +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst> + AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst> + AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst> + ../../../submodules/aai/sparky-be.git/docs/architecture.rst + ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst + MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst> + ../../../submodules/msb/discovery.git/docs/architecture.rst + ../../../submodules/msb/java-sdk.git/docs/architecture.rst + ../../../submodules/msb/swagger-sdk.git/docs/architecture.rst + ../../../submodules/multicloud/framework.git/docs/architecture.rst + +SDKs +---- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/ccsdk/distribution.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/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 +----- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/integration.git/docs/architecture.rst + ../../../submodules/optf/has.git/docs/architecture.rst + ../../../submodules/vnfrqts/guidelines.git/docs/architecture.rst + ../../../submodules/vnfrqts/requirements.git/docs/architecture.rst diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 7ce12034b..c6528f12c 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Developer Guides + .. _doc_onap-developer_guide_projects: Developing ONAP @@ -49,19 +51,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 +92,6 @@ Documentation ../how-to-use-docs/index.rst -External API Framework ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - Holmes ------ @@ -151,32 +146,33 @@ Modeling ../../../submodules/modeling/modelspec.git/docs/index ../../../submodules/modeling/toscaparsers.git/docs/index -ONAP Command Line Interface ---------------------------- +MultiVIM Cloud +-------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/cli.git/docs/index + ../../../submodules/multicloud/framework.git/docs/index -ONAP Optimization Framework +ONAP Command Line Interface --------------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/optf/has.git/docs/index + ../../../submodules/cli.git/docs/index -ONAP University ---------------- +ONAP Operations Manager (experimental) +-------------------------------------- .. toctree:: :maxdepth: 2 :titlesonly: + ../../../submodules/oom.git/docs/index ONAP Use Case User Interface ---------------------------- @@ -291,11 +287,3 @@ VNF Software Development Kit :titlesonly: ../../../submodules/vnfsdk/model.git/docs/index - -VNF Validation --------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index eccd0022a..2d8a25cfa 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -60,8 +60,6 @@ You can add html content that only appears in html output by using the This line will be shown only in html version. -.. index:: single: indices - Creating Indices ---------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst index 8fd9a730b..9c5822d2b 100644 --- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst @@ -100,7 +100,6 @@ A starting structure is shown below and may change as content is integrated for each release. Other ONAP projects will provide content that is referenced from this structure. -.. index:: master :: @@ -133,7 +132,6 @@ ONAP jenkins jobs that verify and merge documentation are triggered by RST file changes in the top level docs directory and below. -.. index:: licensing Licensing --------- diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 4a7300d16..15d71d453 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -390,23 +390,15 @@ Download the DOC repository. git clone http://gerrit.onap.org/r/doc -Change directory to docs & install requirements. - -.. code-block:: bash - - cd doc - sudo pip install -r etc/requirements.txt - Update submodules, build documentation using tox & then open using any browser. .. code-block:: bash cd doc - git submodule update --depth 1 --init - tox -edocs + tox -elocal firefox docs/_build/html/index.html -.. note:: Make sure to run `tox -edocs` and not just `tox`. +.. note:: Make sure to run `tox -elocal` and not just `tox`. diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index a73ae6fb3..6f1dd2d33 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -12,3 +12,8 @@ Creating Documentation include-documentation converting-formats addendum + +.. toctree:: + :hidden: + + update-review.rst diff --git a/docs/guides/onap-developer/settingup/components.rst b/docs/guides/onap-developer/settingup/components.rst new file mode 100644 index 000000000..00ada768e --- /dev/null +++ b/docs/guides/onap-developer/settingup/components.rst @@ -0,0 +1,61 @@ +.. 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: + +User Interfaces +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst#installation> + SDC - Service Design and Creation <../../../submodules/sdc.git/docs/installation.rst> + Use-Case UI <../../../usecase-ui.git/docs/platform/installation.rst> + VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/installation.rst> + +Platform Components +------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + APPC - Application Controller <../../../submodules/appc.git/docs/APPC%20Deployment%20Guidelines/APPC%20Deployment%20Guidelines.rst#deploying-appc> + DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/sections/installation.rst> + Holmes - Alarm Correlation <../../../usecase-ui.git/docs/platform/installation.rst> + Policy <../../../submodules/policy/engine.git/docs/platform/installation.rst> + SDNC - Software Defined Network Controller <../../../submodules/sdnc/northbound.git/docs/installation.rst> + SO - Service Orchestration <../../../submodules/so.git/docs/Install_Configure_SO.rst> + VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/installation.rst> + +Common Services +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/installation.rst> + DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/Installation/Installation.rst> + Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/nfvparser/installation/installation.instruction.rst> + MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/docs/platform/installation.rst> + MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-Heat-Deployment-Guide.rst> + +SDK +--- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + CLI - Command Line Interface<../../../cli.git/docs/installation_guide.rst> + Portal - <../../../portal.git/docs/tutorials/portal-sdk/setting-up.rst> + VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/mktplace-install.rst> diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst new file mode 100644 index 000000000..6d3d891da --- /dev/null +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -0,0 +1,460 @@ +.. 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 +.. + +.. index:: Setting Up Full ONAP + + +======================== +**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 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). + +The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE componntes deployed in High Availability mode. + +**Requirements** +================ + +OpenStack +--------- +ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release. + +You can use various Cloud providers offering OpenStack based solutions. A list of available Cloud providers on the `OpenStack marketplace <https://www.openstack.org/marketplace/public-clouds/>`_. + +You can use your private Cloud infrastructure. + +The following OpenStack components must be deployed in the infrastructure: + - *Cinder* + - *Designate* + - *Glance* + - *Heat* + - *Horizon* + - *Keystone* + - *Neutron* + - *Nova* + +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* + +.. toctree:: + :maxdepth: 1 + + install-designate.rst + + +The OpenStack infrastructure must enable internet access. + +ONAP components +--------------- +The following table presents the mapping between the created VM and the ONAP components, and provides informtaion about he VM (flavor and image): + + =================== ================= ======= ============ + VM name ONAP project(s) Flavor Image + =================== ================= ======= ============ + onap-aai-inst1 AAI xlarge Ubuntu 14.04 + onap-aai-inst2 AAI/UI xlarge Ubuntu 14.04 + onap-appc APPC, CCSDK large Ubuntu 14.04 + onap-clamp CLAMP medium Ubuntu 16.04 + onap-dns-server *Internal DNS* small Ubuntu 14.04 + onap-message-router DMAAP large Ubuntu 14.04 + onap-multi-service MSB, VF-C, VNFSDK xxlarge Ubuntu 16.04 + onap-policy Policy xlarge Ubuntu 14.04 + onap-portal Portal, CLI large Ubuntu 14.04 + onap-robot Integration medium Ubuntu 16.04 + onap-sdc SDC xlarge Ubuntu 16.04 + onap-sdnc SDNC, CCSDK large Ubuntu 14.04 + onap-so SO large Ubuntu 16.04 + onap-vid VID medium Ubuntu 14.04 + onap-dcae-bootstrap DCAE, Holmes small Ubuntu 14.04 + dcaeorcl00 DCAE/Orchestr. medium CentOS 7 + dcaecnsl00 DCAE/Consul medium Ubuntu 16.04 + dcaecnsl01 DCAE/Consul medium Ubuntu 16.04 + dcaecnsl02 DCAE/Consul medium Ubuntu 16.04 + dcaedokp00 DCAE/Policy Hand. medium Ubuntu 16.04 + dcaedoks00 DCAE/VES, Holmes medium Ubuntu 16.04 + dcaepgvm00 DCAE/Postrges medium Ubuntu 16.04 + dcaecdap00 DCAE/CDAP large Ubuntu 16.04 + dcaecdap01 DCAE/CDAP large Ubuntu 16.04 + dcaecdap02 DCAE/CDAP large Ubuntu 16.04 + dcaecdap03 DCAE/CDAP large Ubuntu 16.04 + dcaecdap04 DCAE/CDAP large Ubuntu 16.04 + dcaecdap05 DCAE/CDAP large Ubuntu 16.04 + dcaecdap06 DCAE/CDAP large Ubuntu 16.04 + =================== ================= ======= ============ + +Footprint +--------- +The ONAP installation requires the following footprint: + - 29 VM + - 148 vCPU + - 336 GB RAM + - 3 TB Storage + - 29 floating IP + +.. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation. + +.. Note: you should also reserve some resourcse for the VNFs to be deployed. + +Artifacts +--------- +The following artifacts must be deployed on the OpenStack infrastructure. + - a public SSH key to access the various VM + - private SSH key and public key SSH key for the DCAE VM + - Ubuntu 14.04 image + - Ubuntu 16.04 image + - CentOS 7 image + - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge + +.. Note that floating IP may be private IP. + +.. Note Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_ + The xxlarge flavor should be confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage. + +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 list of various services and ports used can be found on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_ + +**Deployment** +============== + +Source files +------------ + +- Template file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml +- Environment file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env + +Description +----------- + +The ONAP HEAT template spins up the entire ONAP platform. The template, +onap_openstack.yaml, comes with an environment file, +onap_openstack.env, in which all the default values are defined. + +The HEAT template is composed of two sections: (i) parameters, and (ii) +resources. +The parameter section contains the declaration and +description of the parameters that will be used to spin up ONAP, such as +public network identifier, URLs of code and artifacts repositories, etc. +The default values of these parameters can be found in the environment +file. + +The resource section contains the definition of: + +- ONAP Private Management Network, which ONAP components use to communicate with each other and with VNFs +- ONAP Virtual Machines (VMs) +- Public/private key pair used to access ONAP VMs +- Virtual interfaces towards the ONAP Private Management Network +- Disk volumes. + +Each VM specification includes Operating System image name, VM size +(i.e. flavor), VM name, etc. Each VM has two virtual network interfaces: +one towards the public network and one towards the ONAP Private +Management network, as described above. Furthermore, each VM runs a +post-instantiation script that downloads and installs software +dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software +packages and docker containers from remote repositories. + +When the HEAT template is executed, the Openstack HEAT engine creates +the resources defined in the HEAT template, based on the parameters +values defined in the environment file. + +Environment file +---------------- + +Before running HEAT, it is necessary to customize the environment file. +Indeed, some parameters, namely public_net_id, pub_key, +openstack_tenant_id, openstack_username, and openstack_api_key, +need to be set depending on the user's environment: + +**Global parameters** + +:: + + public_net_id: PUT YOUR NETWORK ID/NAME HERE + pub_key: PUT YOUR PUBLIC KEY HERE + openstack_tenant_id: PUT YOUR OPENSTACK PROJECT ID HERE + openstack_username: PUT YOUR OPENSTACK USERNAME HERE + openstack_api_key: PUT YOUR OPENSTACK PASSWORD HERE + horizon_url: PUT THE HORIZON URL HERE + keystone_url: PUT THE KEYSTONE URL HERE (do not include version number) + +openstack_region parameter is set to RegionOne (OpenStack default). If +your OpenStack is using another Region, please modify this parameter. + +public_net_id is the unique identifier (UUID) or name of the public +network of the cloud provider. To get the public_net_id, use the +following OpenStack CLI command (ext is the name of the external +network, change it with the name of the external network of your +installation) + +:: + + openstack network list | grep ext | awk '{print $2}' + +pub_key is string value of the public key that will be installed in +each ONAP VM. To create a public/private key pair in Linux, please +execute the following instruction: + +:: + + user@ubuntu:~$ ssh-keygen -t rsa + +The following operations to create the public/private key pair occur: + +:: + + Generating public/private rsa key pair. + Enter file in which to save the key (/home/user/.ssh/id_rsa): + Created directory '/home/user/.ssh'. + Enter passphrase (empty for no passphrase): + Enter same passphrase again: + Your identification has been saved in /home/user/.ssh/id_rsa. + Your public key has been saved in /home/user/.ssh/id_rsa.pub. + +openstack_username, openstack_tenant_id (password), and +openstack_api_key are user's credentials to access the +OpenStack-based cloud. + +**Images and flavors parameters** + +:: + + ubuntu_1404_image: PUT THE UBUNTU 14.04 IMAGE NAME HERE + ubuntu_1604_image: PUT THE UBUNTU 16.04 IMAGE NAME HERE + flavor_small: PUT THE SMALL FLAVOR NAME HERE + flavor_medium: PUT THE MEDIUM FLAVOR NAME HERE + flavor_large: PUT THE LARGE FLAVOR NAME HERE + flavor_xlarge: PUT THE XLARGE FLAVOR NAME HERE + flavor_xxlarge: PUT THE XXLARGE FLAVOR NAME HERE + +To get the images in your OpenStack environment, use the following +OpenStack CLI command: + +:: + + openstack image list | grep 'ubuntu' + +To get the flavor names used in your OpenStack environment, use the +following OpenStack CLI command: + +:: + + openstack flavor list + +**Network parameters** + +:: + + dns_list: PUT THE ADDRESS OFTHE EXTERNAL DNS HERE (e.g. a comma-separated list of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems). THIS LIST MUST INCLUDE THE DNS SERVER THAT OFFERS DNS AS AS SERVICE (see DCAE section below for more details) + external_dns: PUT THE FIRST ADDRESS OF THE EXTERNAL DNS LIST HERE oam_network_cidr: 10.0.0.0/16 + dns_forwarder: PUT THE IP OF DNS FORWARDER FOR ONAP DEPLOYMENT'S OWN DNS SERVER + oam_network_cidr: 10.0.0.0/16 + +You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers + +ONAP installs a DNS server used to resolve IP addresses in the ONAP OAM private network. +ONAP Amsterdam Release also requires OpenStack Designate DNS support for the DCAE platform, so as to allow IP address discovery and communication among DCAE elements. +This is required because the ONAP HEAT template only installs the DCAE bootstrap container, which will in turn install the entire DCAE platform. +As such, at installation time, the IP addresses of the DCAE components are unknown. + +The DNS server that ONAP installs needs to be connected to the Designate DNS to allow communication between the DCAE elements and the other ONAP components. +To this end, dns\_list, external\_dns, and dns\_forwarder should all have the IP address of the Designate DNS. +These three parameters are redundant, but still required for Amsterdam Release. Originally, dns\_list and external\_dns were both used to circumvent some limitations of older OpenStack versions. +In future releases, the DNS settings and parameters in HEAT will be consolidated. +The Designate DNS is configured to access the external DNS. +As such, the ONAP DNS will forward to the Designate DNS the queries from ONAP components to the external world. +The Designate DNS will then forward those queries to the external DNS. + +**DCAE Parameters** + +DCAE spins up ONAP's data collection and analytics system in two phases. + +The first is the launching of a bootstrap VM that is specified in the ONAP Heat template, as described above. This VM requires a number of deployment-specific configuration parameters being provided so that it can subsequently bring up the DCAE system. + +There are two groups of parameters. + +The first group relates to the launching of DCAE VMs, including parameters such as the keystone URL and additional VM image IDs/names. +Hence these parameters need to be provided to DCAE. +Note that although DCAE VMs will be launched in the same tenant as the rest of ONAP, because DCAE may use MultiCloud node as the agent for interfacing with the underlying cloud, it needs a separate keystone URL (which points to MultiCloud node instead of the underlying cloud). + +The second group of configuration parameters relate to DNS As A Service support (DNSaaS). +DCAE requires DNSaaS for registering its VMs into organization-wide DNS service. +For OpenStack, DNSaaS is provided by Designate, as mentioned above. +Designate support can be provided via an integrated service endpoint listed under the service catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud service. +For the latter case, a number of parameters are needed to configure MultiCloud to use the correct Designate service. + +These parameters are described below: + +:: + + dcae_keystone_url: PUT THE MULTIVIM PROVIDED KEYSTONE API URL HERE + dcae_centos_7_image: PUT THE CENTOS7 VM IMAGE NAME HERE FOR DCAE LAUNCHED CENTOS7 VM + dcae_domain: PUT THE NAME OF DOMAIN THAT DCAE VMS REGISTER UNDER + dcae_public_key: PUT THE PUBLIC KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS + dcae_private_key: PUT THE SECRET KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS + + dnsaas_config_enabled: PUT WHETHER TO USE PROXYED DESIGNATE + dnsaas_region: PUT THE DESIGNATE PROVIDING OPENSTACK'S REGION HERE + dnsaas_keystone_url: PUT THE DESIGNATE PROVIDING OPENSTACK'S KEYSTONE URL HERE + dnsaas_tenant_name: PUT THE TENANT NAME IN THE DESIGNATE PROVIDING OPENSTACK HERE (FOR R1 USE THE SAME AS openstack_tenant_name) + dnsaas_username: PUT THE DESIGNATE PROVIDING OPENSTACK'S USERNAME HERE + dnsaas_password: PUT THE DESIGNATE PROVIDING OPENSTACK'S PASSWORD HERE + +Instantiation +------------- + +The ONAP platform can be instantiated via Horizon (OpenStack dashboard) +or Command Line. + +**Instantiation via Horizon:** + +- Login to Horizon URL with your personal credentials +- Click "Stacks" from the "Orchestration" menu +- Click "Launch Stack" +- Paste or manually upload the HEAT template file (onap_openstack.yaml) in the "Template Source" form +- Paste or manually upload the HEAT environment file (onap_openstack.env) in the "Environment Source" form +- Click "Next" - Specify a name in the "Stack Name" form +- Provide the password in the "Password" form +- Click "Launch" + +**Instantiation via Command Line:** + +- Install the HEAT client on your machine, e.g. in Ubuntu (ref. http://docs.openstack.org/user-guide/common/cli-install-openstack-command-line-clients.html): + +:: + + apt-get install python-dev python-pip + pip install python-heatclient # Install heat client + pip install python-openstackclient # Install the Openstack client to support multiple services + +- Create a file (named i.e. ~/openstack/openrc) that sets all the + environmental variables required to access Rackspace: + +:: + + export OS_AUTH_URL=INSERT THE AUTH URL HERE + export OS_USERNAME=INSERT YOUR USERNAME HERE + export OS_TENANT_ID=INSERT YOUR TENANT ID HERE + export OS_REGION_NAME=INSERT THE REGION HERE + export OS_PASSWORD=INSERT YOUR PASSWORD HERE + +- Run the script from command line: + +:: + + source ~/openstack/openrc + +- In order to install the ONAP platform, type: + +:: + + heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE # Old HEAT client, OR + openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME # New Openstack client + + +.. Note 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 30 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 + + <onap-policy_ip> policy.api.simpledemo.onap.org + <onap-portal_ip> portal.api.simpledemo.onap.org + <onap-sdc_ip> sdc.api.simpledemo.onap.org + <onap-vid_ip> vid.api.simpledemo.onap.org + <onap-aai-inst1_ip> aai.api.simpledemo.onap.org + <onap-aai-inst2_ip> aai.ui.simpledemo.onap.org + + +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 + +Various users are predefined as presented in the following table: + + .. csv-table:: + :header: Role, Login + :widths: 20, 20 + + Superuser,demo + Designer,cs0008 + Tester,jm0007 + Governor,gv0001 + Ops,op0001 + +The password is *demo123456!* + +Go to the `Portal component user guide <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/index.html>`_ + +Other UI documentation: + - `CLAMP <http://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html>`_ + - `SDC <http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html>`_ + - `UI Use-Case <http://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html>`_ + + +**Components** +============== + +The list of various services and ports used can be found on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + http://creativecommons.org/licenses/by/4.0 + Copyright 2017 ONAP + + +.. contents:: diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index 112dc9669..3dc8e5ce3 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -1,5 +1,14 @@ .. 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. + Setting Up ONAP =============== +.. toctree:: + :maxdepth: 1 + :titlesonly: + + fullonap.rst + components.rst diff --git a/docs/guides/onap-developer/settingup/install-designate.rst b/docs/guides/onap-developer/settingup/install-designate.rst new file mode 100644 index 000000000..09576966f --- /dev/null +++ b/docs/guides/onap-developer/settingup/install-designate.rst @@ -0,0 +1,59 @@ +.. 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 Designate on Openstack** +===================================== + +.. tip:: `Openstack Designate documentation <https://docs.openstack.org/designate/latest/index.html>` is an important starting point for configuring Designate. Here, the focus will be on designate for ONAP. + +**Designate Overview** +====================== +Designate is a *DNS as a Service* components. It allows API based interaction with a DNS server. + +This DNS server can be any *well configured* DNS server. + +Designate allows to create **any** entries in the DNS and thus has to be used wisely (see `Designate Production Guidelines <https://docs.openstack.org/designate/latest/admin/production-guidelines.html>` to have a complete explanation). + +In order to be valuable, Designate must be plugged with a DNS Server that will be used: + + - your global (pool of) DNS Server(s). Every entries put by Designate will be seen by everybody. It may then be very dangerous. + - a specific (pool of) DNS Server(s) for your openstack deployment. DNS resolution will work only for your VM. **This is the one that has been tested**. + - a specific (pool of) DNS Server(s) for an openstack tenant. Not a lot of doc is available for that so this part won't be explained here. + +**Designate usage in ONAP** +=========================== + +Currently, only DCAE Gen2 deployment needs designate to work. + +DCAE deployment use cloudify with openstack plugin to start the needed VM for DCAE. In particular, Designate is used to give the IP address of consul server. Thus, the others VMs needs to access the DNS server where Designate push records. + +In order to do that, we'll have to deploy DNS Server(s), configure them to accept dns updates and configure our networks to point to this DNS. +This Fow-To will use bind but you can change to any of the `proposed backends <https://docs.openstack.org/designate/latest/contributor/support-matrix.html>`. + +Limitations with Heat automated deployment +------------------------------------------ +The current design of Heat installer installs DCAE needed VM into the same tenant of the same openstack of the other ONAP components. Thus, this openstack tenant must support Designate. + +Limitations with Kubernetes automated deployment +------------------------------------------------ +The current design of kubernetes deployment installs DCAE into any openstack instances in any tenant. It stills mandate designate on the tenant. + +**Quick Install Guide** +======================= + +Few steps have to be performed. The detail of each steps are in `the config guide of Openstack Designate <https://docs.openstack.org/designate/latest/install/index.html>`: + +1. Install bind9 nameserver +2. Configure it to accept dns updates and forward to your master DNS Server +3. Configure Designate in openstack +4. Create a pool pointing to your nameserver + +Now, when starting the Heat Deployment, use this nameserver. When the stack heat has started, retrieve the random string (XXX in the example) and create the zone XXX.yourdomain (yourdomain is what you have filled in `dcae_domain` in onap_openstack.env). +For OOM, use the DNS on the container host so it can give it to the relevant VM. 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/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 5fa4c8bca..9708ed3c1 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -12,4 +12,3 @@ Describe the different user audiences, tasks performed, and the guides provided servicedesigner.rst serviceadmin.rst platformadmin.rst - diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst index fceea7744..4ebc72ba7 100644 --- a/docs/guides/onap-user/platformadmin.rst +++ b/docs/guides/onap-user/platformadmin.rst @@ -1,6 +1,11 @@ .. 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. Platform Administrator ====================== +.. note:: + Until this section is migrated to gerrit/readthedocs, use the link below. +* `ONAP Portal <https://wiki.onap.org/x/fIsP>`_ diff --git a/docs/guides/onap-user/serviceadmin.rst b/docs/guides/onap-user/serviceadmin.rst index b2faf8613..40bdf01ee 100644 --- a/docs/guides/onap-user/serviceadmin.rst +++ b/docs/guides/onap-user/serviceadmin.rst @@ -2,5 +2,9 @@ Service Administrator ===================== +.. note:: + Until this section is migrated to gerrit/readthedocs, use the links below. +* `Deploy <https://wiki.onap.org/x/CowP>`_ +* `Operate <https://wiki.onap.org/x/TYwP>`_ diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst index 1b51acb35..c934c3a04 100644 --- a/docs/guides/onap-user/servicedesigner.rst +++ b/docs/guides/onap-user/servicedesigner.rst @@ -2,4 +2,7 @@ Service Designer ================ +.. note:: + Until this section is migrated to gerrit/readthedocs, use the link below. +* `Service Designer <https://wiki.onap.org/x/E4AP>`_ |