diff options
Diffstat (limited to 'docs/sections/guides/infra_guides')
3 files changed, 103 insertions, 56 deletions
diff --git a/docs/sections/guides/infra_guides/oom_infra_base_config_setup.rst b/docs/sections/guides/infra_guides/oom_infra_base_config_setup.rst index e5ca289aff..6638eb71b6 100644 --- a/docs/sections/guides/infra_guides/oom_infra_base_config_setup.rst +++ b/docs/sections/guides/infra_guides/oom_infra_base_config_setup.rst @@ -31,18 +31,21 @@ the following mandatory installation and configuration steps must be completed. :local: .. -For additional platform add-ons, see the :ref:`oom_base_optional_addons` section. +For additional platform add-ons, see the :ref:`oom_base_optional_addons` +section. Install & configure kubectl --------------------------- -The Kubernetes command line interface used to manage a Kubernetes cluster needs to be installed -and configured to run as non root. +The Kubernetes command line interface used to manage a Kubernetes cluster needs +to be installed and configured to run as non root. -For additional information regarding kubectl installation and configuration see the `kubectl installation guide`_ +For additional information regarding kubectl installation and configuration see +the `kubectl installation guide`_ -To install kubectl, execute the following, replacing the <recommended-kubectl-version> with the version defined -in the :ref:`versions_table` table:: +To install kubectl, execute the following, replacing the +<recommended-kubectl-version> with the version defined in the +:ref:`versions_table` table:: > curl -LO https://dl.k8s.io/release/v<recommended-kubectl-version>/bin/linux/amd64/kubectl @@ -78,11 +81,12 @@ Validate the installation:: Install & configure helm ------------------------ -Helm is used for package and configuration management of the relevant helm charts. -For additional information, see the `helm installation guide`_ +Helm is used for package and configuration management of the relevant helm +charts. For additional information, see the `helm installation guide`_ -To install helm, execute the following, replacing the <recommended-helm-version> with the version defined -in the :ref:`versions_table` table:: +To install helm, execute the following, replacing the +<recommended-helm-version> with the version defined in the +:ref:`versions_table` table:: > wget https://get.helm.sh/helm-v<recommended-helm-version>-linux-amd64.tar.gz @@ -94,8 +98,8 @@ Verify the helm version with:: > helm version -Helm's default CNCF provided `Curated applications for Kubernetes`_ repository called -*stable* can be removed to avoid confusion:: +Helm's default CNCF provided `Curated applications for Kubernetes`_ repository +called *stable* can be removed to avoid confusion:: > helm repo remove stable @@ -120,10 +124,12 @@ Verify the plugins are installed:: Set the default StorageClass ---------------------------- -In some ONAP components it is important to have a default storageClass defined (e.g. cassandra), -if you don't want to explicitly set it during the deployment via helm overrides. +In some ONAP components it is important to have a default storageClass defined +(e.g. cassandra), if you don't want to explicitly set it during the deployment +via helm overrides. -Therefor you should set the default storageClass (if not done during the K8S cluster setup) via the command:: +Therefor you should set the default storageClass (if not done during the K8S +cluster setup) via the command:: > kubectl patch storageclass <storageclass> -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}' @@ -132,9 +138,10 @@ see `DefaultStorageClass`_ Install the Strimzi Kafka Operator ---------------------------------- -Strimzi Apache Kafka provides a way to run an Apache Kafka cluster on Kubernetes -in various deployment configurations by using kubernetes operators. -Operators are a method of packaging, deploying, and managing Kubernetes applications. +Strimzi Apache Kafka provides a way to run an Apache Kafka cluster on +Kubernetes in various deployment configurations by using kubernetes operators. +Operators are a method of packaging, deploying, and managing Kubernetes +applications. Strimzi Operators extend the Kubernetes functionality, automating common and complex tasks related to a Kafka deployment. By implementing @@ -153,8 +160,9 @@ To add the required helm repository, execute the following:: > helm repo add strimzi https://strimzi.io/charts/ -To install the strimzi kafka operator, execute the following, replacing the <recommended-strimzi-version> with the version defined -in the :ref:`versions_table` table:: +To install the strimzi kafka operator, execute the following, replacing the +<recommended-strimzi-version> with the version defined in the +:ref:`versions_table` table:: > helm install strimzi-kafka-operator strimzi/strimzi-kafka-operator --namespace strimzi-system --version <recommended-strimzi-version> --set watchAnyNamespace=true --create-namespace @@ -192,8 +200,9 @@ to manage cert-manager resources inside your cluster. For installation steps, please refer to `Cert-Manager kubectl plugin documentation`_. -To install cert-manager, execute the following, replacing the <recommended-cm-version> with the version defined -in the :ref:`versions_table` table:: +To install cert-manager, execute the following, replacing the +<recommended-cm-version> with the version defined in the +:ref:`versions_table` table:: > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v<recommended-cm-version>/cert-manager.yaml @@ -216,8 +225,8 @@ Istio Service Mesh `ONAP Next Generation Security & Logging Architecture`_ ONAP is currenty supporting Istio as default ServiceMesh platform. -Therefor the following instructions describe the setup of Istio and required tools. -Used `Istio setup guide`_ +Therefor the following instructions describe the setup of Istio and required +tools. Used `Istio setup guide`_ .. _oom_base_optional_addons_istio_installation: @@ -247,11 +256,11 @@ Install Istio Basic Platform > helm upgrade -i istio-base istio/base -n istio-system --version <recommended-istio-version> -- Create an override for istiod (e.g. istiod.yaml) to add the oauth2-proxy as external - authentication provider and apply some specific config settings - Be aware, that from Istio version 1.21.0 the format of the values.yaml changes. - Additionally a new feature (Native Sidecars) can be enabled, if it is enabled in - Kubernetes (version > 1.28) +- Create an override for istiod (e.g. istiod.yaml) to add the oauth2-proxy as + external authentication provider and apply some specific config settings + Be aware, that from Istio version 1.21.0 the format of the values.yaml + changes. Additionally a new feature (Native Sidecars) can be enabled, if it + is enabled in Kubernetes (version > 1.28) .. collapse:: istiod.yaml (version => 1.21) @@ -263,8 +272,9 @@ Install Istio Basic Platform .. include:: ../../resources/yaml/istiod.yaml :code: yaml -- Install the Istio Base Istio Discovery chart which deploys the istiod service, replacing the - <recommended-istio-version> with the version defined in the :ref:`versions_table` table:: +- Install the Istio Base Istio Discovery chart which deploys the istiod + service, replacing the <recommended-istio-version> with the version + defined in the :ref:`versions_table` table:: > helm upgrade -i istiod istio/istiod -n istio-system --version <recommended-istio-version> --wait -f ./istiod.yaml @@ -303,7 +313,8 @@ In the production setup 2 different Ingress setups are supported. - Istio Gateway `Istio-Gateway`_ (alternative, but in the future deprecated) Depending on the solution, the ONAP helm values.yaml has to be configured. -See the :ref:`OOM customized deployment<oom_customize_overrides>` section for more details. +See the :ref:`OOM customized deployment<oom_customize_overrides>` section for +more details. Gateway-API (recommended) ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -336,8 +347,8 @@ Istio Gateway (alternative) > kubectl label namespace istio-ingress istio-injection=enabled -- To expose additional ports besides HTTP/S (e.g. for external Kafka access, SDNC-callhome) - create an override file (e.g. istio-ingress.yaml) +- To expose additional ports besides HTTP/S (e.g. for external Kafka access, + SDNC-callhome) create an override file (e.g. istio-ingress.yaml) .. collapse:: istio-ingress.yaml @@ -387,7 +398,8 @@ Configure Keycloak ^^^^^^^^^^^^^^^^^^ - To configure the Keycloak instance - create an override file (e.g. keycloak-server-values.yaml) + create an override file (e.g. keycloak-server-values.yaml) and use + the "image.tag" of the keycloak version (here 26.0.6) .. collapse:: keycloak-server-values.yaml diff --git a/docs/sections/guides/infra_guides/oom_infra_deployment_requirements.rst b/docs/sections/guides/infra_guides/oom_infra_deployment_requirements.rst index 5020e22563..535ee10d64 100644 --- a/docs/sections/guides/infra_guides/oom_infra_deployment_requirements.rst +++ b/docs/sections/guides/infra_guides/oom_infra_deployment_requirements.rst @@ -15,8 +15,8 @@ ONAP Deployment Requirements .. rubric:: Minimum Hardware Configuration -Some recommended hardware requirements are provided below. Note that this is for a -full ONAP deployment (all components). +Some recommended hardware requirements are provided below. Note that this is +for a full ONAP deployment (all components). .. table:: OOM Hardware Requirements @@ -26,8 +26,10 @@ full ONAP deployment (all components). 224GB 160GB 112 0.0.0.0/0 (all open) ===== ===== ====== ==================== -Customizing ONAP to deploy only components that are needed will drastically reduce these requirements. -See the :ref:`OOM customized deployment<oom_customize_overrides>` section for more details. +Customizing ONAP to deploy only components that are needed will drastically +reduce these requirements. +See the :ref:`OOM customized deployment<oom_customize_overrides>` section for +more details. .. note:: | Kubernetes supports a maximum of 110 pods per node - this can be overcome by modifying your kubelet config. @@ -50,7 +52,7 @@ The versions of software that are supported and tested by OOM are as follows: ============== =========== ======= ======== ======== ============= ======== Montreal 1.27.5 3.12.3 1.27.x 20.10.x 1.13.2 0.36.1 New Delhi 1.28.6 3.13.1 1.28.x 20.10.x 1.14.4 0.41.0 - Oslo 1.28.6 3.13.1 1.28.x 20.10.x 1.14.4 0.43.0 + Oslo 1.28.6 3.13.1 1.30.x 23.0.x 1.16.2 0.44.0 ============== =========== ======= ======== ======== ============= ======== .. table:: OOM Software Requirements (production) @@ -60,15 +62,15 @@ The versions of software that are supported and tested by OOM are as follows: ============== ====== ============ ============== Montreal 1.19.3 v1.0.0 19.0.3-legacy New Delhi 1.21.0 v1.0.0 22.0.4 - Oslo 1.23.0 v1.0.0 22.0.4 + Oslo 1.24.1 v1.2.1 26.0.6 ============== ====== ============ ============== .. table:: OOM Software Requirements (optional) - ============== ================= ========== ================= - Release Prometheus Stack K8ssandra MariaDB-Operator - ============== ================= ========== ================= - Montreal 45.x 1.10.2 0.23.1 - New Delhi 45.x 1.16.0 0.28.1 - Oslo 45.x 1.19.0 0.30.0 - ============== ================= ========== ================= + ============== =========== ========== =========== ============ =========== + Release Prometheus K8ssandra MariaDB-Op Postgres-Op MongoDB-Op + ============== =========== ========== =========== ============ =========== + Montreal 45.x 1.10.2 0.23.1 - - + New Delhi 45.x 1.16.0 0.28.1 - - + Oslo 45.x 1.20.2 0.36.0 5.7.2 1.18.0 + ============== =========== ========== =========== ============ =========== diff --git a/docs/sections/guides/infra_guides/oom_infra_optional_addons.rst b/docs/sections/guides/infra_guides/oom_infra_optional_addons.rst index 7723a231f4..ce623f3d14 100644 --- a/docs/sections/guides/infra_guides/oom_infra_optional_addons.rst +++ b/docs/sections/guides/infra_guides/oom_infra_optional_addons.rst @@ -12,6 +12,7 @@ .. _K8ssandra setup guide: https://docs.k8ssandra.io/install/ .. _Mariadb-Operator setup guide: https://github.com/mariadb-operator/mariadb-operator .. _Postgres-Operator setup guide: https://github.com/CrunchyData/postgres-operator +.. _MongoDB-Operator setup guide: https://docs.percona.com/percona-operator-for-mongodb/helm.html .. _oom_base_optional_addons: @@ -44,7 +45,9 @@ To install the prometheus stack, execute the following: > helm repo update -- To install prometheus, execute the following, replacing the <recommended-pm-version> with the version defined in the :ref:`versions_table` table:: +- To install prometheus, execute the following, replacing the + <recommended-pm-version> with the version defined in the + :ref:`versions_table` table:: > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --create-namespace --version=<recommended-pm-version> @@ -93,7 +96,6 @@ For setup the kiali operator is used, see `Kiali setup guide`_ > kubectl -n istio-system apply -f kiali-ingress.yaml - Jaeger Installation ------------------- @@ -113,7 +115,8 @@ For setup the K8ssandra operator is used, see `K8ssandra setup guide`_ > kubectl label namespace k8ssandra-operator istio-injection=enabled -- Install the k8ssandra-operator replacing the <recommended-version> with the version defined in the :ref:`versions_table` table:: +- Install the k8ssandra-operator replacing the <recommended-version> with the + version defined in the :ref:`versions_table` table:: > helm repo add k8ssandra https://helm.k8ssandra.io/stable @@ -137,12 +140,15 @@ For setup the Mariadb-Operator is used, see `Mariadb-Operator setup guide`_ > kubectl label namespace mariadb-operator istio-injection=enabled -- Install the mariadb-operator replacing the <recommended-version> with the version defined in the :ref:`versions_table` table:::: +- Install the mariadb-operator replacing the <recommended-version> with the + version defined in the :ref:`versions_table` table:::: - > helm repo add mariadb-operator https://mariadb-operator.github.io/mariadb-operator + > helm repo add mariadb-operator https://helm.mariadb.com/mariadb-operator > helm repo update mariadb-operator + > helm install mariadb-operator-crds --namespace mariadb-operator --version=<recommended-version> + > helm install mariadb-operator --namespace mariadb-operator mariadb-operator/mariadb-operator --set ha.enabled=true --set metrics.enabled=true --set webhook.certificate.certManager=true @@ -156,6 +162,30 @@ Postgres DB clusters, including monitoring and backup For setup the Postgres-Operator is used, see `Postgres-Operator setup guide`_ +MongoDB-Operator Installation +------------------------------ + +MongoDB-Operator is used to ease the installation and lifecycle management of +MongoDB DB instances, including monitoring and backup + +For setup the MongoDB-Operator is used, see `MongoDB-Operator setup guide`_ + +- Install mongodb-operator namespace:: + + > kubectl create namespace mongodb-operator + + > kubectl label namespace mongodb-operator istio-injection=enabled + +- Install the mongodb-operator replacing the <recommended-version> with the + version defined in the :ref:`versions_table` table:: + + > helm repo add percona https://percona.github.io/percona-helm-charts + + > helm repo update percona + + > helm install mongodb-operator --namespace mongodb-operator + percona/psmdb-operator --version=<recommended-version> + Kserve Installation ------------------- @@ -169,16 +199,19 @@ This installation is necessary for the ML models to be deployed as inference service. Once deployed, the inference services can be queried for the prediction. -**Kserve participant component in Policy ACM requires this installation. Kserve participant deploy/undeploy inference services in Kserve.** +**Kserve participant component in Policy ACM requires this installation.** +**Kserve participant deploy/undeploy inference services in Kserve.** Dependent component version compatibility details and installation instructions can be found at `Kserve setup guide`_ Kserve installation requires the following components: -- Istio. Its installation instructions can be found at :ref:`oom_base_optional_addons_istio_installation` +- Istio. Its installation instructions can be found at + :ref:`oom_base_optional_addons_istio_installation` -- Cert-Manager. Its installation instructions can be found at :ref:`oom_base_setup_cert_manager` +- Cert-Manager. Its installation instructions can be found at + :ref:`oom_base_setup_cert_manager` Installation instructions as follows, |