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, 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 < 9.0.0
- , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'simp-mate', '1.6.0'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
Description
mate
is a Puppet module that installs and manages MATE.
This is a SIMP module
This module is a component of the System Integrity Management Platform a compliance-management framework built on Puppet.
If you find any issues, they may be submitted to our bug tracker.
This module is optimally designed for use within a larger SIMP ecosystem, but it can be used independently:
- When included within the SIMP ecosystem, security compliance settings will be managed from the Puppet server.
- If used independently, all SIMP-managed security subsystems are disabled by default and must be explicitly opted into by administrators. See simp_options for more detail.
Setup
To use the module with default settings, just include the class:
include 'mate'
Usage
You can disable configuration of mate by setting mate::configure
to false.
The module will then only install MATE.
This module makes heavy use of data. The dconf
settings are all data-driven,
and the defaults can be seen in the
common.yaml.
You can use the knockout prefix of --
in front of a key to remove it from the
Hash, like this:
mate::dconf_hash:
simp_mate:
--org/mate/settings-daemon/plugins/media-keys:
org/mate/desktop/media-handling:
--automount-open:
Or you can simply set it to the desired value.
Dconf
settings are locked by default so that users can't change them.
This can be disabled on a per setting basis, like in this entry for wallpaper
in mate::dconf_hash
:
mate::dconf_hash:
simp_mate:
org/mate/desktop/background:
picture-uri:
value: file:///usr/local/corp/puppies.jpg
lock: false
Reference
See the API documentation
or run puppet strings
for full details.
Limitations
SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux and compatible distributions, such as CentOS.
Please see the metadata.json
file for the most up-to-date
list of supported operating systems, Puppet versions, and module dependencies.
This module is compatible with GDM v2, v3.
Development
Please read our [Contribution Guide] (https://simp.readthedocs.io/en/stable/contributors_guide/index.html)
Reference
Table of Contents
Classes
Public Classes
mate
: Installs and configures a minimal MATE environment
Private Classes
mate::config
: Set MATE configuration items
Classes
mate
Installs and configures a minimal MATE environment
Parameters
The following parameters are available in the mate
class:
configure
Data type: Boolean
Use the module to configure MATE
@see data/common.yaml
dconf_hash
Data type: Hash[String[1], Dconf::SettingsHash]
Settings specific to dconf and MATE
@see data/common.yaml @see https://wiki.gnome.org/Projects/dconf/SystemAdministrators
dconf_profile_hierarchy
Data type: Dconf::DBSettings
Dconf db priority
@see https://help.gnome.org/admin/system-admin-guide/stable/dconf.html.en @see https://wiki.gnome.org/Projects/dconf/SystemAdministrators
packages
Data type: Hash[String[1], Optional[Hash]]
A Hash of packages to be installed
- NOTE: Setting this will override the default package list
- The ensure value can be set in the hash of each package, like the example below:
@example Override packages { 'gedit' => { 'ensure' => '3.14.3' } }
@see data/common.yaml
package_ensure
Data type: Simplib::PackageEnsure
The SIMP global catalyst to set the default ensure
settings for packages
managed with this module. Will be overwitten by $packages.
Default value: simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })
- Wed Oct 11 2023 Steven Pritchard steve@sicura.us - 1.6.0
- [puppetsync] Updates for Puppet 8
- These updates may include the following:
- Update Gemfile
- Add support for Puppet 8
- Drop support for Puppet 6
- Update module dependencies
- These updates may include the following:
- Wed Aug 23 2023 Steven Pritchard steve@sicura.us - 1.5.0
- Add AlmaLinux 8 support
- Mon Jul 24 2023 Chris Tessmer chris.tessmer@onyxpoint.com - 1.4.0
- Add RockyLinux 8 support
- Fri Jul 15 2022 Joshua Hoblitt josh@hoblitt.com - 1.3.0
- Add EL8 support
- Tue Jun 15 2021 Chris Tessmer chris.tessmer@onyxpoint.com - 1.2.0
- Removed support for Puppet 5
- Ensured support for Puppet 7 in requirements and stdlib
- Fri Dec 18 2020 Chris Tessmer chris.tessmer@onyxpoint.com - 1.1.2
- Maintenance update for module assets
- Thu Jul 23 2020 Jeanne Greulich jeanne.greulich@onyxpoint.com - 1.1.1
- update the upper bound of simplib for SIMP 6.5 release
- Fri Aug 02 2019 Robert Vincent pillarsdotnet@gmail.com - 1.1.0
- Remove Puppet 4 support
- Add Puppet 6 support
- Add puppetlabs-stdlib 6 support
- Thu Mar 07 2019 Liz Nemsick lnemsick.simp@gmail.com - 1.0.2
- Update the upper bound of stdlib to < 6.0.0
- Update a URL in the README.md
- Mon Nov 05 2018 Liz Nemsick lnemsick-simp@gmail.com - 1.0.1
- Update to Hiera 5
- Wed Jun 20 2018 Trevor Vaughan tvaughan@onyxpoint.com - 1.0.0-0
- Initial release of the MATE module
Dependencies
- simp/dconf (>= 0.0.1 < 1.0.0)
- simp/polkit (>= 6.1.0 < 7.0.0)
- simp/simplib (>= 4.9.0 < 5.0.0)
- puppetlabs/stdlib (>= 8.0.0 < 10.0.0)
pupmod-simp-mate - A Puppet Module for managing MATE -- Per Section 105 of the Copyright Act of 1976, these works are not entitled to domestic copyright protection under US Federal law. The US Government retains the right to pursue copyright protections outside of the United States. The United States Government has unlimited rights in this software and all derivatives thereof, pursuant to the contracts under which it was developed and the License under which it falls. --- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.