REFERENCE.md

Reference

Table of Contents

Classes

• simp_ee::bootstrap: Run "simp bootstrap"
• simp_ee::classify: Classify nodes
• simp_ee::config: Configure for simp config
• simp_ee::install: Installs SIMP
• simp_ee::keepalive: Enable ssh keepalives to avoid timeouts

Plans

• simp_ee: Install SIMP Enterprise Edition
• simp_ee::check_puppetserver: Check the status of puppetserver
• simp_ee::rhsm_unregister: Unregister RHEL subscription management
• simp_ee::scanner: Configure simp_scanner Puppet module

Classes

simp_ee::bootstrap

Run "simp bootstrap"

Examples

include simp_ee::bootstrap

simp_ee::classify

Classify nodes

Parameters

The following parameters are available in the simp_ee::classify class:

• files
• owner
• group
• dirmode
• filemode

files

Data type: Array

Hiera files to manage

Default value: [ '/etc/puppetlabs/code/environments/production/hiera.yaml', '/etc/puppetlabs/code/environments/production/data/os/RedHat.yaml', '/etc/puppetlabs/code/environments/production/data/os/windows.yaml', '/etc/puppetlabs/code/environments/production/data/role/console.yaml', '/etc/puppetlabs/code/environments/production/data/role/puppet.yaml', ]

owner

Data type: String[1]

User owner of managed files and directories

Default value: 'root'

group

Data type: String[1]

Group owner of managed files and directories

Default value: 'puppet'

dirmode

Data type: String[4]

Permissions for managed directories

Default value: '0750'

filemode

Data type: String[4]

Permissions for managed files

Default value: '0640'

simp_ee::config

Configure for simp config

Examples

include simp_ee::config

simp_ee::install

Installs SIMP

Examples

include simp_ee::install

Parameters

The following parameters are available in the simp_ee::install class:

• community_release
• enterprise_release
• license_key
• release_package
• release_package_name
• install_type
• community_packages
• enterprise_packages
• license_key_file
• simprelease
• simpreleasetype
• ee_simprelease
• ee_simpreleasetype

community_release

Data type: String

URL of the SIMP Community Edition release package

Default value: 'https://download.simp-project.com/simp-release-community.rpm'

enterprise_release

Data type: String

URL of the SIMP Enterprise Edition release package

Default value: 'https://download.simp-project.com/simp-release-enterprise.rpm'

license_key

Data type: Optional[String]

License key for SIMP Enterprise Edition

Default value: undef

release_package

Data type: String

Default value: $license_key

release_package_name

Data type: String

Default value: (/(?:(?:-\d[^-]*){2})?\.rpm$/, '')

install_type

Data type: Enum[ 'community', 'enterprise' ]

Default value: ('-')[-1]

community_packages

Data type: Array

Default value: [ 'simp-adapter', 'simp', 'puppetserver', ]

enterprise_packages

Data type: Array

Default value: [ 'simp-enterprise', ]

license_key_file

Data type: String

Default value: '/etc/simp/license.key'

simprelease

Data type: Optional[String]

Default value: undef

simpreleasetype

Data type: Optional[String]

Default value: undef

ee_simprelease

Data type: Optional[String]

Default value: undef

ee_simpreleasetype

Data type: Optional[String]

Default value: undef

simp_ee::keepalive

Enable ssh keepalives to avoid timeouts

Plans

simp_ee

Install SIMP Enterprise Edition

Parameters

The following parameters are available in the simp_ee plan:

• targets
• license_key
• ip_subnet
• simprelease
• simpreleasetype
• ee_simprelease
• ee_simpreleasetype
• rhsm_user
• rhsm_pass

targets

Data type: TargetSpec

The targets to run on

Default value: 'all'

license_key

Data type: Optional[String[1]]

A SIMP EE license key

Default value: system::env('SIMP_LICENSE_KEY')

ip_subnet

Data type: String[5]

The IP subnet range to use for the private network (the IP address with the last octet removed)

Default value: system::env('VAGRANT_IP_SUBNET')

simprelease

Data type: Optional[String[1]]

SIMP release version

Default value: system::env('SIMP_RELEASE')

simpreleasetype

Data type: Optional[String[1]]

SIMP release type ("development", for example)

Default value: system::env('SIMP_RELEASETYPE')

ee_simprelease

Data type: Optional[String[1]]

SIMP EE release version

Default value: system::env('SIMP_EE_RELEASE')

ee_simpreleasetype

Data type: Optional[String[1]]

SIMP EE release type ("development", for example

Default value: system::env('SIMP_EE_RELEASETYPE')

rhsm_user

Data type: Optional[String[1]]

Username for registering RHEL nodes with subscription management

Default value: system::env('SIMP_RHSM_USER')

rhsm_pass

Data type: Optional[String[1]]

Password for registering RHEL nodes with subscription management

Default value: system::env('SIMP_RHSM_PASS')

simp_ee::check_puppetserver

Check the status of puppetserver

Parameters

The following parameters are available in the simp_ee::check_puppetserver plan:

• targets

targets

Data type: TargetSpec

The targets to run on

simp_ee::rhsm_unregister

Unregister RHEL subscription management

Parameters

The following parameters are available in the simp_ee::rhsm_unregister plan:

• targets

targets

Data type: TargetSpec

The targets to run on

simp_ee::scanner

Configure simp_scanner Puppet module

Parameters

The following parameters are available in the simp_ee::scanner plan:

• token
• msi_pkg
• rpm_pkg
• targets
• collector
• extra_config

token

Data type: String

The SIMP Console registration token

msi_pkg

Data type: Variant[ Stdlib::HTTPUrl, Stdlib::HTTPSUrl ]

URL of the scanner MSI

rpm_pkg

Data type: Variant[ Stdlib::HTTPUrl, Stdlib::HTTPSUrl ]

URL of the scanner RPM

targets

Data type: TargetSpec

The targets to run on

Default value: 'all'

collector

Data type: Variant[ Undef, Stdlib::HTTPUrl, Stdlib::HTTPSUrl ]

A collector URL to override the default

Default value: undef

extra_config

Data type: Hash

Additional scanner collector configuration

Default value: {}