OpenStack Ironic Puppet Module
Go to file
Tobias Urdin d85f830a3b Release 13.3.1
Change-Id: Id70c0cf4ea6726c3d2fe71681dc9ceb91dc28775
2018-10-13 12:33:23 +02:00
doc Follow the new PTI for document build 2018-02-28 14:42:11 +08:00
examples Add ability to translate swift account project name to UUID 2017-03-28 10:04:19 +03:00
lib/puppet Make providers use auth_url for authentication 2018-08-03 12:01:58 +02:00
manifests Expose the endpoint_override parameter 2018-09-20 13:58:03 +00:00
releasenotes Expose the endpoint_override parameter 2018-09-20 13:58:03 +00:00
spec Expose the endpoint_override parameter 2018-09-20 13:58:03 +00:00
templates Remove ironic inspector dnsmasq bind-interfaces setting 2018-09-10 23:48:59 +00:00
.gitignore Update .gitignore 2018-04-11 08:55:20 +08:00
.gitreview Update .gitreview for stable/rocky 2018-08-21 20:55:47 +00:00
.zuul.yaml import zuul job settings from project-config 2018-08-31 08:44:59 -04:00
CHANGELOG.md Release 8.0.0 2016-03-23 16:07:20 -04:00
Gemfile Update Gemfile for stable/rocky 2018-08-28 13:55:06 +02:00
LICENSE First commit with basic manifests 2013-11-25 20:59:48 +01:00
README.md Remove the unnecessary _ 2018-07-25 11:26:51 +08:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:21 -05:00
bindep.txt modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:18:24 +02:00
metadata.json Release 13.3.1 2018-10-13 12:33:23 +02:00
setup.cfg Update URLs in documents according to document migration 2017-07-14 08:52:18 +08:00
setup.py Add basic structure for ReNo 2016-03-14 08:30:13 -04:00
tox.ini Update UPPER_CONSTRAINTS_FILE for stable/rocky 2018-08-21 20:53:17 +00:00

README.md

Team and repository tags

Team and repository tags

puppet-ironic

Table of Contents

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

Module Description

Setup

What the ironic module affects:

  • Ironic, the baremetal service for OpenStack.

Installing Ironic

puppet module install openstack/ironic

Beginning with ironic

To utilize the ironic module's functionality you will need to declare multiple resources. This is not an exhaustive list of all the components needed. We recommend that you consult and understand the core openstack documentation to assist you in understanding the available deployment options.

# enable Ironic resources
class { '::ironic':
  rabbit_userid       => 'ironic',
  rabbit_password     => 'an_even_bigger_secret',
  rabbit_host         => '127.0.0.1',
  database_connection => 'mysql://ironic:a_big_secret@127.0.0.1/ironic?charset=utf8',
}

class { '::ironic::db::mysql':
  password => 'a_big_secret',
}

class { '::ironic::keystone::auth':
  password => 'a_big_secret',
}

class { '::ironic::client': }

class { '::ironic::conductor': }

class { '::ironic::api':
  admin_password => 'a_big_secret',
}

class { '::ironic::drivers::ipmi': }

# alternatively, you can deploy Ironic with Bifrost. It's a collection of Ansible playbooks to configure
# and install Ironic in a stand-alone fashion (for more information visit https://docs.openstack.org/bifrost/latest/)
class { 'ironic::bifrost':
  ironic_db_password => 'a_big_secret',
  mysql_password => 'yet_another_big_secret',
  baremetal_json_hosts => hiera('your_hiera_var_containing_bm_json_hosts'),
}

Examples of usage also can be found in the examples directory.

Implementation

puppet-ironic

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

Types

ironic_config

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

ironic_config { 'DEFAULT/my_ip' :
  value => 127.0.0.1,
}

This will write my_ip=127.0.0.1 in the [DEFAULT] section.

name

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

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.

Contributors

Release Notes

Repository