puppet-module-oxidized

Table of Contents

1. Description
2. Setup - The basics of getting started with oxidized
   • What oxidized affects
   • Setup requirements
3. Usage - Configuration options and additional functionality
4. Reference - Module reference

Description

This module will manage oxidized

Setup

What oxidized affects

This module will install the oxidize gems and manage the oxidize configs.

Usage

To install oxidized and get a default config:

include ::oxidized

To define a config:

class { '::oxidized':
  config => {
    'rest' => false,
  }
}

Reference

http://treydock.github.io/puppet-module-oxidized/

Reference

Table of Contents

Classes

Public Classes

• oxidized: Manage Oxidized

Private Classes

• oxidized::config: Manage oxidized configs
• oxidized::install: Manage oxidized packages
• oxidized::repo: Manage repos needed for oxidized
• oxidized::service: Manage oxidized service
• oxidized::user: Manage Oxidzed user

Defined types

• oxidized::model: Manage oxidized models

Classes

oxidized

Manage Oxidized

Examples

include oxidized

Parameters

The following parameters are available in the oxidized class:

• manage_repo
• ruby_dependencies
• install_dependencies
• with_web
• package_ensure
• script_package_ensure
• web_package_ensure
• rugged_version
• user
• user_group
• user_uid
• user_group_gid
• user_home
• user_home_mode
• config
• config_mode
• source_type
• devices
• devices_map
• devices_vars_map
• with_service
• service_start
• show_diff
• log
• log_mode
• models

manage_repo

Data type: Boolean

Sets if repos needed for oxidize are managed.

Default value: true

ruby_dependencies

Data type: Array

Ruby dependencies

Default value: []

install_dependencies

Data type: Array

Additional install dependencies

Default value: []

with_web

Data type: Boolean

Sets if the oxidized web should be installed and configured

Default value: false

package_ensure

Data type: String

Ensure value for main oxidized package

Default value: 'installed'

script_package_ensure

Data type: String

Ensure value for oxidized-script package

Default value: 'installed'

web_package_ensure

Data type: Optional[String]

Ensure value for oxidized web package Defaults to installed when with_web is true

Default value: undef

rugged_version

Data type: String

Version of rugged to install with SSH support

Default value: '1.6.3'

user

Data type: String

Oxidize user

Default value: 'oxidized'

user_group

Data type: String

Oxidize user's group

Default value: 'oxidized'

user_uid

Data type: Optional[Integer]

Oxidize user's UID

Default value: undef

user_group_gid

Data type: Optional[Integer]

Oxidize user's group GID

Default value: undef

user_home

Data type: Stdlib::Absolutepath

Oxidize user's home directory path

Default value: '/home/oxidized'

user_home_mode

Data type: Stdlib::FileMode

The permissions of oxidized user's home directory

Default value: '0700'

config

Data type: Hash

Oxidize config hash

Default value: {}

config_mode

Data type: Stdlib::FileMode

Oxidized config file permission mode

Default value: '0600'

source_type

Data type: Enum['csv']

Sets type of source to be used

Default value: 'csv'

devices

Data type: Array[Hash]

Information about devices. Only used when source_type is csv

Default value: []

devices_map

Data type: Hash[String, Integer]

Map of CSV fields for devices Only used when source_type is csv

Default value: { 'name' => 0, 'model' => 1 }

devices_vars_map

Data type: Optional[Hash[String, Integer]]

Set vars_map for device CSV configuration Only used when source_type is csv

Default value: undef

with_service

Data type: Boolean

Sets if the oxidized service should be installed and running

Default value: false

service_start

Data type: String

The command to use to start oxidized service

Default value: '/usr/local/bin/oxidized'

show_diff

Data type: Boolean

Boolean that sets show_diff property for files

Default value: true

log

Data type: Optional[String]

Path to oxidized log file

Default value: undef

log_mode

Data type: Stdlib::FileMode

The permissions of oxidized log file

Default value: '0644'

models

Data type: Hash

Hash of models passed to oxidized::model

Default value: {}

Defined types

oxidized::model

Manage oxidized models

Parameters

The following parameters are available in the oxidized::model defined type:

• source

source

Data type: String

Source of model

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v3.0.0 (2024-10-20)

Full Changelog

Changed

• Major updates - SEE DESCRIPTION #29 (treydock)

Added

• Numerous improvements to management #30 (treydock)

v2.0.0 (2022-08-12)

Full Changelog

Changed

• Several updates to OS support and module dependencies #27 (treydock)

v1.1.0 (2021-07-08)

Full Changelog

Added

• Define file output if no output defined, update acceptance tests #24 (treydock)

v1.0.0 (2021-07-08)

Full Changelog

Changed

• Depend on puppet/rhsm for RedHat, update supported dependency versions #20 (treydock)
• Major updates (see description) #18 (treydock)

Added

• Allow installing specific version of packages #23 (treydock)
• Support EL8 #22 (treydock)
• Support Ubuntu 20.04 #21 (treydock)

v0.7.3 (2020-03-12)

Full Changelog

Fixed

• Notify service when configs changes and fix rugged dependency issue #16 (treydock)

v0.7.2 (2019-12-16)

Full Changelog

Fixed

• Add missing model directory #14 (treydock)

v0.7.1 (2019-11-08)

Full Changelog

Fixed

• Fix path for model file #13 (treydock)

v0.7.0 (2019-11-07)

Full Changelog

Added

• Support defining models or model patches #12 (treydock)
• Support defining oxidized log file #11 (treydock)

v0.6.2 (2019-09-12)

Full Changelog

Fixed

• Fix CSV router.db mapping to take into account mapping parameters #10 (treydock)

v0.6.1 (2019-09-12)

Full Changelog

Fixed

• Fix permissions on /etc/oxidized/config #9 (treydock)

v0.6.0 (2019-09-10)

Full Changelog

Added

• Fix config modes and support changing home and config modes #8 (treydock)
• Support defining CSV device map and vars_map #7 (treydock)

v0.5.1 (2019-09-09)

Full Changelog

Fixed

• Fix CSV config #6 (treydock)

v0.5.0 (2019-09-09)

Full Changelog

Added

• Allow show_diff to be set for files #5 (treydock)

v0.4.0 (2019-08-07)

Full Changelog

Added

• Add ability to manage oxidized service #4 (treydock)

v0.3.0 (2019-08-05)

Full Changelog

Added

• Support Debian and Ubuntu #3 (treydock)

v0.2.0 (2019-08-05)

Full Changelog

Added

• Manage oxidized-web #2 (treydock)
• Support EL6 #1 (treydock)

v0.1.0 (2019-08-05)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator