puppet-designate/README.md
Ben Nemec 8bc63c3933 Update Red Hat package details in readme
Designate has been packaged in RDO for a while, so we should point
users at that instead of asking them to build the package themselves
using a 4 year old spec repo.

Depends-On: I24341aa30286518aa72e01956d2ca1a9028af3bc
Change-Id: I114415ba3f9eb4624e0dea2b68a0b7eec8196982
2017-12-21 15:47:06 +00:00

3.4 KiB

Team and repository tags

Team and repository tags

puppet-designate

Table of Contents

  1. Overview - What is the designate module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with designate
  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 - Notes on the most recent updates to the module

Overview

The designate 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 DNS service for OpenStack.

Module Description

Setup

What the designate module affects:

Installing designate

puppet module install openstack/designate

Implementation

designate

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

Types

designate_config

The designate_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/designate/designate.conf file.

designate_config { 'DEFAULT/notification_driver' :
  value => messaging,
}

This will write notification_driver=messaging in the [DEFAULT] section.

name

Section/setting name to manage from designate.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

None.

Beaker-Rspec

This module has beaker-rspec tests

To run:

bundle install
bundle exec rspec spec/acceptance

Development

Developer documentation for the entire puppet-openstack project.

WORK IN PROGRESS

✓ Basic structure ✓ DB ✓ Keystone (Users, Services, Endpoints) ✓ Client ✓ designate-api ✓ designate-central ✗ designate-agent (in progress) ✗ designate-sink (in progress) ✓ An example of site.pp ✓ Write Tests

Setup

Get Prepared for Deployment

Debian/Ubuntu

  • Debian testing (jessie) include all designate packages.
  • Ubuntu utopic is the minimum requirement for Ubuntu deployment.

Red Hat

  • Packages are available from RDO: https://www.rdoproject.org/
  • See the repo setup instructions for the various RDO deployment methods for details on how to use them.

Contributors

Release Notes