Table of Contents

• Description
  • This is a SIMP module
• Setup
• Usage
• Reference
• Limitations
• Development

Description

gnome is a Puppet module that installs and manages a GNOME 3 installation.

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 'gnome'

Usage

You can disable configuration of gnome by setting gnome::configure to false. The module will then only install Gnome.

This module makes heavy use of data. The dconf and gconf 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:

gnome::dconf_hash:
  simp_gnome:
    --org/gnome/settings-daemon/plugins/media-keys:
    org/gnome/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 gnome::dconf_hash:

gnome::dconf_hash:
  simp_gnome:
    org/gnome/desktop/background:
      picture-uri:
        value: file:///usr/local/corp/puppies.jpg
        lock: false

Reference

See the API documentation for 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 v3.

Development

Please read our Contribution Guide

Reference

Table of Contents

Classes

Public Classes

• gnome: Installs and configures a minimal Gnome environment

Private Classes

• gnome::config: Set configuration unique to Gnome 3

Classes

gnome

Installs and configures a minimal Gnome environment

Parameters

The following parameters are available in the gnome class:

• configure
• dconf_hash
• dconf_profile_hierarchy
• packages
• package_ensure

configure

Data type: Boolean

Use the module to configure Gnome

@see data/common.yaml

dconf_hash

Data type: Hash[String[1], Dconf::SettingsHash]

dconf settings specific to Gnome 3

@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 - 9.4.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

• Wed Aug 23 2023 Steven Pritchard steve@sicura.us - 9.3.0

• Add AlmaLinux 8 support

• Mon Jul 24 2023 Chris Tessmer chris.tessmer@onyxpoint.com - 9.2.0

• Add RockyLinux 8 support

• Tue Jun 15 2021 Chris Tessmer chris.tessmer@onyxpoint.com - 9.1.0

• Removed support for Puppet 5
• Ensured support for Puppet 7 in requirements and stdlib

• Wed Jan 13 2021 Jeanne Greulich jeanne.greulich@onyxpoint.com - 9.0.0-0

• Add EL8 support
  • add dconf settings to dconf hash to ensure users can not disable lock screen or show passwords in plain text
  • update package lists. Common package list is now packages common to gnome V3.
• Remove support for EL6
  • removed support for gnome2
  • removed the gconf parameters and settings.
  • removed test logic
  • removed parameter gnome::gconf_hash
  • removed parameter gnome::enable_gnome

• Thu Jul 23 2020 Jeanne Greulich jeanne.greulich@onyxpoint.com - 8.1.2-0

• update the upper bound of simplib for SIMP 6.5 release

• Thu Aug 15 2019 Trevor Vaughan tvaughan@onyxpoint.com - 8.1.1-0

• Fix compliance engine tests

• Thu Jun 06 2019 Steven Pritchard steven.pritchard@onyxpoint.com - 8.1.0-0

• Add v2 compliance_markup data

• Thu Mar 07 2019 Liz Nemsick lnemsick.simp@gmail.com - 8.0.1-0

• Update the upper bound of stdlib to < 6.0.0
• Update a URL in the README.md

• Fri Sep 07 2018 Liz Nemsick lnemsick.simp@gmail.com - 8.0.0-0

• Update Hiera 4 to Hiera 5

• Fri May 18 2018 Trevor Vaughan tvaughan@onyxpoint.com - 8.0.0-0

• Removed all GDM and Dconf settings - BREAKING
  • Dconf has been moved to its own module
• Ensure that all settings are 100% GNOME specific
• Fixed a typo in the dconf_hash where automount-never was specified instead of autorun-never
• Add support for OEL and Puppet 5

• Wed Sep 20 2017 Liz Nemsick lnemsick.simp@gmail.com - 7.0.1-0

• Add libxkbcommon-x11 to required package list for CentOS/RedHat 7.4.
• Remove unnecessary CentOS data-in-module files. The OS family fact for CentOS is RedHat, so these files are not used.

• Mon Jun 05 2017 Nick Miller nick.miller@onyxpoint.com - 7.0.0-0

• module was rewritten
  • takes advantage of the data in modules paradigm
  • has a single point of entry
• packages now default to 'installed' or the package_ensure catalyst from simp_options
• gnome::dconf::add
  • deprecated in favor of gnome::config::dconf
  • this class is now a temporary shim to ensure backwards compatibility
