X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_setup_paas.rst;h=2dabcb1aeadfd3a8cbb23dd2871e2f3c793ca52e;hb=90aa482417e8731446baaa2040ff12531d6a4c58;hp=6b7b9c3babafe1fd73893e572adde307fb332dcb;hpb=0866aa1ed5305ffa24fd718001ed72cc424f9e3e;p=oom.git diff --git a/docs/oom_setup_paas.rst b/docs/oom_setup_paas.rst index 6b7b9c3bab..2dabcb1aea 100644 --- a/docs/oom_setup_paas.rst +++ b/docs/oom_setup_paas.rst @@ -6,6 +6,7 @@ .. Links .. _Cert-Manager Installation documentation: https://cert-manager.io/docs/installation/kubernetes/ .. _Cert-Manager kubectl plugin documentation: https://cert-manager.io/docs/usage/kubectl-plugin/ +.. _Strimzi Apache Kafka Operator helm Installation documentation: https://strimzi.io/docs/operators/in-development/deploying.html#deploying-cluster-operator-helm-chart-str .. _oom_setup_paas: @@ -15,16 +16,20 @@ ONAP PaaS set-up Starting from Honolulu release, Cert-Manager and Prometheus Stack are a part of k8s PaaS for ONAP operations and can be installed to provide additional functionality for ONAP engineers. +Starting from Jakarta release, Strimzi Apache Kafka is deployed to provide +Apache kafka as the default messaging bus for ONAP. The versions of PaaS components that are supported by OOM are as follows: .. table:: ONAP PaaS components - ============== ============= ================= - Release Cert-Manager Prometheus Stack - ============== ============= ================= + ============== ============= ================= ======= + Release Cert-Manager Prometheus Stack Strimzi + ============== ============= ================= ======= honolulu 1.2.0 13.x - ============== ============= ================= + istanbul 1.5.4 19.x + jakarta 0.28.0 + ============== ============= ================= ======= This guide provides instructions on how to install the PaaS components for ONAP. @@ -34,6 +39,40 @@ components for ONAP. :local: .. +Strimzi Apache Kafka Operator +============================= + +Strimzi 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 a +Kubernetes application. +Strimzi Operators extend Kubernetes functionality, automating common +and complex tasks related to a Kafka deployment. By implementing +knowledge of Kafka operations in code, Kafka administration +tasks are simplified and require less manual intervention. + +Installation steps +------------------ + +The recommended version of Strimzi for Kubernetes 1.19 is v0.28.0. +The Strimzi cluster operator is deployed using helm to install the parent chart +containing all of the required custom resource definitions. This should be done +by a kubernetes administrator to allow for deployment of custom resources in to +any kubernetes namespace within the cluster. + +Full installation instructions can be found in the +`Strimzi Apache Kafka Operator helm Installation documentation`_. + +Installation can be as simple as: + +- Add the helm repo:: + + > helm repo add strimzi https://strimzi.io/charts/ + +- Install the operator:: + + > helm install strimzi-kafka-operator strimzi/strimzi-kafka-operator --namespace strimzi-system --version 0.28.0 --set watchAnyNamespace=true --create-namespace + Cert-Manager ============ @@ -46,7 +85,7 @@ date, and attempt to renew certificates at a configured time before expiry. Installation steps ------------------ -The recommended version of Cert-Manager for Kubernetes 1.19 is v1.2.0. +The recommended version of Cert-Manager for Kubernetes 1.19 is v1.5.4. Cert-Manager is deployed using regular YAML manifests which include all the needed resources (the CustomResourceDefinitions, cert-manager, namespace, and the webhook component). @@ -61,7 +100,7 @@ steps, please refer to `Cert-Manager kubectl plugin documentation`_. Installation can be as simple as:: - > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.2.0/cert-manager.yaml + > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.4/cert-manager.yaml Prometheus Stack (optional) =========================== @@ -79,8 +118,8 @@ Installation steps ------------------ The recommended version of kube-prometheus-stack chart for -Kubernetes 1.19 is 13.x (which is currently the latest major chart version), -for example 13.3.1. +Kubernetes 1.19 is 19.x (which is currently the latest major chart version), +for example 19.0.2. In order to install Prometheus Stack, you must follow these steps: @@ -100,6 +139,6 @@ In order to install Prometheus Stack, you must follow these steps: > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus - To install the kube-prometheus-stack Helm chart in specific version, for example 13.3.1:: + To install the kube-prometheus-stack Helm chart in specific version, for example 19.0.2:: - > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=13.3.1 + > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=19.0.2