Rookify

DISCLAIMER: Rookify is in early development state and is not feature-complete. Don't use it in production environments until it is production-ready and tested!

Overview

Rookify is designed to facilitate a smooth and efficient transition for existing Ceph clusters to a Rook-managed Ceph cluster environment. This tool targets clusters deployed via traditional methods and those set up using the standards of Sovereign Cloud Stack and reference implementation OSISM. By automating the conversion process, this tool aims to minimize downtime and ensure a seamless migration experience.

Features

• Automated Conversion: Simplifies the migration process from a traditional Ceph deployment to a Rook-managed Ceph environment.
• Minimal Downtime: Designed to perform migrations with the least possible impact on availability.
• Preflight Check: Analyzes existing Ceph clusters and checks if migrations are possible.

Prerequisites

• A functioning Ceph cluster deployed via traditional methods.
  • TODO: List supported 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 cluster.
• local development enivornment requires radoslib version 2.0.0 installed

Installation

1. Clone the repository:

   git clone https://github.com/SovereignCloudStack/rookify

2. Navigate to the tool directory:

   cd rookify

3. To install the local development environment (Note: This will install pre-commit in your local user context):

   make setup

4. To install the container-based environment

   make build-container
   docker run -ti --mount type=bind,source="$(pwd)",target=/app/rookify/src/,readonly --workdir=/app/rookify/src rookify:latest

Usage

TODO

Type make to get a list of available development specific commands.

Support

For issues, questions, or contributions, please open an issue or pull request in the GitHub repository. We welcome community feedback and contributions to enhance rookify.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.