diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/helm-search.txt | 1 | ||||
| -rw-r--r-- | docs/oom_quickstart_guide.rst | 12 | ||||
| -rw-r--r-- | docs/oom_setup_paas.rst | 46 | ||||
| -rw-r--r-- | docs/oom_user_guide.rst | 17 |
4 files changed, 66 insertions, 10 deletions
diff --git a/docs/helm-search.txt b/docs/helm-search.txt index 035b9a6b91..4e357b6dc8 100644 --- a/docs/helm-search.txt +++ b/docs/helm-search.txt @@ -35,6 +35,7 @@ local/sdnc 10.0.0 SDN Controller local/sdnc-prom 10.0.0 ONAP SDNC Policy Driven Ownership Management local/sniro-emulator 10.0.0 ONAP Mock Sniro Emulator local/so 10.0.0 ONAP Service Orchestrator +local/strimzi 10.0.0 ONAP Strimzi Apache Kafka local/uui 10.0.0 ONAP uui local/vfc 10.0.0 ONAP Virtual Function Controller (VF-C) local/vid 10.0.0 ONAP Virtual Infrastructure Deployment diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 79a30567fb..a38c6f48bd 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -53,6 +53,18 @@ where <BRANCH> can be an official release tag, such as More details can be found :doc:`here <oom_setup_paas>`. +**Step 4.1** Install Strimzi Kafka Operator: + +- 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 + +More details can be found :doc:`here <oom_setup_paas>`. + **Step 5.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file to suit your deployment with items like the OpenStack tenant information. diff --git a/docs/oom_setup_paas.rst b/docs/oom_setup_paas.rst index ed632dac36..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,17 +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. @@ -35,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 ============ diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 019d84363f..10b57dc5a7 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -55,7 +55,7 @@ ONAP with a few simple commands. Pre-requisites -------------- -Your environment must have the Kubernetes `kubectl` with Cert-Manager +Your environment must have the Kubernetes `kubectl` with Strimzi Apache Kafka, Cert-Manager and Helm setup as a one time activity. Install Kubectl @@ -78,11 +78,6 @@ Verify that the Kubernetes config is correct:: At this point you should see Kubernetes pods running. -Install Cert-Manager -~~~~~~~~~~~~~~~~~~~~ -Details on how to install Cert-Manager can be found -:doc:`here <oom_setup_paas>`. - Install Helm ~~~~~~~~~~~~ Helm is used by OOM for package and configuration management. To install Helm, @@ -96,6 +91,16 @@ Verify the Helm version with:: > helm version +Install Strimzi Apache Kafka Operator +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Details on how to install Strimzi Apache Kafka can be found +:doc:`here <oom_setup_paas>`. + +Install Cert-Manager +~~~~~~~~~~~~~~~~~~~~ +Details on how to install Cert-Manager can be found +:doc:`here <oom_setup_paas>`. + Install the Helm Repo --------------------- Once kubectl and Helm are setup, one needs to setup a local Helm server to |