Foreman Simple User module for Puppet

Every host in The Foreman has an owner which is either a user or a group. This module enables you to ensure the user exists with their SSH keys. Old SSH keys are purged from managed users. This makes it easy to get your infrastructure up and running with centralized logins similar to LDAP.

This requires use of the Foreman ENC and version 1.15+.

Note this module doesn't purge old users. That means that changing owners only adds users.

Usage

Include the top level foreman_simple_user class to create the users.

include foreman_simple_user

Contributing

• Fork the project
• Commit and push until you are happy with your contribution
• Send a pull request with a description of your changes

See the CONTRIBUTING.md file for much more information.

More info

See https://theforeman.org/support

Copyright (c) 2017 Ewoud Kohl van Wijngaarden

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

https://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.

Reference

Table of Contents

Classes

• foreman_simple_user: Ensure foreman users are present on the system

Defined types

• foreman_simple_user::user: Create a single foreman user

Classes

foreman_simple_user

Ensure foreman users are present on the system

Examples

include foreman_simple_user

Parameters

The following parameters are available in the foreman_simple_user class:

• users

users

Data type: Hash[String, Hash]

The hash of users

Default value: getvar('foreman_users', {})

Defined types

foreman_simple_user::user

Create a single foreman user

Examples

foreman_simple_user::user { 'admin':
  ssh_authorized_keys => [
    {
      key     => 'AAA..BBB',
      type    => 'ssh-rsa',
      comment => 'My First Key',
    },
  ],
}

Parameters

The following parameters are available in the foreman_simple_user::user defined type:

• ensure
• username
• group
• home
• password
• comment
• ssh_authorized_keys

ensure

Data type: Enum['present', 'absent', 'role']

The basic state that the user should be in.

Default value: 'present'

username

Data type: String

The username

Default value: $title

group

Data type: String

The primary group of the user

Default value: $title

home

Data type: String

The home directory of the user

Default value: "/home/${title}"

password

Data type: Optional[String]

An optional password for the user

Default value: undef

comment

Data type: Optional[String]

An optional comment about the user. Usually the full name.

Default value: undef

ssh_authorized_keys

Data type: Array[Hash]

A list of authorized keys

Default value: []