Skip to content

Commit

Permalink
feat(github): add documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Nicolas Lamirault <[email protected]>
  • Loading branch information
nlamirault committed Sep 3, 2024
1 parent 1d82c30 commit 53ef0b0
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Portefaix Grafana Dashboards

## Description

This repository contains some [Grafana](https://github.com/grafana/grafana) dashboards.

You can also download them on [Grafana.com](https://grafana.com/grafana/dashboards/?plcmt=top-nav&cta=downloads&search=portefaix).

## Dashboards

| File name | Description | Screenshot |
| :-------- | :---------- | :--------: |

## Installation

### Helm (Grafana or KubePrometheusStack)

```yaml
grafana:
dashboardProviders:
dashboardproviders.yaml:
apiVersion: 1
providers:
- name: "portefaix-grafana-dashboards"
orgId: 1
folder: "Portefaix"
type: file
disableDeletion: true
editable: true
options:
path: /var/lib/grafana/dashboards/portefaix-grafana-dashboards
dashboards:
portefaix-grafana-dashboards:
sre:
url: httpshttps://raw.githubusercontent.com/portefaix/portefaix-grafana-dashboards/dashboards/sre.json
token: ""
```
### Grafana Operator
```yaml
---
apiVersion: grafana.integreatly.org/v1beta1
kind: Grafana
metadata:
name: grafana
labels:
grafana.com/dashboard: main
spec:
config:
log:
mode: "console"
auth:
disable_login_form: "false"
security:
admin_user: root
admin_password: secret
---
apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaDashboard
metadata:
name: grafanadashboard-from-url
labels:
grafana.com/dashboard: main
spec:
instanceSelector:
matchLabels:
grafana.com/dashboard: main
url: "https://raw.githubusercontent.com/portefaix/portefaix-grafana-dashboards/dashboards/sre.json"
```

0 comments on commit 53ef0b0

Please sign in to comment.