Class: Command::PsStop

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

Constant Summary collapse

NAME = 
"ps:stop"
OPTIONS = 
[
  app_option(required: true),
  workload_option,
  replica_option,
  location_option,
  wait_option("workload to not be ready")
].freeze
DESCRIPTION = 
"Stops workloads in app"
LONG_DESCRIPTION = 
<<~DESC
  - Stops workloads in app
DESC
EXAMPLES = 
<<~EX
  ```sh
  # Stops all workloads in app.
  cpflow ps:stop -a $APP_NAME

  # Stops a specific workload in app.
  cpflow ps:stop -a $APP_NAME -w $WORKLOAD_NAME

  # Stops a specific replica of a workload.
  cpflow ps:stop -a $APP_NAME -w $WORKLOAD_NAME -r $REPLICA_NAME
  ```
EX

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::HIDE, Base::REQUIRES_ARGS, Base::USAGE, 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 



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/command/ps_stop.rb', line 30

def call
  workload = config.options[:workload]
  replica = config.options[:replica]
  if replica
    stop_replica(workload, replica)
  else
    workloads = [workload] if workload
    workloads ||= config[:app_workloads] + config[:additional_workloads]

    stop_workloads(workloads)
  end
end