https://github.com/dell/karavi-topology
Karavi Topology provides Kubernetes administrators insight into the Kubernetes storage topology as it relates to Dell products
https://github.com/dell/karavi-topology
Last synced: 12 months ago
JSON representation
Karavi Topology provides Kubernetes administrators insight into the Kubernetes storage topology as it relates to Dell products
- Host: GitHub
- URL: https://github.com/dell/karavi-topology
- Owner: dell
- License: apache-2.0
- Created: 2020-10-15T13:09:05.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-19T09:43:28.000Z (over 1 year ago)
- Last Synced: 2024-12-19T10:23:08.494Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 301 KB
- Stars: 12
- Watchers: 21
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Dell Container Storage Modules (CSM) for Observability - Topology
[](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
[](LICENSE)
[](https://hub.docker.com/r/dellemc/csm-topology)
[](go.mod)
[](https://github.com/dell/karavi-topology/releases/latest)
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](https://dell.github.io/csm-docs/).
## Table of Contents
- [Code of Conduct](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
- [Maintainer Guide](https://github.com/dell/csm/blob/main/docs/MAINTAINER_GUIDE.md)
- [Committer Guide](https://github.com/dell/csm/blob/main/docs/COMMITTER_GUIDE.md)
- [Contributing Guide](https://github.com/dell/csm/blob/main/docs/CONTRIBUTING.md)
- [List of Adopters](https://github.com/dell/csm/blob/main/docs/ADOPTERS.md)
- [Dell support](https://www.dell.com/support/incidents-online/en-us/contactus/product/container-storage-modules)
- [Security](https://github.com/dell/csm/blob/main/docs/SECURITY.md)
- [About](#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](https://docs.docker.com/engine/install/) |
| Docker Registry | | Access to a local/corporate [Docker registry](https://docs.docker.com/registry/) |
| Golang | v1.14+ | [Golang installation](https://github.com/travis-ci/gimme) |
| gosec | | [gosec](https://github.com/securego/gosec) |
| gomock | v.1.4.3 | [Go Mock](https://github.com/golang/mock) |
| git | latest | [Git installation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) |
| 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](https://kubernetes.io/docs/tasks/tools/install-kubectl/) |
| Helm | v.3.3.0 | [Helm installation](https://helm.sh/docs/intro/install/) |
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`
1. Set the DOCKER_REPO environment variable to point to the local Docker repository, for example: `export DOCKER_REPO=:`
1. In the karavi-topology directory, run the following command to build the Docker image called karavi-topology: `make clean build docker`
1. 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:
```console
make test
```
This will also provide code coverage statistics for the various Go packages.
## Versioning
This project is adhering to [Semantic Versioning](https://semver.org/).
## About
Dell Container Storage Modules (CSM) is 100% open source and community-driven. All components are available
under [Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0.html) on
GitHub.