You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f8f6e0a
Browse filesBrowse the repository at this point in the historyBrowse files
Upgrade grafana operator to the latest available version (#356)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
## Release Notes
- **New Features**
- Updated Helm chart and application versions for Grafana Operator.
- Introduced new Custom Resource Definitions (CRDs) for managing alert
rules, contact points, notification policies, and more.
- Added support for ServiceMonitor to enhance Prometheus scraping
capabilities.
- New configuration options for better customization, including
`watchNamespaceSelector`, `isOpenShift`, and `namespaceOverride`.
- **Documentation**
- Expanded README with Terraform installation instructions and upgrade
guidelines.
- Enhanced descriptions for configuration options to improve clarity.
- **Bug Fixes**
- Improved RBAC configurations to ensure proper permissions in
Kubernetes environments.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Signed-off-by: George Gaál <[email protected]>
Copy file name to clipboardExpand all lines: packages/system/grafana-operator/charts/grafana-operator/README.md
+46-4Lines changed: 46 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,18 +7,45 @@ linkTitle: "Helm installation"
7
7
8
8
[grafana-operator](https://github.com/grafana/grafana-operator) for Kubernetes to manage Grafana instances and grafana resources.
Sadly helm OCI charts currently don't support searching for available versions of a helm [oci registry](https://github.com/helm/helm/issues/11000).
21
21
22
+
### Using Terraform
23
+
24
+
To install the helm chart using terraform, make sure you use the right values for `repository` and `name` as shown below:
Helm does not provide functionality to update custom resource definitions. This can result in the operator misbehaving when a release contains updates to the custom resource definitions.
40
+
To avoid issues due to outdated or missing definitions, run the following command before updating an existing installation:
The `--server-side` and `--force-conflict` flags are required to avoid running into issues with the `kubectl.kubernetes.io/last-applied-configuration` annotation.
47
+
By using server side apply, this annotation is not considered. `--force-conflict` allows kubectl to modify fields previously managed by helm.
48
+
22
49
## Development
23
50
24
51
For general and helm specific development instructions please read the [CONTRIBUTING.md](../../../CONTRIBUTING.md)
@@ -38,24 +65,39 @@ It's easier to just manage this configuration outside of the operator.
38
65
| additionalLabels | object |`{}`| additional labels to add to all resources |
39
66
| affinity | object |`{}`| pod affinity |
40
67
| env | list |`[]`| Additional environment variables |
41
-
| fullnameOverride | string |`""`||
68
+
| extraObjects | list |`[]`| Array of extra K8s objects to deploy |
| image.tag | string |`""`| Overrides the image tag whose default is the chart appVersion. |
45
73
| imagePullSecrets | list |`[]`| image pull secrets |
74
+
| isOpenShift | bool |`false`| Determines if the target cluster is OpenShift. Additional rbac permissions for routes will be added on OpenShift |
46
75
| leaderElect | bool |`false`| If you want to run multiple replicas of the grafana-operator, this is not recommended. |
47
76
| metricsService.metricsPort | int |`9090`| metrics service port |
77
+
| metricsService.pprofPort | int |`8888`| port for the pprof profiling endpoint |
48
78
| metricsService.type | string |`"ClusterIP"`| metrics service type |
49
-
| nameOverride | string |`""`||
79
+
| nameOverride | string |`""`| Overrides the name of the chart. |
80
+
| namespaceOverride | string |`""`| Overrides the namespace name. |
50
81
| namespaceScope | bool |`false`| If the operator should run in namespace-scope or not, if true the operator will only be able to manage instances in the same namespace |
51
82
| nodeSelector | object |`{}`| pod node selector |
52
83
| podAnnotations | object |`{}`| pod annotations |
53
84
| podSecurityContext | object |`{}`| pod security context |
54
85
| priorityClassName | string |`""`| pod priority class name |
86
+
| rbac.create | bool |`true`| Specifies whether to create the ClusterRole and ClusterRoleBinding. If "namespaceScope" is true or "watchNamespaces" is set, this will create Role and RoleBinding instead. |
| serviceAccount.annotations | object |`{}`| Annotations to add to the service account |
58
90
| serviceAccount.create | bool |`true`| Specifies whether a service account should be created |
59
91
| serviceAccount.name | string |`""`| The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
92
+
| serviceMonitor | object |`{"additionalLabels":{},"enabled":false,"interval":"1m","metricRelabelings":[],"relabelings":[],"scrapeTimeout":"10s","targetLabels":[],"telemetryPath":"/metrics"}`| Enable this to use with Prometheus Operator |
93
+
| serviceMonitor.additionalLabels | object |`{}`| Set of labels to transfer from the Kubernetes Service onto the target |
94
+
| serviceMonitor.enabled | bool |`false`| When set true then use a ServiceMonitor to configure scraping |
95
+
| serviceMonitor.interval | string |`"1m"`| Set how frequently Prometheus should scrape |
96
+
| serviceMonitor.metricRelabelings | list |`[]`| MetricRelabelConfigs to apply to samples before ingestion |
97
+
| serviceMonitor.relabelings | list |`[]`| Set relabel_configs as per https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config|
98
+
| serviceMonitor.scrapeTimeout | string |`"10s"`| Set timeout for scrape |
99
+
| serviceMonitor.targetLabels | list |`[]`| Set of labels to transfer from the Kubernetes Service onto the target |
100
+
| serviceMonitor.telemetryPath | string |`"/metrics"`| Set path to metrics path |
60
101
| tolerations | list |`[]`| pod tolerations |
102
+
| watchNamespaceSelector | string |`""`| Sets the WATCH_NAMESPACE_SELECTOR environment variable, it defines which namespaces the operator should be listening for based on label and key value pair added on namespace kind. By default it's all namespaces. |
61
103
| watchNamespaces | string |`""`| Sets the WATCH_NAMESPACE environment variable, it defines which namespaces the operator should be listening for. By default it's all namespaces, if you only want to listen for the same namespace as the operator is deployed to look at namespaceScope. |
Copy file name to clipboardExpand all lines: packages/system/grafana-operator/charts/grafana-operator/README.md.gotmpl
+29-1Lines changed: 29 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ linkTitle: "Helm installation"
7
7
8
8
[grafana-operator](https://github.com/grafana/grafana-operator) for Kubernetes to manage Grafana instances and grafana resources.
Sadly helm OCI charts currently don't support searching for available versions of a helm [oci registry](https://github.com/helm/helm/issues/11000).
21
21
22
+
### Using Terraform
23
+
24
+
To install the helm chart using terraform, make sure you use the right values for `repository`and`name` as shown below:
Helm does not provide functionality to update custom resource definitions. This can result in the operator misbehaving when a release contains updates to the custom resource definitions.
41
+
To avoid issues due to outdated or missing definitions, run the following command before updating an existing installation:
The `--server-side`and`--force-conflict` flags are required to avoid running into issues with the `kubectl.kubernetes.io/last-applied-configuration` annotation.
48
+
By using server side apply, this annotation is not considered.`--force-conflict` allows kubectl to modify fields previously managed by helm.
49
+
22
50
## Development
23
51
24
52
For general and helm specific development instructions please read the [CONTRIBUTING.md](../../../CONTRIBUTING.md)
0 commit comments