karavi-metrics-powerflex

README

Dell Container Storage Modules (CSM) for Observability - Metrics for PowerFlex

Metrics for PowerFlex is part of Dell Container Storage Modules (CSM) for Observability, which provides Kubernetes administrators standardized approaches for storage observability in Kuberenetes environments.

Metrics for PowerFlex is an open source distributed solution that provides insight into storage usage and performance as it relates to the CSI (Container Storage Interface) Driver for Dell PowerFlex.

Metrics for PowerFlex captures telemetry data of storage usage and performance obtained through the CSI Driver for Dell PowerFlex. The Metrics service pushes it to the OpenTelemetry Collector, so it can be processed, and exported in a format consumable by Prometheus. Prometheus can then be configured to scrape the OpenTelemetry Collector exporter endpoint to provide metrics so they can be visualized in Grafana.

For documentation, please visit Container Storage Modules documentation.

Table of Contents

• Code of Conduct
• Maintainer Guide
• Committer Guide
• Contributing Guide
• List of Adopters
• Support
• Security
• About

Building Metrics for PowerFlex

If you wish to clone and build the Metrics for PowerFlex service, a Linux host is required with the following installed:

Component	Version	Additional Information
Docker	v19+	Docker installation
Docker Registry		Access to a local/corporate Docker registry
Golang	v1.14+	Golang installation
gosec		gosec
gomock	v.1.4.3	Go Mock
git	latest	Git installation
gcc		Run sudo apt install build-essential
kubectl	1.18-1.20	Ensure you copy the kubeconfig file from the Kubernetes cluster to the linux host. kubectl installation
Helm	v.3.3.0	Helm installation

Once all prerequisites are on the Linux host, follow the steps below to clone and build the metrics service:

1. Clone the repository using the following command: git clone https://github.com/dell/karavi-metrics-powerflex.git
2. Set the DOCKER_REPO environment variable to point to the local Docker repository, for example: export DOCKER_REPO=<ip-address>:<port>
3. In the karavi-metrics-powerflex directory, run the following command to build the Docker image called csm-metrics-powerflex: make docker
4. Tag (with the "latest" tag) and push the image to the local Docker repository by running the following command: make tag push

Note: Linux support only. If you are using a local insecure docker registry, ensure you configure the insecure registries on each of the Kubernetes worker nodes to allow access to the local docker repository.

Testing Metrics for PowerFlex

From the root directory where the repo was cloned, the unit tests can be executed using the following command:

make test

This will also provide code coverage statistics for the various Go packages.

Versioning

This project is adhering to Semantic Versioning.

About

Dell Container Storage Modules (CSM) is 100% open source and community-driven. All components are available under Apache 2 License on GitHub.