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 (C) 2022 Nordix Foundation
7 .. _Prometheus stack README: https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/README.md
8 .. _ONAP Next Generation Security & Logging Structure: https://wiki.onap.org/pages/viewpage.action?pageId=103417456
9 .. _Istio setup guide: https://istio.io/latest/docs/setup/install/helm/
10 .. _Kiali setup guide: https://kiali.io/docs/installation/installation-guide/example-install/
11 .. _Kserve setup guide: https://kserve.github.io/website/0.10/admin/kubernetes_deployment/
12 .. _K8ssandra setup guide: https://docs.k8ssandra.io/install/
13 .. _Mariadb-Operator setup guide: https://github.com/mariadb-operator/mariadb-operator
15 .. _oom_base_optional_addons:
20 The following optional applications can be added to your kubernetes
23 Install Prometheus Stack
24 ------------------------
26 Prometheus is an open-source systems monitoring and alerting toolkit with
29 Kube Prometheus Stack is a collection of Kubernetes manifests, Grafana
30 dashboards, and Prometheus rules combined with documentation and scripts to
31 provide easy to operate end-to-end Kubernetes cluster monitoring with
32 Prometheus using the Prometheus Operator. As it includes both Prometheus
33 Operator and Grafana dashboards, there is no need to set up them separately.
34 See the `Prometheus stack README`_ for more information.
36 To install the prometheus stack, execute the following:
38 - Add the prometheus-community Helm repository::
40 > helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
42 - Update your local Helm chart repository cache::
46 - To install prometheus, execute the following, replacing the <recommended-pm-version> with the version defined in the :ref:`versions_table` table::
48 > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --create-namespace --version=<recommended-pm-version>
54 Kiali is used to visualize the Network traffic in a ServiceMesh enabled cluster
55 For setup the kiali operator is used, see `Kiali setup guide`_
57 - Install kiali-operator namespace::
59 > kubectl create namespace kiali-operator
61 > kubectl label namespace kiali-operator istio-injection=enabled
63 - Install the kiali-operator::
65 > helm repo add kiali https://kiali.org/helm-charts
67 > helm repo update kiali
69 > helm install --namespace kiali-operator kiali/kiali-operator
71 - Create Kiali CR file (e.g. kiali.yaml)
73 .. collapse:: kiali.yaml
75 .. include:: ../../resources/yaml/kiali.yaml
80 > kubectl apply -f kiali.yaml
82 - Create Ingress gateway entry for the kiali web interface
83 using the configured Ingress <base-url> (here "simpledemo.onap.org")
84 as described in :ref:`oom_customize_overrides`
86 .. collapse:: kiali-ingress.yaml
88 .. include:: ../../resources/yaml/kiali-ingress.yaml
91 - Add the Ingress entry for Kiali::
93 > kubectl -n istio-system apply -f kiali-ingress.yaml
101 K8ssandra-Operator Installation
102 -------------------------------
104 K8ssandra-Operator is used to ease the installation and lifecycle management
105 Cassandra clusters, including monitoring and backup
107 For setup the K8ssandra operator is used, see `K8ssandra setup guide`_
109 - Install k8ssandra-operator namespace::
111 > kubectl create namespace k8ssandra-operator
113 > kubectl label namespace k8ssandra-operator istio-injection=enabled
115 - Install the k8ssandra-operator replacing the <recommended-version> with the version defined in the :ref:`versions_table` table::
117 > helm repo add k8ssandra https://helm.k8ssandra.io/stable
119 > helm repo update k8ssandra
121 > helm install k8ssandra-operator --namespace k8ssandra-operator
122 k8ssandra/k8ssandra-operator --set global.clusterScoped=true
123 --version=<recommended-version>
125 Mariadb-Operator Installation
126 -----------------------------
128 Mariadb-Operator is used to ease the installation and lifecycle management
129 MariaDB Galera and Replication clusters, including monitoring and backup
131 For setup the Mariadb-Operator is used, see `Mariadb-Operator setup guide`_
133 - Install mariadb-operator namespace::
135 > kubectl create namespace mariadb-operator
137 > kubectl label namespace mariadb-operator istio-injection=enabled
139 - Install the mariadb-operator replacing the <recommended-version> with the version defined in the :ref:`versions_table` table::::
141 > helm repo add mariadb-operator https://mariadb-operator.github.io/mariadb-operator
143 > helm repo update mariadb-operator
145 > helm install mariadb-operator --namespace mariadb-operator
146 mariadb-operator/mariadb-operator --set ha.enabled=true
147 --set metrics.enabled=true --set webhook.certificate.certManager=true
148 --version=<recommended-version>
154 KServe is a standard Model Inference Platform on Kubernetes. It supports
155 RawDeployment mode to enable InferenceService deployment with Kubernetes
156 resources. Comparing to serverless deployment it unlocks Knative limitations
157 such as mounting multiple volumes, on the other hand Scale down and from Zero
158 is not supported in RawDeployment mode.
160 This installation is necessary for the ML models to be deployed as inference
161 service. Once deployed, the inference services can be queried for the
164 **Kserve participant component in Policy ACM requires this installation. Kserve participant deploy/undeploy inference services in Kserve.**
166 Dependent component version compatibility details and installation instructions
167 can be found at `Kserve setup guide`_
169 Kserve installation requires the following components:
171 - Istio. Its installation instructions can be found at :ref:`oom_base_optional_addons_istio_installation`
173 - Cert-Manager. Its installation instructions can be found at :ref:`oom_base_setup_cert_manager`
175 Installation instructions as follows,
177 - Create kserve namespace::
179 > kubectl create namespace kserve
183 > kubectl apply -f https://github.com/kserve/kserve/releases/download/v<recommended-kserve-version>/kserve.yaml
185 - Install Kserve default serving runtimes::
187 > kubectl apply -f https://github.com/kserve/kserve/releases/download/v<recommended-kserve-version>/kserve-runtimes.yaml
189 - Patch ConfigMap inferenceservice-config as follows::
191 > kubectl patch configmap/inferenceservice-config -n kserve --type=strategic -p '{"data": {"deploy": "{\"defaultDeploymentMode\": \"RawDeployment\"}"}}'