Version information
released Apr 18th 2024
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 8.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'openstack-heat', '24.0.0'Learn more about managing modules with a PuppetfileDocumentation
openstack/heat — version 24.0.0 Apr 18th 2024
Team and repository tags
puppet-heat
Table of Contents
- Overview - What is the heat module?
- Module Description - What does the module do?
- Setup - The basics of getting started with heat
- 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 heat module is 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 orchestration service for OpenStack.
Module Description
The heat module is an attempt to make Puppet capable of managing the entirety of heat.
Setup
What the heat module affects
- Heat, the orchestration service for OpenStack
Installing heat
puppet module install openstack/heat
Beginning with heat
To utilize the heat module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. This is not an exhaustive list of all the components needed. We recommend that you consult and understand the openstack module and the core openstack documentation to assist you in understanding the available deployment options.
# enable heat resources
class { 'heat':
default_transport_url => 'rabbit://heat:an_even_bigger_secret@127.0.0.1:5672/heat',
database_connection => 'mysql+pymysql://heat:a_big_secret@127.0.0.1/heat?charset=utf8',
keystone_password => 'a_big_secret',
}
class { 'heat::api': }
class { 'heat::engine':
auth_encryption_key => '1234567890AZERTYUIOPMLKJHGFDSQ12',
}
class { 'heat::api_cfn': }
Implementation
puppet-heat
heat is a combination of Puppet manifests and Ruby code to deliver configuration and extra functionality through types and providers.
Types
heat_config
The heat_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/heat/heat.conf file.
heat_config { 'DEFAULT/enable_stack_adopt' :
value => True,
}
This will write enable_stack_adopt=True in the [DEFAULT] section.
name
Section/setting name to manage from heat.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
8.0.0 and beyond
From 8.0.0 release and beyond, release notes are published on docs.openstack.org.
##2015-11-25 - 7.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Liberty.
####Backwards-incompatible changes
- change section name for AMQP qpid parameters
- change section name for AMQP rabbit parameters
- update rpc_backend default parameter
- cleanup configure_delegated_roles deprecated parameter
####Features
- add support for RabbitMQ connection heartbeat
- keystone/auth: make service description configurable
- add tag to package and service resources
- add heat::config class
- expose RPC response timeout as a puppet parameter
- support setting instance_user to an empty string
- add heat::db::sync
- add an ability to manage use_stderr parameter
- reflect provider change in puppet-openstacklib
- put all the logging related parameters to the logging class
- add rabbit_ha_queues option
- improve heat::keystone::domain
- remove POSIX users, groups, and file modes
- use postgresql lib class for psycopg package
- move deps & external hooks into a standalone class
- introduce heat::db class
- make the role for heat_stack_user configurable
- allow to not manage Keystone domain
- add hooks for external install & svc management
####Bugfixes
- rely on autorequire for config resource ordering
- fix up doc string for workers variable
####Maintenance
- acceptance: enable debug & verbosity for OpenStack logs
- initial msync run for all Puppet OpenStack modules
- try to use zuul-cloner to prepare fixtures
- remove class_parameter_defaults puppet-lint check
- acceptance: use common bits from puppet-openstack-integration
##2015-10-14 - 6.1.0 ###Summary
This is a feature and maintenance release in the Kilo series.
####Features
- Create Heat Domain with Keystone_domain resource
####Maintenance
- Remove deprecated parameter stack_user_domain
- acceptance: checkout stable/kilo puppet modules
##2015-07-08 - 6.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Kilo.
####Backwards-incompatible changes
- Move rabbit/kombu settings to oslo_messaging_rabbit section
####Features
- Puppet 4.x support
- Implement Keystone domain creation
- Log output of heat-keystone-setup-domain
- Refactorise Keystone resources management
- Move keystone role creation to keystone area
- Support region_name for Heat
- Mark heat's keystone password as secret
- Add support for identity_uri
- Make configuring the service optional
- Set instance_user in heat
- Added missing enable_stack_abandon configuration option
- Tag all Heat packages
- Create a sync_db boolean for Heat
- Engine: validate auth_encryption_key
- Allow setting default config/signal transport
- Run db_sync when heat-common is upgraded
- Introduce public_url, internal_url and admin_url
####Maintenance
- Acceptance tests with Beaker
- Fix spec tests for RSpec 3.x and Puppet 4.x
- Rename keystone_v2_authenticate method
- Make package_ensure consistent across classes
##2015-06-17 - 5.1.0 ###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Switch to TLSv1
- Implement Keystone domain creation
- Run dbsync when engine is upgraded
- db: Added postgresql backend using openstacklib helper
- Add option to configure flavor in heat.conf
####Bugfixes
- Rework delegated roles
- Change default MySQL collate to utf8_general_ci
- Fix ipv6 support
####Maintenance
- spec: pin rspec-puppet to 1.0.1
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Update .gitreview file for project rename
##2014-11-24 - 5.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Bump stdlib dependency to >=4.0.0
####Features
- Add heat::policy to control policy.json
- Deprecate the sql_connection parameter for database_connection parameter
- Add parameters to configure deferred authentication method in heat::engine in accordance with new Juno defaults
- Add parameters to control whether to configure users
- Add manage_service parameters to various classes to control whether the service was managed, as well as added enabled parameters where not already present
- Add the ability to override the keystone service name in keystone::auth
- Migrate the heat::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
##2014-10-16 - 4.2.0 ###Summary
This is a feature and bugfix release in the Icehouse series.
####Backwards-incompatible changes
####Features
- Add ability to hide secret type parameters from logs
- Add class for extended logging options
####Bugfixes
- Fix database resource relationships
- Fix ssl parameter requirements when using kombu and rabbit
##2014-06-19 - 4.1.0 ###Summary
This is a feature release in the Icehouse series.
####Features
- Added SSL endpoint support
##2014-05-05 - 4.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Icehouse.
####Backwards-incompatible changes
- Fix outdated DB connection parameter
####Features
- Add SSL parameter for RabbitMQ
- Add support for puppetlabs-mysql 2.2 and greater
- Add option to define RabbitMQ queues as durable
####Bugfixes
- Fix Keystone auth_uri parameter
##2014-03-26 - 3.1.0 ###Summary
This is a feature and bugfix release in the Havana series.
####Features
- Allow log_dir to be set to false to disable file logging
- Add support for database idle timeout
####Bugfixes
- Fix postgresql connection string
- Align Keystone auth_uri with other OpenStack services
- Fix the EC2 auth token settings
- Fix rabbit_virtual_host configuration
##2014-01-23 - 3.0.0 ###Summary
Initial release of the puppet-heat module.
Dependencies
- puppetlabs/inifile (>=2.0.0 <7.0.0)
- openstack/keystone (>=24.0.0 <25.0.0)
- puppetlabs/stdlib (>=5.0.0 <10.0.0)
- openstack/openstacklib (>=24.0.0 <25.0.0)
- openstack/oslo (>=24.0.0 <25.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.