OpenStack Ironic Puppet Module
Go to file
Takashi Kajinami b79368ec09 Allow enabling debug output of IPMI commands
This change introduces a new parameter, ironic::drivers::ipmi::debug,
so that operators can enabled debug outputs of IPMI commands executed
in ironic.

Change-Id: Ie8993c14649b56e5af530ed2e94e38bc02bb7d55
2020-07-28 11:43:37 +09:00
doc Switch to newer openstackdocstheme and reno versions 2020-06-02 14:40:20 +02:00
examples Convert all class usage to relative names 2019-12-08 23:08:32 +01:00
lib/puppet Use anchor to require necessary packages 2020-05-04 03:04:16 +09:00
manifests Allow enabling debug output of IPMI commands 2020-07-28 11:43:37 +09:00
releasenotes Allow enabling debug output of IPMI commands 2020-07-28 11:43:37 +09:00
spec Allow enabling debug output of IPMI commands 2020-07-28 11:43:37 +09:00
templates Use client architecture and set bootfile-url for DHCPv6 in inspector 2019-10-17 22:02:07 -04: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 switch documentation job to new PTI 2018-08-31 08:24:38 -04: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 Move to opendev 2019-04-22 08:54:01 +08:00
LICENSE First commit with basic manifests 2013-11-25 20:59:48 +01:00
README.md Change rpsec to rspec 2020-04-30 13:24:45 +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 Prepare Victoria M1 2020-06-19 10:38:55 +08:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-02 18:19:58 +01:00
setup.py Add basic structure for ReNo 2016-03-14 08:30:13 -04:00
tox.ini [ussuri][goal] Cleanup for python 2.7 drop 2020-02-15 19:14:01 -06: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. Beaker-Rspec - Beaker-rspec tests for the project
  7. Development - Guide for contributing to the module
  8. Contributors - Those with commits
  9. Release Notes - Release notes for the project
  10. 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

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