Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
- Puppet >= 7.24 < 9.0.0
Start using this module
Add this module to your Puppetfile:
mod 'dmaes-etcd', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
ETCD puppet module
This puppet module manages etcd. It currently uses the operating system's package manager to install the required software. Repo management is not supported. Only tested on etcd v3 api.
Usage
A simple include should cover most use-cases.
include etcd
Alternatively, the etcd class accepts following parameters:
class {'etcd':
package_names => ['etcd'],
config => {
'name' => $facts['networking']['fqdn'],
'data-dir' => '/var/lib/etcd',
}, # Set empty to not manage config
config_dir => '/etc/etcd',
config_file => 'config.yaml',
manage_config_dir => true,
purge_config_dir => true,
manage_service => true,
service_name => 'etcd',
}
See REFERENCE.md for more information. These params can of course also be overwritten using Hiera.
License
Reference
Table of Contents
Classes
Public Classes
etcd: This module manages etcd (https://etcd.io) It uses a package-based install, and does not download binaries from a release page.
Private Classes
etcd::auth: This class manages auth-related stuffetcd::config: This class handles the etcd configuration fileetcd::install: This class handles the etcd installation using the operating system's package manageretcd::service: This class manages the etcd systemd serviceetcd::snapshot: This class manages a systemd timer to create snapshots
Resource types
etcd_role: @summary Manage an etcd roleetcd_role_permission: @summary Manage an etcd role permissionsetcd_user: @summary Manage etcd users. This resource does not manage user passwords, since etcd doesn't provide the necessary endpoints to do this clean
Functions
etcd::prefix_range_end: Calculates the range-end for a given prefix. Can be used for therange_endparameter ofetcd_role_permission, to grant prefix.
Classes
etcd
This module manages etcd (https://etcd.io) It uses a package-based install, and does not download binaries from a release page.
Parameters
The following parameters are available in the etcd class:
package_namesconfigconfig_dirconfig_filemanage_config_dirpurge_config_dirmanage_serviceservice_nameetcdctl_envmanage_etcdctl_profileauthrolespurge_rolesrole_permissionspurge_role_permissionsuserspurge_userssnapshotsnapshot_pathsnapshot_oncalendar
package_names
Data type: Array[String]
A list of packages to install. Empty list will not install any packages. Default: ['etcd']
Default value: ['etcd']
config
Data type: Variant[Hash, String]
Either a hash or a string containing etcd's config. Hash will be converted to yaml, string will be expected to already be in yaml format and will be used as-is. Default: {name: $facts['networking']['fqdn'], data-dir: '/var/lib/etcd'}
Default value:
{
'name' => $facts['networking']['fqdn'],
'data-dir' => '/var/lib/etcd',
}
config_dir
Data type: Stdlib::Unixpath
Unixpath to the configuration directory Default: '/etc/etcd'
Default value: '/etc/etcd'
config_file
Data type: String
Filename of the configfile. Will be combined with $config_dir Default: 'config.yaml'
Default value: 'config.yaml'
manage_config_dir
Data type: Boolean
Wether to manage the config directory or not. Default: false if $config_dir is '/etc' else true
Default value: ($config_dir != '/etc'
purge_config_dir
Data type: Boolean
Wether to purge the config directory or not. Default: same as $manage_config_dir
Default value: $manage_config_dir
manage_service
Data type: Boolean
Wether to manage (run and enable) the service or not. Default: true
Default value: true
service_name
Data type: String
The name of the service Default: 'etcd'
Default value: 'etcd'
etcdctl_env
Data type: Hash[String, String]
Environment variables to use for etcdctl Also used for the custom providers Default: {}
Example for etcd with auth and TLS enabled:
{
'ETCDCTL_INSECURE_TRANSPORT': 'false',
'ETCDCTL_USER': 'root',
'ETCDCTL_PASSWORD': 'Root123!',
}
Default value: {}
manage_etcdctl_profile
Data type: Boolean
Wether to manage /etc/profile.d/etcdctl.sh, containing the env vars from $etcdctl_env. Default: true
Default value: true
auth
Data type: Boolean
Enable/disable auth. Must add credentials to $etcdctl_env when enabled, to keep using types/providers. Default: false
Default value: false
roles
Data type: Hash[String, Hash]
etcd_role resources to create.
Default: {}
Default value: {}
purge_roles
Data type: Boolean
Wether to purge unmanaged roles or not Default: true
Default value: true
role_permissions
Data type: Hash[String, Hash]
etcd_role_permission resources to create.
Default: {}
Default value: {}
purge_role_permissions
Data type: Boolean
Wether to purge unmanaged role permissions or not Default: true
Default value: true
users
Data type: Hash[String, Hash]
etcd_user resources to create.
Default: {}
Default value: {}
purge_users
Data type: Boolean
Wether to purge unmanaged users or not Default: true
Default value: true
snapshot
Data type: Boolean
Add systemd timer to create snapshots in $snapshot_path Default: false
Default value: false
snapshot_path
Data type: Stdlib::Unixpath
The path to save snapshots to, if $snapshot is enabled Default: /var/lib/etcd/snapshot.db
Default value: '/var/lib/etcd/snapshot.db'
snapshot_oncalendar
Data type: String
The systemd OnCalendar timestamp to run snapshotting Default: --* 00:00:00
Default value: '*-*-* 00:00:00'
Resource types
etcd_role
@summary Manage an etcd role
Properties
The following properties are available in the etcd_role type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
Parameters
The following parameters are available in the etcd_role type.
name
namevar
The name of the role.
provider
The specific backend to use for this etcd_role resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
etcd_role_permission
@summary Manage an etcd role permissions
Properties
The following properties are available in the etcd_role_permission type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
key
The key to grant permission on. (required)
permission
The permission type, must be one of (read|write|readwrite).
range_end
Optional range end to grant permission on. Use etcd::prefix_range_end($key) if you want to grant prefix.
role
The name of the role to grant to. (required)
Parameters
The following parameters are available in the etcd_role_permission type.
name
namevar
The name of the role permission. Must be of ${role}:${key} format.
provider
The specific backend to use for this etcd_role_permission resource. You will seldom need to specify this --- Puppet
will usually discover the appropriate provider for your platform.
etcd_user
@summary Manage etcd users. This resource does not manage user passwords, since etcd doesn't provide the necessary endpoints to do this cleanly. Users will be created without password (aka: only cert auth allowed), and manually configured passwords will be ignored.
Properties
The following properties are available in the etcd_user type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
roles
The list of roles to grant to the users.
Parameters
The following parameters are available in the etcd_user type.
name
namevar
The name of the user.
provider
The specific backend to use for this etcd_user resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
Functions
etcd::prefix_range_end
Type: Ruby 4.x API
Calculates the range-end for a given prefix.
Can be used for the range_end parameter of etcd_role_permission, to grant prefix.
etcd::prefix_range_end(String $prefix)
The etcd::prefix_range_end function.
Returns: Any The range-end for the given prefix.
prefix
Data type: String
The prefix key to calculate the range-end for
Dependencies
- puppetlabs-stdlib (>= 9.0.0 < 10.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.
END OF TERMS AND CONDITIONS