OpenStack Trove Puppet Module
Go to file
Jiri Podivin de17c05a96 setuptools: Disable auto discovery
The latest release of setuptools 61.0 made a breaking change[1] and
because of this change 'pip install' fails with the following error.

~~~
error: Multiple top-level packages discovered in a flat-layout:
['lib', 'spec', 'manifests', 'releasenotes'].
~~~

Users that don't set 'packages', 'py_modules', or configuration'
are still likely to observe the auto-discovery behavior, which may
halt the build if the project contains multiple directories and/or
multiple Python files directly under the project root.

To disable auto discovery, one can do below in setup.py

~~~
setuptools.setup(..,packages=[],..)
~~~

or

~~~
setuptools.setup(..,py_modules=[],..)
~~~

[1] https://github.com/pypa/setuptools/issues/3197

Note setup.py is not used to install puppet modules. However it is used
to generate a release note, thus should be fixed.

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: If5299ede0323e0c19bf327031c19811bb836ed9f
2022-03-29 10:42:57 +02:00
doc Update openstackdocstheme to the latest version 2021-09-29 16:06:51 +08:00
examples Use service credential parameters to define keystone v3 auth 2020-05-06 21:36:00 +09:00
lib/puppet Merge "Use single trove.conf for api, conductor and taskmanager" 2022-03-11 00:46:20 +00:00
manifests Merge "guestagent: Deprecate the backup_aes_cbc_key parameter" 2022-03-18 09:29:05 +00:00
releasenotes Merge "guestagent: Deprecate the backup_aes_cbc_key parameter" 2022-03-18 09:29:05 +00:00
spec Merge "Avoid testing details of oslo::messaging(::*)" 2022-03-18 21:50:08 +00:00
templates Remove deprecated rabbit_hosts 2018-12-07 09:56:06 +08:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:25 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:13 +00:00
.zuul.yaml Add Puppet Litmus 2020-09-11 10:14:39 +00:00
bindep.txt modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:20:27 +02:00
CHANGELOG.md Modify http to https. 2018-12-11 15:14:29 +08:00
CONTRIBUTING.rst [ussuri][goal] Add CONTRIBUTING.rst 2020-05-10 22:54:29 +02:00
Gemfile Use openstack_spec_helper from zuul checkout 2020-08-30 23:07:14 +02:00
LICENSE First commit 2014-05-18 01:38:51 -04:00
metadata.json Prepare Yoga RC1 2022-03-13 10:24:30 +00:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:34 -05:00
README.md Add Puppet Litmus 2020-09-11 10:14:39 +00:00
setup.cfg Add information technology in the setup.cfg 2021-10-01 06:54:50 +08:00
setup.py setuptools: Disable auto discovery 2022-03-29 10:42:57 +02:00
tox.ini Stop configuring install_command in tox. 2021-09-29 18:21:19 +09:00

Team and repository tags

Team and repository tags

puppet-trove

Table of Contents

  1. Overview - What is the trove module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with trove
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Contributors - Those with commits
  8. Release Notes - Release notes for the project
  9. 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.

Contributors

Release Notes

Repository