grafana-org-operator

README

Grafana Org Operator

A Kubernetes operator that manages organizations on Grafana instances through Kubernetes Custom Resources.

Description

Grafana instances can have several organizations to isolate users and resources. Unfortunately, those are not supported by Grafana Operator.

With this operator you'll be able to manage:

• GrafanaInstances with URL and credentials to Grafana Admin APIs
• GrafanaOrgs to create orgs in the referenced instance
• GrafanaOrgDatasources to create datasources in the referenced org
• GrafanaOrgDashboards to create dashboards in the referenced org

This operator is not installing Grafana, you'll need an existing instance. This can be done by either:

• using the grafana helm chart directly or within the kube-prometheus-stack helm chart
• using Grafana Operator
• using any other method

Getting Started

Grafana Org Operator can be installed with:

• Helm: See here
• Kustomize: See here
• Plain manifests: See here

Contributing

• File bugs and feature requests in GitLab issues. Security issues should be marked as confidential.
• Propose documentation or code improvements in GitLab merge requests.

This repository enforces commit message convention, to check this locally install the commitlint hook:

npm install  @commitlint/{config-conventional,cli}
echo 'npx commitlint --edit' >> .git/hooks/commit-msg
chmod +x .git/hooks/commit-msg

NOTE: Run make help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2024 Mathieu Parent math.parent@gmail.com.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.