Class: Kafo::ScenarioOption

Inherits:
Object
  • Object
show all
Defined in:
lib/kafo/scenario_option.rb

Overview

A class containing constants for all scenario options

Basic collapse

NAME =

Human readable scenario name

:name
DESCRIPTION =

Description of the installer scenario and its purpose

:description
ANSWER_FILE =

Path to answer file, if the file does not exist a $pwd/config/answers.yaml is used as a fallback

:answer_file
COLORS =

Enable colors? If you don’t touch this, we’ll autodetect terminal capabilities

:colors
COLOR_OF_BACKGROUND =

Color scheme, we support :bright and :dark (first is better for white background, dark for black background)

:color_of_background

Logging collapse

LOG_DIR =

Destination for the log files

:log_dir
LOG_NAME = 
:log_name
LOG_LEVEL = 
:log_level
LOG_OWNER = 
:log_owner
LOG_GROUP = 
:log_group
VERBOSE =

Whether verbose logging is enabled

:verbose
VERBOSE_LOG_LEVEL =

When verbose logging is enabled, which level (and up) is shown.

:verbose_log_level

State collapse

CUSTOM =

Custom storage is handy if you use hooks and you must store some configuration which should persist among installer runs. It can be also used for passing value from one hook to another.

:custom
FACTS = 
:facts

Advanced collapse

CHECK_DIRS =

Checks, implemented as executable files, are loaded from the listed directories.

:check_dirs
HOOK_DIRS =

Hooks in these extra directories will be loaded, by default they are loaded from $installer_dir/hooks/$type when you specify your directory, it will be search for $yourdir/$type/*.rb

:hook_dirs
MODULE_DIRS =

Option to load puppet modules from a specific path. Optional and $pwd/modules is used by default, multiple dirs are allowed

:module_dirs
PARSER_CACHE_PATH =

Kafo has a cache for information parsed from Puppet modules. This determines the location where that information is stored.

:parser_cache_path
IGNORE_UNDOCUMENTED =

By default all module parameters must be documented or an error is raised. This can be used to not raise an error when undocumented parameters are found.

:ignore_undocumented
MAPPING =

An optional mapping of classes

:mapping
NO_PREFIX = 
:no_prefix
ORDER = 
:order
LOW_PRIORITY_MODULES = 
:low_priority_modules
HIERA_CONFIG = 
:hiera_config
KAFO_MODULES_DIR = 
:kafo_modules_dir
CONFIG_HEADER_FILE = 
:config_header_file
DONT_SAVE_ANSWERS = 
:dont_save_answers
ENABLED =

Whether the scenario is enabled or not

:enabled
STORE_DIR = 
:store_dir
INSTALLER_DIR = 
:installer_dir
SKIP_PUPPET_VERSION_CHECK =

Puppet modules declare the Puppet version they’re compatible with. Kafo implements checks to verify this is correct with the Puppet version that’s running. This can be used to bypass the checks

:skip_puppet_version_check