Skip to content

Commit

Permalink
fix: add prerequisites and reduce text, feat: add troubleshoot section
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 87666a7 commit a9382c0
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 15 deletions.
33 changes: 18 additions & 15 deletions docs/guides/deploy-guide/rookify.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,29 @@ Nevertheless, it is **strongly advised** to test Rookify in a controlled environ

:::

Rookify is now available in the SCS Reference Implementation (OSISM) and can be deployed as shown in the [paragraph below](#using-the-scs-reference-implementation-osism).
Currenlty Rookify is best install it on your own machine and then connected through vpn to you target system (the one where Ceph-Ansible needs to be rookified ;) ).

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

## Using the SCS Reference Implementation (OSISM)

:::info
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 infrastructures are complicated, so precautionary backups and safety measure are very much advised.

Rookify will be available in OSISM and will be deployable usin osism-commands based on ansible configurations.
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

But is is not available yet ;)
- 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

## Manual Installation

### Download or Clone the Repository

Clone or download Rookify from the [repository](https://github.com/SovereignCloudStack/rookify).

:::tip

Checkout the included options of the added `Makefile` by simply typing `make`.

:::

## Install and Run Locally

1. Navigate to the tool directory:
Expand All @@ -51,6 +48,12 @@ cd rookify

2. To install Rookify locally, pythons virtualenv will be used (Note: This will install pre-commit in your local user context):

:::tip

Checkout the included options of the added `Makefile` by simply typing `make`.

:::

```
make setup
```
Expand Down
32 changes: 32 additions & 0 deletions docs/guides/troubleshooting-guide/rookify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_label: Rookify
sidebar_position: 40
---

# 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 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.

:::

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

## ssh-issues


**"Failed to load private key" **


- make sure the id-rsa keys are "clean" and do not contain unexpected strings like "\<\<EOF". Possible solution: Clean the keys manually or call `ssh-keygen -p -N "" -f ssh.key` to convert and reformat the keyfile to the expected format.


**"too many authentications error"**

- Sometimes too many keys loaded are loaded by the ssh-agent. Possible solution: Switch off the ssh-agent on you machine. You can do this yourself or by allowing direnv ( `direnv allow` ) to use `.envrc`.

## frozen state

- if the rookify process freezes, check your connections. In the OSISM testbed especially check the vpn-connection (in testbed epository try `make vpn-*`)

0 comments on commit a9382c0

Please sign in to comment.