Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update readme #577

Merged
merged 8 commits into from
Nov 3, 2021
Merged

docs: update readme #577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
55625cd
docs: update readme
hubeadmin Oct 21, 2021
e78cc49
fix: broken images in markdown table
hubeadmin Oct 21, 2021
1504666
chore: fix lint issues
hubeadmin Oct 21, 2021
db4cfe6
chore: address typo
hubeadmin Oct 28, 2021
f056353
add github datasource (#584)
vmanley Oct 28, 2021
c5745fa
docs: update readme.md
hubeadmin Oct 29, 2021
8365117
Merge branch 'master' into misc-updates
hubeadmin Oct 29, 2021
040915d
Merge branch 'master' into misc-updates
hubeadmin Nov 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 60 additions & 116 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,90 +1,17 @@
# Grafana Operator

A Kubernetes Operator based on the Operator SDK for creating and managing Grafana instances.
An operator to provision and manage Grafana Instances, Dashboards, Datasources and notification channels. Based on the [Operator-SDK](https://sdk.operatorframework.io/)

## Companies and teams that trust and use the Grafana operator

<table class="tg">
<tbody>
<tr>
<td class="tg-0lax">
<div class="card" css=>
<img src="media/users/redhat.png" alt="Avatar" style= width=250 height=100;box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; margin: auto; padding: 2px 16px;">
<h4><b></b></h4>
<p><a href="https://www.redhat.com/">Red Hat</a></p>
</div>
</div>
</td>
<td class="tg-0lax">
<div class="card" css=>
<img src="media/users/integreatly.png" alt="Avatar" style=margin: auto;width="250" height="100" box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; padding: 2px 16px;">
<h4><b><a href ="https://github.com/integr8ly/integreatly-operator">Integreatly</a></b></h4>
<p><a href="https://www.redhat.com/en/products/integration">Red Hat</a></p>
</div>
</div>
</td>
<td class="tg-0lax"> <div class="card" css=>
<img src="media/users/continental.png" alt="Avatar" style="margin: auto;width="250" height="100" box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; margin: auto; padding: 2px 16px;">
<h4><b>Digital Services France</b></h4>
<p><a href="https://www.continental.com/">Continental</a></p>
</div>
</div>
</td>
<td class="tg-0lax">
<div class="card" css=>
<img src="media/users/handelsbanken.svg" alt="Avatar" style=margin:auto; width=250; height=150; box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; margin: auto; padding: 2px 16px;">
<h4><b><a href="https://www.handelsbanken.se/en/">handelsbanken</a></b></h4>
<p></p>
</div>
</div>
</td>
<td class="tg-0lax">
<div class="card" css=>
<img src="media/users/xenit.png" alt="Avatar" style=margin:auto; width=250; max-height=150; box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; margin: auto; padding: 2px 16px;">
<h4><b><a href="https://xenit.se/contact/">xenit</a></b></h4>
<p></p>
</div>
</div>
</td>
<td class="tg-0lax">
<div class="card" css=>
<img src="media/users/torqata.jpg" alt="Avatar" style=margin:auto; width=250; max-height=150; box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; margin: auto; padding: 2px 16px;">
<h4><b><a href="https://torqata.com">Torqata</a></b></h4>
<p></p>
</div>
</div>
</td>

<!-- PLACE ME HERE -->
</tr>
</tbody>
</table>

***If you find this operator useful in your product/deployment, feel free to send a pull request to add your company/team to be displayed here!***
| Company | Logo | Company | Logo
| :--- | :----: | :--- | :----: |
| [Red Hat](https://www.redhat.com)| <img src= "./media/users/redhat.png" width=100 height=100 > | [Integreatly](https://www.redhat.com/en/products/integration)|<img src= "./media/users/integreatly.png" width=100 height=100> |
[Continental](https://www.continental.com/)|<img src= "./media/users/continental.png" width=100 height=100 > | [Handelsbanken]("https://www.handelsbanken.se/en/")|<img src= "./media/users/handelsbanken.svg" width=100 height=100 >|
| [Xenit](https://xenit.se/contact/)|<img src= "./media/users/xenit.png" width=150 height=50 >| [Torqata](https://torqata.com)|<img src= "./media/users/torqata.jpg" width=150 height=50 > |

<!-- COPY ME -->
<!-- <td class="tg-0lax">
<div class="card" css=>
<img src="media/users/integreatly.png" alt="Avatar" style="margin: auto; width:100%; height: box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
transition: 0.3s;">
<div class="container" style="text-align: center; margin: auto; padding: 2px 16px;">
<h4><b>Integreatly</b></h4>
<p>Red Hat</p>
</div>
</div>
</td> -->
***If you find this operator useful in your product/deployment, feel free to send a pull request to add your company/team to be displayed here!***

## Grafana Operator on the Kubernetes community Slack

Expand All @@ -106,33 +33,57 @@ or search for "grafana-operator" in the browse channels option.

## Current status

The Operator is available on [Operator Hub](https://operatorhub.io/operator/grafana-operator).
All releases of the operator can be found on [Operator Hub](https://operatorhub.io/operator/grafana-operator).

It can deploy and manage a Grafana instance on Kubernetes and OpenShift. The following features are supported:
***Sometimes a release may take a few hours (in rare cases, days) to land on Operatorhub, please be patient, it's out of our control.***

* Install Grafana to a namespace
* Import Grafana dashboards from the same or other namespaces
* Assign Grafana dashboards to custom or namespace-named grafana folders
* Import Grafana datasources from the same namespace
* Install Plugins (panels) defined as dependencies of dashboards
### Supported Versions

## Summary of benefits
#### v3.x

***This version has known vulnerabilities present, rooted in the version of the operator-sdk that was used, please upgrade to v4(operator-sdk v1.3.0) to mitigate the risk***

This version of the operator will be deprecated in the near future, we recommend new users to install v4 and existing users to upgrade as soon as possible using the [upgrade guide](./documentation/upgrade.md).

We won't be accepting any new features for v3, the only releases made under this version will be either bug-fixes or security patches.

The operator-sdk is an exception to the security patch rule, it cannot be updated without introducing breaking changes, hence the recommendation to upgrade to v4, which mitigates these CVEs.

The documentation for this version can be found here: [https://github.com/grafana-operator/grafana-operator/tree/v3/documentation](https://github.com/grafana-operator/grafana-operator/tree/v3/documentation).

#### v4.x (master)

This is the current main branch of the project, all future development will take place here, any new features and improvements should be submitted against this branch.

Please use the following link to access documentation at any given release of the operator:

A list of benefits of using the operator over a single grafana deployment.
```txt
https://github.com/grafana-operator/grafana-operator/tree/<version>/documentation
```

## Summary of benefits

[The benefits of using an operator over standalone products as outlined by the people that created them](https://operatorframework.io/)
Why decide to go with the Grafana-operator over a standard standalone Grafana deployment for your monitoring stack?

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

* The ability to configure and manage grafana deployments using kubernetes resources such as CRDs,configMaps etc
* Incoming changes to allow for multi-namespace support for the operator, meaning that just one instance of the operator can manage every instance of grafana on the cluster!
* Reducing the need for manual steps, allowing for quicker setups for things such as (and not limited to):
* Ingresses
* Grafana product versions
* Grafana dashboard plugins
* The ability to configure and manage your entire Grafana with the use Kubernetes resources such as CRDs, configMaps, Secrets etc.
* Automation of:
* Ingresses.
* Grafana product versions.
* Grafana dashboard plugins.
* Grafana datasources.
* Grafana notification channel provisioning.
* Oauth proxy.
* many others!
* Manage dashboards more efficiently through jsonnet, plugins and folder assignment, which can all be done through .yamls!
* Periodical reconciliation of resources, ensuring that the desired state is maintained, so nothing will be broken for too long
* Efficient dashboard management through jsonnet, plugins, organisations and folder assignment, which can all be done through `.yamls`!
* Both Kubernetes and OpenShift supported out of the box.
* Multi-Arch builds and container images.
* Operatorhub/OLM support (Allows you to install the operator with a few clicks).

And the things on our roadmap:

* Multi-Namespace and Multi-Instance support, allowing the operator to manage not only your Grafana instance, but also any other grafana instance on the cluster, eg. for public facing customer instance.

## Operator flags

Expand All @@ -147,36 +98,29 @@ The following Grafana resources are supported:
* Grafana
* GrafanaDashboard
* GrafanaDatasource
* GrafanaNotificationChannel

all custom resources use the api group `integreatly.org` and version `v1alpha1`.
hubeadmin marked this conversation as resolved.
Show resolved Hide resolved
To get a overview of the available grafana-operator CRD see api.md.

## Grafana
### Grafanas

Represents a Grafana instance. See [the documentation](./documentation/deploy_grafana.md) for a description of properties supported in the spec.

## GrafanaDashboard
### Dashboards

Represents a Grafana dashboard and allows specifying required plugins. See [the documentation](./documentation/dashboards.md) for a description of properties supported in the spec.

## GrafanaDatasource
### Datasources

Represents a Grafana datasource. See [the documentation](./documentation/datasources.md) for a description of properties supported in the spec.

## Building the operator image
### Notifiers

Init the submodules first to obtain grafonnet:
Represents a Grafana datasource. See [the documentation](./documentation/notifiers.md) for a description of properties supported in the spec.

```sh
make submodule
```

Then build the image using the operator-sdk:

```sh
make docker-build IMG=<registry>/<user>/grafana-operator:<tag>
```

## Running locally
## Developement and Local Deployment

### Using the Makefile
If you want to further develop the operator, here are some instructions how to set up your dev-environment: [follow me](./documentation/develop.md)

If you want to develop/build/test the operator, here are some instructions how to set up your dev-environment: [follow me](./documentation/develop.md)
39 changes: 0 additions & 39 deletions deploy/operatorMasterImage.yaml
View file
Open in desktop

This file was deleted.