From a1903d622ee35b33086ac8ac8fed3b9e775cce22 Mon Sep 17 00:00:00 2001 From: Pawel Wieczorek Date: Thu, 14 Nov 2019 14:19:59 +0100 Subject: docs: Replace include directives for non existent file This patch resolves issue with including non existent file in OOM documentation. Included file has been removed in [1] and seems to be replaced by "kubernetes/onap/values.yaml" from [2] (91% similarity [3]). [1] ed5ff714fac29651318868a65267030e3c31c3ee (Change-Id: Ia51db5f1489e8d63fd7e1f10e80174eb9f182f0f) [2] ac281bd0798ae7308402f4d19d537546d101afba (Change-Id: I4b74a3a8a35a178298af7205762e2aca7c65dda3) [3] Similarity measured with: $ git checkout ed5ff714^ $ wdiff --no-deleted --no-inserted --no-common --statistics \ kubernetes/onap/values.yaml docs/onap_values.yaml Issue-ID: OOM-2203 Change-Id: I9634797c75f4da4652194f72190b21e30c4feb21 Signed-off-by: Pawel Wieczorek --- docs/oom_quickstart_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/oom_quickstart_guide.rst') diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 2399dc3c7e..9478bcdc1a 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -60,7 +60,7 @@ a. Enabling/Disabling Components: Here is an example of the nominal entries that need to be provided. We have different values file available for different contexts. -.. literalinclude:: onap-values.yaml +.. literalinclude:: ../kubernetes/onap/values.yaml :language: yaml -- cgit 1.2.3-korg From 3c7c6c7956eb3104abdb228b04bac116193923c7 Mon Sep 17 00:00:00 2001 From: Pawel Wieczorek Date: Thu, 14 Nov 2019 15:53:52 +0100 Subject: docs: Ensure literalinclude directive rendering Literalinclude directive is not rendered as such unless separated from the surrounding paragraphs by blank lines (like all paragraphs) [1]. [1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks Issue-ID: OOM-1612 Change-Id: I51e7f8f2f99dfe157b24fe7c5ae4d62281d72e86 Signed-off-by: Pawel Wieczorek --- docs/oom_quickstart_guide.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/oom_quickstart_guide.rst') diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 9478bcdc1a..6023565e0a 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -131,10 +131,12 @@ setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 Example Keystone v2.0 + .. literalinclude:: example-integration-override.yaml :language: yaml Example Keystone v3 (required for Rocky and later releases) + .. literalinclude:: example-integration-override-v3.yaml :language: yaml -- cgit 1.2.3-korg From d7a30356e735749f77bf062a10626449b1d11b77 Mon Sep 17 00:00:00 2001 From: Pawel Wieczorek Date: Thu, 14 Nov 2019 16:29:59 +0100 Subject: docs: Enclose all snippets in code blocks This patch improves documentation readability by making all runnable code snippets stand out. Issue-ID: OOM-2207 Change-Id: I0ffd7892a6c3af4d91f5bdd9adb49c1e01a9c475 Signed-off-by: Pawel Wieczorek --- docs/oom_quickstart_guide.rst | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) (limited to 'docs/oom_quickstart_guide.rst') diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 6023565e0a..a04306ce46 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -69,11 +69,10 @@ The ROBOT encrypted Password uses the same encryption.key as SO but an openssl algorithm that works with the python based Robot Framework. .. note:: - To generate ROBOT openStackEncryptedPasswordHere : + To generate ROBOT openStackEncryptedPasswordHere:: - ``cd so/resources/config/mso/`` - - ``/oom/kubernetes/so/resources/config/mso# echo -n "" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p`` + cd so/resources/config/mso/ + /oom/kubernetes/so/resources/config/mso# echo -n "" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p`` c. Generating SO Encrypted Password: The SO Encrypted Password uses a java based encryption utility since the @@ -81,23 +80,21 @@ Java encryption library is not easy to integrate with openssl/python that ROBOT uses in Dublin. .. note:: - To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword: - - SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key` - - OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX - - git clone http://gerrit.onap.org/r/integration - - cd integration/deployment/heat/onap-rke/scripts + To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword + ensure ``default-jdk`` is installed:: + apt-get update; apt-get install default-jdk - javac Crypto.java + Then execute:: - [ if javac is not installed 'apt-get update ; apt-get install default-jdk' ] + SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key` + OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX - java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY" + git clone http://gerrit.onap.org/r/integration + cd integration/deployment/heat/onap-rke/scripts + javac Crypto.java + java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY" d. Update the OpenStack parameters: @@ -207,12 +204,12 @@ Use the following to monitor your deployment and determine when ONAP is ready fo .. note:: While all pods may be in a Running state, it is not a guarantee that all components are running fine. - Launch the healthcheck tests using Robot to verify that the components are healthy. + Launch the healthcheck tests using Robot to verify that the components are healthy:: - > ~/oom/kubernetes/robot/ete-k8s.sh onap health + > ~/oom/kubernetes/robot/ete-k8s.sh onap health -**Step 10.** Undeploy ONAP +**Step 10.** Undeploy ONAP:: -> helm undeploy dev --purge + > helm undeploy dev --purge More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins -- cgit 1.2.3-korg From 63d70fd6f98be6cd9db91e4cd1a66d86db4f2f16 Mon Sep 17 00:00:00 2001 From: Pawel Wieczorek Date: Thu, 14 Nov 2019 18:32:57 +0100 Subject: docs: Use definition list syntax to clarify terms Definition list syntax quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html#definition-lists Issue-ID: OOM-2208 Change-Id: Iaab4b3befd92288813a70d4e1bac8c4c7bb6e4c6 Signed-off-by: Pawel Wieczorek --- docs/oom_quickstart_guide.rst | 36 +++++++++++++++--------------------- 1 file changed, 15 insertions(+), 21 deletions(-) (limited to 'docs/oom_quickstart_guide.rst') diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index a04306ce46..2c25f4b26e 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -103,28 +103,25 @@ available in the environment. To get the most value out of these templates and t automation that can help confirm the setup is correct, please observe the following constraints. -openStackPublicNetId: - -This network should allow heat templates to add interfaces. -This need not be an external network, floating IPs can be assigned to the ports on -the VMs that are created by the heat template but its important that neutron allow -ports to be created on them. +openStackPublicNetId: + This network should allow heat templates to add interfaces. + This need not be an external network, floating IPs can be assigned to the ports on + the VMs that are created by the heat template but its important that neutron allow + ports to be created on them. openStackPrivateNetCidr: "10.0.0.0/16" - -This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity. -The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the -demonstration ip addressing plan embodied in the preload template prevent conflicts when -instantiating the various VNFs. If you need to change this, you will need to modify the preload -data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data -in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect -to create. + This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity. + The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the + demonstration ip addressing plan embodied in the preload template prevent conflicts when + instantiating the various VNFs. If you need to change this, you will need to modify the preload + data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data + in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect + to create. openStackOamNetworkCidrPrefix: "10.0" - -This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the -robot scripts for demonstration. A production deployment need not worry about this -setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix. + This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the + robot scripts for demonstration. A production deployment need not worry about this + setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix. Example Keystone v2.0 @@ -182,17 +179,14 @@ To deploy all ONAP applications use this command:: All override files may be customized (or replaced by other overrides) as per needs. onap-all.yaml - Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file. environment.yaml - Includes configuration values specific to the deployment environment. Example: adapt readiness and liveness timers to the level of performance of your infrastructure openstack.yaml - Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests. **Step 9.** Verify ONAP installation -- cgit 1.2.3-korg From 27c390c9af231c1442cab85c89cd74a6e5198d38 Mon Sep 17 00:00:00 2001 From: Pawel Wieczorek Date: Fri, 15 Nov 2019 11:12:02 +0100 Subject: docs: Mark filenames and inline code To improve readability and avoid confusion, this patch makes: * all path names and package names - italics, * all snippets as well as command names and arguments - fixed length. Issue-ID: OOM-2207 Change-Id: Ib8075c25cb0479e56e3f7634639eb4d7556b36c7 Signed-off-by: Pawel Wieczorek --- docs/oom_quickstart_guide.rst | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'docs/oom_quickstart_guide.rst') diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 2c25f4b26e..2607805015 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -29,25 +29,25 @@ where can be an offical release tag, such as > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm -**Step 3.** Customize the helm charts like oom/kubernetes/onap/values.yaml or an override -file like onap-all.yaml, onap-vfw.yaml or openstack.yaml file to suit your deployment with items like the -OpenStack tenant information. +**Step 3.** Customize the helm charts like `oom/kubernetes/onap/values.yaml` or an override +file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file to suit your deployment +with items like the OpenStack tenant information. .. note:: - Standard and example override files (e.g. onap-all.yaml, openstack.yaml) can be found in - the oom/kubernetes/onap/resources/overrides/ directory. + Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in + the `oom/kubernetes/onap/resources/overrides/` directory. a. You may want to selectively enable or disable ONAP components by changing - the `enabled: true/false` flags. + the ``enabled: true/false`` flags. - b. Encyrpt the OpenStack password using the shell tool for robot and put it in - the robot helm charts or robot section of openstack.yaml + b. Encrypt the OpenStack password using the shell tool for robot and put it in + the robot helm charts or robot section of `openstack.yaml` c. Encrypt the OpenStack password using the java based script for SO helm charts - or SO section of openstack.yaml. + or SO section of `openstack.yaml`. d. Update the OpenStack parameters that will be used by robot, SO and APPC helm @@ -69,7 +69,7 @@ The ROBOT encrypted Password uses the same encryption.key as SO but an openssl algorithm that works with the python based Robot Framework. .. note:: - To generate ROBOT openStackEncryptedPasswordHere:: + To generate ROBOT ``openStackEncryptedPasswordHere``:: cd so/resources/config/mso/ /oom/kubernetes/so/resources/config/mso# echo -n "" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p`` @@ -80,8 +80,8 @@ Java encryption library is not easy to integrate with openssl/python that ROBOT uses in Dublin. .. note:: - To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword - ensure ``default-jdk`` is installed:: + To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword`` + ensure `default-jdk` is installed:: apt-get update; apt-get install default-jdk @@ -103,13 +103,13 @@ available in the environment. To get the most value out of these templates and t automation that can help confirm the setup is correct, please observe the following constraints. -openStackPublicNetId: +``openStackPublicNetId:`` This network should allow heat templates to add interfaces. This need not be an external network, floating IPs can be assigned to the ports on the VMs that are created by the heat template but its important that neutron allow ports to be created on them. -openStackPrivateNetCidr: "10.0.0.0/16" +``openStackPrivateNetCidr: "10.0.0.0/16"`` This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity. The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the demonstration ip addressing plan embodied in the preload template prevent conflicts when @@ -118,7 +118,7 @@ openStackPrivateNetCidr: "10.0.0.0/16" in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect to create. -openStackOamNetworkCidrPrefix: "10.0" +``openStackOamNetworkCidrPrefix: "10.0"`` This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the robot scripts for demonstration. A production deployment need not worry about this setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix. @@ -162,13 +162,13 @@ follows:: .. literalinclude:: helm-search.txt .. note:: - The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use `make` to update your local Helm repository. + The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use ``make`` to update your local Helm repository. **Step 8.** Once the repo is setup, installation of ONAP can be done with a single command .. note:: - The --timeout 900 is currently required in Dublin to address long running initialization tasks + The ``--timeout 900`` is currently required in Dublin to address long running initialization tasks for DMaaP and SO. Without this timeout value both applications may fail to deploy. To deploy all ONAP applications use this command:: @@ -178,15 +178,15 @@ To deploy all ONAP applications use this command:: All override files may be customized (or replaced by other overrides) as per needs. -onap-all.yaml +`onap-all.yaml` Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file. -environment.yaml +`environment.yaml` Includes configuration values specific to the deployment environment. Example: adapt readiness and liveness timers to the level of performance of your infrastructure -openstack.yaml +`openstack.yaml` Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests. **Step 9.** Verify ONAP installation -- cgit 1.2.3-korg