Skip to content

Commit

Permalink
fix: typos and spelling, feat: add information about execution mode
Browse files Browse the repository at this point in the history
Signed-off-by: Boekhorst <[email protected]>
  • Loading branch information
boekhorstb1 committed Nov 11, 2024
1 parent 542c100 commit 53f46e6
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/guides/configuration-guide/rookify.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ sidebar_position: 31
:::warning

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 first, such as the [OSISM testbed](https://github.com/osism/testbed). Addition ure that precautionary backups are made, and all other necessary safety measures are in place.
Nevertheless, it is **strongly advised** to test Rookify in a controlled environment first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally ensure that precautionary backups are made and all other necessary safety measures are in place.

:::

For a condensed summary of the information covered here, refer to the [Rookify GitHub repository](https://github.com/SovereignCloudStack/rookify).

## Config.yaml

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

- [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)
Expand All @@ -30,7 +30,7 @@ general:
machine_pickle_file: data.pickle
```
The `general` section allows for the optional definition of a pickle file, which saves the state of the migration as serialized objects on disk. The pickle filed can be named as desired.
The `general` section allows for the optional definition of a pickle file, which saves the state of the migration as serialized objects on disk. The pickle file can be named as desired.

#### Logging

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/deploy-guide/rookify.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
:::warning

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 first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally, ensure that precautionary backups are made, and all other necessary safety measures are in place.
Nevertheless, it is **strongly advised** to test Rookify in a controlled environment first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally ensure that precautionary backups are made and all other necessary safety measures are in place.

:::

Expand Down
18 changes: 13 additions & 5 deletions docs/guides/operations-guide/rookify.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Rookify (technical preview)
:::warning

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 first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally, ensure that precautionary backups are made, and all other necessary safety measures are in place.
Nevertheless, it is **strongly advised** to test Rookify in a controlled environment first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally ensure that precautionary backups are made and all other necessary safety measures are in place.

:::

Expand All @@ -22,7 +22,7 @@ general:
machine_pickle_file: data.pickle
```
You can then view the migration progress by running `rookify --show-state`.
You can then view the migration progress by running `rookify --show-states`.

:::warning
Rookify treats the pickle file as a source of truth for its operations. If you want to start a clean migration, ensure you delete the file first.
Expand All @@ -44,15 +44,23 @@ Rookify runs in preflight mode by default, meaning it performs all preflight che
Run preflight-mode to ensure Rookify can connect to your target systems.
:::

Rookify's `preflight-mode` allows you to verify that basic commands and connections to the target systems are functioning correctly. Running `--dry-run` mode ensures no migration processes are executed.
Rookify's `preflight-mode` allows you to verify that basic commands and connections to the target systems are functioning correctly. Running `--dry-run` or `-d` mode ensures no migration processes are executed.

### --migrate

:::tip
Ensure that you use the correct `data.pickle` file. If you used the pickle file for other setups previously, be sure to delete it.
:::

Rookify's `execution-mode` allows you to run the migration. This a point of no (easy) return. Be sure to check all your configurations. Run `--migrate` or `-m` to execute the migration process.

### --help

Run `rookify --help` to view the various CLI options available.

### --show
### --show-states

Run `--show` to display the status of your migration process. Note that if you specified a pickle file, Rookify will use it to determine the state of migration.
Run `--show-states` or `-s` to display the status of your migration process. Note that if you specified a pickle file, Rookify will use it to determine the state of migration.

## Debugging and Testing

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/troubleshooting-guide/rookify.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 40
:::warning

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 first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally, ensure that precautionary backups are made, and all other necessary safety measures are in place.
Nevertheless, it is **strongly advised** to test Rookify in a controlled environment first, such as the [OSISM testbed](https://github.com/osism/testbed). Additionally ensure that precautionary backups are made and all other necessary safety measures are in place.

:::

Expand Down

0 comments on commit 53f46e6

Please sign in to comment.