Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simp/pupmod-simp-simp_options
A module to provide `puppet strings`-compatible documentation for all global catalysts and to provide default values for those catalysts as used in a SIMP system.
https://github.com/simp/pupmod-simp-simp_options
puppet simp
Last synced: about 2 months ago
JSON representation
A module to provide `puppet strings`-compatible documentation for all global catalysts and to provide default values for those catalysts as used in a SIMP system.
- Host: GitHub
- URL: https://github.com/simp/pupmod-simp-simp_options
- Owner: simp
- License: apache-2.0
- Created: 2016-11-29T22:21:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T19:53:53.000Z (6 months ago)
- Last Synced: 2024-12-10T06:10:16.694Z (about 2 months ago)
- Topics: puppet, simp
- Language: Ruby
- Size: 184 KB
- Stars: 0
- Watchers: 18
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0.html)
[](https://bestpractices.coreinfrastructure.org/projects/73)
[](https://forge.puppetlabs.com/simp/simp_options)
[](https://forge.puppetlabs.com/simp/simp_options)
[](https://travis-ci.org/simp/pupmod-simp-simp_options)
#### Table of Contents
1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with simp_options](#setup)
* [What simp_options affects](#what-simp_options-affects)
* [Beginning with simp_options](#beginning-with-simp_options)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
## Overview
This module provides variables needed by one or more SIMP module.
## This is a SIMP module
This module is a component of the [System Integrity Management Platform](https://simp-project.com),
a compliance-management framework built on Puppet.
Most SIMP modules actively take advantage of this module when used within the SIMP ecosystem.
**THIS MODULE IS ONLY DATA AND WILL NOT CHANGE YOUR SYSTEM**
## Module Description
The `simp_options` module primarily provides variables that are
* Enablers of capabilities provided or used by SIMP modules.
* Data that describes the configuration of a site.
* The scope of the data is larger than the scope of a single module.
* `0..n` unrelated profiles might make use of this data.
Some of these variables support SIMP's security compliance reporting.
## Setup
### What simp_options affects
The variables provided by `simp_options` are used by SIMP modules to
enable and/or configure capabilities.
### Beginning with simp_options
`simp_options` is configured for you when you run ``simp config`` on your SIMP
system. Otherwise, setup is simple: include the class as the first class in your
``site.pp`` and select the desired capabilities through Hiera or your ENC.
--------------------
**NOTE**
The ``environments/simp/hieradata/simp_defs.yaml`` file delivered with the
simp puppet module is an example file that can be used to create the
appropriate hieradata for your site.
--------------------
## Reference
See [REFERENCE.md](./REFERENCE.md)
## Limitations
This module is applicable to SIMP systems or systems containing SIMP components.
## Development
Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).