class Squarectl::Config::SquarectlEnvironment

• Squarectl::Config::SquarectlEnvironment
• Reference
• Object

Overview

A single deployment environment (e.g. development, staging, production, or the special all holding global defaults). Groups every resolvable attribute plus the conventional per-environment file locations.

:nodoc:

Included Modules

• JSON::Serializable
• YAML::Serializable

Defined in:

squarectl/config/squarectl_environment.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #compose_file_base_for(target)

  Conventional compose files always prepended to the resolved list, in load order: the shared base, the per-target common file, then the per-environment file.

• #compose_file_common_for(target)

  Conventional compose files always prepended to the resolved list, in load order: the shared base, the per-target common file, then the per-environment file.

• #compose_file_env_for(target)

  Conventional compose files always prepended to the resolved list, in load order: the shared base, the per-target common file, then the per-environment file.

• #compose_files : Array(ComposeFile)
• #compose_files=(compose_files : Array(ComposeFile))
• #config_files : Hash(String, String)
• #config_files=(config_files : Hash(String, String))
• #development?

  The development environment is special-cased: it is only allowed with the compose target (enforced in Squarectl.find_environment).

• #domains : Array(Domain)
• #domains=(domains : Array(Domain))
• #env_vars : Array(EnvVar)
• #env_vars=(env_vars : Array(EnvVar))
• #kubernetes_dir

  Where generated Kubernetes manifests for this environment live.

• #name : String
• #name=(name : String)
• #networks : Array(Network)
• #networks=(networks : Array(Network))
• #root_dir
• #secret_files : Hash(String, String)
• #secret_files=(secret_files : Hash(String, String))
• #server : Array(Server)
• #server=(server : Array(Server))
• #setup_commands : Array(SetupCommand)
• #setup_commands=(setup_commands : Array(SetupCommand))
• #short_name

  First 4 characters of the name, used to namespace swarm configs/secrets.

• #ssl_certificates : Array(SSLCertificate)
• #ssl_certificates=(ssl_certificates : Array(SSLCertificate))

Constructor Detail

Instance Method Detail