manageiq-appliance_console 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34445fe4cc1b697688c30f689ed12499635959a5ad428763f2cfaac48a9f64c9
-  data.tar.gz: ed7530438fc6d4cf6d143e99bee966a890af509bdcb065831db8897b995a7fa8
+  metadata.gz: 797309808ab952ceb8d17fc6fab131bf79b05f368880f888a01e107e093feca5
+  data.tar.gz: d4070fb3ca9be9277bb5cafefd6e873431596c034932f903ed33ee49459cbcbb
 SHA512:
-  metadata.gz: a35d79649faa4a600b16959312a35468737a49f106524a510ee6d917154eb736547980a5597edc853b39325730ec3eece30efd4ed7375717525f5ad56ae3191e
-  data.tar.gz: 537c818711a763daa128491cf61895fac0646a568d7b9f39d7701707ecfcef33272d1f0cb7347290f1f61e10eb4cb7729ad2cadd18556ab5c9dd8888c7104842
+  metadata.gz: 76b149807bed8d49aa84ca00b422b7d57ad4db10df43b50e83a768f32a7d826d751d25d8f56fb670a775589d8848524f10cac696f4d46a3039900fe11f3e8cb9
+  data.tar.gz: 97439d9affd187790f55f0340b0750f975acff4d69306097869f67f98b5e60ddaccaf3bce429382fa9d5e54819474ef5f17f7c609cca4dc1d43731a71d406bdf

data/lib/manageiq/appliance_console/cli.rb

@@ -38,7 +38,23 @@ module ApplianceConsole
     end
 
     def database?
-      options[:standalone] || hostname
+      (options[:standalone] || hostname) && !database_admin?
+    end
+
+    def database_admin?
+      db_dump? || db_backup? || db_restore?
+    end
+
+    def db_dump?
+      options[:dump]
+    end
+
+    def db_backup?
+      options[:backup]
+    end
+
+    def db_restore?
+      options[:restore]
     end
 
     def local_database?
@@ -139,68 +155,72 @@ module ApplianceConsole
       self.options = Optimist.options(args) do
         banner "Usage: appliance_console_cli [options]"
 
