Table of Contents

  1. Description
  2. Setup - The basics of getting started with rook
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

Rook is an open source orchestrator providing file, block, and object storage services for distributed storage systems running in cloud-native environments.

This module installs and configures Rook on a Kubernetes cluster.

Setup

To install the rook module, add the rook class to the manifest file:

include 'rook'

When the rook class is declared, Puppet does the following:

  • Downloads and installs the Ceph packages.
  • Configures Rook on Kubernetes.

Usage

To customize options, such as the release channel, add the following code to the manifest file:

class { 'rook':
  version => 'v0.7.0',
}

Tasks

Included in the rook module is an example task that creates the rook namespace, and executes the kubectl tasks to configure rook on kubernetes.

bolt task run rook::rook_namespace kubeconfig=<path-to-config-file> namespace=<namespace-title> ---nodes <k8s-node-name> --user <user> --password <password> --modulepath <module-path>

bolt task run rook::rook_create kubeconfig=<path-to-config-file> config_file=<path-to-config-file> ---nodes <k8s-node-name> --user <user> --password <password> --modulepath <module-path>

For additional information on how to execute a task, see the PE documentation or the Bolt documentation.

Validating and unit testing the module

This module is compliant with the Puppet Development Kit (PDK), which provides tools to help run unit tests on the module and validate the modules' metadata, syntax, and style.

Note: To run static validations and unit tests against this module using the pdk validate and pdk test unit commands, you must be using Puppet 5 or higher. In the following examples, we have specified Puppet 5.5.3.

To validate the metadata.json file, run the following command:

pdk validate metadata --puppet-version='5.5.3'

To validate the Puppet code and syntax, run the following command:

pdk validate puppet --puppet-version='5.5.3'

To unit test the module, run the following command:

pdk test unit --puppet-version='5.5.3'

Reference

Classes

Public Classes

  • rook: Installs and configures rook.
  • rook::params

Private Classes

  • rook::packages: Installs the Ceph packages.
  • rook::storage_class: Installs and configures the Rook storage class for block level storage.

Parameters

env

Specifies the environment variables for Kubectl to connect to the Kubernetes cluster.

Defaults to ['HOME=/root', 'KUBECONFIG=/etc/kubernetes/admin.conf'].

path

Specifies the PATH for all exec resources in the module.

Defaults to ['/usr/bin', '/bin'].

version

Specifies the version of rook to install.

Defaults to 'v0.7.0'.

default_storage

Specifies whether to set the rook-block as the default storage class for the cluster

Defaults to true

Limitations

This module is compatible only with the Linux kernel and supports:

  • Puppet 4 or higher.
  • Kubernetes 1.10.x or higher.
  • Ruby 2.3.0 or higher.

Development

If you have an issue with this module or would like to request a feature, file a ticket.

If you have problems with this module, contact Support.

Contributing

If you would like to add to this module, please follow the rules in the CONTRIBUTING.md.