Module: Splash::Config

Includes:
ConfigUtilities, Constants, Helpers
Included in:
CLISplash::Commands, CLISplash::Documentation, CLISplash::Logs, CLISplash::Processes, CLISplash::WebAdmin, Backends, Backends::File, Backends::Redis, Splash::Commands::CommandWrapper, Daemon::Controller, Daemon::Metrics, Daemon::Orchestrator::Grammar, Daemon::Orchestrator::Scheduler, Loggers, Loggers::Cli, Loggers::Dual, Loggers::LoggerTemplate, Logs::LogScanner, Processes::ProcessScanner, Sequences, Transfers, Transports, Transports::Rabbitmq::Client, Transports::Rabbitmq::Subscriber, WebAdmin::Controller, WebAdminApp
Defined in:
lib/splash/config.rb

Overview

Config namespace

Defined Under Namespace

Classes: ConfigLinter, Configuration

accessors on configurations Items collapse

@@config = 
nil

Constants included from Constants

Splash::Constants::AUTHOR, Splash::Constants::BACKENDS_STRUCT, Splash::Constants::CONFIG_FILE, Splash::Constants::COPYRIGHT, Splash::Constants::DAEMON_LOGMON_SCHEDULING, Splash::Constants::DAEMON_METRICS_SCHEDULING, Splash::Constants::DAEMON_PID_FILE, Splash::Constants::DAEMON_PROCESS_NAME, Splash::Constants::DAEMON_PROCMON_SCHEDULING, Splash::Constants::DAEMON_STDERR_TRACE, Splash::Constants::DAEMON_STDOUT_TRACE, Splash::Constants::DEFAULT_RETENTION, Splash::Constants::EMAIL, Splash::Constants::EXECUTION_TEMPLATE, Splash::Constants::EXECUTION_TEMPLATE_TOKENS_LIST, Splash::Constants::LICENSE, Splash::Constants::LOGGERS_STRUCT, Splash::Constants::PID_PATH, Splash::Constants::PROMETHEUS_ALERTMANAGER_URL, Splash::Constants::PROMETHEUS_PUSHGATEWAY_URL, Splash::Constants::PROMETHEUS_URL, Splash::Constants::TRACE_PATH, Splash::Constants::TRANSPORTS_STRUCT, Splash::Constants::VERSION, Splash::Constants::WEBADMIN_IP, Splash::Constants::WEBADMIN_PID_FILE, Splash::Constants::WEBADMIN_PID_PATH, Splash::Constants::WEBADMIN_PORT, Splash::Constants::WEBADMIN_PROCESS_NAME, Splash::Constants::WEBADMIN_PROXY, Splash::Constants::WEBADMIN_STDERR_TRACE, Splash::Constants::WEBADMIN_STDOUT_TRACE

accessors on configurations Items collapse

Methods included from ConfigUtilities

#addservice, #checkconfig, #flush_backend, #setupsplash

Methods included from Helpers

#check_unicode_term, #daemonize, #format_by_extensions, #format_response, #get_processes, #group_root, #install_file, #is_root?, #make_folder, #make_link, #run_as_root, #search_file_in_gem, #user_root, #verify_file, #verify_folder, #verify_link, #verify_service

Instance Method Details

#get_config(config_file = CONFIG_FILE) ⇒ SPlash::Config::Configuration

factory of Configuration Class instance

Parameters:

  • config_file (String) (defaults to: CONFIG_FILE) —

    the path of the YAML Config file

Returns:

  • (SPlash::Config::Configuration) 


364
365
366
 
# File 'lib/splash/config.rb', line 364

def get_config(config_file=CONFIG_FILE)
  return @@config ||= Configuration::new(config_file)
end

#rehash_config(config_file = CONFIG_FILE) ⇒ SPlash::Config::Configuration

reset of Configuration Class instance

Parameters:

  • config_file (String) (defaults to: CONFIG_FILE) —

    the path of the YAML Config file

Returns:

  • (SPlash::Config::Configuration) 


371
372
373
 
# File 'lib/splash/config.rb', line 371

def rehash_config(config_file=CONFIG_FILE)
  return @@config = Configuration::new(config_file)
end