-        opt :host,     "/etc/hosts name",    :type => :string,  :short => 'H'
-        opt :region,   "Region Number",      :type => :integer, :short => "r"
-        opt :internal, "Internal Database",                     :short => 'i'
-        opt :hostname, "Database Hostname",  :type => :string,  :short => 'h'
-        opt :port,     "Database Port",      :type => :integer,                :default => 5432
-        opt :username, "Database Username",  :type => :string,  :short => 'U', :default => "root"
-        opt :password, "Database Password",  :type => :string,  :short => "p"
-        opt :dbname,   "Database Name",      :type => :string,  :short => "d", :default => "vmdb_production"
-        opt :standalone, "Run this server as a standalone database server", :type => :bool, :short => 'S'
-        opt :key,      "Create encryption key",  :type => :boolean, :short => "k"
-        opt :fetch_key, "SSH host with encryption key", :type => :string, :short => "K"
-        opt :force_key, "Forcefully create encryption key", :type => :boolean, :short => "f"
-        opt :sshlogin,  "SSH login",         :type => :string,                 :default => "root"
-        opt :sshpassword, "SSH password",    :type => :string
-        opt :replication, "Configure database replication as primary or standby", :type => :string, :short => :none
-        opt :primary_host, "Primary database host IP address", :type => :string, :short => :none
-        opt :standby_host, "Standby database host IP address", :type => :string, :short => :none
-        opt :auto_failover, "Configure Replication Manager (repmgrd) for automatic failover", :type => :bool, :short => :none
-        opt :cluster_node_number, "Database unique cluster node number", :type => :integer, :short => :none
-        opt :verbose,  "Verbose",            :type => :boolean, :short => "v"
-        opt :dbdisk,   "Database Disk Path", :type => :string
-        opt :logdisk,  "Log Disk Path",      :type => :string
-        opt :tmpdisk,   "Temp storage Disk Path", :type => :string
-        opt :uninstall_ipa, "Uninstall IPA Client", :type => :boolean,         :default => false
-        opt :ipaserver,  "IPA Server FQDN",  :type => :string
-        opt :ipaprincipal,  "IPA Server principal", :type => :string,          :default => "admin"
-        opt :ipapassword,   "IPA Server password",  :type => :string
-        opt :ipadomain,     "IPA Server domain (optional)", :type => :string
-        opt :iparealm,      "IPA Server realm (optional)", :type => :string
-        opt :ca,                   "CA name used for certmonger",       :type => :string,  :default => "ipa"
-        opt :http_cert,            "install certs for http server",     :type => :boolean
-        opt :extauth_opts,         "External Authentication Options",   :type => :string
-        opt :saml_config,          "Configure Appliance for SAML Authentication",        :type => :boolean, :default => false
-        opt :saml_client_host,     "Optional Appliance host used for SAML registration", :type => :string
-        opt :saml_idp_metadata,    "The file path or URL of the SAML IDP Metadata",      :type => :string
-        opt :saml_enable_sso,      "Optionally enable SSO with SAML Authentication",     :type => :boolean, :default => false
-        opt :saml_unconfig,        "Unconfigure Appliance SAML Authentication",          :type => :boolean, :default => false
-        opt :oidc_config,          "Configure Appliance for OpenID-Connect Authentication",          :type => :boolean, :default => false
-        opt :oidc_url,             "The OpenID-Connect Provider URL",                                :type => :string
-        opt :oidc_client_host,     "Optional Appliance host used for OpenID-Connect Authentication", :type => :string
-        opt :oidc_client_id,       "The OpenID-Connect Provider Client ID",                          :type => :string
-        opt :oidc_client_secret,   "The OpenID-Connect Provider Client Secret",                      :type => :string
-        opt :oidc_insecure,        "OpenID-Connect Insecure No SSL Verify (development)",            :type => :boolean, :default => false
-        opt :oidc_introspection_endpoint, "The OpenID-Connect Provider Introspect Endpoint",         :type => :string
-        opt :oidc_enable_sso,      "Optionally enable SSO with OpenID-Connect Authentication",       :type => :boolean, :default => false
-        opt :oidc_unconfig,        "Unconfigure Appliance OpenID-Connect Authentication",            :type => :boolean, :default => false
-        opt :server,               "{start|stop|restart} actions on evmserverd Server",   :type => :string
-        opt :openscap,             "Setup OpenScap", :type => :boolean, :default => false
-        opt :message_server_config,       "Subcommand to   Configure Appliance as a Kafka Message Server", :type => :boolean, :default => false
-        opt :message_server_unconfig,     "Subcommand to Unconfigure Appliance as a Kafka Message Server", :type => :boolean, :default => false
-        opt :message_client_config,       "Subcommand to   Configure Appliance as a Kafka Message Client", :type => :boolean, :default => false
-        opt :message_client_unconfig,     "Subcommand to Unconfigure Appliance as a Kafka Message Client", :type => :boolean, :default => false
-        opt :message_keystore_username,   "Message Server Keystore Username",                              :type => :string
-        opt :message_keystore_password,   "Message Server Keystore Password",                              :type => :string
-        opt :message_server_username,     "Message Server Username",                                       :type => :string
-        opt :message_server_password,     "Message Server password",                                       :type => :string
-        opt :message_server_port,         "Message Server Port",                                           :type => :integer
-        opt :message_server_use_ipaddr,   "Message Server Use Address",                                    :type => :boolean, :default => false
-        opt :message_server_host,         "Message Server Hostname or IP Address",                         :type => :string
-        opt :message_truststore_path_src, "Message Server Truststore Path",                                :type => :string
-        opt :message_ca_cert_path_src,    "Message Server CA Cert Path",                                   :type => :string
-        opt :message_persistent_disk,     "Message Persistent Disk Path",                                  :type => :string
+        opt :host,                        "/etc/hosts name",                                                :type => :string,  :short => 'H'
+        opt :region,                      "Region Number",                                                  :type => :integer, :short => "r"
+        opt :internal,                    "Internal Database",                                                                 :short => 'i'
+        opt :hostname,                    "Database Hostname",                                              :type => :string,  :short => 'h'
+        opt :port,                        "Database Port",                                                  :type => :integer,                :default => 5432
+        opt :username,                    "Database Username",                                              :type => :string,  :short => 'U', :default => "root"
+        opt :password,                    "Database Password",                                              :type => :string,  :short => "p"
+        opt :dbname,                      "Database Name",                                                  :type => :string,  :short => "d", :default => "vmdb_production"
+        opt :local_file,                  "Source/Destination file for DB dump/backup/restore",             :type => :string,  :shoft => "l"
+        opt :dump,                        "Perform a pg-dump"
+        opt :backup,                      "Perform a pg-basebackup"
+        opt :restore,                     "Restore a database dump/backup"
+        opt :standalone,                  "Run this server as a standalone database server",                :type => :bool,    :short => 'S'
+        opt :key,                         "Create encryption key",                                          :type => :boolean, :short => "k"
+        opt :fetch_key,                   "SSH host with encryption key",                                   :type => :string,  :short => "K"
+        opt :force_key,                   "Forcefully create encryption key",                               :type => :boolean, :short => "f"
+        opt :sshlogin,                    "SSH login",                                                      :type => :string,  :default => "root"
+        opt :sshpassword,                 "SSH password",                                                   :type => :string
+        opt :replication,                 "Configure database replication as primary or standby",           :type => :string,  :short => :none
+        opt :primary_host,                "Primary database host IP address",                               :type => :string,  :short => :none
+        opt :standby_host,                "Standby database host IP address",                               :type => :string,  :short => :none
+        opt :auto_failover,               "Configure Replication Manager (repmgrd) for automatic failover", :type => :bool,    :short => :none
+        opt :cluster_node_number,         "Database unique cluster node number",                            :type => :integer, :short => :none
+        opt :verbose,                     "Verbose",                                                        :type => :boolean, :short => "v"
+        opt :dbdisk,                      "Database Disk Path",                                             :type => :string
+        opt :logdisk,                     "Log Disk Path",                                                  :type => :string
+        opt :tmpdisk,                     "Temp storage Disk Path",                                         :type => :string
+        opt :uninstall_ipa,               "Uninstall IPA Client",                                           :type => :boolean, :default => false
+        opt :ipaserver,                   "IPA Server FQDN",                                                :type => :string
+        opt :ipaprincipal,                "IPA Server principal",                                           :type => :string,  :default => "admin"
+        opt :ipapassword,                 "IPA Server password",                                            :type => :string
+        opt :ipadomain,                   "IPA Server domain (optional)",                                   :type => :string
+        opt :iparealm,                    "IPA Server realm (optional)",                                    :type => :string
+        opt :ca,                          "CA name used for certmonger",                                    :type => :string,  :default => "ipa"
+        opt :http_cert,                   "install certs for http server",                                  :type => :boolean
+        opt :extauth_opts,                "External Authentication Options",                                :type => :string
+        opt :saml_config,                 "Configure Appliance for SAML Authentication",                    :type => :boolean, :default => false
+        opt :saml_client_host,            "Optional Appliance host used for SAML registration",             :type => :string
+        opt :saml_idp_metadata,           "The file path or URL of the SAML IDP Metadata",                  :type => :string
+        opt :saml_enable_sso,             "Optionally enable SSO with SAML Authentication",                 :type => :boolean, :default => false
+        opt :saml_unconfig,               "Unconfigure Appliance SAML Authentication",                      :type => :boolean, :default => false
+        opt :oidc_config,                 "Configure Appliance for OpenID-Connect Authentication",          :type => :boolean, :default => false
+        opt :oidc_url,                    "The OpenID-Connect Provider URL",                                :type => :string
+        opt :oidc_client_host,            "Optional Appliance host used for OpenID-Connect Authentication", :type => :string
+        opt :oidc_client_id,              "The OpenID-Connect Provider Client ID",                          :type => :string
+        opt :oidc_client_secret,          "The OpenID-Connect Provider Client Secret",                      :type => :string
+        opt :oidc_insecure,               "OpenID-Connect Insecure No SSL Verify (development)",            :type => :boolean, :default => false
+        opt :oidc_introspection_endpoint, "The OpenID-Connect Provider Introspect Endpoint",                :type => :string
+        opt :oidc_enable_sso,             "Optionally enable SSO with OpenID-Connect Authentication",       :type => :boolean, :default => false
+        opt :oidc_unconfig,               "Unconfigure Appliance OpenID-Connect Authentication",            :type => :boolean, :default => false
+        opt :server,                      "{start|stop|restart} actions on evmserverd Server",              :type => :string
+        opt :openscap,                    "Setup OpenScap",                                                 :type => :boolean, :default => false
+        opt :message_server_config,       "Subcommand to   Configure Appliance as a Kafka Message Server",  :type => :boolean, :default => false
+        opt :message_server_unconfig,     "Subcommand to Unconfigure Appliance as a Kafka Message Server",  :type => :boolean, :default => false
+        opt :message_client_config,       "Subcommand to   Configure Appliance as a Kafka Message Client",  :type => :boolean, :default => false
+        opt :message_client_unconfig,     "Subcommand to Unconfigure Appliance as a Kafka Message Client",  :type => :boolean, :default => false
+        opt :message_keystore_username,   "Message Server Keystore Username",                               :type => :string
+        opt :message_keystore_password,   "Message Server Keystore Password",                               :type => :string
+        opt :message_server_username,     "Message Server Username",                                        :type => :string
+        opt :message_server_password,     "Message Server password",                                        :type => :string
+        opt :message_server_port,         "Message Server Port",                                            :type => :integer
+        opt :message_server_use_ipaddr,   "Message Server Use Address",                                     :type => :boolean, :default => false
+        opt :message_server_host,         "Message Server Hostname or IP Address",                          :type => :string
+        opt :message_truststore_path_src, "Message Server Truststore Path",                                 :type => :string
+        opt :message_ca_cert_path_src,    "Message Server CA Cert Path",                                    :type => :string
+        opt :message_persistent_disk,     "Message Persistent Disk Path",                                   :type => :string
       end
       Optimist.die :region, "needed when setting up a local database" if region_number_required? && options[:region].nil?
       Optimist.die "Supply only one of --message-server-host or --message-server-use-ipaddr=true" if both_host_and_use_ip_addr_specified?
