openstack/puppet-octavia
Code Issues Proposed changes
99e9b269f1
puppet-octavia/README.md
Flavio Percoco a245d07f19 Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/b58ee10823b575268df4b1be4aac1f9d

Change-Id: I51e400aec66436c8411993d7826153264f20b0f3
2016-11-25 17:37:59 +01:00

2.7 KiB
Raw Blame History

Team and repository tags

Team and repository tags

octavia

Table of Contents

  1. Overview - What is the octavia module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with octavia
  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

Overview

The octavia 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 its self is used to flexibly configure and manage the scalable load balancer service for OpenStack.

Module Description

The octavia module is a thorough attempt to make Puppet capable of managing the entirety of octavia. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the octavia module to assist in manipulation of configuration files.

Setup

What the octavia module affects

  • Octavia, the scalable load balancer service for OpenStack.

Installing octavia

octavia is not currently in Puppet Forge, but is anticipated to be added soon.  Once that happens, you'll be able to install octavia with:
puppet module install openstack/octavia

Beginning with octavia

To utilize the octavia module's functionality you will need to declare multiple resources.

Implementation

octavia

octavia is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.

Limitations

  • All the octavia types use the CLI tools and so need to be ran on the octavia node.

Beaker-Rspec

This module has beaker-rspec tests

To run the tests on the default vagrant node:

bundle install
bundle exec rake acceptance

For more information on writing and running beaker-rspec tests visit the documentation:

Development

Developer documentation for the entire puppet-openstack project.

Contributors