58f113cba1
The latest release of setuptools 61.0 made a breaking change[1] and because of this change 'pip install' fails with the following error. ~~~ error: Multiple top-level packages discovered in a flat-layout: ['lib', 'spec', 'manifests', 'releasenotes']. ~~~ Users that don't set 'packages', 'py_modules', or configuration' are still likely to observe the auto-discovery behavior, which may halt the build if the project contains multiple directories and/or multiple Python files directly under the project root. To disable auto discovery, one can do below in setup.py ~~~ setuptools.setup(..,packages=[],..) ~~~ or ~~~ setuptools.setup(..,py_modules=[],..) ~~~ [1] https://github.com/pypa/setuptools/issues/3197 Note setup.py is not used to install puppet modules. However it is used to generate a release note, thus should be fixed. Signed-off-by: Jiri Podivin <jpodivin@redhat.com> Change-Id: I9767330a94f2406a6e76be0f7ce3886478bce3e5
Team and repository tags
puppet-ironic
Table of Contents
- Overview - What is the ironic module?
- Module Description - What does the module do?
- Setup - The basics of getting started with ironic
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Release notes for the project
- 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': }
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.
```puppet
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.