manageiq-appliance_console 7.1.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d06e58180ded69cdf13cb7651c0179c75682f3eb4d8b140217a26d3a5a83ca
-  data.tar.gz: 44c9e714f68ff5628b117362ddcd61f84a5102a56a123d0257f7c3fb79b750d9
+  metadata.gz: 9ad20683e3cdb9f2f4dfb894e34ba2dedd81aeb6e511db18caae12b92499d5c0
+  data.tar.gz: 4eee448a7715b15f61e325a066c500d7fd40af1b01683d74d74659d215e364cf
 SHA512:
-  metadata.gz: e82ac876ae854f370e79adc5a7684257bb179426e785691eb1e44bc4dc7972c666cdb8bf1479cc7e92d0f3bca32f8a674c856fc112fe3d7d99ea28f2ae2c7504
-  data.tar.gz: 18de59fabdae4811c610e1153f51113e3c2be1ded325504df6593c2c274aff34d0c7121eac3ebf1cf0e8ffb8d3452164f7271719ddc8770ccd973d236d11acd1
+  metadata.gz: 0f1d185402221742019cea8006f5cae97322c3a0fa01eb90cb5f1be821424e4ca3f2e5d2091cc9726b398e6485bc34bbf0c584f124af881607bb2ed470e23757
+  data.tar.gz: 440c7adb764a120a9690851f6046e4206be2d8c5bbc2ea998944646de5144de20031c4feeb98a49392f35743a1833ec529dd6f52ab77b43ce9404540e018e6fc

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [8.0.0] - 2022-10-18
+### Fixed
+- Don't require pressing any key twice for message configuration (#193)
+
+### Added
+- Report messaging configuration on summary info page (#190)
+
+### Changed
+- Refactor EvmServer operations (#194)
+- Only start evmserverd after all application configuration is done (#195)
+- **BREAKING** Don't start evmserverd until messaging is configured (#196)
+- Simplify messaging options by saving in yml files (#197)
+
+[Unreleased]: https://github.com/ManageIQ/manageiq-appliance_console/compare/v8.0.0...HEAD
+[8.0.0]: https://github.com/ManageIQ/manageiq-appliance_console/compare/v7.1.1..v8.0.0

data/bin/appliance_console

@@ -92,18 +92,26 @@ module ApplianceConsole
       eth0.reload
       eth0.parse_conf if eth0.respond_to?(:parse_conf)
 
-      host        = LinuxAdmin::Hosts.new.hostname
-      ip          = eth0.address
-      mac         = eth0.mac_address
-      mask        = eth0.netmask
-      gw          = eth0.gateway
-      dns1, dns2  = dns.nameservers
-      order       = dns.search_order.join(' ')
-      timezone    = LinuxAdmin::TimeDate.system_timezone
-      version     = File.read(VERSION_FILE).chomp if File.exist?(VERSION_FILE)
-      dbhost      = ManageIQ::ApplianceConsole::DatabaseConfiguration.database_host
-      database    = ManageIQ::ApplianceConsole::DatabaseConfiguration.database_name
-      evm_running = LinuxAdmin::Service.new("evmserverd").running?
+      host             = LinuxAdmin::Hosts.new.hostname
+      ip               = eth0.address
+      mac              = eth0.mac_address
+      mask             = eth0.netmask
+      gw               = eth0.gateway
+      dns1, dns2       = dns.nameservers
+      order            = dns.search_order.join(' ')
+      timezone         = LinuxAdmin::TimeDate.system_timezone
+      version          = File.read(VERSION_FILE).chomp if File.exist?(VERSION_FILE)
+      dbhost           = ManageIQ::ApplianceConsole::DatabaseConfiguration.database_host
+      database         = ManageIQ::ApplianceConsole::DatabaseConfiguration.database_name
+      messaging        = ManageIQ::ApplianceConsole::MessageConfiguration.configured?
+      messaging_broker = ManageIQ::ApplianceConsole::MessageServerConfiguration.configured?
+      evm_status       = if ManageIQ::ApplianceConsole::EvmServer.running?
+        "running"
+      elsif ManageIQ::ApplianceConsole::EvmServer.runnable?
+        "not running"
+      else
+        "not configured"
+      end
 
       summary_attributes = [
         summary_entry("Hostname", host),
@@ -117,9 +125,11 @@ module ApplianceConsole
         summary_entry("MAC Address", mac),
         summary_entry("Timezone", timezone),
         summary_entry("Local Database Server", PostgresAdmin.local_server_status),
-        summary_entry("#{I18n.t("product.name")} Server", evm_running ? "running" : "not running"),
+        summary_entry("#{I18n.t("product.name")} Server", evm_status),
         summary_entry("#{I18n.t("product.name")} Database", dbhost || "not configured"),
         summary_entry("Database/Region", database ? "#{database} / #{region.to_i}" : "not configured"),
+        summary_entry("Messaging", messaging ? "configured" : "not configured"),
+        summary_entry("Local Messaging Broker", messaging_broker ? "configured" : "not configured"),
         summary_entry("External Auth", ExternalHttpdAuthentication.config_status),
         summary_entry("#{I18n.t("product.name")} Version", version),
       ]
@@ -322,12 +332,11 @@ Static Network Configuration
 
       when I18n.t("advanced_settings.evmstop")
         say("#{selection}\n\n")
-        service = LinuxAdmin::Service.new("evmserverd")
-        if service.running?
+        if ManageIQ::ApplianceConsole::EvmServer.running?
           if ask_yn? "\nNote: It may take up to a few minutes for all #{I18n.t("product.name")} server processes to exit gracefully. Stop #{I18n.t("product.name")}"
             say("\nStopping #{I18n.t("product.name")} Server...")
             logger.info("EVM server stop initiated by appliance console.")
-            service.stop
+            ManageIQ::ApplianceConsole::EvmServer.stop
           end
         else
           say("\n#{I18n.t("product.name")} Server is not running...")
@@ -339,13 +348,7 @@ Static Network Configuration
         if ask_yn?("\nStart #{I18n.t("product.name")}")
           say("\nStarting #{I18n.t("product.name")} Server...")
           logger.info("EVM server start initiated by appliance console.")
-          begin
-            LinuxAdmin::Service.new("evmserverd").start
-          rescue AwesomeSpawn::CommandResultError => e
-            say e.result.output
-            say e.result.error
-            say ""
-          end
+          ManageIQ::ApplianceConsole::EvmServer.start
           press_any_key
         end
 
@@ -396,6 +399,14 @@ Static Network Configuration
 
         messaging_action = ask_with_menu("Configure Messaging", messaging_options)
 
+        changes_requested = database_action != "no_changes" || messaging_action != "no_changes"
+
+        # Stop evmserver while we make changes to the database and/or messaging configuration
+        if changes_requested
+          say("\nStopping #{I18n.t("product.name")} Server...")
+          ManageIQ::ApplianceConsole::EvmServer.stop
+        end
+
         database_configuration =
           case database_action
           when "create_internal"
@@ -431,13 +442,11 @@ Static Network Configuration
             raise MiqSignalError
           elsif message_server.ask_questions && message_server.configure
             say("\nMessage Server configured successfully.\n")
-            press_any_key
           else
             say("\nMessage Server configuration failed!\n")
             press_any_key
             raise MiqSignalError
           end
-
         when "message_client"
           say("#{selection}\n\n")
 
@@ -448,7 +457,6 @@ Static Network Configuration
             raise MiqSignalError
           elsif message_client.ask_questions && message_client.configure
             say("\nMessage Client configured successfully.\n")
-            press_any_key
           else
             say("\nMessage Client configuration failed!\n")
             press_any_key
@@ -456,6 +464,12 @@ Static Network Configuration
           end
         end
 
+        # Start evmserverd if database and/or messaging were set up and we are supposed to run as an evmserver
+        if changes_requested && database_configuration.run_as_evm_server
+          say("\nStarting #{I18n.t("product.name")} Server...")
+          ManageIQ::ApplianceConsole::EvmServer.start
+        end
+
         press_any_key
 
       when I18n.t("advanced_settings.db_replication")
@@ -553,13 +567,13 @@ Static Network Configuration
         when RE_RESTART
           if are_you_sure?("restart the appliance now")
             logger.info("Appliance restart initiated by appliance console.")
-            LinuxAdmin::Service.new("evmserverd").stop
+            ManageIQ::ApplianceConsole::EvmServer.stop
             LinuxAdmin::System.reboot!
           end
         when RE_DELLOGS
           if are_you_sure?("restart the appliance now")
             logger.info("Appliance restart with clean logs initiated by appliance console.")
-            LinuxAdmin::Service.new("evmserverd").stop
+            ManageIQ::ApplianceConsole::EvmServer.stop
             LinuxAdmin::Service.new("miqtop").stop
             LinuxAdmin::Service.new("miqvmstat").stop
             LinuxAdmin::Service.new("httpd").stop
@@ -575,7 +589,7 @@ Static Network Configuration
         if are_you_sure?("shut down the appliance now")
           say("\nShutting down appliance...  This process may take a few minutes.\n\n")
           logger.info("Appliance shutdown initiated by appliance console")
-          LinuxAdmin::Service.new("evmserverd").stop
+          ManageIQ::ApplianceConsole::EvmServer.stop
           LinuxAdmin::System.shutdown!
         end
 

data/lib/manageiq/appliance_console/cli.rb

@@ -529,15 +529,13 @@ module ApplianceConsole
     end
 
     def set_server_state
-      service = LinuxAdmin::Service.new("evmserverd")
-      service_running = service.running?
       case options[:server]
       when "start"
-        service.start unless service_running
+        EvmServer.start unless EvmServer.running?
       when "stop"
-        service.stop if service_running
+        EvmServer.stop if EvmServer.running?
       when "restart"
-        service.restart
+        EvmServer.restart
       else
         raise "Invalid server action"
       end

data/lib/manageiq/appliance_console/database_admin.rb

@@ -38,7 +38,7 @@ module ManageIQ
 
       def ask_questions
         setting_header
-        if action == :restore && LinuxAdmin::Service.new("evmserverd").running?
+        if action == :restore && EvmServer.running?
           say("\nDatabase restore failed. Please execute the \“Stop EVM Server Processes\” command and try again.")
           press_any_key
           raise MiqSignalError

data/lib/manageiq/appliance_console/database_configuration.rb

@@ -12,7 +12,7 @@ module ApplianceConsole
   class DatabaseConfiguration
     include ManageIQ::ApplianceConsole::ManageiqUserMixin
 
-    attr_accessor :adapter, :host, :username, :database, :port, :region
+    attr_accessor :adapter, :host, :username, :database, :port, :region, :run_as_evm_server
     attr_reader :password
 
     class ModelWithNoBackingTable < ActiveRecord::Base
@@ -38,6 +38,7 @@ module ApplianceConsole
       @adapter ||= "postgresql"
       # introduced by Logging
       self.interactive = true unless hash.key?(:interactive)
+      self.run_as_evm_server = true unless hash.key?(:run_as_evm_server)
     end
 
     def run_interactive
@@ -48,7 +49,6 @@ module ApplianceConsole
 
       raise MiqSignalError unless activate
 
-      post_activation
       say("\nConfiguration activated successfully.\n")
     rescue RuntimeError => e
       puts "Configuration failed#{": " + e.message unless e.class == MiqSignalError}"
@@ -236,18 +236,6 @@ FRIENDLY
       end
     end
 
-    def start_evm
-      pid = fork do
-        begin
-          LinuxAdmin::Service.new("evmserverd").start(true)
-        rescue => e
-          logger.error("Failed to enable and start evmserverd service: #{e.message}")
-          logger.error(e.backtrace.join("\n"))
-        end
-      end
-      Process.detach(pid)
-    end
-
     private
 
     def self.rails_env

data/lib/manageiq/appliance_console/evm_server.rb

@@ -0,0 +1,66 @@
+module ManageIQ
+  module ApplianceConsole
+    class EvmServer
+      class NotRunnableError < RuntimeError; end
+
+      class << self
+        def running?
+          service.running?
+        end
+
+        def start!(enable: false)
+          raise NotRunnableError, "Cannot start #{I18n.t("product.name")}: #{not_runnable_reason}" unless runnable?
+
+          service.start(enable)
+        end
+
+        def start(enable: false)
+          start!(:enable => enable)
+        rescue AwesomeSpawn::CommandResultError => e
+          say(e.result.output)
+          say(e.result.error)
+          say("")
+          false
+        rescue NotRunnableError => e
+          say(e.to_s)
+          say("")
+          false
+        end
+
+        def stop
+          service.stop
+        end
+
+        def restart
+          service.restart
+        end
+
+        def enable
+          service.enable
+        end
+
+        def disable
+          service.disable
+        end
+
+        def runnable?
+          DatabaseConfiguration.database_yml_configured? && MessageConfiguration.configured?
+        end
+
+        def not_runnable_reason
+          if !DatabaseConfiguration.database_yml_configured?
+            "A Database connection has not been configured."
+          elsif !MessageConfiguration.configured?
+            "Messaging has not been configured."
+          end
+        end
+
+        private
+
+        def service
+          @service ||= LinuxAdmin::Service.new("evmserverd")
+        end
+      end
+    end
+  end
+end

data/lib/manageiq/appliance_console/external_database_configuration.rb

@@ -25,10 +25,6 @@ module ApplianceConsole
       say("Database Configuration\n")
       ask_for_database_credentials(false)
     end
-
-    def post_activation
-      start_evm
-    end
   end
 end
 end

data/lib/manageiq/appliance_console/internal_database_configuration.rb

@@ -5,7 +5,7 @@ require "linux_admin"
 module ManageIQ
 module ApplianceConsole
   class InternalDatabaseConfiguration < DatabaseConfiguration
-    attr_accessor :disk, :run_as_evm_server
+    attr_accessor :disk
 
     DEDICATED_DB_SHARED_BUFFERS = "'1GB'".freeze
     SHARED_DB_SHARED_BUFFERS = "'128MB'".freeze
@@ -24,10 +24,9 @@ module ApplianceConsole
     end
 
     def set_defaults
-      self.host              = 'localhost'
-      self.username          = "root"
-      self.database          = "vmdb_production"
-      self.run_as_evm_server = true
+      self.host     = 'localhost'
+      self.username = "root"
+      self.database = "vmdb_production"
     end
 
     def activate
@@ -109,10 +108,6 @@ module ApplianceConsole
       copy_template "pg_ident.conf"
     end
 
-    def post_activation
-      start_evm if run_as_evm_server
-    end
-
     private
 
     def mount_point

data/lib/manageiq/appliance_console/logfile_configuration.rb

@@ -20,7 +20,7 @@ module ApplianceConsole
 
       self.size = Utilities.disk_usage(LOGFILE_DIRECTORY)[0][:total_bytes]
       self.current_logrotate_count = /rotate\s+(\d+)/.match(File.read(MIQ_LOGS_CONF))[1]
-      self.evm_was_running = LinuxAdmin::Service.new("evmserverd").running?
+      self.evm_was_running = EvmServer.running?
     end
 
     def activate
@@ -103,13 +103,13 @@ module ApplianceConsole
 
     def start_evm
       say 'Starting EVM'
-      LinuxAdmin::Service.new("evmserverd").enable.start
+      EvmServer.start(:enable => true)
       LinuxAdmin::Service.new("httpd").enable.start
     end
 
     def stop_evm
       say 'Stopping EVM'
-      LinuxAdmin::Service.new("evmserverd").stop
+      EvmServer.stop
       LinuxAdmin::Service.new("httpd").stop
     end
   end

data/lib/manageiq/appliance_console/message_configuration.rb

@@ -26,6 +26,10 @@ module ManageIQ
         File.exist?("#{BASE_DIR}/bin/kafka-run-class.sh")
       end
 
+      def self.configured?
+        MessageServerConfiguration.configured? || MessageClientConfiguration.configured?
+      end
+
       def initialize(options = {})
         @message_server_port        = options[:message_server_port] || 9093
         @message_keystore_username  = options[:message_keystore_username] || "admin"
@@ -108,20 +112,16 @@ module ManageIQ
 
         messaging_yaml = YAML.load_file(messaging_yaml_sample_path)
 
-        messaging_yaml["production"].delete("username")
-        messaging_yaml["production"].delete("password")
-
-        messaging_yaml["production"]["hostname"]          = message_server_host
-        messaging_yaml["production"]["port"]              = message_server_port
-        messaging_yaml["production"]["sasl.mechanism"]    = "PLAIN"
-        messaging_yaml["production"]["sasl.username"]     = message_keystore_username
-        messaging_yaml["production"]["sasl.password"]     = ManageIQ::Password.try_encrypt(message_keystore_password)
+        messaging_yaml["production"]["host"]      = message_server_host
+        messaging_yaml["production"]["port"]      = message_server_port
+        messaging_yaml["production"]["username"]  = message_keystore_username
+        messaging_yaml["production"]["password"]  = ManageIQ::Password.try_encrypt(message_keystore_password)
 
         if secure?
-          messaging_yaml["production"]["security.protocol"] = "SASL_SSL"
-          messaging_yaml["production"]["ssl.ca.location"]   = ca_cert_path.to_path
+          messaging_yaml["production"]["ssl"]     = true
+          messaging_yaml["production"]["ca_file"] = ca_cert_path.to_path
         else
-          messaging_yaml["production"]["security.protocol"] = "PLAINTEXT"
+          messaging_yaml["production"]["ssl"] = false
         end
 
         File.open(messaging_yaml_path, "w") do |f|
@@ -183,21 +183,7 @@ module ManageIQ
         true
       end
 
-      def configure_messaging_type(value)
-        say(__method__.to_s.tr("_", " ").titleize)
-
-        ManageIQ::ApplianceConsole::Utilities.rake_run!("evm:settings:set", ["/prototype/messaging_type=#{value}"])
-      end
-
-      def restart_evmserverd
-        say("Restart evmserverd if it is running...")
-        evmserverd_service = LinuxAdmin::Service.new("evmserverd")
-        evmserverd_service.restart if evmserverd_service.running?
-      end
-
       def unconfigure
-        configure_messaging_type("miq_queue") # Settings.prototype.messaging_type = 'miq_queue'
-        restart_evmserverd
         remove_installed_files
       end
 

data/lib/manageiq/appliance_console/message_configuration_client.rb

@@ -29,8 +29,6 @@ module ManageIQ
           configure_messaging_yaml          # Set up the local message client in case EVM is actually running on this, Message Server
           create_client_properties          # Create the client.properties configuration fle
           fetch_truststore_from_server      # Fetch the Java Keystore from the Kafka Server
-          configure_messaging_type("kafka") # Settings.prototype.messaging_type = 'kafka'
-          restart_evmserverd
         rescue AwesomeSpawn::CommandResultError => e
           say(e.result.output)
           say(e.result.error)
@@ -77,6 +75,10 @@ module ManageIQ
         fetch_from_server(message_ca_cert_path_src, ca_cert_path)
       end
 
+      def self.configured?
+        MessageClientConfiguration.new.installed_files.all? { |f| File.exist?(f) }
+      end
+
       private
 
       def fetch_from_server(src_file, dst_file)

data/lib/manageiq/appliance_console/message_configuration_server.rb

@@ -43,7 +43,6 @@ module ManageIQ
           configure_keystore                # Populate the Java Keystore
           create_server_properties          # Update the /opt/message/config/server.properties
           configure_messaging_yaml          # Set up the local message client in case EVM is actually running on this, Message Server
-          configure_messaging_type("kafka") # Settings.prototype.messaging_type = 'kafka'
           restart_services
         rescue AwesomeSpawn::CommandResultError => e
           say(e.result.output)
@@ -64,14 +63,17 @@ module ManageIQ
 
         say("Starting kafka and configure it to start on reboots ...")
         LinuxAdmin::Service.new("kafka").start.enable
-
-        restart_evmserverd
       end
 
       def ask_for_parameters
         say("\nMessage Server Parameters:\n\n")
 
         @message_server_host       = ask_for_string("Message Server Hostname or IP address", message_server_host)
+
+        # SSL Validation for Kafka does not work for hostnames containing "localhost"
+        # Therefore we replace with the equivalent IP "127.0.0.1" if a /localhost*/ hostname was entered
+        @message_server_host       = "127.0.0.1" if @message_server_host.include?("localhost")
+
         @message_keystore_username = ask_for_string("Message Keystore Username", message_keystore_username)
         @message_keystore_password = ask_for_password("Message Keystore Password")
         @message_persistent_disk   = ask_for_persistent_disk

data/lib/manageiq/appliance_console/utilities.rb

@@ -27,8 +27,13 @@ module ApplianceConsole
     end
 
     def self.db_connections
+      # TODO: this is impossible to test right now because we need to shell out and run our rails app which isn't a direct dependency here.
+      # We have the settings from the database_configuration, so we should pass them here and simplify this and make it testable.
+      # Basically, we're doing a lot of work to run this 1 query:
+      #   psql -U username -h host postgres -c "select count(*) from pg_stat_activity where datname = 'vmdb_production';"
+      # We shouldn't need to subtract our 1 "connection" in "bail_if_db_connections" if we connect to the postgres db.
       code   = [
-        "database ||= ActiveRecord::Base.configurations[Rails.env]['database']",
+        "database ||= ActiveRecord::Base.configurations.configs_for(:env_name => Rails.env).first.database",
         "conn = ActiveRecord::Base.connection",
         "exit conn.client_connections.count { |c| c['database'] == database }"
       ]

data/lib/manageiq/appliance_console/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module ApplianceConsole
-    VERSION = '7.1.0'.freeze
+    VERSION = '8.0.0'.freeze
   end
 end

data/lib/manageiq-appliance_console.rb

@@ -34,6 +34,7 @@ require 'manageiq/appliance_console/database_replication_standby'
 require 'manageiq/appliance_console/external_auth_options'
 require 'manageiq/appliance_console/external_database_configuration'
 require 'manageiq/appliance_console/external_httpd_authentication'
+require 'manageiq/appliance_console/evm_server'
 require 'manageiq/appliance_console/internal_database_configuration'
 require 'manageiq/appliance_console/key_configuration'
 require 'manageiq/appliance_console/logfile_configuration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-appliance_console
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 8.0.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -346,6 +346,7 @@ files:
 - ".travis.yml"
 - ".whitesource"
 - ".yamllint"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -363,6 +364,7 @@ files:
 - lib/manageiq/appliance_console/database_replication_primary.rb
 - lib/manageiq/appliance_console/database_replication_standby.rb
 - lib/manageiq/appliance_console/errors.rb
+- lib/manageiq/appliance_console/evm_server.rb
 - lib/manageiq/appliance_console/external_auth_options.rb
 - lib/manageiq/appliance_console/external_database_configuration.rb
 - lib/manageiq/appliance_console/external_httpd_authentication.rb
@@ -410,7 +412,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: ManageIQ Appliance Console