15301917ce
Change-Id: Ief392b19c38c7e8d5d53aa99618dfc19cb1e9495
112 lines
6.6 KiB
Markdown
112 lines
6.6 KiB
Markdown
Team and repository tags
|
|
========================
|
|
|
|
[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-oslo.svg)](https://governance.openstack.org/tc/reference/tags/index.html)
|
|
|
|
<!-- Change things from this point on -->
|
|
|
|
oslo
|
|
=======
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview - What is the oslo module?](#overview)
|
|
2. [Module Description - What does the module do?](#module-description)
|
|
3. [Setup - The basics of getting started with oslo](#setup)
|
|
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
|
|
5. [Limitations - OS compatibility, etc.](#limitations)
|
|
6. [Development - Guide for contributing to the module](#development)
|
|
7. [Contributors - Those with commits](#contributors)
|
|
|
|
Overview
|
|
--------
|
|
|
|
The oslo module is a part of [OpenStack](https://www.openstack.org), 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 its self is used to flexibly configure and manage the FIXME service for OpenStack.
|
|
|
|
Module Description
|
|
------------------
|
|
|
|
The oslo module is a thorough attempt to make Puppet capable of managing the entirety of oslo libraries. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the oslo module to assist in manipulation of configuration files.
|
|
|
|
Following versions of oslo libraries are get from requirements.txt in each project.
|
|
|
|
| Name | oslo.cache | oslo.config | oslo.concurrency | oslo.context | oslo.db | oslo.log | oslo.messaging | oslo.middleware | oslo.policy | oslo.reports | oslo.rootwrap | oslo.serialization | oslo.utils | oslo.versionedobjects | oslo.service | oslo.i18n | oslo.vmware |
|
|
| ---- |:-------:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:| -----:|
|
|
| Aodh | n/a | >=2.6.0 | n/a | >=0.2.0 | >=1.12.0 | >=1.2.0 | !=2.8.0,>2.6.1 | !=2.0.0,>=1.2.0 | >=0.5.0 | n/a | n/a | >=1.4.0 | >=1.9.0 | n/a | >=0.1.0 | >=1.5.0 | n/a |
|
|
| Barbican | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | n/a | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | n/a | >=0.5.0 | n/a | n/a | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Cinder | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.2.0 | >=0.13.0 | >=1.0.0 | >=1.5.0 | >=1.16.0 |
|
|
| Ceilometer | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Designate | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Glance | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0| >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.2.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Gnocchi | n/a | >=2.6.0 | n/a | n/a | n/a | >=1.0.0 | n/a | ? | >=0.3.0 | n/a | n/a | >=1.4.0 | >=1.6.0 | n/a | n/a | n/a | n/a |
|
|
| Heat | >= 0.8.0 | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0| >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.4.0 | >= 0.13.0 | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Ironic | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0| >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.2.0 | >= 0.13.0 | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Keystone | >= 0.8.0 | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0| >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.2.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Manila | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Mistral | n/a | >=3.2.0 | >=2.3.0 | n/a | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | n/a | n/a | n/a | n/a | >=1.10.0 | >=3.2.0 | n/a | >=1.0.0 | n/a | n/a |
|
|
| Murano | n/a | >=3.2.0 | n/a | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | n/a | n/a | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Neutron | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >=0.5.0 | >=0.6.0 | >=2.0.0 | >=1.10.0 | >=3.4.0 | >= 0.13.0 | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Rally | n/a | >=3.2.0 | n/a | >=3.2.0 | >=4.1.0 | >=1.14.0 | n/a | n/a | n/a | n/a | n/a | >=1.10.0 | >=3.4.0 | n/a | n/a | >=1.5.0 | n/a |
|
|
| Sahara | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | >= 0.5.0 | n/a | >=2.0.0 | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Tempest | n/a | >=3.2.0 | >=2.3.0 | n/a | n/a | >=1.14.0 | n/a | n/a | n/a | n/a | n/a | >=1.10.0 | >=3.2.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Trove | n/a | >=3.2.0 | >=2.3.0 | >=0.2.0 | >=4.1.0 | >=1.14.0 | !=2.8.0,!=3.1.0,>2.6.1 | >=3.0.0 | n/a | n/a | n/a | >=1.10.0 | >=3.4.0 | n/a | >=1.0.0 | >=1.5.0 | n/a |
|
|
| Tuskar | n/a | >=2.3.0 | n/a | n/a | >=2.4.1 | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a |
|
|
| Swift | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a | n/a |
|
|
| Zaqar | >= 0.8.0 | >=3.2.0 | n/a | >=0.2.0 | n/a | >=1.14.0 | n/a | n/a | >= 0.5.0 | n/a | n/a | >=1.10.0 | >=3.2.0 | n/a | n/a | >=1.5.0 | n/a |
|
|
|
|
Setup
|
|
-----
|
|
|
|
**What the oslo module affects**
|
|
|
|
* [Oslo](https://wiki.openstack.org/wiki/Oslo), the FIXME service for OpenStack.
|
|
|
|
### Installing oslo
|
|
|
|
oslo is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install oslo with:
|
|
puppet module install openstack/oslo
|
|
|
|
### Beginning with oslo
|
|
|
|
To utilize the oslo module's functionality you will need to declare multiple resources.
|
|
|
|
Implementation
|
|
--------------
|
|
|
|
### oslo
|
|
|
|
oslo is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
|
|
|
|
Limitations
|
|
------------
|
|
|
|
* All the oslo types use the CLI tools and so need to be ran on the oslo node.
|
|
|
|
Beaker-Rspec
|
|
------------
|
|
|
|
This module has beaker-rspec tests
|
|
|
|
To run the tests on the default vagrant node:
|
|
|
|
```shell
|
|
bundle install
|
|
bundle exec rake acceptance
|
|
```
|
|
|
|
For more information on writing and running beaker-rspec tests visit the documentation:
|
|
|
|
* https://github.com/puppetlabs/beaker-rspec/blob/master/README.md
|
|
|
|
Development
|
|
-----------
|
|
|
|
Developer documentation for the entire puppet-openstack project.
|
|
|
|
* https://docs.openstack.org/puppet-openstack-guide/latest/
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-oslo/graphs/contributors
|