Nice dashboard and controls for managing Rook Ceph data storage.
You can install/run the Koor data-control-center as a binary or via the Helm chart in Kubernetes.
Using the Helm chart to run in Kubernetes is the recommended way.
Checkout the configuration documentation here.
make
installed- Golang version
1.21
or higher - Node version of at least
v16.x
yarn
for, e.g.,yarn dev
to preview the frontend.buf
cli installed (you can usemake buf
to install it to your Go bin path)go-licenses
: Rungo install github.com/google/go-licenses@latest
.prettier
is installed when runningyarn
.
- Generate Protobuf code:
make gen-proto
- Run server:
make run-server
- Installing the frontend dependencies:
yarn
- Run frontend dev server:
yarn dev
- You can use the built-in debugger to start the "compound" debug group called "All" to have everything ready to start development.
To run the server and everything you need to create a copy of the config.example.yaml
called config.yaml
in the root of the repository.
Depending on what you want to develop/contribute to, you might want to update the config.yaml
as you need. It is recommended to add an user to the users:
list so you can login.
For running the data-control-center a kubeconfig file is currently required. A minikube cluster (extra configuration might be needed) with a Rook Ceph test cluster (manifest) instealld is enough for simple development and testing.
- Must run
prettier
format on any changed files. For Codium/VSCode users that should automatically be configured due to the settings in.vscode/
folder.
The project is licensed under the MIT License.
Licenses of used libraries, code and media can be found in the src/public/licenses/
folder.