7c74f5f8fa
Setuptools v54.1.0 introduces a warning that the use of dash-separated options in 'setup.cfg' will not be supported in a future version [1]. Get ahead of the issue by replacing the dashes with underscores. Without this, we see 'UserWarning' messages like the following on new enough versions of setuptools: UserWarning: Usage of dash-separated 'description-file' will not be supported in future versions. Please use the underscore name 'description_file' instead [1] https://github.com/pypa/setuptools/commit/a2e9ae4cb Change-Id: I27c7081db25b1252d467f9fada3e7f04156a5536
Team and repository tags
barbican
Table of Contents
- Overview - What is the barbican module?
- Module Description - What does the module do?
- Setup - The basics of getting started with barbican
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Release Notes - Release notes for the project
- Contributors - Those with commits
- Repository - The project source code repository
Overview
The barbican 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 not part of the core software. The module itself is used to flexibly configure and manage the Key management service for OpenStack.
Module Description
The barbican module is a thorough attempt to make Puppet capable of managing the entirety of barbican. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the barbican module to assist in manipulation of configuration files.
Setup
What the barbican module affects
- Barbican, the Key management service for OpenStack.
Installing barbican
barbican is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install barbican with:
puppet module install openstack/barbican
Beginning with barbican
To utilize the barbican module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. This is not an exhaustive list of all the components needed, we recommend you consult and understand the openstack module and the core openstack documentation.
Implementation
barbican
barbican is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Limitations
- All the barbican types use the CLI tools and so need to be ran on the barbican node.
Development
Developer documentation for the entire puppet-openstack project.