Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.02 KB

README.md

File metadata and controls

64 lines (42 loc) · 3.02 KB
Raw

Using OpenEBS with K8s

The artifacts in this repository contain unreleased changes.

If you are looking at deploying from a stable release, please follow the instructions at Quick Start Guide

If this is your first time to Kubernetes, please go through these introductory tutorials:

Usage

Installing Pre-released OpenEBS (at your own risk)

kubectl apply -f openebs-operator.yaml

The following YAML contains configuration that is required by the pre-release-features, that are currently under development. As we progress towards the release, the content in this will be either moved to openebs-operator.yaml or installed/configured via the code.

kubectl apply -f openebs-pre-release-features.yaml

(Optional) Configuring CStor Pools and Storage Class

With 0.7, node-disk-manager is installed that discovers and create Disk CRs for each non OS disk attached to the nodes. Get the list of disks using kubectl get disks --show-labels and update the Disk CR Names in the openebs-config.yaml. It is recommended to specify one Disk CR per storage node.

kubectl apply -f openebs-config.yaml

(Optional) Enable monitoring using prometheus and grafana

Use this step if you don't already have monitoring services installed on your k8s cluster.

kubectl apply -f openebs-monitoring-pg.yaml

This folder also contains a sample openebs volume monitoring dashboard (openebs-pg-dashboard.json) that can be imported into your grafana.

(Optional) Enable monitoring using Prometheus Operator

It is assumed that you have prometheus operator already deployed and working fine. If not done already follow instructions to do it here.

While deploying above chart make sure the values of specified field are as follows:

    serviceMonitorSelectorNilUsesHelmValues: false
    serviceMonitorSelector: {}
    serviceMonitorNamespaceSelector: {}

This makes sure that all the ServiceMonitor objects from all namespaces we create further will be selected.

Now to monitor openebs related resources create following ServiceMonitor object in openebs namespace. See openebs-servicemonitor.yaml file.

kubectl -n openebs apply -f openebs-servicemonitor.yaml

Find docs here to read about other fields in ServiceMonitor object.

Now once this config is picked up by prometheus operator it will start scraping the metrics and you can start seeing them in prometheus dashboard. The metrics relevant to openebs are conveniently prefixed with openebs* or latest_openebs*.