Skip to content

Commit

Permalink
deploy-guide: cleanup rook
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Berendt <[email protected]>
  • Loading branch information
berendt committed Feb 6, 2025
1 parent 6b0cec5 commit da38f2c
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 164 deletions.
2 changes: 1 addition & 1 deletion docs/guides/configuration-guide/rook.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The File System ID is a unique identifier for the cluster.
~The identifier is set via the parameter `fsid` in `environments/rook/configuration.yml`~
~and must be unique. It can be generated with `uuidgen`.~

It is generated automatically by the [Rook Deployment](../deploy-guide/services/rook.md).
It is generated automatically by the [Rook Deployment](../deploy-guide/services/ceph/rook.md).

TODO: To evaluate if we want and can pass a `fsid`. This is no out-of-the-box Rook feature, though.

Expand Down
97 changes: 0 additions & 97 deletions docs/guides/deploy-guide/rookify.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ open source projects, please refer to

Before starting the Ceph deployment, the configuration and preparation of the
OSD devices must be completed. The steps that are required for this can be found in the
[Ceph Configuration Guide](../../configuration-guide/ceph.md#osd-devices).
[Ceph Configuration Guide](../../../configuration-guide/ceph.md#osd-devices).

:::

Expand Down Expand Up @@ -145,7 +145,7 @@ Step 3 is then performed **later after** the OpenStack Keystone service has been

:::

1. [Configure the RGW service](./../../configuration-guide/ceph.md#rgw-service)
1. [Configure the RGW service](../../../configuration-guide/ceph.md#rgw-service)

2. Apply role `ceph-rgws` to deploy the Ceph RGW services.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Ceph via Rook (technical preview)
sidebar_label: Rook
sidebar_position: 51
---

Expand All @@ -14,45 +14,33 @@ This is a technical preview and not recommended for production use yet.

:::

In OSISM it is also possible to integrate and use existing Ceph clusters. It
is not necessary to deploy Ceph with OSISM. If Ceph is deployed with OSISM, it
should be noted that OSISM does not claim to provide all possible features of Ceph.
Ceph provided with OSISM is intended to provide the storage for Glance, Nova, Cinder
and Manila. In a specific way that has been implemented by OSISM for years. It
should be checked in advance whether the way in OSISM the Ceph deployment and the
provided features are sufficient. If this is not the case, it is recommended to
deploy Ceph in a different way directly and independently of OSISM. For possible
open source projects, please refer to
[cephadm](https://docs.ceph.com/en/latest/cephadm/index.html) and
[Rook](https://rook.io).

1. Deploy services.

When using rook, all services are deployed via a single helm chart and at the same time. This could be altered by passing custom CRDs. See [Rook Configuration Guide](../../configuration-guide/rook).

When using Rook, all services are deployed via a single helm chart and at the
same time. This could be altered by passing custom CRDs. See
the [Rook Configuration Guide](../../../configuration-guide/rook).

* Install [Kubernetes Cluster](../../deploy-guide/services/kubernetes.md)
* Install [Kubernetes Cluster](../../../deploy-guide/services/kubernetes.md)

* Deploy [Rook Operator Helm Chart](https://rook.io/docs/rook/latest/Helm-Charts/operator-chart/)
* Deploy [Rook Operator](https://rook.io/docs/rook/latest/Helm-Charts/operator-chart/)

```
osism apply rook-operator
```
* Deploy complete Rook Ceph Cluster
* Deploy Ceph cluster
```
osism apply rook
```
* Copy ceph keyrings to kolla directories (if deploying OpenStack)
* Copy Ceph keyrings to kolla directories (if deploying OpenStack)
```
osism apply rook-fetch-keys
```
2. Get ceph keyrings. This places the necessary keys in `/opt/configuration`.
2. Get Ceph keyrings. This places the necessary keys in `/opt/configuration`.
```
osism apply rook-fetch-keys
Expand Down Expand Up @@ -80,19 +68,19 @@ When using rook, all services are deployed via a single helm chart and at the sa
rook_cephclients: {}
```

3. A Ceph client (a wrapper on the manager for entering the rook toolbox) can be deployed.
3. A Ceph client, a wrapper on the manager for entering the Rook toolbox, can be deployed.

```
osism apply cephclient
```

You have to make sure the correct [Configuration Options for the Rook Ceph Client Wrapper](../../configuration-guide/rook.md#client) are net.
You have to make sure the correct [Configuration Options for the Rook Ceph Client Wrapper](../../../configuration-guide/rook.md#client) are net.

4. After getting the Ceph Keyrings, the [OpenStack Deployment](../../deploy-guide/services/openstack.md) can optionally be done.
4. After getting the Ceph Keyrings, the [OpenStack Deployment](../../../deploy-guide/services/openstack.md) can optionally be done.

## RGW service

Deployment of the Ceph RGW Service is enabled by default in rook. This is done by creating a default [CephObjectStore CRD](https://rook.io/docs/rook/latest-release/CRDs/Object-Storage/ceph-object-store-crd/). How the Ceph RGW service can be deployed and integrated into OpenStack is described here.
Deployment of the Ceph RGW Service is enabled by default in Rook. This is done by creating a default [CephObjectStore CRD](https://rook.io/docs/rook/latest-release/CRDs/Object-Storage/ceph-object-store-crd/). How the Ceph RGW service can be deployed and integrated into OpenStack is described here.

In the `environments/rook/configuration.yml` file you have to adapt accordingly to your environment at least like shown below:

Expand Down Expand Up @@ -149,24 +137,3 @@ You can apply the changes running:
```

This will remove all labels and apply the changed inventory groups as labels. After those steps are done it will trigger the rescheduling of the components so they get deployed on the adjusted nodes.

## Cleanup

:::warning

This will permanently delete all your data in the Ceph Cluster. Be sure you know what you are doing before proceeding.

:::

If you want to cleanup/delete the whole cluster, you can do that by enabling `rook_cleanup`.


```yaml title="environments/rook/configuration.yml"
rook_cleanup: true
```
And running the `rook-cleanup` role.

```
osism apply rook-cleanup
```
17 changes: 0 additions & 17 deletions docs/guides/deploy-guide/services/rookify.md

This file was deleted.

File renamed without changes.
2 changes: 1 addition & 1 deletion docs/testbed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ lvm_volumes:
### Ceph via Rook (technical preview)
Please have a look at [Deploy Guide - Services - Rook](guides/deploy-guide/services/rook.md) and [Configuration Guide - Rook](guides/configuration-guide/rook.md) for details on how to configure Rook.
Please have a look at [Deploy Guide - Services - Rook](guides/deploy-guide/services/ceph/rook.md) and [Configuration Guide - Rook](guides/configuration-guide/rook.md) for details on how to configure Rook.
To deploy this in the testbed, you can use an environment variable in your make target.
Expand Down

0 comments on commit da38f2c

Please sign in to comment.