update oom related sections

Issue-ID: DOC-798 Signed-off-by: thmsdt <[email protected]> Change-Id: Ic1230b3b12244e61f4dc98ac91fc56663c76ae82
collivier · Nov 10, 2022 · 7676ca2 · 7676ca2
1 parent 0377ab2
commit 7676ca2
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 86 deletions.
diff --git a/docs/guides/onap-operator/cloud_site/openstack/index.rst b/docs/guides/onap-operator/cloud_site/openstack/index.rst
@@ -21,6 +21,32 @@ In this guideline the following parameters/values will be used
 * Region Name: ONAPCloudRegionName
 * Openstack Tenant Region Value: TenantRegion
 * Cloud Owner: MyCompanyName
+* Openstack Cloud User: e.g. admin
+* Openstack Password: needs to be encrypted (see instructions below)
+
+Encrypt Openstack Password for SO
+---------------------------------
+
+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 encrypted password you need to have the OOM project cloned and
+  ensure `default-jdk` is installed::
+
+    apt-get update; apt-get install default-jdk
+
+  Then execute::
+
+    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"
 
 
 Method 1 : without ONAP MultiCloud
@@ -96,19 +122,14 @@ Check status of https://jira.onap.org/projects/MULTICLOUD/issues/MULTICLOUD-970
   USE catalogdb
 
   # First option: Without using ORCHESTRATOR VALUE set to multicloud
+  # (use Openstack credentials - username, encrypted password)
   INSERT INTO identity_services VALUES('MC_KEYSTONE', 'http://msb-iag.onap:80/api/multicloud/v1/MyCompanyName/ONAPCloudRegionName/identity/v2.0', 'admin', '5b6f369745f5f0e1c61da7f0656f3daf93c8030a2ea94b7964c67abdcfb49bdf2fa2266344b4caaca1eba8264d277831', 'service', 'admin', 1, 'KEYSTONE', 'USERNAME_PASSWORD', 'lastUser', '2019-07-05 10:32:00', '2019-07-05 10:32:00','PROJECT_DOMAIN_NAME','USER_DOMAIN_NAME');
   INSERT INTO cloud_sites VALUES('ONAPCloudRegionName', 'TenantRegion', 'MC_KEYSTONE', 2.5, 'ONAPCloudRegionName', NULL, NULL, NULL, 'MySelf', '2019-07-05 10:32:00', '2019-07-05 10:32:00');
 
   # Second option: using ORCHESTRATOR VALUE set to multicloud from Dublin version
   INSERT INTO cloud_sites(ID, REGION_ID, IDENTITY_SERVICE_ID, CLOUD_VERSION, CLLI, ORCHESTRATOR) values("ONAPCloudRegionName", "ONAPCloudRegionName", "DEFAULT_KEYSTONE", "2.5", "My_Complex", "multicloud");
 
 
-**Known restriction with second option**
-
-See the following tickets:
-
-* `MULTICLOUD-846 <https://jira.onap.org/browse/MULTICLOUD-846>`_
-* `MULTICLOUD-866 <https://jira.onap.org/browse/MULTICLOUD-866>`_
 
 ONAP SO VNF Adapter Rest API endpoint version shall be set to version "v2"
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/guides/onap-operator/settingup/index.rst b/docs/guides/onap-operator/settingup/index.rst
@@ -19,99 +19,33 @@ The recommended ONAP deployment can be deployed on a private set of physical
 hosts or VMs (or even a combination of the two) and is based on Kubernetes,
 Docker containers and Helm installer.
 
-
 Requirements
 ------------
 
-OOM requires the following  Software components.
+ONAP deployment via OOM requires the following software components.
 
-* Kubernetes
+* Kubernetes cluster
 * Helm
 * kubectl
 * Docker
 
 The Software versions needed for the specific ONAP release
 as well as the minimum Hardware configuration can be found in the
-:ref:`OOM Cloud Setup Guide<onap-oom:oom_cloud_setup_guide>`
-
+:ref:`OOM Infrastructure Setup Guide<onap-oom:oom_infra_setup_guide>`
 
 Installation
 ------------
 
