Team and repository tags
========================

[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-cinder.svg)](https://governance.openstack.org/tc/reference/tags/index.html)

<!-- Change things from this point on -->

cinder
======

#### Table of Contents

1. [Overview - What is the cinder module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with cinder](#setup)
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Contributors - Those with commits](#contributors)
8. [Release Notes - Release notes for the project](#release-notes)
9. [Repository - The project source code repository](#repository)

Overview
--------

The cinder module is a part of [OpenStack](https://opendev.org/openstack),
an effort by the OpenStack infrastructure team to provide continuous
integration testing and code review for OpenStack and OpenStack community
projects as part of the core software. The module its self is used to flexibly
configure and manage the block storage service for OpenStack.

Module Description
------------------

The cinder module is a thorough attempt to make Puppet capable of managing
the entirety of cinder. This includes manifests to provision such things as
keystone endpoints, RPC configurations specific to cinder, and database
connections. Types are shipped as part of the cinder module to assist in
manipulation of configuration files.

This module is tested in combination with other modules needed to build
and leverage an entire OpenStack software stack.

Setup
-----

**What the cinder module affects**

* [Cinder](https://docs.openstack.org/cinder/latest/), the block storage service
  for OpenStack.

### Installing cinder

    puppet module install openstack/cinder

### Beginning with cinder

To utilize the cinder module's functionality you will need to declare
multiple resources. This is not an exhaustive list of all the components
needed, we recommend you consult and understand the
[core OpenStack](https://docs.openstack.org) documentation.

**Define a cinder control node**

```puppet
class { 'cinder':
  database_connection   => 'mysql://cinder:secret_block_password@openstack-controller.example.com/cinder',
  default_transport_url => 'rabbit://cinder:secret_password@openstack-controller.example.com:5672',
}

class { 'cinder::api':
  keystone_password       => $keystone_password,
  keystone_user           => $keystone_user,
  keystone_auth_uri       => $keystone_auth_uri,
  service_port            => $keystone_service_port,
  package_ensure          => $cinder_api_package_ensure,
  bind_host               => $cinder_bind_host,
  enabled                 => $cinder_api_enabled,
}

class { 'cinder::scheduler': }
```

**Define a cinder storage node**

```puppet
class { 'cinder':
  database_connection   => 'mysql://cinder:secret_block_password@openstack-controller.example.com/cinder',
  default_transport_url => 'rabbit://cinder:secret_password@openstack-controller.example.com:5672',
}

class { 'cinder::volume': }

cinder::backend::iscsi {
  'iscsi_example':
    target_ip_address => '10.0.0.2',
}
```

**Define a cinder storage node with multiple backends **

```puppet
class { 'cinder':
  database_connection   => 'mysql://cinder:secret_block_password@openstack-controller.example.com/cinder',
  default_transport_url => 'rabbit://cinder:secret_password@openstack-controller.example.com:5672',
}

class { 'cinder::volume': }

cinder::backend::iscsi {'iscsi1':
  target_ip_address => '10.0.0.2',
}

cinder::backend::iscsi {'iscsi2':
  target_ip_address => '10.0.0.3',
}

cinder::backend::iscsi {'iscsi3':
  target_ip_address   => '10.0.0.4',
  volume_backend_name => 'iscsi',
}

cinder::backend::iscsi {'iscsi4':
  target_ip_address   => '10.0.0.5',
  volume_backend_name => 'iscsi',
}

cinder::backend::rbd {'rbd-images':
  rbd_pool => 'images',
  rbd_user => 'images',
}

cinder_type {'iscsi':
  ensure     => present,
  properties => ['volume_backend_name=iscsi,iscsi1,iscsi2'],
}

cinder_type {'rbd-images':
  ensure     => present,
  properties => ['volume_backend_name=rbd-images'],
}

class { 'cinder::backends':
  enabled_backends => ['iscsi1', 'iscsi2', 'rbd-images']
}
```

Note: that the name passed to any backend resource must be unique across all
      backends otherwise a duplicate resource will be defined.

** Using cinder_type **

Cinder allows for the usage of type to set extended information that can be
used for various reasons. We have resource provider for ``cinder_type``
and if you want create some cinder type, you should set ensure to absent.
Properties field is optional and should be an array. All items of array
should match pattern key=value1[,value2 ...]. In case when you want to
delete some type - set ensure to absent.


Implementation
--------------

### cinder

cinder is a combination of Puppet manifest and ruby code to delivery
configuration and extra functionality through types and providers.

### Types

#### cinder_config

The `cinder_config` provider is a children of the ini_setting provider.
It allows one to write an entry in the `/etc/cinder/cinder.conf` file.

```puppet
cinder_config { 'DEFAULT/api_paste_config' :
  value => '/etc/cinder/api-paste.ini',
}
```

This will write `api_paste_config=/etc/cinder/api-paste.ini` in the `[DEFAULT]` section.

##### name

Section/setting name to manage from `cinder.conf`

##### value

The value of the setting to be defined.

##### secret

Whether to hide the value from Puppet logs. Defaults to `false`.

##### ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if
`ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>`

Limitations
-----------

* Setup of storage nodes is limited to Linux and LVM, i.e. Puppet won't
  configure a Nexenta appliance but nova can be configured to use the Nexenta
  driver with Class['cinder::volume::nexenta'].

Development
-----------

Developer documentation for the entire puppet-openstack project.

* https://docs.openstack.org/puppet-openstack-guide/latest/

Contributors
------------

* https://github.com/openstack/puppet-cinder/graphs/contributors

Release Notes
-------------

* https://docs.openstack.org/releasenotes/puppet-cinder

Repository
----------

* https://opendev.org/openstack/puppet-cinder