Class: Command::MaintenanceSetPage

Inherits:
Base
  • Object
show all
Defined in:
lib/command/maintenance_set_page.rb

Constant Summary collapse

NAME = 
"maintenance:set-page"
USAGE = 
"maintenance:set-page PAGE_URL"
REQUIRES_ARGS = 
true
OPTIONS = 
[
  app_option(required: true)
].freeze
DESCRIPTION = 
"Sets the page for maintenance mode"
LONG_DESCRIPTION = 
<<~DESC
  - Sets the page for maintenance mode
  - Only works if the maintenance workload uses the `shakacode/maintenance-mode` image
  - Will set the URL as an env var `PAGE_URL` on the maintenance workload
  - Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
DESC

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::EXAMPLES, Base::HIDE, Base::VALIDATIONS, Base::VALIDATIONS_WITHOUT_ADDITIONAL_OPTIONS, Base::VALIDATIONS_WITH_ADDITIONAL_OPTIONS, Base::WITH_INFO_HEADER

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

add_app_identity_option, all_commands, all_options, all_options_by_key_name, app_option, #args_join, commit_option, common_options, #cp, cpu_option, detached_option, docker_context_option, domain_option, #ensure_docker_running!, entrypoint_option, image_option, #initialize, interactive_option, location_option, log_method_option, logs_limit_option, logs_since_option, memory_option, org_option, #progress, replica_option, #run_command_in_latest_image, #run_cpflow_command, run_release_phase_option, skip_confirm_option, skip_post_creation_hook_option, skip_pre_deletion_hook_option, skip_secret_access_binding_option, skip_secrets_setup_option, #step, #step_finish, terminal_size_option, trace_option, upstream_token_option, use_local_token_option, validations_option, verbose_option, version_option, wait_option, #with_retry, workload_option

Methods included from Helpers

normalize_command_name, normalize_option_name, random_four_digits, strip_str_and_validate

Constructor Details

This class inherits a constructor from Command::Base

Instance Method Details

#call ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/command/maintenance_set_page.rb', line 19

def call
  maintenance_workload = config.current[:maintenance_workload] || "maintenance"

  maintenance_workload_data = cp.fetch_workload!(maintenance_workload)
  maintenance_workload_data.dig("spec", "containers").each do |container|
    next unless container["image"].match?(%r{^shakacode/maintenance-mode})

    container_name = container["name"]
    page_url = config.args.first
    step("Setting '#{page_url}' as the page for maintenance mode") do
      cp.set_workload_env_var(maintenance_workload, container: container_name, name: "PAGE_URL", value: page_url)
    end
  end
end