diff options
| -rw-r--r-- | docs/docs_StndDefined_Events_Collection_Mechanism.rst | 2 | ||||
| -rw-r--r-- | docs/docs_scaleout.rst | 66 | ||||
| -rw-r--r-- | docs/docs_vFW_CNF_CDS.rst | 4 | ||||
| -rw-r--r-- | docs/docs_vfwHPA.rst | 2 | ||||
| -rw-r--r-- | docs/tox.ini | 3 |
5 files changed, 69 insertions, 8 deletions
diff --git a/docs/docs_StndDefined_Events_Collection_Mechanism.rst b/docs/docs_StndDefined_Events_Collection_Mechanism.rst index cc5f00e81..88deba4a1 100644 --- a/docs/docs_StndDefined_Events_Collection_Mechanism.rst +++ b/docs/docs_StndDefined_Events_Collection_Mechanism.rst @@ -40,7 +40,7 @@ In order to prepare second instance of VES Collector please follow below procedu 1. (Optional step) If VES Collector should obtaining X.509 certificates from CMPv2 server for secure xNF connections please follow below steps: - - Install `Cert Manager <https://docs.onap.org/projects/onap-oom/en/latest/oom_setup_paas.html#cert-manager>`_ + - Install `Cert Manager <https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/infra_guides/oom_base_config_setup.html#install-cert-manager>`_ - Configure `Cert Service <https://docs.onap.org/projects/onap-oom-platform-cert-service/en/jakarta/sections/configuration.html>`_ if external CMP v2 server is in use. 2. If usage of config maps from OOM containing schema files is required please follow procedure for diff --git a/docs/docs_scaleout.rst b/docs/docs_scaleout.rst index 7c1c4f3f9..80ee6bf95 100644 --- a/docs/docs_scaleout.rst +++ b/docs/docs_scaleout.rst @@ -79,8 +79,70 @@ A section like that is required in that override file openStackKeystoneVersion: "KEYSTONE_V3" The values that must be changed according to your lab are all "openStack******" parameters + dcaeCollectorIp + nfsIpAddress -To know how to encrypt the openstack passwords, please look at the guide here: -https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html + +**Generating SO Encrypted Password:** + +The SO Encrypted Password uses a java based encryption utility since the +Java encryption library is not easy to integrate with openssl/python that +Robot uses in Dublin and upper versions. + +.. note:: + To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword`` + ensure `default-jdk` is installed:: + + apt-get update; apt-get install default-jdk + + Then execute (on oom repository):: + + 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 + + javac Crypto.java + java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY" + +**Update the OpenStack parameters:** + +There are assumptions in the demonstration VNF Heat templates about the +networking available in the environment. To get the most value out of these +templates and the 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. + +``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_parameters.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. + +**Generating ROBOT Encrypted Password:** + +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`` call on oom respository:: + + cd so/resources/config/mso/ + /oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p`` Initialize the Customer and Owning entities =========================================== diff --git a/docs/docs_vFW_CNF_CDS.rst b/docs/docs_vFW_CNF_CDS.rst index 4ac979e35..5e01df317 100644 --- a/docs/docs_vFW_CNF_CDS.rst +++ b/docs/docs_vFW_CNF_CDS.rst @@ -1865,7 +1865,7 @@ Future development areas for CNF support: Some of the features from the list above are covered by the Jakarta roadmap described in `REQ-890`_. -.. _ONAP Deployment Guide: https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html +.. _ONAP Deployment Guide: https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/deployment_guides/oom_deployment.html .. _CDS Documentation: https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/ .. _vLB use-case: https://wiki.onap.org/pages/viewpage.action?pageId=71838898 .. _vFW_CNF_CDS Model: https://git.onap.org/demo/tree/heat/vFW_CNF_CDS/templates?h=guilin @@ -1890,7 +1890,7 @@ Some of the features from the list above are covered by the Jakarta roadmap desc .. _REQ-458: https://jira.onap.org/browse/REQ-458 .. _REQ-627: https://jira.onap.org/browse/REQ-627 .. _REQ-890: https://jira.onap.org/browse/REQ-890 -.. _Python SDK: https://docs.onap.org/projects/onap-integration/en/latest/integration-tooling.html#python-onapsdk +.. _Python SDK: https://docs.onap.org/projects/onap-integration/en/latest/integration-tooling.html#python-onap-sdk .. _KUD Jenkins ci/cd verification: https://jenkins.onap.org/job/multicloud-k8s-master-kud-deployment-verify-shell/ .. _K8s cloud site config: https://docs.onap.org/en/latest/guides/onap-operator/cloud_site/k8s/index.html .. _SO Monitoring: https://docs.onap.org/projects/onap-so/en/latest/developer_info/Working_with_so_monitoring.html diff --git a/docs/docs_vfwHPA.rst b/docs/docs_vfwHPA.rst index 737b4fd5d..147d80d2a 100644 --- a/docs/docs_vfwHPA.rst +++ b/docs/docs_vfwHPA.rst @@ -30,7 +30,7 @@ This tutorial covers enhancements 1 to 5 in Background of https://wiki.onap.org/ Setting Up and Installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Install OOM ONAP using the deploy script in the integration repo. Instructions for this can be found in this link https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html. When the installation is complete (all the pods are either in running or completed state) Do the following; +Install OOM ONAP using the deploy script in the integration repo. Instructions for this can be found in this link https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/deployment_guides/oom_deployment.html. When the installation is complete (all the pods are either in running or completed state) Do the following; 1. Check that all the required components were deployed; diff --git a/docs/tox.ini b/docs/tox.ini index 64af58bec..543b20671 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -23,6 +23,5 @@ deps = -r{toxinidir}/requirements-docs.txt -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck whitelist_externals = echo |