README.md

OpenEBS Monitoring add-on

A set of Grafana dashboards and Prometheus alerts for OpenEBS that can be installed as a helm chart or imported as jsonnet mixin.

Status

Beta. This repository currently supports dashboards and alerts for Mayastor, LocalPV LVM, LocalPV ZFS OpenEBS storage engines. This project is under active development and seeking contributions from the community.

Install

Using helm

Setup the monitoring helm repository.

helm repo add monitoring https://openebs.github.io/monitoring/
helm repo update

You can then run helm search repo monitoring to see the charts.

Install the helm chart.

helm install monitoring monitoring/monitoring --namespace openebs --create-namespace

The detailed chart documentation is available in charts directory.

Using kubectl

You can generate YAMLs and install using kubectl. See detailed steps at ./jsonnet.

Usage

Accessing Grafana

# Look at the Grafana pod and check that the pod is in running state
kubectl get pods -n [NAMESPACE] | grep -i grafana
# Note the public IP of any one of the nodes
kubectl get nodes -o wide
# Note the Grafana Service IP
kubectl get svc -n [NAMESPACE] | grep -i grafana
# Open browser and visit http://<NodeIp>:<NodePort> 
#  (where <NodeIp> is the public IP address of your node, and <NodePort> is Grafana Service Port)
#  Default Grafana login credentials- [username: admin, password: admin]

NOTE: If public IP is not available then you can access it via port-forwarding

# Perform port-forwarding
# kubectl port-forward --namespace [NAMESPACE] pods/[grafana-pod-name] [grafrana-foward-port]:[grafana-cluster-port]
# Open browser and visit http://127.0.0.1:[grafana-forward-port]
# Default Grafana login credentials- [username: admin, password: admin]

Contributing

OpenEBS welcomes your feedback and contributions in any form possible.

• Want to raise an issue or help with fixes and features?
  • See open issues
  • See Project Roadmap
• See contributing guide

Community

• Join OpenEBS community on Kubernetes Slack
  • Already signed up? Head to our discussions at #openebs
  • Want to join our contributor community meetings, check this out.
• Join our OpenEBS CNCF Mailing lists
  • For OpenEBS project updates, subscribe to OpenEBS Announcements
  • For interacting with other OpenEBS users, subscribe to OpenEBS Users

Code of conduct

Participation in the OpenEBS community is governed by the CNCF Code of Conduct.

License Compliance