-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.gotmpl
129 lines (96 loc) · 5.25 KB
/
README.md.gotmpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{{ template "chart.header" . }}
A fork of the official [rancher cluster monitoring](https://github.com/rancher/charts/tree/dev-v2.9/charts/rancher-monitoring)
with more up-to-date prometheus-operator CRDs, features and a maintained fork of rancher's [prometheus-auth](https://github.com/caas-team/prometheus-auth)
to enable multi-tenancy for the prometheus metrics.
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
## Installation
If you're coming from an existing rancher-monitoring installation:
* you must first update the prometheus-operator CRDs separately. This chart only includes the kube-prometheus-stack *without* the CRDs.
* you should additionally uninstall the rancher-monitoring chart before installing this one.
* do not delete the `rancher-monitoring-crds` chart, as this will delete all custom resources already created (or back them up first and recreate them).
To install run the following command:
```bash
helm -n cattle-monitoring-system upgrade -i rancher-monitoring .
```
## Compatibility matrix
The following table shows the compatibility between the CaaS Cluster Monitoring chart and the CaaS Project Monitoring versions:
| CaaS Cluster Monitoring | compatible with CaaS Project Monitoring | used kube-prometheus-stack |
| ----------------------- | --------------------------------------- | ------------------------------ |
| < 0.0.6 | < 1.0.0 | 51.0.3 |
| 0.0.6 < x < 1.0.0 | 1.0.0 <= y < 1.4.0 | 58.4.0 |
where `x` is the CaaS Cluster Monitoring Version and `y` is the CaaS Project Monitoring Version.
## Configuration
The installation can be configured using the various parameters defined in the `values.yaml` file. The following tables list the configurable parameters of the CaaS Cluster Monitoring chart and their default values.
### caas
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "caas" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### global
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "global" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### kube-prometheus-stack
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "kube-prometheus-stack" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### rkeControllerManager
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "rkeControllerManager" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### rkeEtcd
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "rkeEtcd" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### rkeIngressNginx
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "rkeIngressNginx" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### rkeProxy
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "rkeProxy" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### rkeScheduler
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "rkeScheduler" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}
### hardenedKubelet
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
{{- range .Values }}
{{- if (contains "hardenedKubelet" .Key) }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}