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
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
url = ../modeling/toscaparsers
branch = .
ignore = dirty
+[submodule "docs/submodules/vvp/documentation.git"]
+ path = docs/submodules/vvp/documentation.git
+ url = ../vvp/documentation
+ branch = .
+ ignore = dirty
+[submodule "docs/submodules/aai/event-client.git"]
+ path = docs/submodules/aai/event-client.git
+ url = ../aai/event-client
+[submodule "docs/submodules/ui/dmaapbc.git"]
+ path = docs/submodules/ui/dmaapbc.git
+ url = ../ui/dmaapbc
+ branch = .
+ ignore = dirty
+[submodule "docs/submodules/optf/osdf.git"]
+ path = docs/submodules/optf/osdf.git
+ url = ../optf/osdf
+ branch = .
+ ignore = dirty
+[submodule "docs/submodules/dmaap/datarouter.git"]
+ path = docs/submodules/dmaap/datarouter.git
+ url = ../dmaap/datarouter
+[submodule "docs/submodules/dmaap/dbcapi.git"]
+ path = docs/submodules/dmaap/dbcapi.git
+ url = ../dmaap/dbcapi
--- /dev/null
+---
+project: 'doc'
+project_creation_date: '2017-06-14'
+lifecycle_state: 'Incubation'
+project_lead: &onap_releng_ptl
+ name: 'Greg Glover'
+ email: 'gg2147@att.com'
+ id: 'gglover'
+ company: 'ATT'
+ timezone: 'America/Chicago'
+primary_contact: *onap_releng_ptl
+issue_tracking:
+ type: 'jira'
+ url: 'https://jira.onap.org/projects/DOC'
+ key: 'DOC'
+meetings:
+ - type: 'zoom'
+ agenda: ''
+ url: 'https://wiki.onap.org/x/dZlk'
+ server: 'n/a'
+ channel: 'n/a'
+ repeats: 'weekly'
+ time: '14:00 UTC'
+committers:
+ - <<: *onap_releng_ptl
+ - name: 'Jun (Nicolas) Hu'
+ email: 'jh245g@att.com'
+ company: 'ATT'
+ id: 'jh245g'
+ timezone: 'America/New York'
+ - name: 'Rich Bennett'
+ email: 'rb2745@att.com'
+ company: 'ATT'
+ id: 'rb2745'
+ timezone: 'America/New York'
+ - name: 'Steven Wright'
+ email: 'sw3588@att.com'
+ company: 'ATT'
+ id: 'wombat123'
+ timezone: 'America/Atlanta'
+tsc:
+ approval: 'https://lists.onap.org/pipermail/onap-tsc'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
-#
# The short X.Y version.
-version = 'Latest'
+version = 'master branch'
# The full version, including alpha/beta/rc tags.
-release = 'Latest'
+release = 'master branch'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
- 'submodules/so.git/aria/multivim-plugin/',
'_build'
]
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: API Reference
+
.. _doc-apiref:
REST API Reference
:maxdepth: 1
:titlesonly:
- VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/vnfsdk-apis.rst>
+ VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: Platform Architecture
+
.. _doc-architecture:
Architecture
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-Introducing the ONAP Architecture (Amsterdam Release)
+Introducing the ONAP Architecture (Beijing Release)
=====================================================
Introduction
- The architecture shall support elastic scaling as needs grow or
shrink
-|image0|\
+|image0|\
**Figure 1:** ONAP Platform
and policies (including recipes for corrective/remedial action) using
the ONAP Design Framework Portal.
-|image1|\
+|image1|\
-**Figure 2:** ONAP Platform components (Amsterdam Release)
+**Figure 2:** ONAP Platform components (Beijing Release)
Portal
++++++
a Security Framework. These components use common services that support
logging, access control, and data management.
-Orchestration
+Orchestration
+++++++++++++
The Service Orchestrator (SO) component executes the
restoration and recovery. They support standardized VNF interfaces and
guidelines.
-Operating in a virtualized environment introduces new security challenges
+Operating in a virtualized environment introduces new security challenges
and opportunities. ONAP provides increased security by embedding access controls
-in each ONAP platform component, augmented by analytics and policy components
+in each ONAP platform component, augmented by analytics and policy components
specifically designed for the detection and mitigation of security violations.
-Amsterdam Use Cases
+Beijing 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:
+For the first release of ONAP (“Beijing”), we introduce two use cases:
vCPE and VoLTE.
\ **Virtual CPE Use Case**
**Voice over LTE (VoLTE) Use Case**
-The second use case developed with Amsterdam is Voice over LTE. This use
+The second use case developed with Beijing is Voice over LTE. This use
case demonstrates how a Mobile Service Provider (SP) could deploy VoLTE
services based on SDN/NFV. The SP is able to onboard the service via
ONAP. Specific sub-use cases are:
.. 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
Integration
-----------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/integration.git/docs/index
+* ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`.
+* To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
Logging Enhancements Project
----------------------------
../../../submodules/cli.git/docs/index
+ONAP Operations Manager (experimental)
+--------------------------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ ../../../submodules/oom.git/docs/index
ONAP Use Case User Interface
----------------------------
This line will be shown only in html version.
-.. index:: single: indices
-
Creating Indices
----------------
integrated for each release. Other ONAP projects will provide
content that is referenced from this structure.
-.. index:: master
::
RST file changes in the top level docs directory and below.
-.. index:: licensing
Licensing
---------
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ width="245.00406mm"
+ height="55.2243mm"
+ viewBox="0 0 245.00405 55.2243"
+ version="1.1"
+ id="svg8"
+ inkscape:version="0.92.1 r15371"
+ sodipodi:docname="git_branches.svg"
+ inkscape:export-filename="/home/edby8475/Documents/Projets_Orange/ONAP/git_branches.png"
+ inkscape:export-xdpi="96"
+ inkscape:export-ydpi="96">
+ <defs
+ id="defs2">
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker8537"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path8535"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker7039"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend"
+ inkscape:collect="always">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ id="path7037"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker5938"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ id="path5936"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker5459"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ id="path5457"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lend"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path4715"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ </defs>
+ <sodipodi:namedview
+ id="base"
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1.0"
+ inkscape:pageopacity="0.0"
+ inkscape:pageshadow="2"
+ inkscape:zoom="0.7"
+ inkscape:cx="309.86346"
+ inkscape:cy="-20.987063"
+ inkscape:document-units="mm"
+ inkscape:current-layer="layer1"
+ showgrid="true"
+ inkscape:window-width="1680"
+ inkscape:window-height="986"
+ inkscape:window-x="0"
+ inkscape:window-y="27"
+ inkscape:window-maximized="1"
+ fit-margin-top="0"
+ fit-margin-left="0"
+ fit-margin-right="0"
+ fit-margin-bottom="0">
+ <inkscape:grid
+ type="xygrid"
+ id="grid10"
+ units="cm"
+ spacingx="2"
+ spacingy="2"
+ originx="91.41838"
+ originy="-115.8675" />
+ </sodipodi:namedview>
+ <metadata
+ id="metadata5">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+ <dc:title></dc:title>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g
+ inkscape:label="Calque 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(91.418392,-125.9082)">
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 149.99999,157 h -240"
+ id="path3682"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ inkscape:connector-curvature="0"
+ id="path3693"
+ d="m -50.000022,157 -10,-10 h 1.2e-5 l -10,10"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ sodipodi:nodetypes="cccc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 20.000002,157 -10,-10 h -50 l -10,10"
+ id="path3695"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cccc" />
+ <path
+ inkscape:connector-curvature="0"
+ id="path3697"
+ d="m 10.000002,147.05417 -10.02863,-10 h -19.911584 l -10.059786,10"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ sodipodi:nodetypes="cccc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 149.99999,167 h -90 l -10,-10"
+ id="path3699"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccc" />
+ <path
+ inkscape:connector-curvature="0"
+ id="path3701"
+ d="m 50.000002,157 -10,-10 h -10 l -10,10"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ sodipodi:nodetypes="cccc" />
+ <circle
+ id="path3709"
+ cx="-156.91447"
+ cy="-70.053894"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-172.98799"
+ y="48.645218"
+ id="text3713"
+ transform="rotate(-45)"><tspan
+ sodipodi:role="line"
+ id="tspan3711"
+ x="-172.98799"
+ y="48.645218"
+ style="font-size:2.82222223px;stroke-width:0.26458332">Master</tspan></text>
+ <circle
+ r="2.5"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ cy="-60.43219"
+ cx="-147.15913"
+ id="circle3715"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ cy="-49.718792"
+ cx="-157.04811"
+ id="circle3719"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ cy="-39.963455"
+ cx="-147.15913"
+ id="circle3721"
+ transform="rotate(-90)" />
+ <circle
+ id="circle3723"
+ cx="-147.15913"
+ cy="-30.341751"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ cy="-20.051872"
+ cx="-137.03445"
+ id="circle3725"
+ transform="rotate(-90)" />
+ <circle
+ id="circle3727"
+ cx="-147.15913"
+ cy="-10.029264"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ cy="0.39425087"
+ cx="-137.03445"
+ id="circle3729"
+ transform="rotate(-90)" />
+ <circle
+ id="circle3731"
+ cx="-147.15913"
+ cy="10.015955"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ cy="20.172205"
+ cx="-157.0481"
+ id="circle3733"
+ transform="rotate(-90)" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-151.95352"
+ y="57.447376"
+ id="text3713-3"
+ transform="rotate(-45)"><tspan
+ sodipodi:role="line"
+ id="tspan3711-6"
+ x="-151.95352"
+ y="57.447376"
+ style="font-size:2.82222223px;stroke-width:0.26458332">Feature1</tspan></text>
+ <text
+ transform="rotate(-45)"
+ id="text3765"
+ y="71.835785"
+ x="-137.57268"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ y="71.835785"
+ x="-137.57268"
+ id="tspan3763"
+ sodipodi:role="line">Feature2</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-127.77207"
+ y="78.916374"
+ id="text3769"
+ transform="rotate(-45)"><tspan
+ sodipodi:role="line"
+ x="-127.77207"
+ y="78.916374"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ id="tspan3775">enhanced feature2</tspan></text>
+ <circle
+ id="circle3779"
+ cx="-167.0166"
+ cy="59.71204"
+ style="fill:#008000;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ id="circle3781"
+ cx="-147.15913"
+ cy="30.178896"
+ style="fill:#ff0000;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#ff0000;stroke:#000000;stroke-width:0.33072913"
+ cy="40.195267"
+ cx="-147.15913"
+ id="circle3783"
+ transform="rotate(-90)" />
+ <text
+ transform="rotate(-45)"
+ id="text3787"
+ y="121.33652"
+ x="-87.108055"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan3785"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ y="121.33652"
+ x="-87.108055"
+ sodipodi:role="line">bugfix1</tspan></text>
+ <path
+ sodipodi:nodetypes="cccc"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 79.99999,157 -10,-10 h 1.2e-5 l -20,10"
+ id="path3800"
+ inkscape:connector-curvature="0" />
+ <circle
+ r="2.5"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ cy="69.971039"
+ cx="-147.15913"
+ id="circle3802"
+ transform="rotate(-90)" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-59.193871"
+ y="149.89697"
+ id="text3808"
+ transform="rotate(-45)"><tspan
+ sodipodi:role="line"
+ x="-59.193871"
+ y="149.89697"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ id="tspan3806">feature3</tspan></text>
+ <path
+ inkscape:connector-curvature="0"
+ id="path3833"
+ d="m 99.99999,157 -10,-10 h 1.2e-5 l -10,10"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ sodipodi:nodetypes="cccc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 99.99999,167 -10,-20"
+ id="path3856"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <circle
+ id="circle3835"
+ cx="-147.15913"
+ cy="90.082069"
+ style="fill:#ff0000;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <text
+ transform="rotate(-45)"
+ id="text3841"
+ y="164.13176"
+ x="-45.183849"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan3839"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ y="164.13176"
+ x="-45.183849"
+ sodipodi:role="line">bugfix2</tspan></text>
+ <circle
+ id="circle3798"
+ cx="-157.0481"
+ cy="49.839127"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ id="circle3819"
+ cx="-157.31537"
+ cy="79.662285"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#008000;stroke:#000000;stroke-width:0.33072913"
+ cy="100.02003"
+ cx="-167.09488"
+ id="circle3854"
+ transform="rotate(-90)" />
+ <path
+ inkscape:connector-curvature="0"
+ id="path3858"
+ d="m 130.05422,157 -10,-10 h -10 l -10.05423,10"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ sodipodi:nodetypes="cccc" />
+ <circle
+ id="circle3860"
+ cx="-147.15913"
+ cy="110.10485"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#d45500;stroke:#000000;stroke-width:0.33072913"
+ cy="120.12096"
+ cx="-147.15913"
+ id="circle3862"
+ transform="rotate(-90)" />
+ <text
+ transform="rotate(-45)"
+ id="text3866"
+ y="178.45798"
+ x="-31.003382"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan3864"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ y="178.45798"
+ x="-31.003382"
+ sodipodi:role="line">feature4</tspan></text>
+ <circle
+ id="circle3868"
+ cx="-156.91447"
+ cy="130.27434"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ r="2.5"
+ transform="rotate(-90)" />
+ <path
+ sodipodi:nodetypes="ccc"
+ inkscape:connector-curvature="0"
+ id="path3870"
+ d="m 150.05422,177 h -10 l -10,-20"
+ style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+ <circle
+ r="2.5"
+ style="fill:#008000;stroke:#000000;stroke-width:0.33072913"
+ cy="139.66118"
+ cx="-176.98384"
+ id="circle3872"
+ transform="rotate(-90)" />
+ <circle
+ r="2.5"
+ style="fill:#0000ff;stroke:#000000;stroke-width:0.33072913"
+ cy="100.02017"
+ cx="-156.91447"
+ id="circle3843"
+ transform="rotate(-90)" />
+ <text
+ id="text3876"
+ y="165.63252"
+ x="63.213688"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan3874"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ y="165.63252"
+ x="63.213688"
+ sodipodi:role="line">stable/A</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="142.27473"
+ y="174.96959"
+ id="text3880"><tspan
+ sodipodi:role="line"
+ x="142.27473"
+ y="174.96959"
+ style="font-size:2.82222223px;stroke-width:0.26458332"
+ id="tspan3878">stable/B</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="6.8720784"
+ y="167.3783"
+ id="text3903"><tspan
+ sodipodi:role="line"
+ id="tspan3901"
+ x="6.8720784"
+ y="167.3783"
+ style="font-size:3.52777767px;stroke-width:0.26458332">Stable branch creation</tspan></text>
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26499999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow1Lend)"
+ d="M 6.4666547,169 H 48.46666 l 6.000001,-6"
+ id="path3905"
+ inkscape:connector-curvature="0" />
+ <text
+ id="text5453"
+ y="172.20334"
+ x="56.934578"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="font-size:3.52777767px;stroke-width:0.26458332"
+ y="172.20334"
+ x="56.934578"
+ id="tspan5451"
+ sodipodi:role="line">cherry pick bugfix2</tspan></text>
+ <path
+ inkscape:connector-curvature="0"
+ id="path5455"
+ d="m 57.649986,173.82498 h 34 l 4.350004,-14"
+ style="fill:none;stroke:#000000;stroke-width:0.26499999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker5459)"
+ sodipodi:nodetypes="ccc" />
+ <text
+ id="text5932"
+ y="179.3783"
+ x="88.459633"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="font-size:3.52777767px;stroke-width:0.26458332"
+ y="179.3783"
+ x="88.459633"
+ id="tspan5930"
+ sodipodi:role="line">Stable branch creation</tspan></text>
+ <path
+ inkscape:connector-curvature="0"
+ id="path5934"
+ d="m 88.05421,181 h 42 l 6,-10"
+ style="fill:none;stroke:#000000;stroke-width:0.26499999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker5938)"
+ sodipodi:nodetypes="ccc" />
+ <circle
+ transform="rotate(-90)"
+ r="2.5"
+ style="fill:none;stroke:#000000;stroke-width:0.33072913"
+ cy="-87.251816"
+ cx="-129.88918"
+ id="circle6900" />
+ <text
+ id="text6914"
+ y="131.28157"
+ x="-84.371376"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="font-size:3.52777767px;stroke-width:0.26458332"
+ y="131.28157"
+ x="-84.371376"
+ id="tspan6912"
+ sodipodi:role="line">=1 commit</tspan></text>
+ <text
+ id="text7033"
+ y="172.37086"
+ x="-49.921974"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="font-size:3.52777767px;stroke-width:0.26458332"
+ y="172.37086"
+ x="-49.921974"
+ sodipodi:role="line"
+ id="tspan7461">merge branch 'feature1'</tspan></text>
+ <path
+ inkscape:connector-curvature="0"
+ id="path7035"
+ d="m -30.00001,177 h -20 l -6,-26"
+ style="fill:none;stroke:#000000;stroke-width:0.26499999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker7039)"
+ sodipodi:nodetypes="ccc" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-49.921974"
+ y="176.07498"
+ id="text7473"><tspan
+ id="tspan7471"
+ sodipodi:role="line"
+ x="-49.921974"
+ y="176.07498"
+ style="font-size:3.52777767px;stroke-width:0.26458332">to master branch</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-91.499352"
+ y="167.07919"
+ id="text8521"><tspan
+ id="tspan8519"
+ sodipodi:role="line"
+ x="-91.499352"
+ y="167.07919"
+ style="font-size:3.52777767px;stroke-width:0.26458332">create branch</tspan></text>
+ <text
+ id="text8525"
+ y="170.78331"
+ x="-91.499352"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="font-size:3.52777767px;stroke-width:0.26458332"
+ y="170.78331"
+ x="-91.499352"
+ sodipodi:role="line"
+ id="tspan8523">for 'feature1'</tspan></text>
+ <path
+ sodipodi:nodetypes="ccc"
+ style="fill:none;stroke:#000000;stroke-width:0.30303907;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker8537)"
+ d="m -90.00001,173 h 24 l 2,-22"
+ id="path8533"
+ inkscape:connector-curvature="0" />
+ </g>
+</svg>
Some initial set up is required to connect a project with
the master document structure and enable automated publishing of
-changes as summarized in the following diagram and description below
+changes as summarized in the following diagram and description below
below.
.. seqdiag::
DR [label = "Doc Gerrit Repo" , color=pink];
PR [label = "Other Project\nGerrit Repo", color=pink ];
PA [label = "Other Project\nAuthor/Committer", color=lightblue];
-
+
=== One time setup doc project only ===
- RD -> DA [label = "Acquire Account" ];
+ RD -> DA [label = "Acquire Account" ];
DA -> DR [label = "Create initial\n doc repository content"];
DA <<-- DR [label = "Merge" ];
RD <-- DA [label = "Connect gerrit.onap.org" ];
PA -> DR [label = "Add project repo as\ngit submodule" ];
DR -> DA [label = "Review & Plan to\nIntegrate Content with\nTocTree Structure" ];
DR <-- DA [label = "Vote +2/Merge" ];
- PA <-- DR [label = "Merge Notification" ];
+ PA <-- DR [label = "Merge Notification" ];
PA -> PR [label = "Create in project repo\ntop level directory and index.rst" ];
PR -> DA [label = "Add as Reviewer" ];
PR <-- DA [label = "Approve and Integrate" ];
PA <-- PR [label = "Merge" ];
}
-
-
+
+
Setup doc project
-----------------
These steps are performed only once for the doc project and include:
(1) creating in the doc repository an initial:
- - sphinx master document index
- - a directory structure aligned with the document structure
- - tests performed in jenkins verify jobs
- - sphinx configuration
-
+ - sphinx master document index
+ - a directory structure aligned with the document structure
+ - tests performed in jenkins verify jobs
+ - sphinx configuration
+
(2) establishing an account at readthedocs connected with the doc
doc project repo in gerrit.onap.org.
Setup project repositories(s)
-----------------------------
-These steps are performed for each project repository that provides documentation.
+These steps are performed for each project repository that provides documentation.
First let's set two variables that will be used in the subsequent steps.
Set reponame to the project repository you are setting up just as it appears in the
reponame=
lfid=
-The next step is to add a directory in the doc project where your project will be included as a
+The next step is to add a directory in the doc project where your project will be included as a
submodule and at least one reference from the doc project to the documentation index in your repository.
The following sequence will do this over ssh.
If your access network restricts ssh, you will need to use equivalent git commands and
HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
-
+
.. code-block:: bash
git clone ssh://$lfid@gerrit.onap.org:29418/doc
git submodule update docs/submodules/$reponame.git
echo " $reponame <../submodules/$reponame.git/docs/index>" >> docs/release/repolist.rst
-
+
git add .
git commit -s
git review
-
+
.. caution::
Wait for the above change to be merged before any merge to the
project repository that you have just added as a submodule.
If you have additional content, you can include it by editing the
index.rst file and/or adding other files before the git commit.
See `Templates and Examples`_ below and :ref:`converting-to-rst` for more information.
-
+
.. code-block:: bash
------------------------------------------------
.. toctree::
:maxdepth: 1
-
+
" > docs/index.rst
-
+
git add .
git commit -s
git review
-
+
The diagram below illustrates what is accomplished in the setup steps
above from the perspective of a file structure created for a local test,
- ONAP gerrit project repositories,
- doc project repository master document index.rst, templates, configuration, and other documents
-- submodules directory where other project repositories and directories/files are referenced
+- submodules directory where other project repositories and directories/files are referenced
- file structure: directories (ellipses), files(boxes)
- references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)
.. graphviz::
-
+
digraph docstructure {
size="8,12";
node [fontname = "helvetica"];
gerrit -> doc;
gerrit -> aaf;
gerrit -> aai;
- gerrit -> reponame;
+ gerrit -> reponame;
gerrit -> repoelipse;
repoelipse [label=". . . ."];
gerrit -> vnfsdk;
//Show example of local reponame instance of component info
reponame -> reponamedocsdir;
- reponamesm -> reponamedocsdir;
+ reponamesm -> reponamedocsdir;
reponamedocsdir [label="docs"];
- reponamedocsdir -> repnamedocsdirindex;
+ reponamedocsdir -> repnamedocsdirindex;
repnamedocsdirindex [label="index.rst", shape=box];
- //Show detail structure of a portion of doc/docs
+ //Show detail structure of a portion of doc/docs
doc -> docs;
- docs -> confpy;
+ docs -> confpy;
confpy [label="conf.py",shape=box];
- docs -> masterindex;
+ docs -> masterindex;
masterindex [label="Master\nindex.rst", shape=box];
docs -> release;
- docs -> templates;
- docs -> otherdocdocumentelipse;
+ docs -> templates;
+ docs -> otherdocdocumentelipse;
otherdocdocumentelipse [label="...other\ndocuments"];
docs -> submodules
-
+
masterindex -> releasedocumentindex [style=dashed, label="sphinx\ntoctree\nreference"];
-
+
//Show submodule linkage to docs directory
- submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
+ submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
reponamesm [label="reponame.git"];
//Example Release document index that references component info provided in other project repo
- release -> releasedocumentindex;
+ release -> releasedocumentindex;
releasedocumentindex [label="index.rst", shape=box];
releasedocumentindex -> releaserepolist [style=dashed, label="sphinx\ntoctree\nreference"];
- releaserepolist [label="repolist.rst", shape=box];
+ releaserepolist [label="repolist.rst", shape=box];
release -> releaserepolist;
releaserepolist -> repnamedocsdirindex [style=dashed, label="sphinx\ntoctree\nreference"];
-
+
}
+About GIT branches
+------------------
+
+GIT is a powerful tool allowing many actions, but without respecting some rules
+the GIT structure can be quickly ugly and unmaintaible.
+
+Here are some conventions about GIT branches:
+ - ALWAYS create a local branch to edit or create any file. This local branch
+ will be considered as a topic in Gerrit and allow contributors to work at the
+ same time on the same project.
+ - 1 feature = 1 branch. In the case of documentation, a new chapter or page about
+ a new code feature can be considered as a 'doc feature'
+ - 1 bug = 1 branch. In the case of documentation, a correction on an existing
+ sentence can be considered as a 'doc bug'
+ - the master branch is considered as "unstable", containing new features that
+ will converge to a stable situation for the release date.
+
+The day of the release, the repository owner will create a new branch to
+fix the code and documentation. This will represent the 'stable' code of the
+release. In this context:
+ - NEVER push a new feature on a stable branch
+ - Only bug correction are authorized on a stable branch using cherry pick method
+
+.. image:: git_branches.png
+
Creating Restructured Text
==========================
Templates and Examples
----------------------
Templates are available that capture the kinds of information
-useful for different types of projects and provide some examples of
-restructured text. We organize templates in the following way to: help authors
-understand relationships between documents; keep the user audience context in mind when writing;
+useful for different types of projects and provide some examples of
+restructured text. We organize templates in the following way to: help authors
+understand relationships between documents; keep the user audience context in mind when writing;
and tailor sections for different kinds of projects.
**Sections** Represent a certain type of content. A section is **provided** in a repository, to
-In addition to these simple templates and examples
+In addition to these simple templates and examples
there are many open source projects (e.g. Open Daylight, Open Stack)
that are using Sphinx and Readthedocs where you may find examples to start with.
Working with project teams we will continue to enhance templates here and
-capture frequently asked questions on the developer wiki question
+capture frequently asked questions on the developer wiki question
topic `documentation <https://wiki.onap.org/questions/topics/16384055/documentation>`_.
Each project should: decide what is relevant content; determine the
best way to create/maintain it in a CI/CD process; and work with the
documentation team to reference content from the master index and guides.
-Consider options including filling in a template,
+Consider options including filling in a template,
identifying existing content that can be used as is or
easily converted, and use of Sphinx directives/extensions to automatically
generate restructured text from other source you already have.
firefox docs/_build/html/index.html
.. note:: Make sure to run `tox -elocal` and not just `tox`.
-
-
-
include-documentation
converting-formats
addendum
+
+.. toctree::
+ :hidden:
+
+ update-review.rst
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
http://creativecommons.org/licenses/by/4.0
+.. _index-setting-individual-components:
=========================================
**Setting Up individual ONAP components**
=========================================
-It is possible to deploy individual components.
+From a developer perspective, ONAP can be installed component per component. This advanced installation procedure is recommended only for experienced developers who desire to focus their attention on a few components and who have a deep understanding of dependencies between components.
+This type of installation is not recommended to fully install ONAP.
-The documentation to install the various components is available here:
+The installation procedures for the various components are provided below:
-TODO Link to installations
+User Interfaces
+---------------
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ CLAMP - :ref:`Closed Loop Automation Platform<index-clamp-installation>`
+ SDC - Service Design and Creation <../../../submodules/sdc.git/docs/installation.rst>
+ Use-Case UI <../../../submodules/usecase-ui.git/docs/platform/installation.rst>
+ VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/installation.rst>
+ SDNC - Software-Defined Networks Controller <../../../submodules/sdnc/oam.git/docs/installation.rst>
+
+Platform Components
+-------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ APPC - Application Controller <../../../submodules/appc.git/docs/APPC%20Deployment%20Guidelines/APPC%20Deployment%20Guidelines.rst>
+ DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/installation.rst>
+ Holmes - Alarm Correlation <../../../submodules/holmes.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/platform/installation.rst>
+ MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-Heat-Deployment-Guide.rst>
+
+SDK
+---
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ CLI - Command Line Interface<../../../submodules/cli.git/docs/installation_guide.rst>
+ Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/setting-up.rst>
+ VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/mktplace-install.rst>
:depth: 2
..
+.. index:: Setting Up Full ONAP
+
========================
**Setting Up Full ONAP**
**Context**
===========
-ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on Open Stack.
+ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack HEAT Template.
-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.
+Using the Amsterdam HEAT Template installer, ONAP can be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components.
-The VNFs managed by ONAP may be deployed in different Open Stack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
+The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure. For details, refer :ref:`to MultiCloud project<index-multicloud>`.
-Figure 1
+The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE components deployed in High Availability mode.
-The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant)
+The installation requires some manual tasks to setup the DCAE components.
+.. _demo-installing-running-onap-requirements:
**Requirements**
================
---------
ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
-The following Open Stack components must be deployed in the infrastructure:
+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 Open Stack, you can use various solutions:
- - `OpenStack installer <https://docs.openstack.org/install-guide/>`_
+To deploy OpenStack, you can use various solutions:
+ - `OpenStack installation guide <https://docs.openstack.org/install-guide/>`_
- `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_
+ - `OpenStack Ocata installation guide <https://docs.openstack.org/ocata/install/>`_
+
+.. tip::
+ - Notice the documentation version mentioned in the URL, e.g. ocata/, pike/, latest/ ...
+ - The installation is pretty huge, some automated scripts have been created by the community:
+
+ - `OpenStack installation with Ansible (All openstack services) <https://docs.openstack.org/openstack-ansible/latest/>`_
+ - `OpenStack Ocata installation scripts for testing environment (DO NOT install Heat, Designate and Cinder Volume services) <https://github.com/reachsrirams/openstack-scripts>`_
+
+Use the procedure below to deploy and configure *Designate* manually
+
+.. toctree::
+ :maxdepth: 1
-*Designate* component is usually not deployed using standard OpenStack installers.
-Please find a guide to deploy and configure *Designate*
+ install-designate.rst
+
+
+The OpenStack infrastructure must enable internet access and you need to have an "External network" already configured properly.
+The External network ID will have to be provided in the Heat environment file.
+
+ONAP components
+---------------
+The following table presents the mapping between the created VM and the ONAP components, and provides VM information (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:
- - xx VM
- - xxx vCPU
- - xxx RAM
- - xxx Storage
- - xxx floating IP
- - a public SSH key
- - a private SSH key
+ - 29 VM
+ - 148 vCPU
+ - 336 GB RAM
+ - 3 TB Storage
+ - 29 floating IP addresses
+
+.. Note: The default flavor size may be optimized. The ONAP community is working to update flavors of basic ONAP installation.
+
+.. Note: You should also reserve some resources for the VNFs to be deployed.
-Note that floating IP may be private IP.
+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 (https://cloud-images.ubuntu.com/releases/14.04/14.04/)
+ - Ubuntu 16.04 image (https://cloud-images.ubuntu.com/releases/16.04/release/)
+ - CentOS 7 image (http://cloud.centos.org/centos/7/images/)
+ - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
+
+.. Note: The 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 configured 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)
+Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop).
-The following YAML file presents the ports exposed by the various components:
+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>`_.
-.. code-block:: yaml
+**Deployment**
+==============
- ---
- aai:
- - 8889
+Source files
+------------
-TODO Generate the YAML file with installation
+Both following files must be downloaded and configured to match your configuration:
-TODO Provide a command to create the security groups
+- 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
-**Deployment**
-==============
+The environment file must be customized as described in the following sections.
+
+.. Note Amsterdam release files
+
+Description
+-----------
+
+The ONAP HEAT template spins up all the components expect the DCAE. 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 create the public/private key pair:
+
+::
+
+ 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 phase consists of launching 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
-------------
-- To deploy ONAP, use the Heat template and follow the described guidelines in integration project.
-- The Heat template deployment may take time (up to one hour) depending on your hardware environment.
+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:**
+
+- You need to have the OpenStack Heat service installed:
+
+- Create a file (named i.e. ~/openstack/openrc) that sets all the
+ environmental variables required to access your OpenStack tenant:
+
+::
+
+ 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
+ export OS_USER_DOMAIN_NAME=INSERT YOUR DOMAIN HERE
+ export OS_PROJECT_NAME=INSERT YOUR PROJECT NAME HERE
+
+- Run the script from command line:
+
+::
+
+ source ~/openstack/openrc
+
+- In order to install the ONAP platform, type:
+
+::
+
+ # Old HEAT client
+ heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE
+
+ OR
+
+ # New OpenStack client
+ openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME
+
+
+.. Note The HEAT template deployment may take time (up to one hour) depending on your hardware environment.
+
+Deploy DCAE
+-----------
+The HEAT template deployed the onap-dcae-bootstrap virtual machine.
+
+.. Note To provide the manual tasks to configure the local 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.
+Every ONAP component offers a HealthCheck REST API. The Robot Virtual Machine (*onap-robot*) can be used to test that every components run smoothly.
Run the following command to perform the HealthCheck:
.. code-block:: bash
docker exec -it openecompete_container /var/opt/OpenECOMP_ETE/runTags.sh -i health h -d ./html -V /share/config/integration_robot_properties.py -V /share/config/integration_preload_parameters.py -V /share/config/vm_properties.py
-This testsuite will execute 31 tests towards the various ONAP components.
+This test suite will execute 30 tests towards the various ONAP components.
+
+After the installation, it is possible to deploy the various use-cases described in `ONAP wiki <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
Detect problems
---------------
* 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:
+The list of containers are described on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
+. 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.
+The current ONAP installation is using the *onap.org* domain.
To use the portal on your desktop, you must configure the following information in your *host* file (located in /etc/host for Linux or /windows/system32/drivers/etc/hosts for Windows):
.. code-block:: bash
- 104.239.249.17 policy.api.simpledemo.onap.org
- 104.130.31.25 portal.api.simpledemo.onap.org
- 104.239.249.15 sdc.api.simpledemo.onap.org
- 104.130.170.142 vid.api.simpledemo.onap.org
- 104.239.249.72 aai.api.simpledemo.onap.org
- TODO ADD ui.aai
+ <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:
+You can use the Horizon dashboard to get the IP addresses associated with the Virtual Machines or use the following command line:
.. code-block:: bash
Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
-Go to the Portal component user guide.
+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
- - SDC Portal
- - UI Case
+ - `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 following YAML file presents the list of containers for every Virtual Machine
-
-.. code-block:: yaml
-
- aai:
- - traversal
- - be
- - fe
- appc
- - fe
+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::
--- /dev/null
+.. 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 (LATEST) <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.
+ - Notice the documentation version mentioned in the URL, e.g. ocata/, pike/, latest/ ...
+
+**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.
Tutorials
=========
-.. toctree::
- :maxdepth: 1
- :titlesonly:
+.. note::
+ Until this section is migrated to gerrit/readthedocs, use the links below.
+
+.. caution::
+ The tutorials may refer to earlier versions of software
+ and have not been certified on the latest Amsterdam Release.
+
+* `Automatically Creating a Netconf Mount in APPC from SDNC <https://wiki.onap.org/x/JYUx>`_
+
+* `Clearwater vIMS Onboarding and Instantiation <https://wiki.onap.org/x/RJp9>`_
+
+* `How to use SLI-API for SDNC Model, Directed Graph and Adapter prototyping <https://wiki.onap.org/x/0wCW>`_
+
+* `Setting up a Nexus Proxy <https://wiki.onap.org/x/_y70>`_
servicedesigner.rst
serviceadmin.rst
platformadmin.rst
-
.. 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
-======================
+User Portal
+===========
+.. note::
+ Until this section is migrated to gerrit/readthedocs, use the link below.
+* `User Portal <https://wiki.onap.org/x/fIsP>`_
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>`_
Service Designer
================
+.. note::
+ Until this section is migrated to gerrit/readthedocs, use the link below.
+* `Service Designer <https://wiki.onap.org/x/E4AP>`_
release/index
guides/onap-developer/index
guides/onap-user/index
+ use-cases/index
=============
-Version: x.y.z
+Version: 1.0.0
--------------
-:Release Date: yyyy-mm-dd
+:Release Date: 2017-11-16
**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**
-
-
**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.
===========
.. 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
------------------
+Getting Started With Amsterdam
+------------------------------
Summary
+++++++
+ONAP provides a comprehensive platform for real-time, policy-driven
+service orchestration and automation including virtual network functions and applications
+instantiation and configuration, but also physical network functions configuration.
+ONAP 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 BPMN 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. SO is especially able to drive any OpenStack-based cloud platform.
+
+ - Software Defined Network Controller (SDNC) executes network configuration for
+ cloud computing resources and network.
+
+ - Application Controller (APPC) executes Virtual Network Functions (VNF) configurations and lifecycle
+ management operations.
+
+ - Virtual Function Controller (VF-C) is responsible for lifecycle management of virtual network functions
+ and network services based on VNF using VNF Manager.
+
+ - 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 events, performance,
+ usage and publishes information to policy that executes the rules to perform
+ closed loop actions.
+ - Holmes provides alarm correlation and analysis for Telecom cloud
+ infrastructure and services, including servers, cloud infrastructure,
+ VNFs and Network Services.
+
+ - 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
+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.
+Platforms Requirements
+++++++++++++++++++++++
+ONAP Amsterdam Release has been tested on Linux OSs. Details are :ref:`available here <demo-installing-running-onap-requirements>`.
-Supported Platforms
-+++++++++++++++++++
+.. index:: Download
+
+Download & Install
+++++++++++++++++++
+There are 3 approaches to install ONAP:
+
+* Full ONAP installation using Heat template
+* Advanced installation to install individual components
+* Experimental installation using Kubernetes
+
+Full ONAP installation using Heat template
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
+
+Advanced installation to install individual components
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+From a developer perspective, ONAP can be installed component per component. For details, refer to :ref:`the installation procedure available for each component<index-setting-individual-components>`.
+The advanced installation procedure is recommended only for experienced developers who desire to focus their attention on a few components and who have a deep understanding of dependencies between components.
+This type of installation is not recommended to fully install ONAP.
+
+* The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
+* The 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.
+
+Experimental installation using Kubernetes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+From a complete demo solution perspective using Kubernetes. This installs the whole ONAP, refer to :ref:`ONAP Operations Manager - Quick Start Guide <onap-operations-manager-project>`.
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 :ref:`architecture view<doc-architecture>` of how components
- relate to each other.
+ * A high level :ref:`architecture view<doc-architecture>` of how components
+ relate to each other.
-* A collection of documentation provided
- by :ref:`each project <doc_onap-developer_guide_projects>`.
+ * 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.
+Usage
++++++
+This section is intended to provide users on the usage of ONAP components.
+
+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>`_.
+
+.. 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>`_.
Known Issues and Limitations
++++++++++++++++++++++++++++
-TBP overall / general statement
-See :ref:`release notes <doc-releaserepos>` for each project.
-
-License
-+++++++
+Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`.
+.. 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.
+ * 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, post your question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
+ You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_.
-Download and Use
-++++++++++++++++
+You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
-* 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
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
:titlesonly:
aai/aai-common<../submodules/aai/aai-common.git/docs/release-notes.rst>
- 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
----------------------
: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
:titlesonly:
ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst>
- ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst>
- ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst>
Closed Loop Automation Platform
-------------------------------
: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
----------------------------
:maxdepth: 1
:titlesonly:
- logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst
+ logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst>
Modeling
--------
:maxdepth: 1
:titlesonly:
- modeling/modelspec<../submodules/modeling/modelspec.git/docs/release-notes.rst>
- modeling/toscaparsers<../submodules/modeling/toscaparsers.git/docs/release-notes.rst>
+ modeling/modelspec<../submodules/modeling/toscaparsers.git/docs/javatoscachecker/release-notes/release-notes.rst>
+ modeling/toscaparsers<../submodules/modeling/toscaparsers.git/docs/nfvparser/release-notes/release-notes.rst>
Micro Services Bus
------------------
:titlesonly:
msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst>
- msb/discovery<../submodules/msb/discovery.git/docs/release-notes.rst>
- msb/java-sdk<../submodules/msb/java-sdk.git/docs/release-notes.rst>
- msb/swagger-sdk<../submodules/msb/swagger-sdk.git/docs/release-notes.rst>
MultiVIM Cloud
--------------
multicloud/framework<../submodules/multicloud/framework.git/docs/Release Notes.rst>
+ONAP Operations Manager (experimental)
+--------------------------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ OOM<../submodules/oom.git/docs/release-notes.rst>
+
Policy Framework
----------------
: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>
- sdc/sdc-docker-base<../submodules/sdc/sdc-docker-base.git/docs/release-notes.rst>
- 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
: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
:maxdepth: 1
:titlesonly:
- vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst>
vid<../submodules/vid.git/docs/release-notes.rst>
VNF Requirements
: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
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: Projects Providing Documentation
+
.. _doc-repolist:
Project/Components
ccsdk/platform/blueprints <../submodules/ccsdk/platform/blueprints.git/docs/index>
ccsdk/platform/nbapi <../submodules/ccsdk/platform/nbapi.git/docs/index>
CCSDK Orchestrator Plugins <../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
ccsdk/storage/esaas <../submodules/ccsdk/storage/esaas.git/docs/index>
ccsdk/storage/pgaas <../submodules/ccsdk/storage/pgaas.git/docs/index>
ccsdk/utils <../submodules/ccsdk/utils.git/docs/index>
sdc/sdc-titan-cassandra <../submodules/sdc/sdc-titan-cassandra.git/docs/index>
sdc/sdc-tosca <../submodules/sdc/sdc-tosca.git/docs/index>
sdc/sdc-workflow-designer <../submodules/sdc/sdc-workflow-designer.git/docs/index>
- sdnc/adaptors <../submodules/sdnc/adaptors.git/docs/index>
- sdnc/architecture <../submodules/sdnc/architecture.git/docs/index>
- sdnc/core <../submodules/sdnc/core.git/docs/index>
- sdnc/features <../submodules/sdnc/features.git/docs/index>
- sdnc/northbound <../submodules/sdnc/northbound.git/docs/index>
sdnc/oam <../submodules/sdnc/oam.git/docs/index>
- sdnc/parent <../submodules/sdnc/parent.git/docs/index>
- sdnc/plugins <../submodules/sdnc/plugins.git/docs/index>
Service Orchestrator <../submodules/so.git/docs/index>
so/libs <../submodules/so/libs.git/docs/index>
Use Case User Interface <../submodules/usecase-ui.git/docs/index>
../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>
+ aai/event-client <../submodules/aai/event-client.git/docs/index>
+ optf/osdf <../submodules/optf/osdf.git/docs/index>
+ dmaap/datarouter <../submodules/dmaap/datarouter.git/docs/index>
+ dmaap/dbcapi <../submodules/dmaap/dbcapi.git/docs/index>
+++ /dev/null
-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
-Subproject commit 443034182c2b9c6b53081a31b8c4ef1e15eb89de
+Subproject commit 0fdcb08954af21edea2e965e3f6b9bb6c8a6443e
-Subproject commit 722f59e75b5e8d6b2f7ade57c00db8c4b9e75078
+Subproject commit 55f25defdee4c12beace81f45eda5fb076d5b0e2
-Subproject commit 383c9a08b5a659a836e3ad6c32114e5afcddb487
+Subproject commit 8ac643868c8b551b01d29177fb4e351d36056f23
-Subproject commit 1f6c64eae79dad77bf75432f23e4b137d6db174c
+Subproject commit effb4f1d758d3d37dbba6f2748c25bfdbe636735
--- /dev/null
+Subproject commit 4150ee34ae503c83734aca7e62ca9911b354c881
-Subproject commit 8bcb89b5c1b7acf62a6f87dabd8b5df9f4570b51
+Subproject commit 629fdccb42a58348b6a691ab736ba1600ea813a3
-Subproject commit ed9fd62c6060a3a5ae34a6fd61939f13be07973c
+Subproject commit 84fed80a912de04b4fbd4383d468a5b258f1238b
-Subproject commit ea8c76cca7dbc83aff1c73d1b7bf4b00597e42ae
+Subproject commit 439954be802b246cb0f89ee7347d167419526f9d
-Subproject commit 0d7b5be02c42f97257d79d84809b51ab6a58e6ea
+Subproject commit 3df51c6bb79df182be4f0f1bac20bde75f434494
-Subproject commit 12bc08602be497c4cd3b49328a042d28663f9f4b
+Subproject commit c62d00e30accbea9a60c66cceaaf52fa434057b2
-Subproject commit 0410a5cbc5272087b6ac7b7a311e0644aa92c16f
+Subproject commit d6cc55a6ebb045c0f714363593bbb7e919cb2b6f
-Subproject commit b10a7484f4bce80d9fa41953051977b54c28386d
+Subproject commit 49afe7c88086ee3233d09e9a8386a7509426385c
-Subproject commit 1565be2e406cac067eebc9604f27f762124622cf
+Subproject commit 6e6babd96b389602e6ab4b3550a0c3db4f9ae7c6
+++ /dev/null
-Subproject commit fe80fe11b82b5b8bfc38349a4304cbe8f1fc0724
+++ /dev/null
-Subproject commit 9a9542e5fa1050d9f85f3a96ddcc69717cc1de6b
+++ /dev/null
-Subproject commit 024e6d1689ee38b37ac054636557b5dff8f26270
+++ /dev/null
-Subproject commit eff81fd8cbdcb6dabd3b9d41a1d2659ccd57f2f9
-Subproject commit 84b497a7ced1328fa5d559e029647e55beab018a
+Subproject commit 4e1b45a2e3e474606965ca3b66bd5f82f526b0ce
-Subproject commit 4588521e040bf27577a0c98db82d9809ef5a6698
+Subproject commit 13bb4e3201f9c17ba9c72278dd67a7da5c827bf8
-Subproject commit f2650c8b133ff9569994eed1c6edc88af981d84c
+Subproject commit 6156e258a8b9df35d2c2c8872a2213b21a446523
-Subproject commit 59c0e4f513607e8363b9c9133a5043475d750a9f
+Subproject commit 16d3ea9a0229cbe22ac7729a97838141e3fab5d6
-Subproject commit 09f2cc5eb10c6193ac8406555da983479576e672
+Subproject commit ef55ef2163dee32905bd10b0a0b3ea0f6a763322
--- /dev/null
+Subproject commit b52cf192dad4a6d6bd884dd66243bf2d16be9225
--- /dev/null
+Subproject commit 443fb3c2146e363d0ddb2911b6c848b3c15c7d3a
-Subproject commit 201409190e22128363178c94be43bb32c4021887
+Subproject commit afd26e40bddd223c335416fe18fabb8445864495
-Subproject commit ea08755cd8354a8fe6f30a2797cb5bb3ccb63da8
+Subproject commit 4ed7d0b1dd4dc81e66acdcd568b7212a28e3510f
-Subproject commit 6e600a30fdcc421ac7e4ca0d2989c29a3bb1f39c
+Subproject commit 37e6d19d137f924626413aad8931f273cd2ababa
-Subproject commit 39a2f2f7910a0d86163ad23fe91c2a11e98ece07
+Subproject commit 1358e55ffafce7277bfb3e46cfbecb4c83c4f84c
-Subproject commit 51fe8a5ab1e89bdfb4f0dd188c9144034476eb20
+Subproject commit 9ffcefcbbb6ad6b8ba485a402ccc3e469285ec4b
-Subproject commit d650571280c041e0602dd93ff407dd16092a320e
+Subproject commit 3e820db44c997193a4ec1cecf25295f43c689a26
-Subproject commit 0b8395037536b8341850eecbff8aac03b40d7b0d
+Subproject commit b7165820de2d5bd56e874c496e85dfc5dadda94d
-Subproject commit ddf80e22433f6e5d49923fd1523ca49369a2f583
+Subproject commit dcdaf85627b6930ee89ef69991c8780955c4c7dd
-Subproject commit 6c2333a71c1e94f1d565473afd71adcdb54a2d1b
+Subproject commit cfbdab0feccd3f444ac8c3f24e801456230a6a33
-Subproject commit a33ca6e2189e8dbf94a927488a49c5ae380485e5
+Subproject commit 722d78240f9ae320ceb262b496cf8cee07ae2591
-Subproject commit 742803f35720c6f35245c54c5fe90f073dcc01f7
+Subproject commit 0b09ca26c00330d5d4b7e92d3db2615a65a36fdf
-Subproject commit 0cfd9d031bf80a39e6677291b3a407eefc400013
+Subproject commit c9effec3dc4eaf6c213512df96829e51996d8498
-Subproject commit c2c4d76e70b24e9702419864d0ec422eddfae8d4
+Subproject commit 41c491482386f37ac876717e0f565ba0781e2d8a
-Subproject commit 6962b915986486f4dad166e7b3de7089311ac2c4
+Subproject commit 84dca64425db27fe9b2850a2ca20fdff09ac54d4
--- /dev/null
+Subproject commit 356b52c79dc56b97d910211272c7bdbef80b884a
-Subproject commit 8169b8491fb2512e78764cf3f3b1e2f1ad4a2fba
+Subproject commit 289e35d52503eda71d870da734ab23fc96ba0e8c
-Subproject commit 6cf1569c50ab43c6642b7028a0bbdd9bbe901b17
+Subproject commit 9576d2117df8f9116861f4fa13e1571a590e4cd3
-Subproject commit ce113865c2fafa11ef20f56201e2004013bc1169
+Subproject commit f83c9fd3f761d394049fb4c47ce7fd86e49b5ecc
-Subproject commit a5ae1468e16834137bc8331dc1661e700f181dc8
+Subproject commit a492ff29a0ff1a69991dd2a101c0e06168d43c85
-Subproject commit 3c2636c53deea68359a8deb028bef3ef1e31502f
+Subproject commit e8d8a37da95c6fea435e0b3e93a477b5aa45b9b1
-Subproject commit bb953da096e7118b98b7932059076a4a34fe8da8
+Subproject commit cb3fe736c296ddca3825220011fa7528b64ee271
-Subproject commit baeee36a30b042ca7c7333f850eafc86cd8db496
+Subproject commit 83a4e4067fd50cec9bdfbacf18f953cef62b52e6
-Subproject commit 326de6efcd2fa5a37c6a7d971ee9fc1cb9ac34f3
+Subproject commit 644e2206bcbaa87744b08b869ee8a378c9fae2fc
-Subproject commit 29660c673b5a54ea93238cdd94c14f8ee7c7d8ce
+Subproject commit 548e5f5ed2ad5a7c8ac29a6f5245c4779bb28f11
+++ /dev/null
-Subproject commit d69f503c3231553405a4cbc7ab08f40c6f55befd
+++ /dev/null
-Subproject commit 2f0dca3d080e8c940be7a271423ec9cddc86a2e0
-Subproject commit c195cf39d0d782c2b017226edba58dc4da38cedb
+Subproject commit ebb2eb69d7b6fa80dbf228fc7fe365f9c71a8df4
+++ /dev/null
-Subproject commit 6848b3186e75546797206985921b8f61aa18c10b
+++ /dev/null
-Subproject commit 9c6a1f08827e2183e5410c82f0fb2941b83918db
-Subproject commit 4b4e9274a650ead672c14e7a30685e804883ce34
+Subproject commit 2822ea7882e20879b1556bf98cf28695f5052348
+++ /dev/null
-Subproject commit 4b1a1aa3b2015845abe5a2ebcd8f61542aae01b9
+++ /dev/null
-Subproject commit 9a5f0571502661b29b435f07f58237ac1544de17
-Subproject commit 104aefb5d0fce75ee5c5ec4f4de1a6954925b5b6
+Subproject commit dee036198ee09d71bfdd50247c1d23a7f472df87
-Subproject commit b806b52778e67ce790c2f9302984dbcd84597bb0
+Subproject commit 0a6ac21843364dd67f5e01d23a1f03911f8cf605
--- /dev/null
+Subproject commit b9a6ae1246c02031deb7f5e0d016f242e7d99452
-Subproject commit ca5773b60f804bb7543f569419e12dacf59f020c
+Subproject commit ae944fbb80a8f3ce27c9bf832e2c30c27ec78078
-Subproject commit c794226f618330350de1aaecfe6dedd458e07865
+Subproject commit a357d2aa24921d7c1100954e67cbe40cf49d916e
-Subproject commit 8f612e9dc8b0cccffa5a3629430c61101030aa88
+Subproject commit 5a233ba6b2d258ed009e3515513679102e0b0eaa
-Subproject commit 61a1ab786f241942e417fd3ef12de99d099b3183
+Subproject commit b8f216557afb06c59bfc2acbffb9f9abff7546b7
-Subproject commit 433e6a3c6770c41445728cce2fd737a93751b55d
+Subproject commit 60d5c1fd450347135455d0266e11bb9eeabc27b9
-Subproject commit a3adf07306490e9d0e88229c165630124376c86f
+Subproject commit 8821cb26ccb6161e2d3e32ee2f7f572f1d6cb73a
--- /dev/null
+Subproject commit 0ca827db0fd2cee74377c844175c0df0037f4ac2
--- /dev/null
+.. 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.
+
+ONAP Use Cases
+==============
+
+Example uses case descriptions and sequence diagrams illustrating
+interactions between platform components.
+
+.. toctree::
+ :maxdepth: 1
+
+ vfw.rst
--- /dev/null
+.. 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.
+
+vFirewall
+=========
+
+Description
+-----------
+
+Onboarding
+----------
+
+
+.. uml::
+
+ @startuml
+ title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services
+ ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT)
+ note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\
+ ONAP_User -> SDC : vFW_vDNS service onboarding
+ ONAP_User -> SDC : vFW_vDNS distribution
+ |||
+ SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+ SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+ SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+ @enduml
+
+Instantiation
+-------------
+
+.. uml::
+
+ @startuml
+ title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
+ participant ONAP_User
+ participant Robot
+ Participant SDC
+ Participant VID
+ Participant SO
+ ONAP_User -> AAI : populate cloud inventory
+ note left of AAI: manual via curl or POSTMAN
+ |||
+ ONAP_User -> VID : vFW_vDNS deployment
+ VID -> SDC : Lookup VNF artifacts
+ VID -> AAI : Lookup cloud locations, subscriber
+ VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules)
+ SO -> AAI : inventory update
+ VID -> SO : vFW_vDNS VNF Instantiation\n(base modules)
+ note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice
+ SO -> AAI : inventory update
+ ONAP_User -> SDNC : VNF API Preload VNF/VF data
+ VID -> SO : vFW_vDNS VF Instantiation\n(base modules)
+ SO -> AAI : inventory update
+ SO -> SDNC : Generic VNF API\n(assign)
+ SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters
+ Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or
+ CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation
+ Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation
+ Hypervisor -> CloudAPI : complete
+ CloudAPI -> Multi_VIM : complete
+ Multi_VIM -> SO : complete
+ note right : SO may poll for completion
+ SO -> SDNC: Generic VNF API\n(activated)
+ note left : on failure from Openstack SO issues rollback to SDNC
+ SDNC -> AAI : L3 Network resource update
+ SO -> VID : complete
+ note right : VID will poll for completion
+ ONAP_User -> Robot : run Heat Bridge
+ Robot -> CloudAPI : retrieve cloud data
+ Robot -> AAI : Update with cloud data
+ |||
+ @enduml
+
--- /dev/null
+# Formats in addition to HTML
+
+formats:
+ - none
+
+# Pip requirements
+requirements_file: etc/requirements.txt
+
+# Build Container
+build:
+ image: latest
Code Review / doc.git / commitdiff
