Skip to content

Commit d169309

Browse files
authored
Reorganize the README to add instructions and Public Weekly Link (grafana#1448)
* Reorganize the README * center alignment * update heading level * update slack link * add a codeowners file * newline
1 parent 01abb82 commit d169309

File tree

2 files changed

+89
-37
lines changed

2 files changed

+89
-37
lines changed

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @NissesSenap @weisdd @ishanjainn @theSuess @HubertStefanski @pb82

README.md

Lines changed: 88 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,111 @@
1+
<div align="center">
2+
13
# Grafana Operator
24

3-
[![Grafana](https://img.shields.io/badge/grafana-%23F46800.svg?&logo=grafana&logoColor=white)](https://grafana.com)
5+
[![Grafana](https://img.shields.io/badge/grafana-%23F46800.svg?&logo=grafana&logoColor=white)](https://grafana.com/)
46
[![Grafana Operator](https://img.shields.io/badge/Grafana%20Operator-orange)](https://grafana.github.io/grafana-operator/)
57
[![GitHub tag](https://img.shields.io/github/tag/grafana/grafana-operator.svg)](https://github.com/grafana/grafana-operator/tags)
68
[![GitHub Last Commit](https://img.shields.io/github/last-commit/grafana/grafana-operator)](https://github.com/grafana/grafana-operator/tags)
79
[![GitHub Contributors](https://img.shields.io/github/contributors/grafana/grafana-operator)](https://github.com/grafana/grafana-operator/tags)
810

9-
The Grafana Operator is a Kubernetes operator built to help you manage your Grafana instances in and outside of
10-
Kubernetes.
11-
12-
We make it possible for you to manage and share your grafana resources through code between multiple instances in an
13-
easy and scalable way.
11+
**[Official Documentation](https://grafana-operator.github.io/grafana-operator/)** | **[Quickstart](#getting-started)** | **[Installation](#installation)** | **[Tutorials](https://grafana.com/docs/grafana-cloud/developer-resources/infrastructure-as-code/grafana-operator/)**
1412

15-
Find out more on our official website:
16-
***[grafana.github.io/grafana-operator](https://grafana-operator.github.io/grafana-operator/).***
13+
</div>
1714

18-
## Some Convincing Benefits
15+
The Grafana Operator is a Kubernetes operator built to help you manage your Grafana instances and its resources in and outside of
16+
Kubernetes.
1917

20-
Why go with the Grafana-operator over a standard standalone Grafana deployment for your monitoring stack?
18+
Whether you’re running one Grafana instance or many, the Grafana Operator simplifies the processes of installing, configuring, and maintaining Grafana and its resources. Additionally, it's perfect for those who prefer to manage resources using infrastructure as code or using GitOps workflows through tools like ArgoCD and Flux CD.
2119

22-
If [the benefits of using an operator over standalone products as outlined by the people that created them](https://operatorframework.io/)
23-
and our current high-profile users aren't enough to convince you, here's some more:
20+
## Getting Started
2421

25-
- The ability to run a multi-namespace, multi-instance Grafana deployment without having to concern yourself with the
26-
overhead of managing it!
27-
- Management of Dashboards, Datasources, Plugins etc. through code
28-
- Efficient dashboard management through Jsonnet/Grafonnet, plugins and folders
29-
- Agnostic deployment on k8s and Openshift
30-
- The operator knows what environment it runs, and adjust the deployment accordingly without user interference!
31-
- Management of external Grafana instances
32-
- Run the operator for off-cluster instances and leverage the benefits of GitOps without abandoning your
33-
previous instances!
34-
- Multi-Arch builds and container images.
35-
- Operatorhub/OLM support (Allows you to install the operator with a few clicks).
22+
### Installation
23+
24+
**Option 1: Helm Chart**
25+
26+
Deploy the Grafana Operator easily in your cluster using Helm:
27+
28+
```bash
29+
helm upgrade -i grafana-operator oci://ghcr.io/grafana/helm-charts/grafana-operator --version v5.6.3
30+
```
31+
32+
**Option 2: Kustomize & More**
33+
34+
Prefer Kustomize, Openshift OLM, or Kubernetes directly? Find detailed instructions in our [Installation Guide](https://grafana.github.io/grafana-operator/docs/installation/kustomize/).
35+
36+
For even more detailed setups, see our [documentation](docs/README.md).
37+
38+
### Example: Deploying Grafana & A Dashboard
39+
40+
Here's a simple example of deploying Grafana and a Grafana Dashboard using the custom resources (CRs) defined by the Grafana Operator:
41+
42+
```yaml
43+
apiVersion: grafana.integreatly.org/v1beta1
44+
kind: Grafana
45+
metadata:
46+
name: grafana
47+
labels:
48+
dashboards: "grafana"
49+
spec:
50+
config:
51+
log:
52+
mode: "console"
53+
auth:
54+
disable_login_form: false
55+
security:
56+
admin_user: root
57+
admin_password: secret
58+
59+
---
60+
apiVersion: grafana.integreatly.org/v1beta1
61+
kind: GrafanaDashboard
62+
metadata:
63+
name: sample-dashboard
64+
spec:
65+
resyncPeriod: 30s
66+
instanceSelector:
67+
matchLabels:
68+
dashboards: "grafana"
69+
json: >
70+
{
71+
"title": "Simple Dashboard",
72+
"timezone": "browser",
73+
"refresh": "5s",
74+
"panels": [],
75+
"time": {
76+
"from": "now-6h",
77+
"to": "now"
78+
}
79+
}
80+
```
81+
82+
For more tailored setups and resources management, check out these guides:
83+
84+
- [Managing Data Sources and Dashboards](https://grafana.com/docs/grafana-cloud/developer-resources/infrastructure-as-code/grafana-operator/operator-dashboards-folders-datasources/)
85+
- [GitOps Dashboards Management with ArgoCD](https://grafana.com/docs/grafana-cloud/developer-resources/infrastructure-as-code/grafana-operator/manage-dashboards-argocd/)
86+
87+
## Why Grafana Operator?
88+
89+
Switching to Grafana Operator from traditional deployments amplifies your efficiency by:
90+
91+
- Enabling multi-instance and multi-namespace Grafana deployments effortlessly.
92+
- Simplifying dashboard, data sources, and plugin management through code.
93+
- Supporting both Kubernetes and Openshift with smart adjustments based on the environment.
94+
- Allowing management of external Grafana instances for robust GitOps integration.
95+
- Providing multi-architecture support, making it versatile across different platforms.
96+
- Offering one-click installation through Operatorhub/OLM.
3697
3798
## Get In Touch!
3899
39-
The best way to reach us is to file an issue on
40-
***[Issues Tab](https://github.com/grafana/grafana-operator/issues)***
41-
or click on the ***[Slack Icon](https://kubernetes.slack.com/archives/C019A1KTYKC)*** below
42-
43-
We're happy to help out in all grafana-operator issues, and if you're not sure, we'll point you in the right direction!
100+
Got questions or suggestions? Let us know! The quickest way to reach us is through our [GitHub Issues](https://github.com/grafana/grafana-operator/issues) or by joining our weekly public meeting on Tuesdays at 12:30 PM UTC (link [here](https://meet.google.com/spw-jtbk-mwj)).
44101
45-
<a href="https://kubernetes.slack.com/archives/C019A1KTYKC"><img src= "./media/slack.png" align='middle' width=100 height=100 ></a>
46-
47-
## Getting Started
102+
Feel free to drop into our Grafana Operator discussions on:
48103
49-
All of our releases are available through
104+
[![Kubernetes Slack](https://img.shields.io/badge/kubernetes%20slack-white?logo=slack&logoColor=black)](https://kubernetes.slack.com/archives/C019A1KTYKC) [![Grafana Slack](https://img.shields.io/badge/grafana%20community%20Slack-4A254A?logo=slack&logoColor=white)](https://join.slack.com/t/grafana/shared_invite/zt-2eqidcplt-QzkxMuhZA4tGQeFQenE_MQ)
50105
51-
- Helm
52-
- Kustomize
53-
- Openshift OLM and Kubernetes ***[Operator Hub](https://operatorhub.io/operator/grafana-operator)***
54106
55-
Follow our ***[docs](docs/README.md)*** for more installation specific instructions
56107
57-
### Development And Local Deployment
108+
## Contributing
58109
59110
For more information on how to contribute to the operator look at [CONTRIBUTING.md](CONTRIBUTING.md).
60111

0 commit comments

Comments
 (0)