diff options
Diffstat (limited to 'docs/guides')
19 files changed, 1239 insertions, 130 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index a1db2b3d8..db4cd6a51 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -2,6 +2,8 @@ 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 @@ -57,4 +59,4 @@ SDK :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> diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 960cda23b..d4f38d9cf 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -3,6 +3,8 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Platform Architecture + .. _doc-architecture: Architecture diff --git a/docs/guides/onap-developer/architecture/media/ONAP-toplevel.png b/docs/guides/onap-developer/architecture/media/ONAP-toplevel.png Binary files differindex 7b22ac264..f2373739c 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-toplevel.png +++ b/docs/guides/onap-developer/architecture/media/ONAP-toplevel.png diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index 95b91b2d9..44c5f3a1b 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -2,7 +2,7 @@ .. 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 @@ -99,7 +99,7 @@ following foundational principles: - The architecture shall support elastic scaling as needs grow or shrink -|image0|\ +|image0|\ **Figure 1:** ONAP Platform @@ -115,9 +115,9 @@ necessary to develop service/operations-specific collection, analytics, 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 ++++++ @@ -209,7 +209,7 @@ Analytics and Events (DCAE), Active and Available Inventory (A&AI), and 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 @@ -300,16 +300,16 @@ provide access management and security enforcement, data backup, 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** @@ -349,7 +349,7 @@ Read the Residential vCPE Use Case with ONAP whitepaper to learn more. **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: diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index d78f3f8fd..5d6c63abe 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Developer Guides + .. _doc_onap-developer_guide_projects: Developing ONAP @@ -104,11 +106,8 @@ Holmes 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 ---------------------------- @@ -163,6 +162,14 @@ ONAP Command Line Interface ../../../submodules/cli.git/docs/index +ONAP Operations Manager (experimental) +-------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/oom.git/docs/index ONAP Use Case User Interface ---------------------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index eccd0022a..2d8a25cfa 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -60,8 +60,6 @@ You can add html content that only appears in html output by using the This line will be shown only in html version. -.. index:: single: indices - Creating Indices ---------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst index 8fd9a730b..9c5822d2b 100644 --- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst @@ -100,7 +100,6 @@ A starting structure is shown below and may change as content is integrated for each release. Other ONAP projects will provide content that is referenced from this structure. -.. index:: master :: @@ -133,7 +132,6 @@ ONAP jenkins jobs that verify and merge documentation are triggered by RST file changes in the top level docs directory and below. -.. index:: licensing Licensing --------- diff --git a/docs/guides/onap-developer/how-to-use-docs/git_branches.png b/docs/guides/onap-developer/how-to-use-docs/git_branches.png Binary files differnew file mode 100644 index 000000000..00c698451 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/git_branches.png diff --git a/docs/guides/onap-developer/how-to-use-docs/git_branches.svg b/docs/guides/onap-developer/how-to-use-docs/git_branches.svg new file mode 100644 index 000000000..faddef9cf --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/git_branches.svg @@ -0,0 +1,620 @@ +<?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> diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 15d71d453..4e76f6149 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -6,7 +6,7 @@ Setting Up 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:: @@ -19,9 +19,9 @@ below. 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" ]; @@ -29,32 +29,32 @@ below. 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 @@ -67,7 +67,7 @@ clone requests over ssh. 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. @@ -75,7 +75,7 @@ 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 @@ -86,11 +86,11 @@ The following sequence will do this over ssh. 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. @@ -107,7 +107,7 @@ to convert or add new content you can update the index and add files under the d 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 @@ -120,13 +120,13 @@ to convert or add new content you can update the index and add files under the d ------------------------------------------------ .. 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, @@ -134,14 +134,14 @@ a jenkins verify job, and/or published release documentation including: - 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"]; @@ -156,7 +156,7 @@ a jenkins verify job, and/or published release documentation including: gerrit -> doc; gerrit -> aaf; gerrit -> aai; - gerrit -> reponame; + gerrit -> reponame; gerrit -> repoelipse; repoelipse [label=". . . ."]; gerrit -> vnfsdk; @@ -164,48 +164,73 @@ a jenkins verify job, and/or published release documentation including: //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 @@ -245,17 +270,17 @@ Collections -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. @@ -399,6 +424,3 @@ Update submodules, build documentation using tox & then open using any browser. firefox docs/_build/html/index.html .. note:: Make sure to run `tox -elocal` and not just `tox`. - - - diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index a73ae6fb3..6f1dd2d33 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -12,3 +12,8 @@ Creating Documentation include-documentation converting-formats addendum + +.. toctree:: + :hidden: + + update-review.rst diff --git a/docs/guides/onap-developer/settingup/components.rst b/docs/guides/onap-developer/settingup/components.rst index e6aaf5fb7..047038d0f 100644 --- a/docs/guides/onap-developer/settingup/components.rst +++ b/docs/guides/onap-developer/settingup/components.rst @@ -1,13 +1,64 @@ .. 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> diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst index 61921add2..0ae6646a0 100644 --- a/docs/guides/onap-developer/settingup/fullonap.rst +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -7,6 +7,8 @@ :depth: 2 .. +.. index:: Setting Up Full ONAP + ======================== **Setting Up Full ONAP** @@ -16,16 +18,17 @@ **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** ================ @@ -34,69 +37,377 @@ OpenStack --------- ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release. -The following Open Stack components must be deployed in the infrastructure: +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 --------------- @@ -106,29 +417,30 @@ Here is a simple procedure to detect where the problem occurs: * Check the OpenStack Virtual Machine logs * Connect to the Virtual Machine and check that the various containers are running. -The list of containers are described in the following section. In case some containers are missing, check the docker logs using the following command: +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 @@ -136,27 +448,36 @@ You can use the Horizon dashboard to get the IP adresses associated with the Vir 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:: diff --git a/docs/guides/onap-developer/settingup/install-designate.rst b/docs/guides/onap-developer/settingup/install-designate.rst new file mode 100644 index 000000000..b6979c356 --- /dev/null +++ b/docs/guides/onap-developer/settingup/install-designate.rst @@ -0,0 +1,61 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + http://creativecommons.org/licenses/by/4.0 + 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. diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst index a4bcbaef2..2365efd10 100644 --- a/docs/guides/onap-developer/tutorials/index.rst +++ b/docs/guides/onap-developer/tutorials/index.rst @@ -3,7 +3,18 @@ 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>`_ diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 14e27423b..d0b52f8f0 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -13,4 +13,3 @@ Describe the different user audiences, tasks performed, and the guides provided servicedesigner.rst serviceadmin.rst platformadmin.rst - diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst index fceea7744..8c1fb2e6b 100644 --- a/docs/guides/onap-user/platformadmin.rst +++ b/docs/guides/onap-user/platformadmin.rst @@ -1,6 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. -Platform Administrator -====================== +User Portal +=========== +.. note:: + Until this section is migrated to gerrit/readthedocs, use the link below. +* `User Portal <https://wiki.onap.org/x/fIsP>`_ diff --git a/docs/guides/onap-user/serviceadmin.rst b/docs/guides/onap-user/serviceadmin.rst index b2faf8613..40bdf01ee 100644 --- a/docs/guides/onap-user/serviceadmin.rst +++ b/docs/guides/onap-user/serviceadmin.rst @@ -2,5 +2,9 @@ Service Administrator ===================== +.. note:: + Until this section is migrated to gerrit/readthedocs, use the links below. +* `Deploy <https://wiki.onap.org/x/CowP>`_ +* `Operate <https://wiki.onap.org/x/TYwP>`_ diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst index 1b51acb35..c934c3a04 100644 --- a/docs/guides/onap-user/servicedesigner.rst +++ b/docs/guides/onap-user/servicedesigner.rst @@ -2,4 +2,7 @@ Service Designer ================ +.. note:: + Until this section is migrated to gerrit/readthedocs, use the link below. +* `Service Designer <https://wiki.onap.org/x/E4AP>`_ |
