1de53afc37
Depends-On: https://review.opendev.org/#/c/751233 Change-Id: I24aa4a6e0e93712fb3240e25bba36558aac11887
5.4 KiB
Team and repository tags
puppet-trove
Table of Contents
- Overview - What is the trove module?
- Module Description - What does the module do?
- Setup - The basics of getting started with trove
- 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 trove 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 module itself is used to flexibly configure and manage the database service for OpenStack.
Module Description
Setup
What the trove module affects:
- trove, the database service for OpenStack.
Installing trove
puppet module install openstack/trove
Implementation
trove
trove is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Types
trove_config
The trove_config provider is a child of the ini_setting provider. It allows one to write an entry in the /etc/trove/trove.conf file.
trove_config { 'DEFAULT/backlog' :
value => 4096,
}
This will write backlog=4096 in the [DEFAULT] section.
name
Section/setting name to manage from trove.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>
trove_conductor_config
The trove_conductor_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/trove/trove-conductor.conf file.
trove_conductor_config { 'DEFAULT/auth_url' :
value => http://localhost:5000/v3,
}
This will write auth_url=http://localhost:5000/v3 in the [DEFAULT] section.
name
Section/setting name to manage from trove.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>
trove_guestagent_config
The trove_guestagent_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/trove/trove-guestagent.conf file.
trove_guestagent_config { 'DEFAULT/trove_auth_url' :
value => http://localhost:5000/v3,
}
This will write trove_auth_url=http://localhost:5000/v3 in the [DEFAULT] section.
name
Section/setting name to manage from trove.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>
trove_taskmanager_config
The trove_taskmanager_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/trove/trove-taskmanager.conf file.
trove_taskmanager_config { 'DEFAULT/network_driver' :
value => trove.network.neutron.NeutronDriver,
}
This will write network_driver=trove.network.neutron.NeutronDriver in the [DEFAULT] section.
name
Section/setting name to manage from trove.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
Security
For security reasons, a separate in-cloud RabbitMQ cluster should be set up for trove to use. The reason for this is that the guest agent needs to communicate with RabbitMQ, so it is not advisable to give instances access to the same RabbitMQ server that the core OpenStack services are using for communication.
Please note that puppet-trove cannot check if this rule is being followed, so it is the deployer's responsibility to do it.
Development
Developer documentation for the entire puppet-openstack project.