OpenEBS Monitoring add-on

This repository contains monitoring-related (like Prometheus, grafana, etc,) artifacts like helm charts/ YAMLs. The goal of this repository is to provide an easy to setup monitoring stack for OpenEBS.

This repository will aggregate all the monitoring related artifacts that are currently spread across multiple repositories like:

• https://github.com/openebs/openebs/tree/master/k8s
• https://github.com/openebs/charts/tree/gh-pages/grafana-charts

Status

Pre-alpha. Under active development.

Usage

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add the repo as follows:

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

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

Install Chart

Please visit the link for install instructions via helm3.

# Helm
helm install [RELEASE_NAME] openebs-monitoring/openebs-monitoring --namespace [NAMESPACE] --create-namespace

See helm install for command documentation.

Install openebs-addon-only

#Helm
helm install [RELEASE_NAME] openebs-monitoring/openebs-monitoring -n  [PROMETHEUS-STACK-NAMESPACE]  --set kube-prometheus-stack.install=false, openebsMonitoringAddon.enabled=true

Please visit the link for more detailed instructions.

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
# Open browser and visit http://<NodeIp>:<NodePort> (where <NodeIp> is the public IP address of your node, and default Grafana <NodePort> is 32515)
# 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] 32515:3000
# Open browser and visit http://127.0.0.1:32515
# Default Grafana login credentials- [username: admin, password: admin]

The detailed chart documentation is available in openebs-monitoring directory.

Contributing

OpenEBS community welcomes your feedback and contributions in any form possible.

Want to raise an issue or help with fixes and features?

• See open issues
• 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.