volume_sweeper 1.0.0

data/lib/volume_sweeper/metrics/controller.rb

@@ -0,0 +1,41 @@
+
+module Prometheus
+  module Controller
+    # TODO: ..
+    def self.setup_metrics
+      metrics_dir = Rails.root.join 'tmp', 'prometheus'
+      Dir["#{metrics_dir}/*.bin"].each { |file_path| File.unlink(file_path) }
+      Prometheus::Client.config.data_store = Prometheus::Client::DataStores::DirectFileStore.new(dir: metrics_dir)
+
+      @prometheus ||= Prometheus::Client.registry
+
+      register_gauge :available_block_volume_count,
+                     'The total of unattached block volumes.',
+                     :available_block_volume_count
+      register_gauge :released_pv_count,
+                     'The total of released persistent volumes.',
+                     :released_pv_count
+      register_gauge :inactive_block_volume_count,
+                     'The number of block volumes count that are unused (no instance or PV bound).',
+                     :inactive_block_volume_count
+
+    end
+
+    def self.clear_metrics
+      @prometheus ||= Prometheus::Client.registry
+      unregister_gauge :available_block_volume_count
+      unregister_gauge :released_pv_count
+      unregister_gauge :inactive_block_volume_count
+    end
+
+    def self.register_gauge key, docstring, *labels
+      gauge = Prometheus::Client::Gauge.new key, docstring: docstring, labels: labels
+      @prometheus.register(gauge)
+      gauge
+    end
+
+    def self.unregister_gauge key
+      @prometheus.unregister key
+    end
+  end
+end

data/lib/volume_sweeper/metrics/prometheus.rb

@@ -0,0 +1,4 @@
+module VolumeSweeper
+  module Prometheus
+  end
+end

data/lib/volume_sweeper/providers/aws.rb

@@ -0,0 +1,39 @@
+require 'active_support/core_ext/object/blank'
+require_relative 'base'
+require_relative '../utils/log'
+
+module VolumeSweeper
+  module Providers
+
+    class Aws < Base
+      DEFAULT_REGION = 'us-west-2'
+
+      def initialize config_path: nil, region: nil, mode: :audit, **kwargs
+        super
+        @region ||= DEFAULT_REGION
+        validate_attrs
+      end
+
+      def scan_block_volumes
+        raise NotImplementedError
+      end
+
+      def delete_block_volumes ids_list
+        return if ids_list.blank? || @run_mode != :delete
+        raise NotImplementedError
+      end
+
+      private
+
+      def prepare_config
+      end
+
+      def validate_attrs
+        return unless @account_id.blank?
+        @log.msg "provider error: aws account id is not assigned", level: :error
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/volume_sweeper/providers/base.rb

@@ -0,0 +1,23 @@
+module VolumeSweeper
+  module Providers
+
+    class Base
+      attr_reader :base_link
+
+      def initialize **kwargs
+        @run_mode = kwargs[:mode]&.to_sym || :audit
+        @config_location = kwargs[:config_path]
+        @account_id = kwargs[:account_id]
+        @compartment_id = kwargs[:account_id]
+        @region = kwargs[:region]
+
+        @log = Utils::Log.instance
+        @log.msg "#{self.class.name.downcase.split(":").last}: running in :#{@run_mode} mode."
+      end
+
+      def scan_volumes; end
+      def delete_volumes ids_list; end
+    end
+
+  end
+end

data/lib/volume_sweeper/providers/oci.rb

@@ -0,0 +1,124 @@
+require 'oci/common'
+require 'oci/auth/auth'
+require 'oci/core/core'
+require 'active_support/core_ext/object/blank'
+require_relative 'base'
+require_relative '../utils/log'
+
+module VolumeSweeper
+  module Providers
+
+    class Oci < Base
+      DEFAULT_REGION = 'me-jeddah-1'
+
+      DEFAULT_PAGE_SIZE = 30
+      VOLUME_ATTRS = %i{ id displayName volumeId lifecycleState sizeInGBs timeCreated definedTags freeformTags }
+
+      attr_accessor :config_location
+
+      def initialize config_path: nil, region: nil, mode: :audit, **kwargs
+        super
+        @region ||= DEFAULT_REGION
+        @base_link = "https://cloud.oracle.com/block-storage/volumes"
+        validate_attrs
+      end
+
+      def scan_block_volumes
+        volumes = Array.new
+        opts = { compartment_id: @compartment_id, limit: DEFAULT_PAGE_SIZE, lifecycle_state: 'AVAILABLE' }
+
+        run_api_call do |config|
+          api = OCI::Core::BlockstorageClient.new config: config, region: @region
+          page = nil
+          begin
+            output = api.list_volumes **opts.merge({ page: page })
+            page = output.headers['opc-next-page']
+            output.data.map { |v| volumes << v.to_hash.compact.slice(*VOLUME_ATTRS) }
+            sleep 2
+          end until page.nil? || page&.empty?
+          @log.msg "oci: collected #{volumes.size} block volumes from the compartment."
+        end
+
+        volume_attachments = Array.new
+        opts = { limit: DEFAULT_PAGE_SIZE }
+        run_api_call do |config|
+          api = OCI::Core::ComputeClient.new config: config, region: @region
+          page = nil
+          begin
+            output = api.list_volume_attachments @compartment_id, **opts.merge({ page: page })
+            page = output.headers['opc-next-page']
+            output.data.map do |v|
+              volume_attachments << v.to_hash.compact.slice(*VOLUME_ATTRS) if v.lifecycle_state =~ /ATTACH/
+            end
+            sleep 2
+          end until page.nil? || page&.empty?
+          @log.msg "oci: collected #{volume_attachments.size} block volume attachements from the compartment."
+        end
+
+        @log.msg "oci: filtering out any block volume with an active attachment."
+        result = volumes.reject do |v|
+          volume_attachments.any? { |va| va[:volumeId] == v[:id] }
+        end || []
+
+        @log.msg "oci: found #{result.size} unattached block volumes."
+        [volumes.size, result]
+      end
+
+      def delete_block_volumes ids_list
+        @log.msg "oci: #{ids_list&.count || 0} block volumes are eligible for cleanup."
+        return if ids_list.blank?
+
+        unless @run_mode == :delete
+          @log.msg "oci: running in :#{@run_mode} mode, exiting without delete operations."
+          return
+        end
+
+        @log.msg "oci: unused volume clean-up operation started."
+
+        ids_list.each do |id|
+          @log.msg "oci: deleting block volume #{id} .."
+          run_api_call do |config|
+            api = OCI::Core::BlockstorageClient.new config: config, region: @region
+            output = api.delete_volume id, compartment_id: @compartment_id
+            if output.status.to_s =~ /2\d\d/
+              @log.msg "oci: block volume #{id} is deleted successfully."
+            else
+              @log.msg "oci: block volume #{id} has failed."
+            end
+            sleep 2.5
+          end
+        end
+      end
+
+      private
+
+      def prepare_config
+        @config_location   ||= '~/.oci/config'
+        @oci_configuration ||= OCI::ConfigFileLoader.load_config(
+          config_file_location: self.config_location,
+          profile_name: 'DEFAULT'
+        )
+      end
+
+      def run_api_call
+        prepare_config
+        yield @oci_configuration if block_given?
+      rescue OCI::Errors::ServiceError => err
+        @log.msg err, level: :error
+        raise if err.status_code != 304
+      rescue OCI::Errors::NetworkError,
+             OCI::Errors::ResponseParsingError,
+             StandardError => err
+        @log.msg err, level: :error
+        raise
+      end
+
+      def validate_attrs
+        return unless @compartment_id.blank?
+        @log.msg "provider error: oci compartment id is not assigned", level: :error
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/volume_sweeper/utils/log.rb

@@ -0,0 +1,19 @@
+require 'logger'
+require 'singleton'
+
+module VolumeSweeper
+  module Utils
+    class Log
+      include Singleton
+
+      def initialize
+        @logger = Logger.new STDOUT
+        @logger.level = Logger::DEBUG
+      end
+
+      def msg *message, level: :info
+        @logger.send level.to_s, message.join('').to_s if @logger.respond_to?(level)
+      end
+    end
+  end
+end

data/lib/volume_sweeper/utils/notification.rb

@@ -0,0 +1,148 @@
+require 'mail'
+require 'network-client'
+require 'active_support/core_ext/object/blank'
+
+module VolumeSweeper
+  module Utils
+    class Notification
+
+      attr_reader :default_subject
+
+      def initialize **kwargs
+        @log = Utils::Log.instance
+
+        setup_configuration **kwargs
+        configure_mailer
+        configure_ms_teams
+      end
+
+      def send_mail text
+        return unless smtp_configured?
+        @log.msg "#{self_name}: sending mail notification."
+
+        sender, receiver = @smtp_sender, @smtp_receiver
+        subject = message_subject
+        content = build_message_content text
+        Mail.deliver do
+          from     sender
+          to       receiver
+          subject  subject
+          content_type 'text/html; charset=UTF-8'
+          body     content
+        end
+
+        @log.msg "#{self_name}: email is sent successfully.", level: :info
+
+      rescue Exception => e
+        @log.msg "#{self_name}: mail notification failed.", level: :error
+        @log.msg "#{self_name}: #{e.message}.", level: :error
+      end
+
+      def send_ms_teams_notice text
+        return unless @webhook_url.present?
+
+        @log.msg "#{self_name}: sending ms teams notification."
+
+        request = Net::HTTP::Post.new @webhook_url.request_uri
+        request['Content-Type'] = 'application/json'
+        request.body = { title: message_subject, text: text }.to_json
+
+        http = Net::HTTP.new @webhook_url.host, @webhook_url.port
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        body = http.request(request)&.body
+        @log.msg "#{self_name}: ms teams notification is sent."
+        body
+      rescue StandardError => e
+        @log.msg "#{self_name}: ms teams notification failed.", level: :error
+        @log.msg "#{self_name}: #{e.message}.", level: :error
+      end
+
+      private
+
+      def self_name
+        @klass ||= self.class.name.downcase.split(":").last
+      end
+
+      def setup_configuration **opts
+        %i[smtp_host smtp_port smtp_username smtp_password notification_subject
+           smtp_tls smtp_sender smtp_receiver ms_teams_webhook].each do |sym|
+            @log.msg "#{self_name}: argument #{sym} is empty.", level: :warn if opts[sym].blank?
+            instance_variable_set "@#{sym.to_s}", opts[sym]
+        end
+        default_subject = "Notification: block volume operation."
+      end
+
+      def smtp_configured?
+        @smtp_host.present? && @smtp_port.present?
+      end
+
+      def configure_mailer
+        return unless smtp_configured?
+
+        host, port = @smtp_host, @smtp_port
+        username = @smtp_username
+        password = @smtp_password
+        tls_flag = @smtp_tls&.downcase == 'true'
+        auth = username.present? && password.present? ? 'login' : nil
+
+        Mail.defaults do
+          delivery_method :smtp, address: host, port: port, user_name: username,
+                                 password: password, authentication: auth,
+                                 enable_starttls_auto: tls_flag
+        end
+      end
+
+      def configure_ms_teams
+        return unless @ms_teams_webhook.present?
+        @webhook_url = URI.parse @ms_teams_webhook
+      end
+
+      def message_subject
+        @notification_subject || default_subject
+      end
+
+      def build_message_content text
+        <<~EOD
+          <style>
+            body {
+              background-color: whitesmoke;
+              font-family: Georgia, Times;
+              font-size: 15px;
+            }
+            .content {
+              margin: 20px 20px 0 20px;
+              padding: 10px;
+              background-color: white;
+            }
+            .foot {
+              margin: 0 20px 20px 20px;
+              padding: 5px;
+              border: 0;
+              text-align: center;
+              background-color: black;
+              color: white;
+              font-family: Arial, Times;
+              font-size: 13px;
+            }
+          </style>
+          <div class="content">
+            Hello,
+            <br><br>
+
+            #{text}
+            <br>
+
+            Regards,<br>
+            <span style="font-weight: 600">Automation</span>
+            <br>
+          </div>
+          <div class="foot">
+          © - Volume Sweeper Notification.
+          </div>
+        EOD
+      end
+    end
+  end
+end

data/lib/volume_sweeper/utils/notification_formatter.rb

@@ -0,0 +1,47 @@
+require 'erb'
+require 'active_support/core_ext/object/blank'
+
+module VolumeSweeper
+  module Utils
+    class NotificationFormatter
+
+      def initialize provider_base_url, run_mode
+        @provider_base_url = provider_base_url
+        @run_mode = run_mode || :audit
+      end
+
+      def formlate_meessage volumes, active_count: nil
+        active_list = volumes[:active_ids]
+        unused_list = volumes[:unused_ids]
+        active_count = active_count || volumes[:active_ids] || 0
+
+        if unused_list.blank? || unused_list.none?
+          <<~EOD
+            The environment is scanned and no unused block volumes found.<br>
+            * Active volumes: #{active_count}<br>
+            * Unused volumes: #{unused_list&.count || 0}<br>
+          EOD
+        else
+          notice = @run_mode == :delete ? "scheduled for deletion" : "eligibile for deletion"
+          ERB.new(
+            <<~HTML
+              The environment is scanned.<br>
+              * Active volumes: #{active_count}<br>
+              * Unused volumes: #{unused_list&.count || 0}<br>
+
+              Found the following volumes without instance bound or K8S PV relation.<br>
+              <u>(#{notice}):</u> <br>
+              <ul style="color: #400707">
+                <% unused_list.each do |vol| %>
+                <li>volume: <a href="#{@provider_base_url}/<%= vol %>"><%= vol %></a>.</li>
+                <% end %>
+              </ul>
+            HTML
+          ).result(binding)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/volume_sweeper/version.rb

@@ -0,0 +1,3 @@
+module VolumeSweeper
+  VERSION = "1.0.0"
+end

data/lib/volume_sweeper.rb

@@ -0,0 +1,6 @@
+require_relative 'volume_sweeper/version'
+require_relative 'volume_sweeper/core'
+require_relative 'volume_sweeper/cli'
+
+module VolumeSweeper
+end