Skip to content

ceph/ceph-csi-operator

Repository files navigation

Ceph CSI Operator

Go Report Card License Mergify Status Version

Table of Contents

Overview

The Ceph CSI Operator provides native management interfaces for Ceph-CSI drivers (CephFS, RBD, and NFS) for Kubernetes based environments. The operator automates the deployment, configuration, and management of these drivers using new Kubernetes APIs defined as a set of Custom Resource Definitions (CRDs).

Quick Start

For those eager to get started quickly, follow the steps outlined in the Quick Start Guide.

Installation

For detailed installation instructions, including methods using Helm and manual deployment, please visit the Installation Guide.

Usage

To learn how to use the Ceph CSI Operator, refer to the Usage Guide.

Contributing

We welcome contributions to the Ceph CSI Operator! Please follow development-guide and coding style guidelines if you are interested to contribute to this repo.

Reporting Issues

If you encounter a problem, please open an issue on GitHub. Be sure to fill the template when opening an issue.

Pull Requests

We encourage you to submit pull requests for bug fixes, improvements, or new features. Please ensure that your code adheres to our coding standards and includes tests where applicable.

License

The Ceph CSI Operator is licensed under the Apache License 2.0. See the LICENSE file for more details.

Contact

Please use the following to reach members of the community: