Skip to content

Commit 94139d3

Browse files
philippart-sphilippart-s
committed
doc: 📝 add some precision on parameters
1 parent ed9c337 commit 94139d3

File tree

7 files changed

+281
-106
lines changed

7 files changed

+281
-106
lines changed

‎pages/platform/kubernetes-k8s/monitoring-apps-grafana-prometheus/guide.en-asia.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,47 +83,72 @@ Hang tight while we grab the latest from your chart repositories...
8383
Update Complete. ⎈Happy Helming!⎈
8484
</code></pre>
8585

86-
You need to modify some settings. To do this, inspect the chart to retrieve these values ​​in a file:
86+
You could need to modify some settings. To do this, you can set parameters on the command line (`--set param.name=value`) or create a local `values.yml` based on the values from the chart.
87+
To get all the possible parameters:
8788

8889
```bash
89-
helm inspect values prometheus-community/kube-prometheus-stack > /tmp/kube-prometheus-stack.values
90+
helm inspect values prometheus-community/kube-prometheus-stack
9091
```
9192

92-
Open the `/tmp/kube-prometheus-stack.values` file in your favorite editor.
93-
94-
Then search into it for `adminPassword` and replace it with the password you want to use for Grafana.
95-
96-
By default, the Grafana password should be like this:
93+
> [!primary]
94+
>
95+
> Some default values come from other charts, like Grafana for example: https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml
96+
>
9797
98+
For example, a good practice is to change the default administrator password for Grafana.
99+
You can find it in the `grafana` section of the default values of the chart with the name `adminPassword`.
100+
Copy and save the Grafana admin password, you will use it later in this tutorial.
101+
You need change other parameters, like the service type for example.
102+
You can create a `/tmp/values.yml` as following to change these parameters:
98103
```yaml
99-
adminPassword: prom-operator
104+
grafana:
105+
adminPassword: <my cool password>
106+
service:
107+
type: LoadBalancer
108+
109+
prometheus:
110+
prometheusSpec:
111+
serviceMonitorSelectorNilUsesHelmValues: false
112+
service:
113+
type: LoadBalancer
100114
```
101115
102-
Copy and save the Grafana admin password, you will use it later in this tutorial.
103-
104116
You are now ready to install Prometheus and Grafana.
105117
106118
```bash
107119
helm install prometheus-community/kube-prometheus-stack \
108120
--create-namespace --namespace prometheus \
109121
--generate-name \
110-
--values /tmp/kube-prometheus-stack.values \
122+
--values /tmp/values.yml
123+
```
124+
125+
Or you can directly set parameters to avoid creating a `values.yml`:
126+
127+
```bash
128+
helm install prometheus-community/kube-prometheus-stack \
129+
--create-namespace --namespace prometheus \
130+
--generate-name \
111131
--set prometheus.service.type=LoadBalancer \
112132
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
133+
--set grafana.adminPAssword=<my cool password>
113134
--set grafana.service.type=LoadBalancer
114135
```
115136

137+
138+
> [!primary]
139+
>
140+
> You can choose to install or not some components, for example if you don't want Grafana just add `--set grafana.enabled=false` or add the `enabled: false` in the section `grafana` of the `/tmp/values.yml` file.
141+
>
142+
116143
As you can see, a new `prometheus` namespace will be created and we specified that we want to deploy a LoadBalancer in order to access externally to Prometheus and Grafana easily.
117144

118145
You should have a behavior like this:
119146

120147
<pre class="console"><code>$ helm install prometheus-community/kube-prometheus-stack \
121148
--create-namespace --namespace prometheus \
122149
--generate-name \
123-
--values /tmp/kube-prometheus-stack.values \
124-
--set prometheus.service.type=LoadBalancer \
125-
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
126-
--set grafana.service.type=LoadBalancer
150+
--values /tmp/values.yml
151+
127152
NAME: kube-prometheus-stack-1647417678
128153
LAST DEPLOYED: Wed Mar 16 09:01:23 2022
129154
NAMESPACE: prometheus

‎pages/platform/kubernetes-k8s/monitoring-apps-grafana-prometheus/guide.en-au.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,47 +83,72 @@ Hang tight while we grab the latest from your chart repositories...
8383
Update Complete. ⎈Happy Helming!⎈
8484
</code></pre>
8585

86-
You need to modify some settings. To do this, inspect the chart to retrieve these values ​​in a file:
86+
You could need to modify some settings. To do this, you can set parameters on the command line (`--set param.name=value`) or create a local `values.yml` based on the values from the chart.
87+
To get all the possible parameters:
8788

8889
```bash
89-
helm inspect values prometheus-community/kube-prometheus-stack > /tmp/kube-prometheus-stack.values
90+
helm inspect values prometheus-community/kube-prometheus-stack
9091
```
9192

92-
Open the `/tmp/kube-prometheus-stack.values` file in your favorite editor.
93-
94-
Then search into it for `adminPassword` and replace it with the password you want to use for Grafana.
95-
96-
By default, the Grafana password should be like this:
93+
> [!primary]
94+
>
95+
> Some default values come from other charts, like Grafana for example: https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml
96+
>
9797
98+
For example, a good practice is to change the default administrator password for Grafana.
99+
You can find it in the `grafana` section of the default values of the chart with the name `adminPassword`.
100+
Copy and save the Grafana admin password, you will use it later in this tutorial.
101+
You need change other parameters, like the service type for example.
102+
You can create a `/tmp/values.yml` as following to change these parameters:
98103
```yaml
99-
adminPassword: prom-operator
104+
grafana:
105+
adminPassword: <my cool password>
106+
service:
107+
type: LoadBalancer
108+
109+
prometheus:
110+
prometheusSpec:
111+
serviceMonitorSelectorNilUsesHelmValues: false
112+
service:
113+
type: LoadBalancer
100114
```
101115
102-
Copy and save the Grafana admin password, you will use it later in this tutorial.
103-
104116
You are now ready to install Prometheus and Grafana.
105117
106118
```bash
107119
helm install prometheus-community/kube-prometheus-stack \
108120
--create-namespace --namespace prometheus \
109121
--generate-name \
110-
--values /tmp/kube-prometheus-stack.values \
122+
--values /tmp/values.yml
123+
```
124+
125+
Or you can directly set parameters to avoid creating a `values.yml`:
126+
127+
```bash
128+
helm install prometheus-community/kube-prometheus-stack \
129+
--create-namespace --namespace prometheus \
130+
--generate-name \
111131
--set prometheus.service.type=LoadBalancer \
112132
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
133+
--set grafana.adminPAssword=<my cool password>
113134
--set grafana.service.type=LoadBalancer
114135
```
115136

137+
138+
> [!primary]
139+
>
140+
> You can choose to install or not some components, for example if you don't want Grafana just add `--set grafana.enabled=false` or add the `enabled: false` in the section `grafana` of the `/tmp/values.yml` file.
141+
>
142+
116143
As you can see, a new `prometheus` namespace will be created and we specified that we want to deploy a LoadBalancer in order to access externally to Prometheus and Grafana easily.
117144

118145
You should have a behavior like this:
119146

120147
<pre class="console"><code>$ helm install prometheus-community/kube-prometheus-stack \
121148
--create-namespace --namespace prometheus \
122149
--generate-name \
123-
--values /tmp/kube-prometheus-stack.values \
124-
--set prometheus.service.type=LoadBalancer \
125-
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
126-
--set grafana.service.type=LoadBalancer
150+
--values /tmp/values.yml
151+
127152
NAME: kube-prometheus-stack-1647417678
128153
LAST DEPLOYED: Wed Mar 16 09:01:23 2022
129154
NAMESPACE: prometheus