@@ -218,11 +238,12 @@ module ApplianceConsole
     end
 
     def region_number_required?
-      !options[:standalone] && local_database?
+      !options[:standalone] && local_database? && !database_admin?
     end
 
     def run
-      Optimist.educate unless set_host? || key? || database? || tmp_disk? || log_disk? ||
+      Optimist.educate unless set_host? || key? || database? || db_dump? || db_backup? ||
+                              db_restore? || tmp_disk? || log_disk? ||
                               uninstall_ipa? || install_ipa? || certs? || extauth_opts? ||
                               set_server_state? || set_replication? || openscap? ||
                               saml_config? || saml_unconfig? ||
@@ -240,6 +261,9 @@ module ApplianceConsole
       create_key if key?
       set_db if database?
       set_replication if set_replication?
+      db_dump if db_dump?
+      db_backup if db_backup?
+      db_restore if db_restore?
       config_tmp_disk if tmp_disk?
       config_log_disk if log_disk?
       uninstall_ipa if uninstall_ipa?
@@ -344,6 +368,33 @@ module ApplianceConsole
       db_replication.activate
     end
 
+    def db_dump
+      PostgresAdmin.backup_pg_dump(extract_db_opts(options))
+    end
+
+    def db_backup
+      PostgresAdmin.backup(extract_db_opts(options))
+    end
+
+    def db_restore
+      PostgresAdmin.restore(extract_db_opts(options))
+    end
+
+    DB_OPT_KEYS = %i[dbname username password hostname port local_file].freeze
+    def extract_db_opts(options)
+      require 'manageiq/appliance_console/postgres_admin'
+
+      db_opts = {}
+
+      DB_OPT_KEYS.each { |k| db_opts[k] = options[k] if options[k] }
+
+      if db_dump? && options[:exclude_table_data]
+        db_opts[:exclude_table_data] = options[:exclude_table_data]
+      end
+
+      db_opts
+    end
+
     def key_configuration
       @key_configuration ||= KeyConfiguration.new(
         :action   => options[:fetch_key] ? :fetch : :create,

data/lib/manageiq/appliance_console/database_admin.rb

@@ -23,22 +23,17 @@ module ManageIQ
 
       WARN
 
-      attr_accessor :uri
-      attr_reader :action, :backup_type, :task, :task_params, :delete_agree, :filename
+      attr_reader :action, :backup_type, :database_opts, :delete_agree, :filename
 
       def initialize(action = :restore, input = $stdin, output = $stdout)
         super(input, output)
 
-        @action      = action
-        @task_params = []
+        @action        = action
+        @database_opts = {:dbname => DatabaseConfiguration.database_name}
       end
 
-      def local_backup?
-        backup_type == "local".freeze
-      end
-
-      def object_store_backup?
-        backup_type == "s3".freeze || backup_type == "swift".freeze
+      def uri
+        @database_opts[:local_file]
       end
 
       def ask_questions
@@ -51,7 +46,6 @@ module ManageIQ
         say(DB_DUMP_WARNING) if action == :dump
         ask_file_location
         ask_for_tables_to_exclude_in_dump
-        ask_to_split_up_output
       end
 
       def activate
@@ -63,144 +57,11 @@ module ManageIQ
       end
 
       def ask_file_location
-        @backup_type = ask_with_menu(*file_menu_args) do |menu|
-          menu.choice(CANCEL) { |_| raise MiqSignalError }
-        end
-        if URI(backup_type).scheme
-          ask_custom_file_options(backup_type)
-        else
-          # calling methods like ask_ftp_file_options and ask_s3_file_options
-          send("ask_#{backup_type}_file_options")
-        end
-      end
-
-      def ask_local_file_options
-        @uri         = just_ask(*filename_prompt_args)
-        @task        = "evm:db:#{action}:local"
-        @task_params = ["--", {:local_file => uri}]
-      end
-
-      def ask_nfs_file_options
-        @filename    = just_ask(*filename_prompt_args) unless action == :restore
-        @uri         = ask_for_uri(*remote_file_prompt_args_for("nfs"))
-        @task        = "evm:db:#{action}:remote"
-
-        params = {:uri => uri}
-        params[:remote_file_name] = filename if filename
-
-        @task_params = ["--", params]
-      end
-
-      def ask_smb_file_options
-        @filename    = just_ask(*filename_prompt_args) unless action == :restore
-        @uri         = ask_for_uri(*remote_file_prompt_args_for("smb"))
-        user         = just_ask(USER_PROMPT)
-        pass         = ask_for_password("password for #{user}")
-
-        params = {
-          :uri          => uri,
-          :uri_username => user,
-          :uri_password => pass
-        }
-        params[:remote_file_name] = filename if filename
-
-        @task        = "evm:db:#{action}:remote"
-        @task_params = ["--", params]
-      end
-
-      def ask_s3_file_options
-        access_key_prompt = <<-PROMPT.strip_heredoc.chomp
-          Access Key ID with access to this file.
-          Example: 'amazon_aws_user'
-        PROMPT
-
-        @filename    = just_ask(*filename_prompt_args) unless action == :restore
-        @uri         = ask_for_uri(*remote_file_prompt_args_for("s3"), :optional_path => true)
-        region       = just_ask("Amazon Region for database file", "us-east-1")
-        user         = just_ask(access_key_prompt)
-        pass         = ask_for_password("Secret Access Key for #{user}")
-
-        params = {
-          :uri          => uri,
-          :uri_username => user,
-          :uri_password => pass,
-          :aws_region   => region
-        }
-        params[:remote_file_name] = filename if filename
-
-        @task        = "evm:db:#{action}:remote"
-        @task_params = ["--", params]
-      end
-
-      def ask_ftp_file_options
-        @filename    = just_ask(*filename_prompt_args) unless action == :restore
-        @uri         = ask_for_uri(*remote_file_prompt_args_for("ftp"), :optional_path => true)
-        user         = just_ask(USER_PROMPT)
-        pass         = ask_for_password("password for #{user}")
-
-        params = { :uri => uri }
-        params[:uri_username]     = user     if user.present?
-        params[:uri_password]     = pass     if pass.present?
-        params[:remote_file_name] = filename if filename
-
-        @task        = "evm:db:#{action}:remote"
-        @task_params = ["--", params]
-      end
-
-      def ask_custom_file_options(server_uri)
-        hostname  = URI(server_uri).host
-        @filename = ask_custom_file_prompt(hostname)
-        @uri      = server_uri
-
-        params = {:uri => uri, :remote_file_name => filename}
-
-        if (custom_params = custom_endpoint_config_for(hostname))
-          params.merge!(custom_params[:rake_options]) if custom_params[:rake_options]
-        end
-
-        @task        = "evm:db:#{action}:remote"
-        @task_params = ["--", params]
-      end
-
-      def ask_swift_file_options
-        require 'uri'
-        swift_user_prompt = <<-PROMPT.strip_heredoc.chomp
-          User Name with access to this file.
-          Example: 'openstack_user'
-        PROMPT
-
-        @filename  = just_ask(*filename_prompt_args) { |q| q.readline = false } unless action == :restore
-        @uri       = URI(ask_for_uri(*remote_file_prompt_args_for("swift")) { |q| q.readline = false })
-        @task      = "evm:db:#{action}:remote"
-        user       = just_ask(swift_user_prompt) { |q| q.readline = false }
-        pass       = ask_for_password("password for #{user}") { |q| q.readline = false }
-        @uri.query = swift_query_elements.join('&').presence
-
-        params = {
-          :uri          => @uri.to_s,
-          :uri_username => user,
-          :uri_password => pass
-        }
-        params[:remote_file_name] = filename if filename
-        @task        = "evm:db:#{action}:remote"
-        @task_params = ["--", params]
-      end
-
-      def swift_query_elements
-        region            = just_ask("OpenStack Swift Region") { |q| q.readline = false }
-        @uri.port         = just_ask("OpenStack Swift Port", "5000") { |q| q.readline = false }
-        security_protocol = ask_with_menu(*security_protocol_menu_args)
-        api_version       = ask_with_menu(*api_version_menu_args) { |q| q.readline = false }
-        domain_ident      = just_ask("OpenStack V3 Domain Identifier") { |q| q.readline = false } if api_version == "v3"
-        query_elements    = []
-        query_elements    << "region=#{region}"                       if region.present?
-        query_elements    << "api_version=#{api_version}"             if api_version.present?
-        query_elements    << "domain_id=#{domain_ident}"              if domain_ident.present?
-        query_elements    << "security_protocol=#{security_protocol}" if security_protocol.present?
+        @database_opts[:local_file] = just_ask(*filename_prompt_args)
       end
 
       def ask_to_delete_backup_after_restore
-        if action == :restore && local_backup?
+        if action == :restore
           say("The local database restore file is located at: '#{uri}'.\n")
           @delete_agree = agree("Should this file be deleted after completing the restore? (Y/N): ")
         end
@@ -222,20 +83,14 @@ module ManageIQ
                                         255,
                                         Float::INFINITY)
 
