Skip to content

Commit

Permalink
feat: add docs for osism and scs websites
Browse files Browse the repository at this point in the history
Signed-off-by: Boekhorst <[email protected]>
  • Loading branch information
boekhorstb1 committed Sep 25, 2024
1 parent 18ffe02 commit 796bc62
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/configuration-guide/rookify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
sidebar_label: Configure Rookify: Migrate to Rook from Ceph Ansible (technical preview)
sidebar_position: 31
---

# Configure Rookify: Migrate from Ceph Ansible to Rook (Technical Preview)

The [Rookify GitHub repository](https://github.com/SovereignCloudStack/rookify) includes a README.md that provides a condensed summary of the information covered here.

Rookify is developed to migrate from Ceph-Ansible to Rook _in place_ and _without downtime_.

Nevertheless, it is **strongly advised** to test Rookify in a controlled environment beforehand, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally, ensure that all precautionary backups are taken, and any other necessary safety measures are in place.

## Config.yaml

The primary configuration file for Rookify is `config.yaml`. The repository contains an example file for general use, as well as one specifically tailored to the OSISM testbed setup:

- [config.example.yaml](https://github.com/SovereignCloudStack/rookify/blob/main/config.example.yaml)
- [config.example.osism.yaml](https://github.com/SovereignCloudStack/rookify/blob/main/config.example.osism.yaml)

### Parameters

```yaml
general:
machine_pickle_file: data.pickle
```
The general section allows for optional definition of a pickle file, which allows for saving the state of the migration as serialized objects on disk. The pickle filed can be named as pleased.
```yaml
logging:
level: INFO # level at which logging should start
format:
time: "%Y-%m-%d %H:%M.%S" # other example: "iso"
renderer: console # or: json
```
The `logging` section allows for specification of `structlog`. The `level` parameter can be set to all python [log-levels](https://docs.python.org/3/library/logging.html#logging-levels), i.e. `NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAl`, but it is recommended to use `INFO`.

```yaml
ceph:
config: ./.ceph/ceph.conf
keyring: ./.ceph/ceph.client.admin.keyring
```

The `ceph` section specifies the `ceph.conf` and `ceph.client.admin.keyring` of the target systems (i.e. the system where Ceph-Ansible needs to be migrated to Rook).
17 changes: 17 additions & 0 deletions docs/deploy-guide/rookify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: Migrate Ceph-Ansible via Rookify (technical preview)
sidebar_position: 51
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Migrate Ceph-Ansible via Rookify (technical preview)

:::warning

This is a technical preview and not recommended for production use yet.

:::

Rookify is now also available in OSISM.
15 changes: 15 additions & 0 deletions docs/operations-guide/rookify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_label: Ceph via Rook (technical preview)
---

# Ceph via Rook (technical preview)

:::warning

This is a technical preview and not recommended for production use yet. This whole
document has to be reworkded with more rook like handling. Do not take it for
granted yet.

:::

## Where to find docs

0 comments on commit 796bc62

Please sign in to comment.