Skip to content

About

Ceph provider implementation of the IronCore storage interface

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

5 stars

Watchers

4 watching

Forks

ceph-provider

REUSE status GitHub License PRs Welcome

ceph-provider is a Ceph based provider implementation of the ironcore Volume and Bucket types.

Please consult the project documentation for additional information.

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running on the cluster

  1. Install Instances of Custom Resources:
kubectl apply -f config/samples/
  1. Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/ceph-provider:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/ceph-provider:tag

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

We'd love to get feedback from you. Please report bugs, suggestions or post questions by opening a GitHub issue.

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

Integration Tests

The integration tests start a single-node Ceph cluster (ceph-test) with Docker. The volume provider links against the Ceph client libraries (librados, librbd). If they are not installed, e.g. on macOS, run the tests in a container that has them:

make docker-integration-tests

With the libraries installed, run them directly:

make integration-tests

Variables:

  • CEPH_CLIENT_VERSION: the Ceph release tag of the client libraries in the container, e.g. v19.2.7. The default is set in the Dockerfile, which also uses it for the published images.
  • CEPH_TEST_CLUSTER_VERSION: the Ceph release tag of the cluster, e.g. v19.2.7. Defaults to CEPH_CLIENT_VERSION.

Licensing

Copyright 2025 SAP SE or an SAP affiliate company and IronCore contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.

About

Ceph provider implementation of the IronCore storage interface

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

5 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages