Skip to content

Commit

Permalink
docs(rook-ceph): update backstage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tyriis committed Apr 8, 2024
1 parent 809cddf commit 925319d
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions .backstage/components/rook-ceph/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
# rook-ceph

## something
## overview

## something else
The `rook-ceph` component is a storage operator for Kubernetes, leveraging the power of Ceph, a highly scalable and resilient storage system.
It abstracts the complexity of deploying and managing Ceph storage clusters, making it easy to provision, scale, and maintain Ceph within your Kubernetes environment.
With `rook-ceph`, you can leverage Ceph's capabilities for object storage, block storage, and file systems in a cloud-native way.
It provides seamless integration with Kubernetes, allowing you to use standard Kubernetes primitives for managing storage.
This component is part of Rook, an open-source cloud-native storage orchestrator, providing the platform, framework, and support for a diverse set of storage solutions to natively integrate with cloud-native environments.

??? success
Content.
## setup

??? warning classes
Content.
Setting up `rook-ceph` involves a few steps to ensure a successful deployment on your Kubernetes cluster.

```plantuml id="myDiag" format="png" classes="uml myDiagram" alt="My super diagram placeholder" title="My super diagram" width="300px" height="300px"
Goofy -> MickeyMouse: calls
Goofy <-- MickeyMouse: responds
```
First, you need to install the Rook operator. This can be done by applying the Rook operator manifest using `kubectl`.

Next, you need to create a Rook cluster. This involves defining a `CephCluster` resource in a YAML file, specifying the desired configuration for your Ceph storage cluster.

Once the Rook operator and the Ceph cluster are up and running, you can start provisioning storage.
Rook allows you to define `CephBlockPool`, `CephFilesystem`, and `CephObjectStore` resources to create block devices, file systems, and S3-compatible object stores, respectively.

Remember to monitor the status of your `rook-ceph` deployment regularly. You can use the `ceph status` command for this purpose.

Detailed instructions and examples can be found in the official Rook documentation. Always ensure your Kubernetes environment meets the prerequisites before starting the setup.

## usage

Using `rook-ceph` involves interacting with the storage resources it provides.

For block storage, you can create a PersistentVolumeClaim against a StorageClass that uses the `rook-ceph-block` provisioner. This will dynamically provision a PersistentVolume backed by a Rook Ceph block device.

0 comments on commit 925319d

Please sign in to comment.