-          @task_params.last[:"exclude-table-data"] = table_excludes
-        end || true
-      end
-
-      def ask_to_split_up_output
-        if action == :dump && should_split_output?
-          @task_params.last[:byte_count] = ask_for_string("byte size to split by", "500M")
+          @database_opts[:exclude_table_data] = table_excludes
         end || true
       end
 
       def confirm_and_execute
         if allowed_to_execute?
           processing_message
-          run_rake
+          run_action
         end
         press_any_key
       end
@@ -259,58 +114,18 @@ module ManageIQ
         end
       end
 
-      def api_version_menu_args
-        [
-          "OpenStack API Version",
-          [["Keystone v2".freeze, "v2".freeze], ["Keystone v3".freeze, "v3".freeze], ["None".freeze, nil]].freeze,
-          ["Keystone v2".freeze, "v2".freeze],
-          nil
-        ]
-      end
-
-      def file_menu_args
-        [
-          action == :restore ? "Restore Database File Source" : "#{action.capitalize} Output File Destination",
-          file_options,
-          "local",
-          nil
-        ]
-      end
-
-      def security_protocol_menu_args
-        [
-          "OpenStack Security Protocol",
-          [["SSL without validation".freeze, "ssl".freeze], ["SSL".freeze, "ssl-with-validation".freeze], ["Non-SSL".freeze, "non-ssl".freeze], ["None".freeze, nil]].freeze,
-          ["Non-SSL".freeze, "non-ssl".freeze],
-          nil
-        ]
-      end
-
       def setting_header
         say("#{I18n.t("advanced_settings.db#{action}")}\n\n")
       end
 
       private
 
-      def ask_custom_file_prompt(hostname)
-        prompts = custom_endpoint_config_for(hostname)
-        prompt_text  = prompts && prompts[:filename_text] || "Target filename for backup".freeze
-        prompt_regex = prompts && prompts[:filename_validator]
-        validator    = prompt_regex ? ->(x) { x.to_s =~ /#{prompt_regex}/ } : ->(x) { x.to_s.present? }
-        just_ask(prompt_text, nil, validator)
-      end
-
       def skip_file_location?(hostname)
         config = custom_endpoint_config_for(hostname)
         return false unless config && config[:enabled_for].present?
         !Array(config[:enabled_for]).include?(action.to_s)
       end
 
-      def custom_endpoint_config_for(hostname)
-        # hostname has a period in it, so we need to look it up by [] instead of the traditional i18n method
-        I18n.t("database_admin.prompts", :default => {})[hostname.to_sym]
-      end
-
       def should_exclude_tables?
         ask_yn?("Would you like to exclude tables in the dump") do |q|
           q.readline = true
@@ -327,16 +142,12 @@ module ManageIQ
         return restore_prompt_args if action == :restore
         default = action == :dump ? DB_DEFAULT_DUMP_FILE : DB_RESTORE_FILE
         prompt  = "location to save the #{action} file to"
-        if object_store_backup?
-          prompt  = "name for the remote #{action} file"
-          default = File.basename(default)
-        end
         [prompt, default, nil, "file that exists"]
       end
 
       def restore_prompt_args
         default   = DB_RESTORE_FILE
-        validator = LOCAL_FILE_VALIDATOR if local_backup?
+        validator = LOCAL_FILE_VALIDATOR
         prompt    = "location of the local restore file"
         [prompt, default, validator, "file that exists"]
       end
@@ -347,12 +158,12 @@ module ManageIQ
                   else
                     "location to save the remote #{action} file to"
                   end
-        prompt += "\nExample: #{sample_url(remote_type)}"
+        prompt += "\nExample: #{sample_url}"
         [prompt, remote_type]
       end
 
-      def sample_url(scheme)
-        I18n.t("database_admin.sample_url.#{scheme}")
+      def sample_url
+        I18n.t("database_admin.sample_url.nfs")
       end
 
       def processing_message
@@ -364,15 +175,33 @@ module ManageIQ
         say(msg)
       end
 
-      def run_rake
-        rake_success = ManageIQ::ApplianceConsole::Utilities.rake(task, task_params)
-        if rake_success && action == :restore && delete_agree
+      def run_action
+        success = send(action)
+        if success && action == :restore && delete_agree
           say("\nRemoving the database restore file #{uri}...")
           File.delete(uri)
-        elsif !rake_success
+        elsif !success
           say("\nDatabase #{action} failed. Check the logs for more information")
         end
       end
+
+      def backup
+        result = PostgresAdmin.backup(database_opts)
+        ManageIQ::ApplianceConsole.logger.info("[#{@database_opts[:dbname]}] database has been backed up to file: [#{uri}]")
+        result
+      end
+
+      def dump
+        result = PostgresAdmin.backup_pg_dump(database_opts)
+        ManageIQ::ApplianceConsole.logger.info("[#{@database_opts[:dbname]}] database has been dumped up to file: [#{uri}]")
+        result
+      end
+
+      def restore
+        result = PostgresAdmin.restore(database_opts.merge(:backup_type => backup_type))
+        ManageIQ::ApplianceConsole.logger.info("[#{@database_opts[:dbname]}] database has been restored from file: [#{uri}]")
+        result
+      end
     end
   end
 end

data/lib/manageiq/appliance_console/database_configuration.rb

@@ -5,9 +5,13 @@ require 'manageiq-password'
 require 'pathname'
 require 'fileutils'
 
+require_relative './manageiq_user_mixin'
+
 module ManageIQ
 module ApplianceConsole
   class DatabaseConfiguration
+    include ManageIQ::ApplianceConsole::ManageiqUserMixin
+
     attr_accessor :adapter, :host, :username, :database, :port, :region
     attr_reader :password
 
@@ -275,7 +279,10 @@ FRIENDLY
 
     def do_save(settings)
       require 'yaml'
-      File.write(DB_YML, YAML.dump(settings))
+      File.open(DB_YML, "w") do |f|
+        f.write(YAML.dump(settings))
+        f.chown(manageiq_uid, manageiq_gid)
+      end
     end
 
     def initialize_from_hash(hash)

data/lib/manageiq/appliance_console/external_auth_options.rb

@@ -82,8 +82,7 @@ module ApplianceConsole
         say("\nUpdating external authentication options on appliance ...")
         params = update_hash.collect { |key, value| "#{key}=#{value}" }
         params = configure_provider_type!(params)
-        result = ManageIQ::ApplianceConsole::Utilities.rake_run("evm:settings:set", params)
-        raise parse_errors(result).join(', ') if result.failure?
+        ManageIQ::ApplianceConsole::Utilities.rake_run!("evm:settings:set", params)
       end
     end
 
@@ -152,17 +151,8 @@ module ApplianceConsole
 
     def load_current
       say("\nFetching external authentication options from appliance ...")
-      result = ManageIQ::ApplianceConsole::Utilities.rake_run("evm:settings:get", EXT_AUTH_OPTIONS.keys)
-
-      if result.success?
-        return parse_response(result)
-      else
-        raise parse_errors(result).join(', ')
-      end
-    end
-
-    def parse_errors(result)
-      result.error.split("\n").collect { |line| line if line =~ /^error: /i }.compact
+      result = ManageIQ::ApplianceConsole::Utilities.rake_run!("evm:settings:get", EXT_AUTH_OPTIONS.keys)
+      parse_response(result)
     end
 
     def normalize_key(key)

data/lib/manageiq/appliance_console/internal_database_configuration.rb

@@ -1,6 +1,5 @@
 require "pathname"
 require "manageiq/appliance_console/postgres_admin"
-require "pg"
 require "linux_admin"
 
 module ManageIQ
@@ -149,14 +148,14 @@ module ApplianceConsole
     end
 
     def create_postgres_root_user
-      with_pg_connection do |conn|
+      PostgresAdmin.with_pg_connection do |conn|
         esc_pass = conn.escape_string(password)
         conn.exec("CREATE ROLE #{username} WITH LOGIN CREATEDB SUPERUSER PASSWORD '#{esc_pass}'")
       end
     end
 
     def create_postgres_database
-      with_pg_connection do |conn|
+      PostgresAdmin.with_pg_connection do |conn|
         conn.exec("CREATE DATABASE #{database} OWNER #{username} ENCODING 'utf8'")
       end
     end
@@ -165,16 +164,9 @@ module ApplianceConsole
       AwesomeSpawn.run!("/sbin/restorecon -R -v #{mount_point}")
     end
 
-    def with_pg_connection
-      conn = PG.connect(:user => "postgres", :dbname => "postgres")
-      yield conn
-    ensure
-      conn.close
-    end
-
     def apply_initial_configuration
       shared_buffers = run_as_evm_server ? SHARED_DB_SHARED_BUFFERS : DEDICATED_DB_SHARED_BUFFERS
-      with_pg_connection { |conn| conn.exec("ALTER SYSTEM SET shared_buffers TO #{shared_buffers}") }
+      PostgresAdmin.with_pg_connection { |conn| conn.exec("ALTER SYSTEM SET shared_buffers TO #{shared_buffers}") }
 
       restart_postgres
     end

data/lib/manageiq/appliance_console/key_configuration.rb

@@ -4,6 +4,8 @@ require 'net/scp'
 require 'active_support/all'
 require 'manageiq-password'
 
+require_relative './manageiq_user_mixin'
+
 module ManageIQ
 module ApplianceConsole
   CERT_DIR = ENV['KEY_ROOT'] || ManageIQ::ApplianceConsole::RAILS_ROOT.join("certs")
@@ -11,6 +13,8 @@ module ApplianceConsole
   NEW_KEY_FILE = "#{KEY_FILE}.tmp".freeze
 
   class KeyConfiguration
+    include ManageIQ::ApplianceConsole::ManageiqUserMixin
+
     attr_accessor :host, :login, :password, :key_path, :action, :force
 
     def initialize(options = {})
@@ -89,7 +93,9 @@ module ApplianceConsole
     end
 
     def create_key
-      ManageIQ::Password.generate_symmetric(NEW_KEY_FILE) && true
+      return unless !!ManageIQ::Password.generate_symmetric(NEW_KEY_FILE)
+
+      File.chown(manageiq_uid, manageiq_gid, NEW_KEY_FILE)
     end
 
     def fetch_key
@@ -97,6 +103,7 @@ module ApplianceConsole
       Net::SCP.start(host, login, :password => password) do |scp|
         scp.download!(key_path, NEW_KEY_FILE)
       end
+      File.chown(manageiq_uid, manageiq_gid, NEW_KEY_FILE)
       File.exist?(NEW_KEY_FILE)
     rescue => e
       say("Failed to fetch key: #{e.message}")

data/lib/manageiq/appliance_console/manageiq_user_mixin.rb

@@ -0,0 +1,15 @@
+module ManageIQ
+  module ApplianceConsole
+    module ManageiqUserMixin
+      extend ActiveSupport::Concern
+
+      def manageiq_uid
+        @manageiq_uid ||= Process::UID.from_name("manageiq")
+      end
+
+      def manageiq_gid
+        @manageiq_gid ||= Process::GID.from_name("manageiq")
+      end
+    end
+  end
+end

data/lib/manageiq/appliance_console/message_configuration.rb

@@ -1,9 +1,13 @@
 require 'active_support/core_ext/module/delegation'
 require 'pathname'
 
+require_relative './manageiq_user_mixin'
+
 module ManageIQ
   module ApplianceConsole
     class MessageConfiguration
+      include ManageIQ::ApplianceConsole::ManageiqUserMixin
+
       attr_reader :message_keystore_username, :message_keystore_password,
                   :message_server_host, :message_server_port,
                   :miq_config_dir_path, :config_dir_path, :sample_config_dir_path,
@@ -116,7 +120,10 @@ module ManageIQ
           messaging_yaml["production"]["security.protocol"] = "PLAINTEXT"
         end
 
-        File.write(messaging_yaml_path, messaging_yaml.to_yaml)
+        File.open(messaging_yaml_path, "w") do |f|
+          f.write(messaging_yaml.to_yaml)
+          f.chown(manageiq_uid, manageiq_gid)
+        end
       end
 
       def remove_installed_files
@@ -175,8 +182,7 @@ module ManageIQ
       def configure_messaging_type(value)
         say(__method__.to_s.tr("_", " ").titleize)
 
-        result = ManageIQ::ApplianceConsole::Utilities.rake_run("evm:settings:set", ["/prototype/messaging_type=#{value}"])
-        raise parse_errors(result).join(', ') if result.failure?
+        ManageIQ::ApplianceConsole::Utilities.rake_run!("evm:settings:set", ["/prototype/messaging_type=#{value}"])
       end
 
       def restart_evmserverd

data/lib/manageiq/appliance_console/message_configuration_client.rb

@@ -82,6 +82,8 @@ module ManageIQ
       def fetch_from_server(src_file, dst_file)
         return if file_found?(dst_file)
 
+        FileUtils.mkdir_p(dst_file.dirname) unless dst_file.dirname.directory?
+
         Net::SCP.start(message_server_host, message_server_username, :password => message_server_password) do |scp|
           scp.download!(src_file, dst_file)
         end

data/lib/manageiq/appliance_console/message_configuration_server.rb

@@ -184,6 +184,8 @@ module ManageIQ
 
         keystore_params = assemble_keystore_params
 
+        FileUtils.mkdir_p(keystore_dir_path) unless keystore_dir_path.directory?
+
         # Generte a Java keystore and key pair, creating keystore.jks
         # :stdin_data provides the -storepass twice to confirm and an extra CR to accept the same password for -keypass
         AwesomeSpawn.run!("keytool", :params => keystore_params, :stdin_data => "#{message_keystore_password}\n#{message_keystore_password}\n\n")

data/lib/manageiq/appliance_console/postgres_admin.rb

@@ -1,6 +1,7 @@
 require 'awesome_spawn'
 require 'pathname'
 require 'linux_admin'
+require 'pg'
 
 module ManageIQ
 module ApplianceConsole
@@ -46,6 +47,13 @@ module ApplianceConsole
       "xfs".freeze
     end
 
+    def self.with_pg_connection(db_opts = {:user => user, :dbname => user})
+      conn = PG.connect(db_opts)
+      yield conn
+    ensure
+      conn.close if conn
+    end
+
     def self.initialized?
       !Dir[data_directory.join("*")].empty?
     end
@@ -100,13 +108,13 @@ module ApplianceConsole
 
     def self.restore(opts)
       file        = opts[:local_file]
-      backup_type = opts.delete(:backup_type)
+      backup_type = opts.delete(:backup_type) || validate_backup_file_type(file)
+
+      prepare_restore(backup_type, opts[:dbname])
 
-      case
-      when backup_type == :pgdump     then restore_pg_dump(opts)
-      when backup_type == :basebackup then restore_pg_basebackup(file)
-      when pg_dump_file?(file)        then restore_pg_dump(opts)
-      when base_backup_file?(file)    then restore_pg_basebackup(file)
+      case backup_type
+      when :pgdump     then restore_pg_dump(opts)
+      when :basebackup then restore_pg_basebackup(file)
       else
         raise "#{file} is not a database backup"
       end
@@ -142,6 +150,7 @@ module ApplianceConsole
       args = combine_command_args(opts, :format => "c", :file => opts[:local_file], nil => dbname)
       args = handle_multi_value_pg_dump_args!(opts, args)
 
+      FileUtils.mkdir_p(File.dirname(opts.fetch(:local_file, "")))
       run_command_with_logging("pg_dump", opts, args)
       opts[:local_file]
     end
@@ -320,6 +329,84 @@ module ApplianceConsole
     ensure
       File.delete(error_path) if File.exist?(error_path)
     end
+
+    private_class_method def self.prepare_restore(backup_type, dbname)
+      if application_connections?
+        message = "Database restore failed. Shut down all evmserverd processes before attempting a database restore"
+        ManageIQ::ApplianceConsole.logger.error(message)
+        raise message
+      end
+
+      disable_replication(dbname)
+
+      conn_count = connection_count(backup_type, dbname)
+      if conn_count > 1
+        message = "Database restore failed. #{conn_count - 1} connections remain to the database."
+        ManageIQ::ApplianceConsole.logger.error(message)
+        raise message
+      end
+    end
+
+    private_class_method def self.application_connections?
+      result = [{"count" => 0}]
+
+      with_pg_connection do |conn|
+        result = conn.exec("SELECT COUNT(pid) FROM pg_stat_activity WHERE application_name LIKE '%MIQ%'")
+      end
+
+      result[0]["count"].to_i > 0
+    end
+
+    private_class_method def self.disable_replication(dbname)
+      require 'pg/logical_replication'
+
+      with_pg_connection do |conn|
+        pglogical = PG::LogicalReplication::Client.new(conn)
+
+        if pglogical.subscriber?
+          pglogical.subcriptions(dbname).each do |subscriber|
+            sub_id = subscriber["subscription_name"]
+            begin
+              pglogical.drop_subscription(sub_id, true)
+            rescue PG::InternalError => e
+              raise unless e.message.include?("could not connect to publisher")
+              raise unless e.message.match?(/replication slot .* does not exist/)
+
+              pglogical.disable_subscription(sub_id).check
+              pglogical.alter_subscription_options(sub_id, "slot_name" => "NONE")
+              pglogical.drop_subscription(sub_id, true)
+            end
+          end
+        elsif pglogical.publishes?('miq')
+          pglogical.drop_publication('miq')
+        end
+      end
+    end
+
+    private_class_method def self.connection_count(backup_type, dbname)
+      result = nil
+
+      with_pg_connection do |conn|
+        query  = "SELECT COUNT(pid) FROM pg_stat_activity"
+        query << " WHERE backend_type = 'client backend'" if backup_type == :basebackup
+        query << " WHERE datname = '#{dbname}'"           if backup_type == :pgdump
+        result = conn.exec(query)
+      end
+
+      result[0]["count"].to_i
+    end
+
+    private_class_method def self.validate_backup_file_type(file)
+      if base_backup_file?(file)
+        :basebackup
+      elsif pg_dump_file?(file)
+        :pgdump
+      else
+        message = "#{filename} is not in a recognized database backup format"
+        ManageIQ::ApplianceConsole.error(message)
+        raise message
+      end
+    end
   end
 end
 end

data/lib/manageiq/appliance_console/utilities.rb

@@ -16,6 +16,16 @@ module ApplianceConsole
       result
     end
 
+    def self.rake_run!(task, params)
+      result = rake_run(task, params)
+      if result.failure?
+        parsed_errors = result.error.split("\n").select { |line| line.match?(/^error: /i) }.join(', ')
+        raise parsed_errors
+      end
+
+      result
+    end
+
     def self.db_connections
       result = AwesomeSpawn.run("bin/rails runner",
                                 :params => ["exit EvmDatabaseOps.database_connections"],

data/lib/manageiq/appliance_console/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module ApplianceConsole
-    VERSION = '6.1.0'.freeze
+    VERSION = '7.0.0'.freeze
   end
 end

data/locales/appliance/en.yml

@@ -39,22 +39,6 @@ en:
     summary: Summary Information
     quit: Quit
   database_admin:
-    menu_order:
-    - local
-    - nfs
-    - smb
-    - s3
-    - ftp
-    - swift
     local: Local file
-    nfs: Network File System (NFS)
-    smb: Samba (SMB)
-    s3: Amazon S3 (S3)
-    ftp: File Transfer Protocol (FTP)
-    swift: OpenStack Swift (Swift)
     sample_url:
       nfs: nfs://host.mydomain.com/exported/my_exported_folder/db.backup
-      smb: smb://host.mydomain.com/my_share/daily_backup/db.backup
-      s3: s3://mybucket/my_subdirectory/daily_backup/db.backup
-      ftp: ftp://host.mydomain.com/path/to/daily_backup/db.backup
-      swift: swift://host.mydomain.com/path/to/daily_backup/db.backup

data/manageiq-appliance_console.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "net-scp",                 "~> 1.2.1"
   spec.add_runtime_dependency "optimist",                "~> 3.0"
   spec.add_runtime_dependency "pg"
+  spec.add_runtime_dependency "pg-logical_replication"
   spec.add_runtime_dependency "rbnacl",                  ">= 3.2", "< 5.0"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-appliance_console
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - ManageIQ Developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -184,6 +184,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg-logical_replication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -303,7 +317,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: ManageIQ Appliance Console
-email: 
+email:
 executables:
 - appliance_console
 - appliance_console_cli
@@ -347,6 +361,7 @@ files:
 - lib/manageiq/appliance_console/logger.rb
 - lib/manageiq/appliance_console/logging.rb
 - lib/manageiq/appliance_console/logical_volume_management.rb
+- lib/manageiq/appliance_console/manageiq_user_mixin.rb
 - lib/manageiq/appliance_console/message_configuration.rb
 - lib/manageiq/appliance_console/message_configuration_client.rb
 - lib/manageiq/appliance_console/message_configuration_server.rb
@@ -367,7 +382,7 @@ homepage: https://github.com/ManageIQ/manageiq-appliance_console
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -382,8 +397,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.17
+signing_key:
 specification_version: 4
 summary: ManageIQ Appliance Console
 test_files: []