diff options
84 files changed, 1201 insertions, 1804 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/.gitmodules b/.gitmodules index bf84b34e1..d26fcafbd 100644 --- a/.gitmodules +++ b/.gitmodules @@ -163,26 +163,6 @@ url = ../ccsdk/platform/plugins branch = . ignore = dirty -[submodule "docs/submodules/ccsdk/sli/adaptors.git"] - path = docs/submodules/ccsdk/sli/adaptors.git - url = ../ccsdk/sli/adaptors - branch = . - ignore = dirty -[submodule "docs/submodules/ccsdk/sli/core.git"] - path = docs/submodules/ccsdk/sli/core.git - url = ../ccsdk/sli/core - branch = . - ignore = dirty -[submodule "docs/submodules/ccsdk/sli/northbound.git"] - path = docs/submodules/ccsdk/sli/northbound.git - url = ../ccsdk/sli/northbound - branch = . - ignore = dirty -[submodule "docs/submodules/ccsdk/sli/plugins.git"] - path = docs/submodules/ccsdk/sli/plugins.git - url = ../ccsdk/sli/plugins - branch = . - ignore = dirty [submodule "docs/submodules/ccsdk/storage/esaas.git"] path = docs/submodules/ccsdk/storage/esaas.git url = ../ccsdk/storage/esaas @@ -198,46 +178,16 @@ url = ../ccsdk/utils branch = . ignore = dirty -[submodule "docs/submodules/sdnc/adaptors.git"] - path = docs/submodules/sdnc/adaptors.git - url = ../sdnc/adaptors - branch = . - ignore = dirty -[submodule "docs/submodules/sdnc/architecture.git"] - path = docs/submodules/sdnc/architecture.git - url = ../sdnc/architecture - branch = . - ignore = dirty [submodule "docs/submodules/sdnc/core.git"] path = docs/submodules/sdnc/core.git url = ../sdnc/core branch = . ignore = dirty -[submodule "docs/submodules/sdnc/features.git"] - path = docs/submodules/sdnc/features.git - url = ../sdnc/features - branch = . - ignore = dirty -[submodule "docs/submodules/sdnc/northbound.git"] - path = docs/submodules/sdnc/northbound.git - url = ../sdnc/northbound - branch = . - ignore = dirty [submodule "docs/submodules/sdnc/oam.git"] path = docs/submodules/sdnc/oam.git url = ../sdnc/oam branch = . ignore = dirty -[submodule "docs/submodules/sdnc/parent.git"] - path = docs/submodules/sdnc/parent.git - url = ../sdnc/parent - branch = . - ignore = dirty -[submodule "docs/submodules/sdnc/plugins.git"] - path = docs/submodules/sdnc/plugins.git - url = ../sdnc/plugins - branch = . - ignore = dirty [submodule "docs/submodules/portal.git"] path = docs/submodules/portal.git url = ../portal diff --git a/docs/conf.py b/docs/conf.py index 95c2a8c00..393e2ac42 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -94,7 +94,6 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [ - 'submodules/aai/aai-common.git/docs/platform/offeredapis.rst', '_build' ] @@ -169,7 +168,7 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%d-%b-%y %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -195,7 +194,7 @@ html_static_path = ['_static'] #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True 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>`_ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 716baa9ea..8c8b5e133 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -13,13 +13,13 @@ Version: x.y.z -------------- -:Release Date: yyyy-mm-dd +:Release Date: 2017-11-20 **New Features** -Release controlled documentation moved to / now managed in gerrit and published +Project release controlled documentation is now managed in gerrit and published on readthedocs. **Bug Fixes** @@ -27,9 +27,9 @@ on readthedocs. **Other** -The developer wiki still contains pages that are release dependent, should be -under change control in gerrit, and are being referenced from some gerrit change controlled documentation. The pages and links that remain to be migrated -are listed in <JIRA ISSUE> and by TBD tag or other indicator on the wiki. +The developer wiki still contains some pages that are referenced from the +readthedocs documentation. The pages and links that remain to be migrated +are listed in Jira Issue DOC-179 and labeled on the wiki with "move-to-rtd". =========== diff --git a/docs/release/index.rst b/docs/release/index.rst index c7dd5bb0c..bc4ee5674 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,12 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 +.. index:: Release Notes + Releases ======== -ONAP is developed and released around 6 month cycles. After an initial -major release, additional stable point releases may be created. The first -release is Amsterdam and subsequent major release will be named using city -names. +This page is the ONAP Amsterdam Release Notes. The first release is +Amsterdam and subsequent major release will be named using city names. + +* Release Name: Amsterdam +* Release Version: 1.0.0 +* Release Date: November 16, 2017 Amsterdam Release @@ -14,65 +18,179 @@ Amsterdam Release Summary +++++++ +ONAP provides a comprehensive platform for real-time, policy-driven +orchestration and automation of physical and virtual network functions +that will enable software, network, IT and cloud providers and developers +to rapidly automate new services and support complete life cycle management. +By unifying member resources, ONAP will accelerate the development of a +vibrant ecosystem around a globally shared architecture and implementation +for network automation–with an open standards focus–faster than any one +product could on its own. Functionality +++++++++++++ +**Portal** - a single, consistent user experience for both design timer +and run time environments, based on the user’s role. + +**Design Time Framework** - a comprehensive development environment with +tools, techniques, and repositories for defining/describing resources, +services, and products: + + - Service Design and Creation (SDC) provides tools, techniques, and + repositories to define/simulate/certify system assets as well as their + associated processes and policies. + + - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier + packaging and validation. + + - Policy Creation (POLICY) deals with conditions, requirements, + constraints, attributes, or needs that must be provided, maintained, + and/or enforced. + + - Closed Loop Automation Management Platform (CLAMP) provides a method + for designing and managing control loops. + +**Runtime Framework** - The runtime execution framework executes the +rules and policies distributed by the design and creation environment +and Controllers that manage resources corresponding to their assigned +controlled domain: + + - Service Orchestrator (SO) executes the specified processes and automates + sequences of activities, tasks, rules and policies needed for on-demand + creation, modification or removal of network, application or infrastructure + services and resources. + - Software Defined Network Controller (SDNC) network configuration of + cloud computing resources. + + - Application Controller (APPC) Application resources. + + - Virtual Function Controller (VF-C) provides an ETSI NFV compliant NFV-O + functions, and is responsible for life cycle management of virtual services + and the associated physical COTS server infrastructure. + + - Active and Available Inventory (A&AI) provides real-time views of a + system’s resources, services, products and their relationships with each + other. + +**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze > +Detect -> Publish -> Respond: + + - Data Collection, Analytics and Events (DCAE) collects performance, + usage, and configuration data and publishes information to policy, + orchestration, and the data lake. + + - “Holmes” provides alarm correlation and analysis for Telecom cloud + infrastructure and services, including hosts, vims, VNFs and NSs + + - Common Services - operational services for all ONAP components including + activity logging, reporting, common data layer, access control, resiliency, + and software lifecycle management. Project Specific Release Notes ++++++++++++++++++++++++++++++ -Major and stable point releases are specified by a list of project artifact -versions in a :ref:`manifest here<doc-release-manifest>`. -Each project provides detailed :ref:`release notes here <doc-releaserepos>` -and prepends to these if/when any updated versions, the project team believes -are compatible with major release, are made available. +ONAP releases are specified by a list of project artifact +versions in a :ref:`manifest<doc-release-manifest>`. +Each project provides detailed :ref:`release notes<doc-releaserepos>` +and prepends to these if/when any updated versions the project team believes +are compatible with a major release are made available. Supported Platforms +++++++++++++++++++ - +ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is +the only OS supported. Documentation +++++++++++++ -Release controlled documentation is available :ref:`here <master_index>`. +ONAP Amsterdam Release documentation is available :ref:`here <master_index>`. For Amsterdam this includes: -* A high level architecture view of how components delivered by all projects - relate to each other are :ref:`available here <doc-architecture>`. + * A high level :ref:`architecture view<doc-architecture>` of how components + relate to each other. -* A collection of documentation provided by each project and for some projects - several components / repositories within the project - are :ref:`available here <doc-repolist>`. + * A collection of documentation provided + by :ref:`each project <doc_onap-developer_guide_projects>`. -* Application Programming Interface Reference :ref:`available here <doc-apiref>` + * Application Programming Interface + Reference :ref:`available here <doc-apiref>`. -* The `developer wiki <http://wiki.onap.org>`_ remains a good source of - information on meeting plans and notes from committees, project teams, - community events and general, release independent information about - ONAP. Release dependent information is being migrated from the wiki to - gerrit source control. See the doc - project :ref:`release notes <doc-release-notes>` for current status. + * The `developer wiki <http://wiki.onap.org>`_ remains a good source of + information on meeting plans and notes from committees, project teams and + community events. Known Issues and Limitations ++++++++++++++++++++++++++++ -TBP overall / general statement -See :ref:`release notes <doc-releaserepos>` for each project. +Known Issues and limitations are documented in each project Release Notes. -License -+++++++ +Refer to :ref:`release notes <doc-releaserepos>` for each project. +.. index:: Licensing + +Licenses +++++++++ +ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_. +ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_. + +.. index:: Reporting Bugs + 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. + +.. index:: Download + +Download +++++++++ + +* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ . + +* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap . + + +.. index:: Installation + + +Install ++++++++ +There are 2 approaches to install ONAP. + +* From a complete demo solution perspective. This installs the whole ONAP, + refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`. + +* From a developer perspective. ONAP is installed component per component. + Each + component :ref:`installation is listed in<doc_onap-developer_guide_projects>`. + The list of ports used by default within ONAP is documented + in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_. +Usage ++++++ +This section is intended to provide users on the usage of ONAP components. -Download and Use -++++++++++++++++ +Instructions on using the ONAP deployment including Robot, Portal, SDC and VID +in the context of running (Onboarding, service creation, service deployment, +VNF creation, VNF preload, VF Module creation and closed loop operations) +the vFirewall sanity use case is documented +in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_. -* Source Code in Gerrit https://gerrit.onap.org -* Artifacts in Nexus / Docker Hub +.. Include files referenced by link in the toctree as hidden -* Platform :ref:`Demo <demo-installing-running-onap>`. +.. toctree:: + :hidden: + release-manifest.rst + releaserepos.rst + repolist.rst diff --git a/docs/release/release-manifest.rst b/docs/release/release-manifest.rst index a74fc721d..97838745b 100644 --- a/docs/release/release-manifest.rst +++ b/docs/release/release-manifest.rst @@ -2,6 +2,8 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Release Manifest + .. _doc-release-manifest: Release Manifest diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 7d445f922..2f736f978 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,29 +20,167 @@ 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/nfvparser/release-notes/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> - optf/has<../submodules/optf/has.git/docs/release-notes.rst> + +MultiVIM Cloud +-------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + multicloud/framework<../submodules/multicloud/framework.git/docs/Release Notes.rst> + +ONAP Operations Manager (experimental) +-------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/oom.git/docs/index/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> @@ -46,20 +188,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> @@ -77,5 +275,4 @@ Project Specific Release Notes sdnc/parent<../submodules/sdnc/parent.git/docs/release-notes.rst> sdnc/plugins<../submodules/sdnc/plugins.git/docs/release-notes.rst> oom<../submodules/oom.git/docs/release-notes.rst> - multicloud/framework<../submodules/multicloud/framework.git/docs/release-notes.rst> aaf/authz<../submodules/aaf/authz.git/docs/release-notes.rst> diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index a4fdebc59..ae8adcdec 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -3,6 +3,8 @@ Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Projects Providing Documentation + .. _doc-repolist: Project/Components @@ -17,7 +19,6 @@ Project/Components AAI External System Registration UI <../submodules/aai/esr-gui.git/docs/index> AAI External System Registration Server <../submodules/aai/esr-server.git/docs/index> AAI Sparky Inventory UI <../submodules/aai/sparky-be.git/docs/index> - AAI Sparky Inventory Service <../submodules/aai/sparky-fe.git/docs/index> ../submodules/appc/deployment.git/docs/index ../submodules/appc.git/docs/index CCSDK Dashboard <../submodules/ccsdk/dashboard.git/docs/index> @@ -76,3 +77,4 @@ Project/Components ../submodules/vnfrqts/guidelines.git/docs/index ../submodules/vnfrqts/requirements.git/docs/index VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index> + VVP Documentation <../submodules/vvp/documentation.git/docs/index> diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 85c7da158..000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,12 +0,0 @@ -tox -Sphinx==1.5.3 -doc8 -docutils -setuptools -six -sphinx_rtd_theme -sphinxcontrib-blockdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme>=0.4.11 diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject 352ed747897655097983945fe059dd9ac84e0ef +Subproject 443034182c2b9c6b53081a31b8c4ef1e15eb89d diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git -Subproject 180a93b00640885e39e37f28c95c1d5c4c36499 +Subproject 722f59e75b5e8d6b2f7ade57c00db8c4b9e7507 diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject 8bcb89b5c1b7acf62a6f87dabd8b5df9f4570b5 +Subproject 8330923db923414eef5413acb2ac977b39f7ca4 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject e209859ea9cef3e74ffce2be049705237a8500b +Subproject 5081f315711dcdba531a1ca0a91765445f0564f diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject c0101f1b7e98bd39d3b6ba16b7baacb57a4b0e8 +Subproject caa4598ad7a4b55f08e41b11d32f82b98d83a1e diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 8b022a066415d239f661213bf37fdc0c2718f76 +Subproject 0b434132494d98f5fa60409016c5fd1fcb82162 diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git -Subproject 9fea1c8b286fc0c37872b56662f541d1d6da90f +Subproject 38f9a17313fd5e2b60af17f51f04a8e34072ba7 diff --git a/docs/submodules/ccsdk/platform/nbapi.git b/docs/submodules/ccsdk/platform/nbapi.git -Subproject f948056df2a7c0eaf77cf87e86583caec116d40 +Subproject b10a7484f4bce80d9fa41953051977b54c28386 diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git -Subproject de5d4b4c2fa42066a0e5afca4a7ff6e3a101c6d +Subproject 1565be2e406cac067eebc9604f27f762124622c diff --git a/docs/submodules/ccsdk/sli/adaptors.git b/docs/submodules/ccsdk/sli/adaptors.git deleted file mode 160000 -Subproject 62c68af9f6dca99bf3a867e1bbcc008aa5603ae diff --git a/docs/submodules/ccsdk/sli/core.git b/docs/submodules/ccsdk/sli/core.git deleted file mode 160000 -Subproject bf966e65057f8239a8110025af33c1f6775529b diff --git a/docs/submodules/ccsdk/sli/northbound.git b/docs/submodules/ccsdk/sli/northbound.git deleted file mode 160000 -Subproject da99eed5436f92eb2b4794cc0399bdb0eb400af diff --git a/docs/submodules/ccsdk/sli/plugins.git b/docs/submodules/ccsdk/sli/plugins.git deleted file mode 160000 -Subproject 5abb631c6cb327eb420c6a61c0b98270c673f73 diff --git a/docs/submodules/ccsdk/storage/pgaas.git b/docs/submodules/ccsdk/storage/pgaas.git -Subproject 464f57c18c0bf4f599e2f294a31b93d737dfb82 +Subproject 84b497a7ced1328fa5d559e029647e55beab018 diff --git a/docs/submodules/ccsdk/utils.git b/docs/submodules/ccsdk/utils.git -Subproject d1bc529750385aefca8453ff97c86e282e9604e +Subproject 4588521e040bf27577a0c98db82d9809ef5a669 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 73f5f8ba2480fc8d45153f2845174e75b70bc01 +Subproject fd8cb97d1e0ade1f0a21f3a90e6d9d91562d378 diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject a093cd6ac4633505b67dfff1b3eeb7f1159773c +Subproject 59c0e4f513607e8363b9c9133a5043475d750a9 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject 4367b9df79a5fb12fd43658f370de23b3b56f33 +Subproject de4209833da37685f6f05a6732366e38dfadbed diff --git a/docs/submodules/dmaap/messagerouter/messageservice.git b/docs/submodules/dmaap/messagerouter/messageservice.git -Subproject 201409190e22128363178c94be43bb32c402188 +Subproject 919615c27f42dcd314679877aad41614b4b7978 diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject c8103b3d39394ba98a03a9938835a94ea8cbd3f +Subproject ea08755cd8354a8fe6f30a2797cb5bb3ccb63da diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git -Subproject 4ffb3501b062976124862ff929c41419894d186 +Subproject 6e600a30fdcc421ac7e4ca0d2989c29a3bb1f39 diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 071b81cf985c482bb0a38ca1c96491feefd1ec1 +Subproject 88655bc580098756b290d14e2f247fa0cb607ab diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject a4aeb668f0f2e936b1f613628a42ddeaae3bea1 +Subproject 02a454ac7e6b6bd4d827d9761e9d8a0908c23fc diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject 85c7b852eb07f63011562e26646c93b72b6d538 +Subproject 048f610c3bd896496fe488336ba689ed429b432 diff --git a/docs/submodules/modeling/toscaparsers.git b/docs/submodules/modeling/toscaparsers.git -Subproject 4a03e87e806b8db187b4b3111882094f11d16f2 +Subproject 3b4294c9f4f5df133bb7063e901629ebdef69f2 diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git -Subproject 84f80b1dcc9a3fabbbe39384e53b8dc9d9f5081 +Subproject 0902420a4bf3c5f7723bc60ced0aab2066b829c diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 9c7964ac0fd1230fd3ecc1d21fa07d15c47fa67 +Subproject 0cfd9d031bf80a39e6677291b3a407eefc40001 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject bfd703b9e3377ff26e2f1cb3c463c2ed385b47f +Subproject 9f870bea670b25d0b892d91736313f886379563 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 3898b1b9731035e4e2a37f0428a5f76355c0af1 +Subproject 5574639015d8316696a0964c6f2f842679e4bc3 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject e1356d767afc0510ed174992a9de2112faa35fa +Subproject 3b0029e2d987eede8af0a678bec44a33bbc7bec diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 12c3634e003a5a326e2192127e73606f71c80e8 +Subproject 3e54d3de51fa86255ca5059c59fd68aea0f5948 diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git -Subproject 540fa7f9202bef93be0c4523f4615d26dbdf86f +Subproject 20c644471a162abf72c7f10f47c45663c42de81 diff --git a/docs/submodules/sdnc/adaptors.git b/docs/submodules/sdnc/adaptors.git deleted file mode 160000 -Subproject d69f503c3231553405a4cbc7ab08f40c6f55bef diff --git a/docs/submodules/sdnc/architecture.git b/docs/submodules/sdnc/architecture.git deleted file mode 160000 -Subproject 2f0dca3d080e8c940be7a271423ec9cddc86a2e diff --git a/docs/submodules/sdnc/core.git b/docs/submodules/sdnc/core.git -Subproject c195cf39d0d782c2b017226edba58dc4da38ced +Subproject ebb2eb69d7b6fa80dbf228fc7fe365f9c71a8df diff --git a/docs/submodules/sdnc/features.git b/docs/submodules/sdnc/features.git deleted file mode 160000 -Subproject 6848b3186e75546797206985921b8f61aa18c10 diff --git a/docs/submodules/sdnc/northbound.git b/docs/submodules/sdnc/northbound.git deleted file mode 160000 -Subproject f9fa722e44042ae612d3a2103f355d619903497 diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 204da530ab853b8825c1acec5a68e11194bd24d +Subproject 65631026c8f90a2c24be8e7411882bb9599a3b8 diff --git a/docs/submodules/sdnc/parent.git b/docs/submodules/sdnc/parent.git deleted file mode 160000 -Subproject 4b1a1aa3b2015845abe5a2ebcd8f61542aae01b diff --git a/docs/submodules/sdnc/plugins.git b/docs/submodules/sdnc/plugins.git deleted file mode 160000 -Subproject 9a5f0571502661b29b435f07f58237ac1544de1 diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 8d496b4f1516d25e39bbd909cb7185e74a453cc +Subproject 5f8f48521c763419781fafd0db92f4763846c5b diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git -Subproject 1d585bf5da83e67d7f6b4b709c40dc596442e22 +Subproject b3521591069d1be86cab83c0b8533fc049a1a33 diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject d3301895be14050af777d279702d8d2e56e028f +Subproject a4cfab7c03a77d5809c0687aafa2a757270ca94 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 7b0cf6bcfba0c207fcd2062e36162804b00e50c +Subproject 80dde5e567e17128a09326a124e72bf25fe5ea7 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject ce389b5342e7614c5d79533b718710dc4b76e6b +Subproject 8c8ca82422c2acd2deee287a3d63b9d5fd0adaa diff --git a/docs/submodules/vnfrqts/guidelines.git b/docs/submodules/vnfrqts/guidelines.git -Subproject 5c116697b5f077711523e8857ffaf59af0ebcd9 +Subproject b8f216557afb06c59bfc2acbffb9f9abff7546b diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject 1926f89fdfe77475c2d119c51beaceae6da96cc +Subproject d4cf8e9d3a1cd454e023b0f160b174e3155706e diff --git a/docs/submodules/vnfsdk/model.git b/docs/submodules/vnfsdk/model.git -Subproject f07745d26fdb2b59748499c8a715d5892607a09 +Subproject 24d831b021d94ec504cad9a92e23476eb88b288 diff --git a/docs/templates/sections/apiexample/dcaecdap.rst b/docs/templates/sections/apiexample/dcaecdap.rst deleted file mode 100644 index 16dc2cf43..000000000 --- a/docs/templates/sections/apiexample/dcaecdap.rst +++ /dev/null @@ -1,662 +0,0 @@ -=============== -CDAP Broker API -=============== - -:Date: 2017-10-09 - -.. contents:: - :depth: 3 -.. - -Overview -======== - -Version information -------------------- - -*Version* : 4.0.10 - -Paths -===== - -GET / ------ - -Description -~~~~~~~~~~~ - -shows some information about this service - -Responses -~~~~~~~~~ - -+---------+--------------------------------------------+-------------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+============================================+===================+ -| **200** | successful response | `info <#_info>`__ | -+---------+--------------------------------------------+-------------------+ - -GET /application ----------------- - -Description -~~~~~~~~~~~ - -get all applications registered with this broker - -Responses -~~~~~~~~~ - -+---------+-------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+===========================================+===============+ -| **200** | successful response | `appname <#_a | -| | | ppname>`__ | -| | | (array) | -+---------+-------------------------------------------+---------------+ - -PUT /application/{appname} --------------------------- - -Description -~~~~~~~~~~~ - -(This is a hacky way of supporting "oneOf" because Swagger does not -support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. -This is the same endpoint as PUT /application/appname, except the PUT -body is different.) - -Register a hydrator app for service and configuration discovery. This -will light up a metrics and health endpoint for this app. ``appname`` is -assumed to also be the key in consul. - -Parameters -~~~~~~~~~~ - -+----------+---------------+---------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+=================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+---------------------------------+------------------+ -| **Body** | | **putbody** | required put body | `hydratorappput | -| | | *required* | | <#_hydratorapppu | -| | | | t>`__ | -+----------+---------------+---------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+===============+ -| **200** | Successful response | `application | -| | | <#_applicatio | -| | | n>`__ | -+---------+----------------------------------------------------+---------------+ -| **400** | put was performed but the appname was already | No Content | -| | registered with the broker, or Invalid PUT body | | -+---------+----------------------------------------------------+---------------+ - -Consumes -~~~~~~~~ - -- ``application/json`` - -Produces -~~~~~~~~ - -- ``application/json`` - -POST /application/delete ------------------------- - -Description -~~~~~~~~~~~ - -endpoint to delete multiple applications at once. Returns an array of -status codes, where statuscode[i] = response returned from -DELETE(application/i) - -Parameters -~~~~~~~~~~ - -+----------+----------------+------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+================+==============================+==================+ -| **Body** | | **postbody** | required post body | `multideleteput | -| | | *required* | | <#_multideletepu | -| | | | t>`__ | -+----------+----------------+------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------+-------------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+==============================================+===================+ -| **200** | successful response | `returncode | -| | | <#_returncode>`__ | -| | | (array) | -+---------+----------------------------------------------+-------------------+ - -GET /application/{appname} --------------------------- - -Description -~~~~~~~~~~~ - -Returns the representation of the application resource, including the -links for healthcheck and metrics. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+===============+ -| **200** | Successful response | `application | -| | | <#_applicatio | -| | | n>`__ | -+---------+----------------------------------------------------+---------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker. | | -+---------+----------------------------------------------------+---------------+ - -PUT /application/{appname} --------------------------- - -Description -~~~~~~~~~~~ - -Register an app for service and configuration discovery. This will light -up a metrics and health endpoint for this app. ``appname`` is assumed to -also be the key in consul. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+--------------------------------+------------------+ -| **Body** | | **putbody** | required put body | `appput <#_apppu | -| | | *required* | | t>`__ | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+--------------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+==================================================+===============+ -| **200** | Successful response | `Application | -| | | <#_applicatio | -| | | n>`__ | -+---------+--------------------------------------------------+---------------+ -| **400** | put was performed but the appname was already | No Content | -| | registered with the broker, or Invalid PUT body | | -+---------+--------------------------------------------------+---------------+ - -Consumes -~~~~~~~~ - -- ``application/json`` - -Produces -~~~~~~~~ - -- ``application/json`` - -DELETE /application/{appname} ------------------------------ - -Description -~~~~~~~~~~~ - -Remove an app for service and configuration discovery. This will remove -the metrics and health endpoints for this app. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response | No Content | -+---------+----------------------------------------------------+----------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker. | | -+---------+----------------------------------------------------+----------------+ - -GET /application/{appname}/healthcheck --------------------------------------- - -Description -~~~~~~~~~~~ - -Perform a healthcheck on the running app appname. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application to get | string (text) | -| | | *required* | the healthcheck for. | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response, healthcheck pass | No Content | -+---------+----------------------------------------------------+----------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker, or the healthcheck has failed (though I | | -| | would like to disambiguiate from the first case, | | -| | CDAP returns a 404 for this). | | -+---------+----------------------------------------------------+----------------+ - -GET /application/{appname}/metrics ----------------------------------- - -Description -~~~~~~~~~~~ - -Get live (real-time) app specific metrics for the running app appname. -Metrics are customized per each app by the component developer - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application to get | string (text) | -| | | *required* | metrics for. | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response | `MetricsObject | -| | | <#_metricsobje | -| | | ct>`__ | -+---------+----------------------------------------------------+----------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker. | | -+---------+----------------------------------------------------+----------------+ - -PUT /application/{appname}/reconfigure --------------------------------------- - -Description -~~~~~~~~~~~ - -Reconfigures the application. - -Parameters -~~~~~~~~~~ - -+----------+---------------+----------------------------+--------------------+ -| Type | Name | Description | Schema | -+==========+===============+============================+====================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+----------------------------+--------------------+ -| **Body** | | **putbody** | required put body | `reconfigput | -| | | *required* | | <#_reconfigput>`__ | -+----------+---------------+----------------------------+--------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response | No Content | -+---------+----------------------------------------------------+----------------+ -| **400** | Bad request. Can happen with 1) {appname} is not | No Content | -| | registered with the broker, 2) the required PUT | | -| | body is wrong, or 3) the smart interface was | | -| | chosen and none of the config keys match anything | | -| | in app\_config or app\_preferences | | -+---------+----------------------------------------------------+----------------+ - -Definitions -=========== - -Application ------------ - -+---------------------+---------------------------------------------+------------------+ -| Name | Description | Schema | -+=====================+=============================================+==================+ -| | **appname** | application name | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ -| | **connectionurl** | input URL that you can POST data into (URL | string | -| | *optional* | of the CDAP stream) | | -+---------------------+---------------------------------------------+------------------+ -| | **healthcheckurl**| fully qualified url to perform healthcheck | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ -| | **metricsurl** | fully qualified url to get metrics from | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ -| | **service | a list of HTTP services exposed by this | `service\_method | -| endpoints** | CDAP application | <#_service_metho | -| | *optional* | | d>`__ | -| | | (array) | -+---------------------+---------------------------------------------+------------------+ -| | **url** | fully qualified url of the resource | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ - -MetricsObject -------------- - -key,value object where the key is 'appmetrics' and the value is an app -dependent json and specified by the component developer - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **appmetrics** | object | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -appname -------- - -an application name - -*Type* : string - -appput ------- - -+-------------------------------+---------------------------------------------+--------------------+ -| Name | Description | Schema | -+===============================+=============================================+====================+ -| | **app\_config** | the application config JSON | object | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **app\_preferences** | the application preferences JSON | object | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **artifact\_name** | the name of the CDAP artifact to be added | string | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **cdap\_application\_type** | denotes whether this is a program-flowlet | enum | -| | *optional* | style application or a hydrator pipeline. | (program-flowlet | -| | For program-flowlet style apps, this value | ) | -| | must be "program-flowlet" | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **jar\_url** | the URL that the JAR you’re deploying | string | -| | *optional* | resides | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **namespace** | the cdap namespace this is deployed into | string | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **program\_preferences** | | `programpref | -| | *optional* | | <#_programpref>`__ | -| | | (array) | -+-------------------------------+---------------------------------------------+--------------------+ -| | **programs** | | `programs | -| | *optional* | | <#_programs>`__ | -| | | (array) | -+-------------------------------+---------------------------------------------+--------------------+ -| | **services** | | `service\_endpoint | -| | *optional* | | <#_service_endpoin | -| | | t>`__ (array) | -+-------------------------------+---------------------------------------------+--------------------+ -| | **streamname** | name of the CDAP stream to ingest data into | string | -| | *optional* | this app. Should come from the developer | | -| | and Tosca model. | | -+-------------------------------+---------------------------------------------+--------------------+ - -hydratorappput --------------- - -+-----------------------------------+---------------------------------------------+---------------+ -| Name | Description | Schema | -+===================================+=============================================+===============+ -| | **cdap\_application\_TYPE** | denotes whether this is a program-flowlet | enum | -| | style application or a hydrator pipeline. | (hydrator-pip | -| | *required* | For hydrator, this value must be | eline) | -| | "hydrator-pipeline" | | -+-----------------------------------+---------------------------------------------+---------------+ -| | **dependencies** | represents a list of dependencies to be | `hydratordep | -| | *optional* | loaded for this pipeline. Not required. | <#_hydratorde | -| | | p>`__ (array) | -+-----------------------------------+---------------------------------------------+---------------+ -| | **namespace** | the cdap namespace this is deployed into | string | -| | *required* | | | -+-----------------------------------+---------------------------------------------+---------------+ -| | **pipeline\_config\_json\_url** | the URL of the config.json for this | string | -| | *required* | pipeline | | -+-----------------------------------+---------------------------------------------+---------------+ -| | **streamname** | name of the CDAP stream to ingest data into | string | -| | *required* | this app. Should come from the developer | | -| | and Tosca model. | | -+-----------------------------------+---------------------------------------------+---------------+ - -hydratordep ------------ - -represents a hydrator pipeline dependency. An equivalent to the -following CURLs are formed with the below four params shown in CAPS:: - - curl -v -w"\\n" -X POST - http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME - -H "Artifact-Extends:ARTIFACT\_EXTENDS\_HEADER" -H - “Artifact-Version:ARTIFACT\_VERSION\_HEADER” –data-binary @(DOWNLOADED - FROM ARTIFACT\_URL)","curl -v -w"\\n" -X PUT - http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties - -d (DOWNLOADED FROM UI\_PROPERTIES\_URL)" - -+---------------------------------+---------------------------------------------+----------+ -| Name | Description | Schema | -+=================================+=============================================+==========+ -| | **artifact\_extends\_header** | the value of the header that gets passed in | string | -| | *required* | for artifact-extends, e.g., | | -| | "Artifact-Extends:system:cdap-data-pipeline | | -| | [4.0.1,5.0.0)" | | -+---------------------------------+---------------------------------------------+----------+ -| | **artifact\_name** | the name of the artifact | string | -| | *required* | | | -+---------------------------------+---------------------------------------------+----------+ -| | **artifact\_url** | the URL of the artifact JAR | string | -| | *required* | | | -+---------------------------------+---------------------------------------------+----------+ -| | **artifact\_version\_header** | the value of the header that gets passed in | string | -| | *required* | for artifact-version, e.g., | | -| | "Artifact-Version:1.0.0-SNAPSHOT" | | -+---------------------------------+---------------------------------------------+----------+ -| | **ui\_properties\_url** | the URL of the properties.json if the | string | -| | *optional* | custom artifact has UI properties. This is | | -| | optional. | | -+---------------------------------+---------------------------------------------+----------+ - -info ----- - -some broker information - -+------------------+---------------------------------------------+-----------+ -| Name | Description | Schema | -+==================+=============================================+===========+ -| | **broker API | the API version of this running broker | string | -| version** | | | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ -| | **cdap GUI | The GUI port of the CDAP cluster this | integer | -| port** | broker is managing. Mostly to help users of | | -| | *optional* | this API check their application in cdap. | | -| | Note, will return UNKNOWN\_CDAP\_VERSION if | | -| | it cannot be determined. | | -+------------------+---------------------------------------------+-----------+ -| | **cdap | the version of the CDAP cluster this broker | string | -| cluster | is managing. Note, will return | | -| version** | UKNOWN\_CDAP\_VERSION if it cannot be | | -| | *optional* | determined. | | -+------------------+---------------------------------------------+-----------+ -| | **managed cdap | the url of the CDAP cluster API this broker | string | -| url** | is managing | | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ -| | **number | | integer | -| of applications | | | -| registered** | | | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ -| | **uptime (s)** | | integer | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ - -multideleteput --------------- - -+--------------------------------+----------------------------------+ -| Name | Schema | -+================================+==================================+ -| | **appnames** | `appname <#_appname>`__ (array) | -| | *optional* | | -+--------------------------------+----------------------------------+ - -programpref ------------ - -the list of programs in this CDAP app - -+--------------+---------------------------------------------+----------+ -| Name | Description | Schema | -+==============+=============================================+==========+ -| | **program\ | the name of the program | string | -| _id** | | | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ -| | **program_ | the preference JSON to set for this program | object | -| \pref** | | | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ -| | **program\ | must be one of flows, mapreduce, schedules, | string | -| _type** | spark, workflows, workers, or services | | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ - -programs --------- - -the list of programs in this CDAP app - -+--------------+---------------------------------------------+-----------+ -| Name | Description | Schema | -+==============+=============================================+===========+ -| | **program\ | the name of the program | string | -| _id** | | | -| | *optional* | | | -+--------------+---------------------------------------------+-----------+ -| | **program\ | must be one of flows, mapreduce, schedules, | string | -| _type** | spark, workflows, workers, or services | | -| | *optional* | | | -+--------------+---------------------------------------------+-----------+ - -reconfigput ------------ - -+-----------------------------+-----------------------------+------------------+ -| Name | Description | Schema | -+=============================+=============================+==================+ -| | **config** | the config JSON | object | -| | *required* | | | -+-----------------------------+-----------------------------+------------------+ -| | **reconfiguration\_type** | the type of reconfiguration | enum | -| | *required* | | (program-flowlet | -| | | -app-config, | -| | | program-flowlet- | -| | | app-preferences, | -| | | program-flowlet- | -| | | smart) | -+-----------------------------+-----------------------------+------------------+ - -returncode ----------- - -an httpreturncode - -*Type* : integer - -service\_endpoint ------------------ - -descirbes a service endpoint, including the service name, the method -name, and the method type (GET, PUT, etc, most of the time will be GET) - -+--------------------------+-----------------------------------------+---------+ -| Name | Description | Schema | -+==========================+=========================================+=========+ -| | **endpoint\_method** | GET, POST, PUT, etc | string | -| | *optional* | | | -+--------------------------+-----------------------------------------+---------+ -| | **service\ _endpoint** | the name of the endpoint on the service | string | -| | *optional* | | | -+--------------------------+-----------------------------------------+---------+ -| | **service\_name** | the name of the service | string | -| | *optional* | | | -+--------------------------+-----------------------------------------+---------+ - -service\_method ---------------- - -a URL and HTTP method exposed via a CDAP service - -+--------------+---------------------------------------------+----------+ -| Name | Description | Schema | -+==============+=============================================+==========+ -| | **method** | HTTP method you can perform on the URL, | string | -| | *optional* | e.g., GET, PUT, etc | | -+--------------+---------------------------------------------+----------+ -| | **url** | the fully qualified URL in CDAP for this | string | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ diff --git a/docs/templates/sections/apiexample/swagger2markup.rst b/docs/templates/sections/apiexample/swagger2markup.rst deleted file mode 100644 index b83bd4d96..000000000 --- a/docs/templates/sections/apiexample/swagger2markup.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - -Swagger2Markup(asciidoc) to Asciidoctor(docbook) to Pandoc(RST) -=============================================================== - -vfc-nfvo-lcm ------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - vfcexample.rst - - -DCAE and YAML intput --------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - dcaecdap.rst diff --git a/docs/templates/sections/apiexample/swaggerv2doc.rst b/docs/templates/sections/apiexample/swaggerv2doc.rst deleted file mode 100644 index a0f13e061..000000000 --- a/docs/templates/sections/apiexample/swaggerv2doc.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - - -Sphinx swaggerv2doc directive ------------------------------ -Here is an example of vfc-nfvo-lcm API. - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json - - diff --git a/docs/templates/sections/apiexample/vfcexample.rst b/docs/templates/sections/apiexample/vfcexample.rst deleted file mode 100644 index 71d3b7814..000000000 --- a/docs/templates/sections/apiexample/vfcexample.rst +++ /dev/null @@ -1,768 +0,0 @@ -================================================= -ONAP VFC Network Service Lifecycle Management API -================================================= - -:Date: 2017-10-09 - -.. contents:: - :depth: 3 -.. - -Overview -======== - -VFC Network Service Lifecycle Management Rest API. - -Version information -------------------- - -*Version* : 1.0.0 - -Contact information -------------------- - -| *Contact* : ONAP VFC team -| *Contact Email* : onap-discuss@lists.onap.org - -URI scheme ----------- - -| *BasePath* : /api/nslcm/v1 -| *Schemes* : HTTP, HTTPS - -Consumes --------- - -- ``application/json`` - -Produces --------- - -- ``application/json`` - -Paths -===== - -jobstatus ---------- - -:: - - GET /jobs/{jobId} - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Path* | | **jobId** | job Id | string | -| * | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ -| **Query | | **respons | job response message id | string | -| ** | eId** | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+-------------------------+--------------------------------------------------+ -| HTTP Code | Schema | -+=========================+==================================================+ -| **202** | `JobDetailInfo <#_jobdetailinfo>`__ | -+-------------------------+--------------------------------------------------+ - -Tags -~~~~ - -- job - -ns create ---------- - -:: - - POST /ns - -Description -~~~~~~~~~~~ - -ns create - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Body* | | **NSCreat | NS Instance Create Request | `NsCreateRequest | -| * | eRequest** | | <#_nscreaterequ | -| | | *required | | est>`__ | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | successful operation | `NsCreateRespo | -| | | nse <#_nscreat | -| | | eresponse>`__ | -+---------+----------------------------------------------------+----------------+ -| **404** | URL not found | No Content | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns get ------- - -:: - - GET /ns - -Description -~~~~~~~~~~~ - -ns get - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Query | | **csarId* | job response message id | string | -| ** | * | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | successful operation | `NsInstancesIn | -| | | fo <#_nsinstan | -| | | cesinfo>`__ | -+---------+----------------------------------------------------+----------------+ -| **404** | URL not found | No Content | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns Instantiate --------------- - -:: - - POST /ns/{nsInstanceId}/Instantiate - -Description -~~~~~~~~~~~ - -ns Instantiate - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Path* | | **nsInsta | | string | -| * | nceId** | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ -| **Body* | | **NSInsta | NS Instantiate Request Body | `NsInstantiateRe | -| * | ntiateReque | | quest <#_nsinsta | -| | st** | | ntiaterequest>`_ | -| | | *required | | _ | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | | `JobInfo <#_jo | -| | | binfo>`__ | -+---------+----------------------------------------------------+----------------+ -| **201** | Invalid Request | No Content | -+---------+----------------------------------------------------+----------------+ -| **404** | URL not found | No Content | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns scale --------- - -:: - - POST /ns/{nsInstanceId}/scale - -Description -~~~~~~~~~~~ - -ns scale - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Path* | | **nsInsta | | string | -| * | nceId** | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ -| **Body* | | **ScaleNS | Scale NS Request Body | `NsScaleRequest | -| * | Request** | | <#_nsscalereques | -| | | *required | | t>`__ | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | | `JobInfo <#_jo | -| | | binfo>`__ | -+---------+----------------------------------------------------+----------------+ -| **201** | Invalid Request | No Content | -+---------+----------------------------------------------------+----------------+ -| **404** | URL not found | No Content | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns get ------- - -:: - - GET /ns/{ns_instance_id} - -Description -~~~~~~~~~~~ - -ns get - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | successful operation | `NsInstanceInf | -| | | o <#_nsinstanc | -| | | einfo>`__ | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns delete ---------- - -:: - - DELETE /ns/{ns_instance_id} - -Description -~~~~~~~~~~~ - -ns delete - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Path* | | **ns\_ins | Identifier of the NS instance. | string | -| * | tance\_id** | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **204** | The NS instance resource and the associated NS | No Content | -| | identifier were deleted successfully. | | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns heal -------- - -:: - - POST /ns/{ns_instance_id}/heal - -Description -~~~~~~~~~~~ - -ns heal - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Path* | | **ns\_ins | Identifier of the NS instance. | string | -| * | tance\_id** | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ -| **Body* | | **healVnf | healVnfData | `NsHealRequest < | -| * | Data** | | #_nshealrequest> | -| | | *required | | `__ | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **202** | | `JobInfo <#_jo | -| | | binfo>`__ | -+---------+----------------------------------------------------+----------------+ -| **404** | URL not found | No Content | -+---------+----------------------------------------------------+----------------+ -| **500** | the url is invalid | No Content | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -ns terminate ------------- - -:: - - POST /ns/{ns_instance_id}/terminate - -Description -~~~~~~~~~~~ - -ns terminate - -Parameters -~~~~~~~~~~ - -+---------+-------------+--------------------------------------+------------------+ -| Type | Name | Description | Schema | -+=========+=============+======================================+==================+ -| **Path* | | **ns\_ins | Identifier of the NS instance. | string | -| * | tance\_id** | | | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ -| **Body* | | **NsTermi | NsTerminateRequest | `NsTerminateRequ | -| * | nateRequest | | est <#_nstermina | -| | ** | | terequest>`__ | -| | | *required | | | -| | * | | | -+---------+-------------+--------------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **202** | | `JobInfo <#_jo | -| | | binfo>`__ | -+---------+----------------------------------------------------+----------------+ -| **500** | the url is invalid | No Content | -+---------+----------------------------------------------------+----------------+ - -Tags -~~~~ - -- ns - -Definitions -=========== - -JobDetailInfo -------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **jobId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **responseDescriptor** | `responseDescriptor <#_jobdetailinfo_resp | -| | *optional* | onsedescriptor>`__ | -+--------------------------------+-------------------------------------------+ - -**responseDescriptor** - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **errorCode** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **progress** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **responseHistoryList** | < `jobResponseInfo <#_jobresponseinfo>`__ | -| | *optional* | > array | -+--------------------------------+-------------------------------------------+ -| | **responseId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **status** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **statusDescription** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -JobInfo -------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **jobId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -LocationConstraint ------------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **locationConstraints** | `locationConstraints <#_locationconstrain | -| | *optional* | t_locationconstraints>`__ | -+--------------------------------+-------------------------------------------+ -| | **vnfProfileId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -**locationConstraints** - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **vimid** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsCreateRequest ---------------- - -+-------------+---------------------------------------------+------------------+ -| Name | Description | Schema | -+=============+=============================================+==================+ -| | **csarId* | the NS package ID | string | -| * | | | -| | *optional | | | -| * | | | -+-------------+---------------------------------------------+------------------+ -| | **descrip | | string | -| tion** | | | -| | *optional | | | -| * | | | -+-------------+---------------------------------------------+------------------+ -| | **nsName* | | string | -| * | | | -| | *optional | | | -| * | | | -+-------------+---------------------------------------------+------------------+ - -NsCreateResponse ----------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **nsInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsHealRequest -------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **additionalParams** | `additionalParams <#_nshealrequest_additi | -| | *optional* | onalparams>`__ | -+--------------------------------+-------------------------------------------+ -| | **cause** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnfInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -**additionalParams** - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **action** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **actionvminfo** | `actionvminfo <#_nshealrequest_actionvmin | -| | *optional* | fo>`__ | -+--------------------------------+-------------------------------------------+ - -**actionvminfo** - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **vmid** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vmname** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsInstanceInfo --------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **description** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **nsInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **nsName** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **nsState** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **nsdId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vlInfo** | < `vlInfo <#_vlinfo>`__ > array | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnfInfo** | < `vnfInfo <#_vnfinfo>`__ > array | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnffgInfo** | < `vnffgInfo <#_vnffginfo>`__ > array | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsInstancesInfo ---------------- - -*Type* : < `NsInstanceInfo <#_nsinstanceinfo>`__ > array - -NsInstantiateRequest --------------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **LocationConstraints** | < | -| | *optional* | `LocationConstraint <#_locationconstraint | -| | >`__ | -| | > array | -+--------------------------------+-------------------------------------------+ -| | **additionalParamForNs** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsScaleByStepsData ------------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **aspectId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **numberOfSteps** | integer | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **scalingDirection** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsScaleRequest --------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **scaleNsByStepsData** | `NsScaleByStepsData <#_nsscalebystepsdata | -| | *optional* | >`__ | -+--------------------------------+-------------------------------------------+ -| | **scaleType** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -NsTerminateRequest ------------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **gracefulTerminationTimeout | string | -| ** | | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **terminationType** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -cpInfo ------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **cpInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **cpInstanceName** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **cpdId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -jobResponseInfo ---------------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **errorCode** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **progress** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **responseId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **status** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **statusDescription** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -vlInfo ------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **relatedCpInstanceId** | < `cpInfo <#_cpinfo>`__ > array | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vlInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vlInstanceName** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vldId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -vnfInfo -------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **vnfInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnfInstanceName** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnfdId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -vnffgInfo ---------- - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **cpId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **nfp** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **pnfId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **virtualLinkId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnfId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ -| | **vnffgInstanceId** | string | -| | *optional* | | -+--------------------------------+-------------------------------------------+ diff --git a/docs/templates/sections/apiexample/worddoc2rst.rst b/docs/templates/sections/apiexample/worddoc2rst.rst deleted file mode 100644 index 2e1f8148c..000000000 --- a/docs/templates/sections/apiexample/worddoc2rst.rst +++ /dev/null @@ -1,11 +0,0 @@ - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Word Document Converted to RST ------------------------------- -This is an example of an APPC API Guide. - -.. toctree:: - :maxdepth: 1 - - ../../../submodules/appc.git/docs/APPC API Guide/APPC API Guide diff --git a/docs/templates/sections/offeredapis.rst b/docs/templates/sections/offeredapis.rst index f5032b4cc..23504c1da 100644 --- a/docs/templates/sections/offeredapis.rst +++ b/docs/templates/sections/offeredapis.rst @@ -12,14 +12,3 @@ Offered APIs * This note must be removed after content has been added. - - -Here are several examples: - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - apiexample/swaggerv2doc.rst - apiexample/swagger2markup.rst - apiexample/worddoc2rst.rst diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 000000000..d65278abe --- /dev/null +++ b/readthedocs.yml @@ -0,0 +1,7 @@ +# Formats in addition to HTML + +formats: + - none + +# Pip requirements +requirements_file: etc/requirements.txt @@ -10,6 +10,16 @@ commands = echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo +[testenv:local] +deps = -r{toxinidir}/etc/requirements.txt +commands = + git submodule update --depth 1 --init + sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = + echo + git + [testenv:docs-linkcheck] deps = -r{toxinidir}/etc/requirements.txt commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |