diff options
| -rw-r--r-- | docs/index.rst | 3 | ||||
| -rw-r--r-- | docs/oom_setup_paas.rst | 103 |
2 files changed, 105 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 68b38de9aa..639e069e6d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung +.. Copyright 2018-2021 Amdocs, Bell Canada, Orange, Samsung, Nokia .. _master_index: @@ -15,6 +15,7 @@ OOM Documentation Repository oom_quickstart_guide_helm3.rst oom_user_guide.rst oom_user_guide_helm3.rst + oom_setup_paas.rst oom_developer_guide.rst oom_cloud_setup_guide.rst release-notes.rst diff --git a/docs/oom_setup_paas.rst b/docs/oom_setup_paas.rst new file mode 100644 index 0000000000..9d90558250 --- /dev/null +++ b/docs/oom_setup_paas.rst @@ -0,0 +1,103 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2021 Nokia + +.. 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/ + +.. _oom_setup_paas: + +ONAP PaaS set-up (optional) +########################### + +Starting from Honolulu release, Cert-Manager and Prometheus Stack are a part +of k8s PaaS for ONAP operations and can be optionally installed to provide +additional functionality for ONAP engineers. + +The versions of PaaS compoents that are supported by OOM are as follows: + +.. table:: ONAP PaaS components + + ============== ============= ================= + Release Cert-Manager Prometheus Stack + ============== ============= ================= + honolulu 1.2.0 13.x + ============== ============= ================= + +This guide provides instructions on how to install the following PaaS +components for ONAP: + +- Cert-Manager +- Prometheus Stack + +Cert-Manager +============ + +Cert-Manager is a native Kubernetes certificate management controller. +It can help with issuing certificates from a variety of sources, such as +Let’s Encrypt, HashiCorp Vault, Venafi, a simple signing key pair, self +signed or external issuers. It ensures certificates are valid and up to +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. +Cert-Manager is deployed using regular YAML manifests which include all +the needed resources (the CustomResourceDefinitions, cert-manager, +namespace, and the webhook component). + +Full installation instructions, including details on how to configure extra +functionality in Cert-Manager can be found in the +`Cert-Manager Installation documentation`_. + +There is also a kubectl plugin (kubectl cert-manager) that can help you +to manage cert-manager resources inside your cluster. For installation +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 + +Prometheus Stack +================ + +Prometheus is an open-source systems monitoring and alerting toolkit with +an active ecosystem. + +Kube Prometheus Stack is a collection of Kubernetes manifests, Grafana +dashboards, and Prometheus rules combined with documentation and scripts to +provide easy to operate end-to-end Kubernetes cluster monitoring with +Prometheus using the Prometheus Operator. As it includes both Prometheus +Operator and Grafana dashboards, there is no need to set up them separately. + +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. + +In order to install Prometheus Stack, you must follow these steps: + +- Create the namespace for Prometheus Stack:: + + > kubectl create namespace prometheus + +- Add the prometheus-community Helm repository:: + + > helm repo add prometheus-community https://prometheus-community.github.io/helm-charts + +- Update your local Helm chart repository cache:: + + > helm repo update + +- To install the kube-prometheus-stack Helm chart in latest version:: + + > 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:: + + > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=13.3.1 |