4b4fbf78830e30219f41ebb40ead9623c3d92659
[oom.git] / docs / sections / guides / infra_guides / oom_base_optional_addons.rst
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
5
6 .. Links
7 .. _Prometheus stack README: https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack#readme
8
9 .. _oom_base_optional_addons:
10
11 OOM Optional Addons
12 ###################
13
14 The following optional applications can be added to your kubernetes environment.
15
16 Install Prometheus Stack
17 ************************
18
19 Prometheus is an open-source systems monitoring and alerting toolkit with
20 an active ecosystem.
21
22 Kube Prometheus Stack is a collection of Kubernetes manifests, Grafana
23 dashboards, and Prometheus rules combined with documentation and scripts to
24 provide easy to operate end-to-end Kubernetes cluster monitoring with
25 Prometheus using the Prometheus Operator. As it includes both Prometheus
26 Operator and Grafana dashboards, there is no need to set up them separately.
27 See the `Prometheus stack README`_ for more information.
28
29 To install the prometheus stack, execute the following:
30
31 - Add the prometheus-community Helm repository::
32
33     > helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
34
35 - Update your local Helm chart repository cache::
36
37     > helm repo update
38
39 - To install prometheus, execute the following, replacing the <recommended-pm-version> with the version defined in the :ref:`versions_table` table::
40
41     > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --create-namespace --version=<recommended-pm-version>