e2bcbee792
With the creation of the new openstack_config provider, some processing
that was done in manila_config has been centralized in
openstack_config
Impacted methods are :
* section
* setting
* separator
Also, this commit adds the fact that, when passing a specific string
(ensure_absent_val) the provider will behave as if ensure => absent was
specified. '<SERVICE DEFAULT>' is the default value for
ensure_absent_val.
The use case is the following :
manila_config { 'DEFAULT/foo' : value => 'bar' } # will work as usual
manila_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>' } # will mean absent
That means that all the current :
if $myvar {
manila_config { 'DEFAULT/foo' : value => $myvar }
} else {
manila_config { 'DEFAULT/foo' : ensure => absent }
}
can be removed in favor of :
manila_config { 'DEFAULT/foo' : value => $myvar }
If for any reason '<SERVICE DEFAULT>' turns out to be a valid value for
a specific parameter. One could by pass that doing the following :
manila_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>',
ensure_absent_val => 'foo' }
Change-Id: I3c58ba14c8ddd6f20d7f97154f7c68bf12273e07
Depends-On: I0eeebde3aac2662cc7e69bfad7f8d2481463a218
103 lines
2.7 KiB
Markdown
103 lines
2.7 KiB
Markdown
manila
|
|
=======
|
|
|
|
6.0.0 - 2015.1.0 - Kilo
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview - What is the manila module?](#overview)
|
|
2. [Module Description - What does the module do?](#module-description)
|
|
3. [Setup - The basics of getting started with manila](#setup)
|
|
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
|
|
5. [Development - Guide for contributing to the module](#development)
|
|
6. [Contributors - Those with commits](#contributors)
|
|
|
|
Overview
|
|
--------
|
|
|
|
The manila module is part of [OpenStack](https://github.com/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 file system service for OpenStack.
|
|
|
|
Module Description
|
|
------------------
|
|
|
|
The manila module is a thorough attempt to make Puppet capable of managing the entirety of manila. This includes manifests to provision such things as keystone endpoints, RPC configurations specific to manila, and database connections.
|
|
|
|
This module is tested in combination with other modules needed to build and leverage an entire OpenStack software stack.
|
|
|
|
Setup
|
|
-----
|
|
|
|
**What the manila module affects**
|
|
|
|
* manila, the file system service for OpenStack.
|
|
|
|
### Installing manila
|
|
|
|
puppet module install openstack/manila
|
|
|
|
### Beginning with manila
|
|
|
|
To utilize the manila module's functionality you will need to declare multiple resources. [TODO: add example]
|
|
|
|
|
|
Implementation
|
|
--------------
|
|
|
|
### manila
|
|
|
|
manila is a combination of Puppet manifests and ruby code to delivery configuration and extra functionality through types and providers.
|
|
|
|
### Types
|
|
|
|
#### manila_config
|
|
|
|
The `manila_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/manila/manila.conf` file.
|
|
|
|
```puppet
|
|
manila_config { 'DEFAULT/verbose' :
|
|
value => true,
|
|
}
|
|
```
|
|
|
|
This will write `verbose=true` in the `[DEFAULT]` section.
|
|
|
|
##### name
|
|
|
|
Section/setting name to manage from `manila.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>`
|
|
|
|
Beaker-Rspec
|
|
------------
|
|
|
|
This module has beaker-rspec tests
|
|
|
|
To run:
|
|
|
|
``shell
|
|
bundle install
|
|
bundle exec rspec spec/acceptance
|
|
``
|
|
|
|
Development
|
|
-----------
|
|
|
|
Developer documentation for the entire puppet-openstack project.
|
|
|
|
* https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-manila/graphs/contributors
|