diff options
Diffstat (limited to 'docs/guides/onap-operator/settingup/index.rst')
| -rw-r--r-- | docs/guides/onap-operator/settingup/index.rst | 86 |
1 files changed, 10 insertions, 76 deletions
diff --git a/docs/guides/onap-operator/settingup/index.rst b/docs/guides/onap-operator/settingup/index.rst index 764f3ee9a..fe4d46ded 100644 --- 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>` |