9316fc4af8
Depends-On: https://review.opendev.org/#/c/751233/ Change-Id: I9c4424475f47a973d9bbd1628424549e954e8249
3.2 KiB
Team and repository tags
sahara
Table of Contents
- Overview - What is the sahara module?
- Module Description - What does the module do?
- Setup - The basics of getting started with sahara
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Release notes for the project
- Repository - The project source code repository
Overview
The sahara module is a part of 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 Sahara module itself is used to flexibly configure and manage the clustering service for OpenStack.
Module Description
The sahara module is an attempt to make Puppet capable of managing the entirety of sahara.
Setup
What the sahara module affects:
- Sahara, the data processing service for OpenStack.
Installing Sahara
puppet module install openstack/sahara
Beginning with sahara
To use the sahara 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 of openstack documentation.
Examples of usage can be found in the examples directory.
Implementation
sahara
puppet-sahara is a combination of Puppet manifests and ruby code to deliver configuration and extra functionality through types and providers.
Types
sahara_config
The sahara_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/sahara/sahara.conf file.
sahara_config { 'DEFAULT/use_neutron' :
value => True,
}
This will write use_neutron=True in the [DEFAULT] section.
name
Section/setting name to manage from sahara.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
None.
Development
Developer documentation for the entire puppet-openstack project.