pelagia

module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2025 License: Apache-2.0

README

What is Pelagia?

Pelagia is a Kubernetes controller that provides all-in-one management for Ceph clusters installed by Rook. It delivers two main features:

  • Aggregates all Rook Custom Resources (CRs) into a single CephDeployment resource, simplifying the management of Ceph clusters.
  • Provides automated lifecycle management (LCM) of Rook Ceph OSD nodes for bare-metal clusters. Automated LCM is managed by the special CephOsdRemoveTask resource.

Why Pelagia?

Pelagia is designed to simplify the management of Ceph clusters in Kubernetes installed by Rook.

Being solid Rook users, we had dozens of Rook CRs to manage. Thus, one day we decided to create a single resource that would aggregate all Rook CRs and deliver a smoother LCM experience. This is how Pelagia was born.

It supports almost all Rook CRs API, including CephCluster, CephBlockPool, CephFilesystem, CephObjectStore, and others, aggregating them into a single specification. We continuously work on improving Pelagia's API, adding new features, and enhancing existing ones.

Pelagia collects Ceph cluster state and all Rook CRs statuses into single CephDeploymentHealth CR. This resource highlights of Ceph cluster and Rook APIs issues, if any.

Another important thing we implemented in Pelagia is the automated lifecycle management of Rook Ceph OSD nodes for bare-metal clusters. This feature is delivered by the CephOsdRemoveTask resource, which automates the process of removing OSD disks and nodes from the cluster. We are using this feature in our everyday day-2 operations routine.

How to use Pelagia?

To use Pelagia, you need to install it in your Kubernetes cluster. You can do this by using the dedicated Helm chart. Once installed, you can create a CephDeployment resource to manage your Ceph cluster.

Pelagia supports installation in Ceph OSD LCM-only mode, which means that you do not need to install the CephDeployment controller if you only want to use the CephOsdRemoveTask resource for automated LCM of Rook Ceph OSD nodes. The only thing you need to create is empty CephDeploymentHealth CR.

You can find the detailed documentation on how to install and use Pelagia in the Quick start guide.

Version compatibility

Pelagia version Ceph version Rook version Ceph-CSI version
1.0.0 19.2.3 (Squid), 18.2.7 (Reef) 1.17.4 3.14.0

Documentation

For installation, deployment, and administration, see our Documentation and Quick start guide. Have some questions? Use our GitHub Discussions.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Directories

Path Synopsis
cmd
connector command
controller command
disk-daemon command
pkg
apis/ceph.pelagia.lcm
This file ensures Go source parsers acknowledge the lcm package and any child packages.
This file ensures Go source parsers acknowledge the lcm package and any child packages.
apis/ceph.pelagia.lcm/v1alpha1
Package v1alpha1 contains API Schema definitions for the cephdeploymenthealth v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=lcm.mirantis.com
Package v1alpha1 contains API Schema definitions for the cephdeploymenthealth v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=lcm.mirantis.com
client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/ceph.pelagia.lcm/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/clientset/versioned/typed/ceph.pelagia.lcm/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL