Class: Command::CleanupImages

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

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

NAME = 
"cleanup-images"
OPTIONS = 
[
  app_option(required: true),
  skip_confirm_option
].freeze
DESCRIPTION = 
<<~DESC
  Deletes all images for an app that either exceed the max quantity or are older than the specified amount of days
DESC
LONG_DESCRIPTION = 
<<~DESC
  - Deletes all images for an app that either exceed the max quantity or are older than the specified amount of days
  - Specify the max quantity through `image_retention_max_qty` in the `.controlplane/controlplane.yml` file
  - Specify the amount of days through `image_retention_days` in the `.controlplane/controlplane.yml` file
  - If `image_retention_max_qty` is specified, any images that exceed it will be deleted, regardless of `image_retention_days`
  - Will ask for explicit user confirmation
  - Never deletes the latest image
DESC

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::EXAMPLES, 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

rubocop:disable Metrics/MethodLength



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/command/cleanup_images.rb', line 22

def call # rubocop:disable Metrics/MethodLength
  ensure_max_qty_or_days!

  return progress.puts("No images to delete.") if images_to_delete.empty?

  progress.puts("Images to delete:")
  images_to_delete.each do |image|
    created = Shell.color((image[:created]).to_s, :red)
    reason = Shell.color(image[:reason], :red)
    progress.puts("  - #{image[:name]} (#{created} - #{reason})")
  end

  return unless confirm_delete

  progress.puts
  delete_images
end