diff --git a/docs/guides/configuration-guide/rookify.md b/docs/guides/configuration-guide/rookify.md index adb13ef911..7c49b50e50 100644 --- a/docs/guides/configuration-guide/rookify.md +++ b/docs/guides/configuration-guide/rookify.md @@ -83,7 +83,7 @@ kubernetes: config: ./k8s/config ``` -The `kubernetes` section specifies the kubernetes configuration (e.g. if you use kubectl it is located in `~/.kube/config`) for rookifies kubernetes library. Rookify needs to connect to the kubernetes cluster on the target systems in order to use Rook. +The `kubernetes` section specifies the kubernetes configuration (e.g. if you use kubectl it is located in `~/.kube/config`) for Rookify's kubernetes library. Rookify needs to connect to the kubernetes cluster on the target systems in order to use Rook. ```yaml title="config.example.yaml" rook: diff --git a/docs/guides/deploy-guide/rookify.md b/docs/guides/deploy-guide/rookify.md index 1fbdabcd40..d9c86b4dc3 100644 --- a/docs/guides/deploy-guide/rookify.md +++ b/docs/guides/deploy-guide/rookify.md @@ -17,20 +17,18 @@ Nevertheless, it is **strongly advised** to test Rookify in a controlled environ Currently it is recommended to install Rookify on your own machine and then connect through VPNs to you target system (the one where Ceph-Ansible needs to be rookified ;) ). -Rookify runs `in place`, which means that there are no parallel nodes necesssary. As mentioned above, Rookify is developed to migrate from Ceph-Ansible to Rook _in place_ and _without downtime_ but infrastructure can be complex, so precautionary backups and safety measure are very much advised. +Rookify runs `in place`, which means that there are no parallel nodes necessary. As mentioned above, Rookify is developed to migrate from Ceph-Ansible to Rook _in place_ and _without downtime_ but infrastructure can be complex, so precautionary backups and safety measure are very much advised. The [Rookify GitHub repository](https://github.com/SovereignCloudStack/rookify) includes a README.md that provides a condensed summary of the information covered here. ## Prerequisites && Requirements -- A functioning Ceph cluster deployed via traditional methods. -- Access to a Kubernetes cluster with sufficient resources to host the - migrated Ceph cluster. - - Kubernetes nodes should be rolled out at least on the OSD nodes -- Rook operator version 1.13 or higher installed in the Kubernetes clu -ster. -- _local development enivornment_ requires radoslib version 2.0.0 inst -alled +- A functioning Ceph cluster deployed using traditional methods. +- Access to a Kubernetes cluster with sufficient resources to host the migrated Ceph cluster. +- Kubernetes nodes must be deployed on at least the OSD nodes. +- Rook operator version 1.13 or higher installed on the Kubernetes cluster. +- `radoslib` version 2.0.0 installed. +- For a _dockerized setup_, `docker` and `docker compose` are required. ## Manual Installation @@ -46,7 +44,7 @@ Clone or download Rookify from the [repository](https://github.com/SovereignClou cd rookify ``` -2. To install Rookify locally, pythons virtualenv will be used (Note: This will install pre-commit in your local user context): +2. To install Rookify locally, python's `virtualenv` will be used (Note: This will install pre-commit in your local user context): :::tip @@ -62,7 +60,7 @@ This command also checks if you have the required python library for `radoslib` :::tip -Before running rookify, first check all options by using `rookify --help` +Before running Rookify, first check all options by using `rookify --help`. ::: @@ -77,7 +75,7 @@ make run-local-rookify ## Install and Run from within a Container -1. Navigate to the tool directory: +1. Navigate to the tool directory: 2. To install Rookify into a container, podman or docker can be used (Note: in both cases pythons library for `radoslib` needs to be installed locally): @@ -92,6 +90,6 @@ To run rookify you can either enter the container and run rookify from there or :::note -Before running rookify, it can be usefull to check all options by using `rookify --help` +Before running rookify, it can be useful to check all options by using `rookify --help` ::: diff --git a/docs/guides/operations-guide/rookify.md b/docs/guides/operations-guide/rookify.md index 4ad33bc18b..5b99e67092 100644 --- a/docs/guides/operations-guide/rookify.md +++ b/docs/guides/operations-guide/rookify.md @@ -36,7 +36,7 @@ Now you will be able to view the state of progress by running `rookify --show-st Rookify executes the preflight mode, i.e. `--dry-run`, per default. ::: -Currently rookify executes the preflight mode, i.e. `--dry-run`, per default. This means: if you run rookify without any additional arguments, it will run all preflight checks of the modules and their (indirect) dependent modules as configured in `config.yaml`. +Currently Rookify executes the preflight mode, i.e. `--dry-run`, per default. This means: if you run Rookify without any additional arguments, it will run all preflight checks of the modules and their (indirect) dependent modules as configured in `config.yaml`. ### --dry-run @@ -76,7 +76,7 @@ You can also set the other formatting options, as indicated by the comments, for ### Run tests -Make sure you can reach Rookifies code on you system. Then you can either: +Make sure you can reach Rookify's code on your system. Then you can run the following for testing: -1. run `make run-tests-locally` from the working directory of the rookify repository. If you prefer to use a containerized setup, use `make run-tests`. +1. run `make run-tests-locally` from the working directory of the Rookify repository. If you prefer to use a containerized setup, use `make run-tests`. 2. run `.venv/bin/python -m pytest` from the virtual environment of you installation