-Creation of Kubernetes cluster is described here:
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-:ref:`OOM Cloud Setup Guide<onap-oom:oom_cloud_setup_guide>`
-
-:ref:`ONAP on HA Kubernetes Cluster<onap-oom:onap-on-kubernetes-with-rancher>`
-
-Some ONAP functionalities require optional PaaS components described here:
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-:ref:`ONAP PaaS set-up (optional)<onap-oom:oom_setup_paas>`
-
-ONAP installation is described here:
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-:ref:`OOM Quickstart Guide<onap-oom:oom_quickstart_guide>`
-
-:ref:`OOM User Guide<onap-oom:oom_user_guide>`
-
-Alternative way of offline ONAP installation is described here:
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-:ref:`OOM Offline-Installer<onap-oom-offline-installer:master_index>`
-
-.. note::
-   Prior to deployment of ONAP, there is no need to download manually any Docker
-   container. The OOM deployment takes care to automatically download the Docker
-   containers.
-
-   It is also possible to deploy a subset of ONAP components on a single VM.
-   The VM flavor to be used depends on the number of ONAP components to be
-   deployed.
-
-NodePorts
----------
-
-NodePorts are used to allow client applications, that run outside of
-Kubernetes, access to ONAP components deployed by OOM.
-A NodePort maps an externally reachable port to an internal port of an ONAP
-microservice.
-It should be noted that the use of NodePorts is temporary.
-An alternative solution based on Ingress Controller, which initial support is
-already in place. It is planned to become a default deployment option in the
-Guilin release.
-
-More information from official Kubernetes documentation about
-`NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport>`_.
+On the target Kubernetes cluster ONAP requires the setup of a Base Platform:
 
-The following table lists all the NodePorts used by ONAP.
+:ref:`OOM Base Platform <onap-oom:oom_base_setup_guide>`
 
-.. csv-table:: NodePorts table
-   :file: nodeports.csv
-   :widths: 20,20,20,20,20
-   :header-rows: 1
+Additional optional setups (e.g. Prometheus) and instructions can be found in:
 
-.. note::
-   \*) POMBA, LOG and SNIRO are not part of the default Frankfurt ONAP
-   deployment.
+:ref:`OOM Ingress controller setup (optional)<onap-oom:oom_base_optional_addons>`
 
-This table retrieves information from the ONAP deployment using the following
-Kubernetes command:
+:ref:`OOM Ingress controller setup (optional)<onap-oom:oom_setup_ingress_controller>`
 
-.. code-block:: bash
+ONAP configuration and installation instructions are described here:
 
-  kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'
+:ref:`OOM Deployment Guide<onap-oom:oom_deploy_guide>`
diff --git a/docs/platform/components/index.rst b/docs/platform/components/index.rst
@@ -171,8 +171,8 @@ OOM - ONAP Operations Manager
      - Documentation
    * - :ref:`oom<onap-oom:master_index>`
      - ONAP Operations Manager
-   * - :ref:`oom/offline-installer<onap-oom-offline-installer:master_index>`
-     - OOM Offline Installer
+   * - :ref:`oom/platform/cert-service<onap-oom-platform-cert-service:master_index>`
+     - OOM Certification Service
 
 OOF - Optimization Framework
 ----------------------------

diff --git a/docs/release/component-release-notes.rst b/docs/release/component-release-notes.rst
@@ -81,8 +81,6 @@ OOM - ONAP Operations Manager
 - :ref:`oom <onap-oom:release_notes>`
 - :ref:`oom/platform/cert-service <onap-oom-platform-cert-service:release_notes>`
 
-.. - :ref:`oom/offline-installer <onap-oom-offline-installer:release_notes>` ### changelog file needs at least the anchor / combine CL & RL?
-
 POLICY - Policy Framework
 -------------------------
 - :ref:`policy/parent <onap-policy-parent:release_notes>`