feat: add guide docs for rookify #688
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boekhorstb1
commented
Sep 25, 2024
•
boekhorstb1
commented
- adding docs for rookify: deploy, config and operation guides
boekhorstb1
force-pushed
the
rookify-docs
branch
from
67dc1d5
to
9cb354c
Compare
4 tasks
boekhorstb1
force-pushed
the
rookify-docs
branch
from
1c12f7d
to
873a72f
Compare
b1-lender
requested changes
Oct 7, 2024
boekhorstb1
force-pushed
the
rookify-docs
branch
from
89019c3
to
c757e79
Compare
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Co-authored-by: b1-lender <lender@b1-systems.de> Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Co-authored-by: b1-lender <lender@b1-systems.de> Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Co-authored-by: b1-lender <lender@b1-systems.de> Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Co-authored-by: b1-lender <lender@b1-systems.de> Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Co-authored-by: b1-lender <lender@b1-systems.de> Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Co-authored-by: b1-lender <lender@b1-systems.de> Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
Signed-off-by: Boekhorst <boekhorst@b1-systems.de>
boekhorstb1
force-pushed
the
rookify-docs
branch
from
c625bd3
to
542c100
Compare
b1-lender
approved these changes
Oct 8, 2024
NotTheEvilOne
requested changes
Oct 31, 2024
| :::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. |
There was a problem hiding this comment.
nit: Additionally ensure that ... are made and all ...
|
|
||
| ## 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: |
There was a problem hiding this comment.
Alternatively:
... tailored for OSISM based setups:
As far as I know OSISM's Rook based Ceph installation has settled on the same labels as configured in the example mentioned.
| 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. |
| :::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. |
There was a problem hiding this comment.
nit: Additionally ensure that ... are made and all ...
|
|
||
| - 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. |
There was a problem hiding this comment.
Monitor and OSD daemons should stay in place. Former to ensure that the Ceph endpoints do not change during migration, the later ones to have access to the underlying hardware.
| :::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. |
There was a problem hiding this comment.
nit: Additionally ensure that ... are made and all ...
| machine_pickle_file: data.pickle | ||
| ``` | ||
|
|
||
| You can then view the migration progress by running `rookify --show-state`. |
There was a problem hiding this comment.
It's rookify --show-states at the time of writing :)
|
|
||
| Run `rookify --help` to view the various CLI options available. | ||
|
|
||
| ### --show |
There was a problem hiding this comment.
It's still --show-states here as well ;)
|
|
||
| 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. | ||
|
|
||
| ### --help |
There was a problem hiding this comment.
I like mentioning the --help parameter. As we currently do not mention --migrate it ensures users check for it manually. On the other hand we might want to add --migrate as well as the opposite of --dry-run?
| :::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. |
There was a problem hiding this comment.
nit: Additionally ensure that ... are made and all ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.