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/
15 Starting from Honolulu release, Cert-Manager and Prometheus Stack are a part
16 of k8s PaaS for ONAP operations and can be installed to provide
17 additional functionality for ONAP engineers.
19 The versions of PaaS components that are supported by OOM are as follows:
21 .. table:: ONAP PaaS components
23 ============== ============= =================
24 Release Cert-Manager Prometheus Stack
25 ============== ============= =================
28 ============== ============= =================
30 This guide provides instructions on how to install the PaaS
41 Cert-Manager is a native Kubernetes certificate management controller.
42 It can help with issuing certificates from a variety of sources, such as
43 Let’s Encrypt, HashiCorp Vault, Venafi, a simple signing key pair, self
44 signed or external issuers. It ensures certificates are valid and up to
45 date, and attempt to renew certificates at a configured time before expiry.
50 The recommended version of Cert-Manager for Kubernetes 1.19 is v1.5.4.
51 Cert-Manager is deployed using regular YAML manifests which include all
52 the needed resources (the CustomResourceDefinitions, cert-manager,
53 namespace, and the webhook component).
55 Full installation instructions, including details on how to configure extra
56 functionality in Cert-Manager can be found in the
57 `Cert-Manager Installation documentation`_.
59 There is also a kubectl plugin (kubectl cert-manager) that can help you
60 to manage cert-manager resources inside your cluster. For installation
61 steps, please refer to `Cert-Manager kubectl plugin documentation`_.
63 Installation can be as simple as::
65 > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.4/cert-manager.yaml
67 Prometheus Stack (optional)
68 ===========================
70 Prometheus is an open-source systems monitoring and alerting toolkit with
73 Kube Prometheus Stack is a collection of Kubernetes manifests, Grafana
74 dashboards, and Prometheus rules combined with documentation and scripts to
75 provide easy to operate end-to-end Kubernetes cluster monitoring with
76 Prometheus using the Prometheus Operator. As it includes both Prometheus
77 Operator and Grafana dashboards, there is no need to set up them separately.
82 The recommended version of kube-prometheus-stack chart for
83 Kubernetes 1.19 is 19.x (which is currently the latest major chart version),
86 In order to install Prometheus Stack, you must follow these steps:
88 - Create the namespace for Prometheus Stack::
90 > kubectl create namespace prometheus
92 - Add the prometheus-community Helm repository::
94 > helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
96 - Update your local Helm chart repository cache::
100 - To install the kube-prometheus-stack Helm chart in latest version::
102 > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus
104 To install the kube-prometheus-stack Helm chart in specific version, for example 19.0.2::
106 > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=19.0.2