README.md

Dell Container Storage Modules (CSM) for Observability - Topology

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

Topology provides Kubernetes administrators with the topology data related to containerized storage that is provisioned by CSI (Container Storage Interface) Drivers for Dell storage products.

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 Topology

If you wish to clone and build the CSM Topology services, 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-topology.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-topology directory, run the following command to build the Docker image called karavi-topology: make clean build docker
4. To tag (with the "latest" tag) and push the image to the local Docker repository run the following command: make tag push

Note: This only supports Linux. 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 Topology

From the root directory where the repo was cloned, the unit tests can be executed by running the command as follows:

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.