‎pages/platform/kubernetes-k8s/monitoring-apps-grafana-prometheus/guide.en-ca.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,47 +83,72 @@ Hang tight while we grab the latest from your chart repositories...
8383
Update Complete. ⎈Happy Helming!⎈
8484
</code></pre>
8585

86-
You need to modify some settings. To do this, inspect the chart to retrieve these values ​​in a file:
86+
You could need to modify some settings. To do this, you can set parameters on the command line (`--set param.name=value`) or create a local `values.yml` based on the values from the chart.
87+
To get all the possible parameters:
8788

8889
```bash
89-
helm inspect values prometheus-community/kube-prometheus-stack > /tmp/kube-prometheus-stack.values
90+
helm inspect values prometheus-community/kube-prometheus-stack
9091
```
9192

92-
Open the `/tmp/kube-prometheus-stack.values` file in your favorite editor.
93-
94-
Then search into it for `adminPassword` and replace it with the password you want to use for Grafana.
95-
96-
By default, the Grafana password should be like this:
93+
> [!primary]
94+
>
95+
> Some default values come from other charts, like Grafana for example: https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml
96+
>
9797
98+
For example, a good practice is to change the default administrator password for Grafana.
99+
You can find it in the `grafana` section of the default values of the chart with the name `adminPassword`.
100+
Copy and save the Grafana admin password, you will use it later in this tutorial.
101+
You need change other parameters, like the service type for example.
102+
You can create a `/tmp/values.yml` as following to change these parameters:
98103
```yaml
99-
adminPassword: prom-operator
104+
grafana:
105+
adminPassword: <my cool password>
106+
service:
107+
type: LoadBalancer
108+
109+
prometheus:
110+
prometheusSpec:
111+
serviceMonitorSelectorNilUsesHelmValues: false
112+
service:
113+
type: LoadBalancer
100114
```
101115
102-
Copy and save the Grafana admin password, you will use it later in this tutorial.
103-
104116
You are now ready to install Prometheus and Grafana.
105117
106118
```bash
107119
helm install prometheus-community/kube-prometheus-stack \
108120
--create-namespace --namespace prometheus \
109121
--generate-name \
110-
--values /tmp/kube-prometheus-stack.values \
122+
--values /tmp/values.yml
123+
```
124+
125+
Or you can directly set parameters to avoid creating a `values.yml`:
126+
127+
```bash
128+
helm install prometheus-community/kube-prometheus-stack \
129+
--create-namespace --namespace prometheus \
130+
--generate-name \
111131
--set prometheus.service.type=LoadBalancer \
112132
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
133+
--set grafana.adminPAssword=<my cool password>
113134
--set grafana.service.type=LoadBalancer
114135
```
115136

137+
138+
> [!primary]
139+
>
140+
> You can choose to install or not some components, for example if you don't want Grafana just add `--set grafana.enabled=false` or add the `enabled: false` in the section `grafana` of the `/tmp/values.yml` file.
141+
>
142+
116143
As you can see, a new `prometheus` namespace will be created and we specified that we want to deploy a LoadBalancer in order to access externally to Prometheus and Grafana easily.
117144

118145
You should have a behavior like this:
119146

120147
<pre class="console"><code>$ helm install prometheus-community/kube-prometheus-stack \
121148
--create-namespace --namespace prometheus \
122149
--generate-name \
123-
--values /tmp/kube-prometheus-stack.values \
124-
--set prometheus.service.type=LoadBalancer \
125-
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
126-
--set grafana.service.type=LoadBalancer
150+
--values /tmp/values.yml
151+
127152
NAME: kube-prometheus-stack-1647417678
128153
LAST DEPLOYED: Wed Mar 16 09:01:23 2022
129154
NAMESPACE: prometheus

‎pages/platform/kubernetes-k8s/monitoring-apps-grafana-prometheus/guide.en-gb.md

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -83,47 +83,72 @@ Hang tight while we grab the latest from your chart repositories...
8383
Update Complete. ⎈Happy Helming!⎈
8484
</code></pre>
8585

