OpenStack Ironic Puppet Module
Go to file
OpenStack Release Bot 59461cac46 Update master for stable/xena
Add file to the reno documentation build to show release notes for
stable/xena.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/xena.

Sem-Ver: feature
Change-Id: Ife3708edba9c0c9a01c1c1500d38527135046cb3
2021-10-07 08:24:05 +00:00
doc Update openstackdocstheme to the latest version 2021-09-29 16:06:50 +08:00
examples Convert all class usage to relative names 2019-12-08 23:08:32 +01:00
lib/puppet Deprecate invalid ironic_api_paste_ini 2021-08-11 14:47:26 +09:00
manifests Support use of dnsmasq as tftp service 2021-10-04 15:17:41 +00:00
releasenotes Update master for stable/xena 2021-10-07 08:24:05 +00:00
spec Support use of dnsmasq as tftp service 2021-10-04 15:17:41 +00:00
templates Support use of dnsmasq as tftp service 2021-10-04 15:17:41 +00:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:24 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:48:23 +00:00
.zuul.yaml Add Puppet Litmus 2020-08-31 21:26:32 +02:00
bindep.txt modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:18:24 +02:00
CHANGELOG.md Release 8.0.0 2016-03-23 16:07:20 -04:00
CONTRIBUTING.rst [ussuri][goal] Add CONTRIBUTING.rst 2020-05-10 22:39:37 +02:00
Gemfile Use openstack_spec_helper from zuul checkout 2020-08-30 22:57:45 +02:00
LICENSE First commit with basic manifests 2013-11-25 20:59:48 +01:00
metadata.json Fix stdlib version in metadata 2021-09-23 19:44:22 +08:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:21 -05:00
README.md Add Puppet Litmus 2020-08-31 21:26:32 +02:00
setup.cfg Add information technology in the setup.cfg 2021-10-01 06:54:49 +08:00
setup.py Delete useless code for setup.py 2021-09-30 13:38:33 +08:00
tox.ini Stop configuring install_command in tox. 2021-09-29 18:03:53 +09:00

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
  8. Release Notes - Release notes for the project
  9. Repository - The project source code repository

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':
  default_transport_url => 'rabbit://ironic:an_even_bigger_secret@127.0.0.1:5672/ironic',
  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

None

Development

Developer documentation for the entire puppet-openstack project.

Contributors

Release Notes

Repository