1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright 2021 Nokia
7 .. _Cert-Manager Installation documentation: https://cert-manager.io/docs/installation/kubernetes/
8 .. _Cert-Manager kubectl plugin documentation: https://cert-manager.io/docs/usage/kubectl-plugin/
9 .. _Strimzi Apache Kafka Operator helm Installation documentation: https://strimzi.io/docs/operators/in-development/deploying.html#deploying-cluster-operator-helm-chart-str
16 Starting from Honolulu release, Cert-Manager and Prometheus Stack are a part
17 of k8s PaaS for ONAP operations and can be installed to provide
18 additional functionality for ONAP engineers.
19 Starting from Jakarta release, Strimzi Apache Kafka is deployed to provide
20 Apache kafka as the default messaging bus for ONAP.
22 The versions of PaaS components that are supported by OOM are as follows:
24 .. table:: ONAP PaaS components
26 ============== ============= ================= =======
27 Release Cert-Manager Prometheus Stack Strimzi
28 ============== ============= ================= =======
32 ============== ============= ================= =======
34 This guide provides instructions on how to install the PaaS
42 Strimzi Apache Kafka Operator
43 =============================
45 Strimzi provides a way to run an Apache Kafka cluster on Kubernetes
46 in various deployment configurations by using kubernetes operators.
47 Operators are a method of packaging, deploying, and managing a
48 Kubernetes application.
49 Strimzi Operators extend Kubernetes functionality, automating common
50 and complex tasks related to a Kafka deployment. By implementing
51 knowledge of Kafka operations in code, Kafka administration
52 tasks are simplified and require less manual intervention.
57 The recommended version of Strimzi for Kubernetes 1.19 is v0.28.0.
58 The Strimzi cluster operator is deployed using helm to install the parent chart
59 containing all of the required custom resource definitions. This should be done
60 by a kubernetes administrator to allow for deployment of custom resources in to
61 any kubernetes namespace within the cluster.
63 Full installation instructions can be found in the
64 `Strimzi Apache Kafka Operator helm Installation documentation`_.
66 Installation can be as simple as:
70 > helm repo add strimzi https://strimzi.io/charts/
72 - Install the operator::
74 > helm install strimzi-kafka-operator strimzi/strimzi-kafka-operator --namespace strimzi-system --version 0.28.0 --set watchAnyNamespace=true --create-namespace
79 Cert-Manager is a native Kubernetes certificate management controller.
80 It can help with issuing certificates from a variety of sources, such as
81 Let’s Encrypt, HashiCorp Vault, Venafi, a simple signing key pair, self
82 signed or external issuers. It ensures certificates are valid and up to
83 date, and attempt to renew certificates at a configured time before expiry.
88 The recommended version of Cert-Manager for Kubernetes 1.19 is v1.5.4.
89 Cert-Manager is deployed using regular YAML manifests which include all
90 the needed resources (the CustomResourceDefinitions, cert-manager,
91 namespace, and the webhook component).
93 Full installation instructions, including details on how to configure extra
94 functionality in Cert-Manager can be found in the
95 `Cert-Manager Installation documentation`_.
97 There is also a kubectl plugin (kubectl cert-manager) that can help you
98 to manage cert-manager resources inside your cluster. For installation
99 steps, please refer to `Cert-Manager kubectl plugin documentation`_.
101 Installation can be as simple as::
103 > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.4/cert-manager.yaml
105 Prometheus Stack (optional)
106 ===========================
108 Prometheus is an open-source systems monitoring and alerting toolkit with
111 Kube Prometheus Stack is a collection of Kubernetes manifests, Grafana
112 dashboards, and Prometheus rules combined with documentation and scripts to
113 provide easy to operate end-to-end Kubernetes cluster monitoring with
114 Prometheus using the Prometheus Operator. As it includes both Prometheus
115 Operator and Grafana dashboards, there is no need to set up them separately.
120 The recommended version of kube-prometheus-stack chart for
121 Kubernetes 1.19 is 19.x (which is currently the latest major chart version),
124 In order to install Prometheus Stack, you must follow these steps:
126 - Create the namespace for Prometheus Stack::
128 > kubectl create namespace prometheus
130 - Add the prometheus-community Helm repository::
132 > helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
134 - Update your local Helm chart repository cache::
138 - To install the kube-prometheus-stack Helm chart in latest version::
140 > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus
142 To install the kube-prometheus-stack Helm chart in specific version, for example 19.0.2::
144 > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=19.0.2