86-
You need to modify some settings. To do this, inspect the chart to retrieve these values ​​in a file:
86+
You could need to modify some settings. To do this, you can set parameters on the command line (`--set param.name=value`) or create a local `values.yml` based on the values from the chart.
87+
To get all the possible parameters:
8788

8889
```bash
89-
helm inspect values prometheus-community/kube-prometheus-stack > /tmp/kube-prometheus-stack.values
90+
helm inspect values prometheus-community/kube-prometheus-stack
9091
```
9192

92-
Open the `/tmp/kube-prometheus-stack.values` file in your favorite editor.
93-
94-
Then search into it for `adminPassword` and replace it with the password you want to use for Grafana.
95-
96-
By default, the Grafana password should be like this:
93+
> [!primary]
94+
>
95+
> Some default values come from other charts, like Grafana for example: https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml
96+
>
9797
98+
For example, a good practice is to change the default administrator password for Grafana.
99+
You can find it in the `grafana` section of the default values of the chart with the name `adminPassword`.
100+
Copy and save the Grafana admin password, you will use it later in this tutorial.
101+
You need change other parameters, like the service type for example.
102+
You can create a `/tmp/values.yml` as following to change these parameters:
98103
```yaml
99-
adminPassword: prom-operator
104+
grafana:
105+
adminPassword: <my cool password>
106+
service:
107+
type: LoadBalancer
108+
109+
prometheus:
110+
prometheusSpec:
111+
serviceMonitorSelectorNilUsesHelmValues: false
112+
service:
113+
type: LoadBalancer
100114
```
101115
102-
Copy and save the Grafana admin password, you will use it later in this tutorial.
103-
104116
You are now ready to install Prometheus and Grafana.
105117
106118
```bash
107119
helm install prometheus-community/kube-prometheus-stack \
108120
--create-namespace --namespace prometheus \
109121
--generate-name \
110-
--values /tmp/kube-prometheus-stack.values \
122+
--values /tmp/values.yml
123+
```
124+
125+
Or you can directly set parameters to avoid creating a `values.yml`:
126+
127+
```bash
128+
helm install prometheus-community/kube-prometheus-stack \
129+
--create-namespace --namespace prometheus \
130+
--generate-name \
111131
--set prometheus.service.type=LoadBalancer \
112132
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
133+
--set grafana.adminPAssword=<my cool password>
113134
--set grafana.service.type=LoadBalancer
114135
```
115136

137+
138+
> [!primary]
139+
>
140+
> You can choose to install or not some components, for example if you don't want Grafana just add `--set grafana.enabled=false` or add the `enabled: false` in the section `grafana` of the `/tmp/values.yml` file.
141+
>
142+
116143
As you can see, a new `prometheus` namespace will be created and we specified that we want to deploy a LoadBalancer in order to access externally to Prometheus and Grafana easily.
117144

118145
You should have a behavior like this:
119146

120147
<pre class="console"><code>$ helm install prometheus-community/kube-prometheus-stack \
121148
--create-namespace --namespace prometheus \
122149
--generate-name \
123-
--values /tmp/kube-prometheus-stack.values \
124-
--set prometheus.service.type=LoadBalancer \
125-
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false \
126-
--set grafana.service.type=LoadBalancer
150+
--values /tmp/values.yml
151+
127152
NAME: kube-prometheus-stack-1647417678
128153
LAST DEPLOYED: Wed Mar 16 09:01:23 2022
129154
NAMESPACE: prometheus
@@ -250,4 +275,4 @@ Prometheus and Grafana are very powerful monitoring tools, but also have alertin
250275

251276
To learn more about using your Kubernetes cluster the practical way, we invite you to look at our [OVHcloud Managed Kubernetes documentation](../).
252277

253-
Join our [community of users](https://community.ovh.com/en/).
278+
Join our [community of users](https://community.ovh.com/en/).

0 commit comments

Comments
 (0)