Class: Command::Delete

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

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

NAME = 
"delete"
OPTIONS = 
[
  app_option(required: true),
  workload_option,
  skip_confirm_option,
  skip_pre_deletion_hook_option
].freeze
DESCRIPTION = 
"Deletes the whole app (GVC with all workloads, all volumesets and all images) or a specific workload"
LONG_DESCRIPTION = 
<<~DESC
  - Deletes the whole app (GVC with all workloads, all volumesets and all images) or a specific workload
  - Also unbinds the app from the secrets policy, as long as both the identity and the policy exist (and are bound)
  - Will ask for explicit user confirmation
  - Runs a pre-deletion hook before the app is deleted if `hooks.pre_deletion` is specified in the `.controlplane/controlplane.yml` file
  - If the hook exits with a non-zero code, the command will stop executing and also exit with a non-zero code
  - Use `--skip-pre-deletion-hook` to skip the hook if specified in `controlplane.yml`
DESC
EXAMPLES = 
<<~EX
  ```sh
  # Deletes the whole app (GVC with all workloads, all volumesets and all images).
  cpflow delete -a $APP_NAME

  # Deletes a specific workload.
  cpflow delete -a $APP_NAME -w $WORKLOAD_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 



31
32
33
34
35
36
37
38
 
# File 'lib/command/delete.rb', line 31

def call
  workload = config.options[:workload]
  if workload
    delete_single_workload(workload)
  else
    delete_whole_app
  end
end