• gnome::config::dconf
  • allows setting more than one key/value pair (only one could be set in dconf::add)
  • class name is not a verb
  • dconf settings controlled by this class can be modified in data, including removing default settings

• Thu May 04 2017 Nick Miller nick.miller@onyxpoint.com - 6.0.3-0

• Moved the simp dconf profile below the user profile so users can change their own settings in the desktop
• Confine puppet version in metadata.json

• Thu Apr 27 2017 Jeanne Greulich jeanne.greulich@onyxpoint.com - 6.0.3-0

• Add dconf rule to not display user lists

• Mon Apr 17 2017 Nick Miller nick.miller@onyxpoint.com - 6.0.3-0

• Updated polkit setting to use the new defined type from the polkit module
• Added polkit dependency
• dconf update execs now catch failures

• Mon Mar 15 2017 Jeanne Greulich jeanne.greulich@onyxpoint.com - 6.0.2-0

• Fixed packages lists
• Fixed screensaver logic
• gconf type was not getting values correctly

• Tue Feb 21 2017 Nick Miller nick.miller@onyxpoint.com - 6.0.1-0

• Added check for gdm_version before it's used

• Tue Dec 13 2016 Liz Nemsick lnemsick.simp@gmail.com - 6.0.0-0

• Added strong typing of parameters

• Thu Dec 01 2016 Nick Markowski nmarkowski@keywcorp.com - 6.0.0-0

• Renamed module from 'windowmanager' to 'gnome'

• Wed Nov 23 2016 Jeanne Greulich jgreulich@onyxpoint.com - 5.0.0-0

• Fix dependancies for simp 6 bump

• Mon Nov 21 2016 Chris Tessmer chris.tessmer@onyxpoint.com - 5.0.0-0

• Updated to compliance_markup version 2

• Mon Nov 21 2016 Liz Nemsick lnemsick.simp@gmail.com - 4.1.4-0

• Include gconf type removed from xwindows project.

• Thu Jul 28 2016 Trevor Vaughan tvaughan@onyxpoint.com - 4.1.2-0

• Corrected the scope include syntax

• Tue Jun 7 2016 Ralph Wright rwright@onyxpoint.com - 4.1.1-0

• Added dconf support
• Added security settings using dconf

• Tue Mar 01 2016 Ralph Wright ralph.wright@onyxpoint.com - 4.1.0-3

• Added compliance function support

• Fri Jan 16 2015 Trevor Vaughan tvaughan@onyxpoint.com - 4.1.0-2

• Changed puppet-server requirement to puppet

• Tue Sep 30 2014 Nick Markowski nmarkowski@keywcorp.com - 4.1.0-1

• Updated for RHEL7

• Thu Mar 20 2014 Nick Markowski nmarkowski@keywcorp.com - 4.1.0-0

• Updated for puppet3/hiera and added rspec tests

• Wed Oct 02 2013 Trevor Vaughan tvaughan@onyxpoint.com - 4.0.0-6

• Use 'versioncmp' for all version comparisons.

• Fri May 03 2013 Nick Markowski nmarkowski@keywcorp.com 4.0.0-5

• Added pupmod-mozilla as a dependency

• Tue Dec 11 2012 Maintenance 4.0.0-4

• Created a Cucumber test to ensure that windowmanager install correctly from the windowmanager module with all dependencies.

• Fri May 25 2012 Maintenance 4.0.0-3

• Added a windowmanager::gnome::sec class that is included by default and provides some common security settings via gconf.
• Moved mit-tests to /usr/share/simp...
• Updated pp files to better meet Puppet's recommended style guide.

• Fri Mar 02 2012 Maintenance 4.0.0-2

• Improved test stubs.

• Mon Dec 26 2011 Maintenance 4.0.0-1

• Updated the spec file to not require a separate file list.

• Wed Nov 02 2011 Maintenance 4.0.0-0

• Updated to handle RHEL6

• Tue Jan 11 2011 Maintenance 2.0.0-0

• Refactored for SIMP-2.0.0-alpha release

• Tue Oct 26 2010 Maintenance - 1-1

• Converting all spec files to check for directories prior to copy.

• Mon May 24 2010 Maintenance 1.0-0

• Code refactoring.

• Thu Oct 1 2009 Maintenance 0.1-0

• Initial Release