odysseus-cli 0.3.0 → 0.9.0

data/bin/odysseus

@@ -3,17 +3,30 @@
 
 require 'odysseus'
 require 'odysseus/cli/cli'
+require 'odysseus/cli/version'
 require 'optparse'
 
+# `dependency` is the name; `dep` is shorthand; `accessory` is the former
+# name, kept for one release.
+DEPENDENCY_ALIASES = %w[dependency dep accessory].freeze
+
 def main
   # Debug mode: verbose output with no spinners
   debug_mode = ENV['ODYSSEUS_DEBUG'] == '1' || ARGV.include?('--debug')
   ARGV.delete('--debug')
 
+  # Answered before anything else so it works without a deploy.yml or a server.
+  # Note -v is taken by --verbose, so the flag spelling is --version only.
+  if ARGV[0] == 'version' || ARGV.include?('--version')
+    print_version
+    return
+  end
+
   cli = Odysseus::CLI::CLI.new(debug: debug_mode)
 
   commands = {
     'deploy' => { method: :deploy, needs_server: false },
+    'rollback' => { method: :rollback, needs_server: false },
     'build' => { method: :build, needs_server: false },
     'pussh' => { method: :pussh, needs_server: false },
     'status' => { method: :status, needs_server: true },
@@ -21,17 +34,24 @@ def main
     'logs' => { method: :logs, needs_server: true },
     'cleanup' => { method: :cleanup, needs_server: true },
     'validate' => { method: :validate, needs_server: false },
-    'accessory' => { method: :accessory_dispatch, needs_server: false },
-    'app' => { method: :app_dispatch, needs_server: false },
-    'secrets' => { method: :secrets_dispatch, needs_server: false }
+    'doctor' => { method: :doctor, needs_server: false },
+    'setup' => { method: :setup, needs_server: false }
   }
+  # `dependency`, `app` and `secrets` are not in the table: they have
+  # subcommands of their own and are handled by the guards below, which return
+  # before the table is read. The table used to list them anyway, naming
+  # methods — dependency_dispatch, app_dispatch, secrets_dispatch — that the
+  # CLI has never had. Unreachable, so harmless, until someone moved a guard.
 
   command = ARGV[0]
-  command_args = ARGV[1..-1] || []
-
-  # Handle accessory subcommands
-  if command == 'accessory'
-    handle_accessory_command(cli, command_args)
+  command_args = ARGV[1..] || []
+
+  # Handle dependency subcommands. `dep` is shorthand; `accessory` was the name
+  # before the rename and still works, with a notice — a silent alias never gets
+  # migrated away from.
+  if DEPENDENCY_ALIASES.include?(command)
+    puts "Note: 'accessory' was renamed to 'dependency'. The old name still works for now." if command == 'accessory'
+    handle_dependency_command(cli, command_args)
     return
   end
 
@@ -60,9 +80,10 @@ def main
     opts.on('--push', 'Push image to registry after build') { |v| options[:push] = v }
     opts.on('--context PATH', 'Build context path') { |v| options[:context] = v }
     opts.on('--build', 'Build image before pussh') { |v| options[:build] = v }
-    opts.on('--role ROLE', 'Role for logs command') { |v| options[:role] = v }
+    opts.on('--role ROLE', 'Server role: web, jobs, worker, ... (default: web)') { |v| options[:role] = v }
     opts.on('--service NAME', 'Service name') { |v| options[:service] = v }
     opts.on('--dry-run', 'Don\'t actually deploy') { |v| options[:'dry-run'] = v }
+    opts.on('--list', 'List rollback candidates per host without changing anything') { |v| options[:list] = v }
     opts.on('-v', '--verbose', 'Show commands being executed') { |v| options[:verbose] = v }
     # Cleanup options
     opts.on('--prune-images', 'Also prune dangling images') { |v| options[:all] = v }
@@ -70,8 +91,17 @@ def main
     opts.on('-f', '--follow', 'Follow log output') { |v| options[:follow] = v }
     opts.on('-n', '--lines N', Integer, 'Number of lines to show') { |v| options[:lines] = v }
     opts.on('--since TIME', 'Show logs since timestamp') { |v| options[:since] = v }
+    # Setup options
+    opts.on('--as USER', 'Bootstrap identity for setup (default: ubuntu)') { |v| options[:as] = v }
+    opts.on('--key PATH', 'Public key to install (repeatable; default: ssh.keys siblings)') do |v|
+      (options[:key] ||= []) << v
+    end
   end.parse!(command_args)
 
+  # rollback takes an optional positional VERSION; OptionParser#parse! has
+  # already removed the flags, so anything left is that argument.
+  options[:version] = command_args[0] if command == 'rollback' && command_args[0]
+
   cmd_info = commands[command]
 
   if cmd_info[:needs_server]
@@ -87,52 +117,52 @@ def main
   end
 end
 
-def handle_accessory_command(cli, args)
+def handle_dependency_command(cli, args)
   subcommand = args[0]
-  subcommand_args = args[1..-1] || []
+  subcommand_args = args[1..] || []
 
   # Commands that don't need a server argument (hosts come from config)
-  accessory_commands_no_server = {
-    'boot' => :accessory_boot,
-    'boot-all' => :accessory_boot_all,
-    'remove' => :accessory_remove,
-    'restart' => :accessory_restart,
-    'upgrade' => :accessory_upgrade,
-    'status' => :accessory_status
+  dependency_commands_no_server = {
+    'boot' => :dependency_boot,
+    'boot-all' => :dependency_boot_all,
+    'remove' => :dependency_remove,
+    'restart' => :dependency_restart,
+    'upgrade' => :dependency_upgrade,
+    'status' => :dependency_status
   }
 
   # Commands that need a server argument (for interactive/logs on specific host)
-  accessory_commands_with_server = {
-    'logs' => :accessory_logs,
-    'exec' => :accessory_exec,
-    'shell' => :accessory_shell
+  dependency_commands_with_server = {
+    'logs' => :dependency_logs,
+    'exec' => :dependency_exec,
+    'shell' => :dependency_shell
   }
 
-  all_commands = accessory_commands_no_server.merge(accessory_commands_with_server)
+  all_commands = dependency_commands_no_server.merge(dependency_commands_with_server)
 
   unless subcommand && all_commands[subcommand]
-    puts "Usage: odysseus accessory <subcommand> [options]"
-    puts ""
-    puts "Subcommands (hosts from config):"
-    puts "  boot                  Boot an accessory (requires --name)"
-    puts "  boot-all              Boot all accessories"
-    puts "  remove                Remove an accessory (requires --name)"
-    puts "  restart               Restart an accessory (requires --name)"
-    puts "  upgrade               Upgrade accessory to new image (requires --name)"
-    puts "  status                Show accessory status"
-    puts ""
-    puts "Subcommands (require server):"
-    puts "  logs <server>         Show accessory logs (requires --name)"
-    puts "  exec <server>         Execute command in accessory (requires --name)"
-    puts "  shell <server>        Open interactive shell in accessory (requires --name)"
-    puts ""
-    puts "Options:"
-    puts "  --config FILE         Path to deploy.yml (default: deploy.yml)"
-    puts "  --name NAME           Accessory name"
-    puts "  -f, --follow          Follow log output (logs only)"
-    puts "  -n, --lines N         Number of lines (logs only, default: 100)"
-    puts "  --since TIME          Show logs since timestamp (logs only)"
-    puts "  --command CMD         Command to execute (exec only)"
+    puts 'Usage: odysseus dependency <subcommand> [options]'
+    puts ''
+    puts 'Subcommands (hosts from config):'
+    puts '  boot                  Boot a dependency (requires --name)'
+    puts '  boot-all              Boot all dependencies'
+    puts '  remove                Remove a dependency (requires --name)'
+    puts '  restart               Restart a dependency (requires --name)'
+    puts '  upgrade               Upgrade a dependency to a new image (requires --name)'
+    puts '  status                Show dependency status'
+    puts ''
+    puts 'Subcommands (require server):'
+    puts '  logs <server>         Show dependency logs (requires --name)'
+    puts '  exec <server>         Execute a command in a dependency (requires --name)'
+    puts '  shell <server>        Open an interactive shell in a dependency (requires --name)'
+    puts ''
+    puts 'Options:'
+    puts '  --config FILE         Path to deploy.yml (default: deploy.yml)'
+    puts '  --name NAME           Dependency name'
+    puts '  -f, --follow          Follow log output (logs only)'
+    puts '  -n, --lines N         Number of lines (logs only, default: 100)'
+    puts '  --since TIME          Show logs since timestamp (logs only)'
+    puts '  --command CMD         Command to execute (exec only)'
     exit 1
   end
 
@@ -140,18 +170,18 @@ def handle_accessory_command(cli, args)
 
   OptionParser.new do |opts|
     opts.on('--config FILE', 'Path to deploy.yml') { |v| options[:config] = v }
-    opts.on('--name NAME', 'Accessory name') { |v| options[:name] = v }
+    opts.on('--name NAME', 'Dependency name') { |v| options[:name] = v }
     opts.on('-f', '--follow', 'Follow log output') { |v| options[:follow] = v }
     opts.on('-n', '--lines N', Integer, 'Number of lines') { |v| options[:lines] = v }
     opts.on('--since TIME', 'Show logs since timestamp') { |v| options[:since] = v }
     opts.on('--command CMD', 'Command to execute') { |v| options[:command] = v }
   end.parse!(subcommand_args)
 
-  if accessory_commands_with_server[subcommand]
+  if dependency_commands_with_server[subcommand]
     # These commands need a server argument
     server = subcommand_args[0]
     unless server
-      puts "Error: accessory #{subcommand} requires a server argument"
+      puts "Error: dependency #{subcommand} requires a server argument"
       exit 1
     end
     cli.send(all_commands[subcommand], server, options)
@@ -163,7 +193,7 @@ end
 
 def handle_app_command(cli, args)
   subcommand = args[0]
-  subcommand_args = args[1..-1] || []
+  subcommand_args = args[1..] || []
 
   app_commands = {
     'shell' => :app_shell,
@@ -172,17 +202,18 @@ def handle_app_command(cli, args)
   }
 
   unless subcommand && app_commands[subcommand]
-    puts "Usage: odysseus app <subcommand> <server> [options]"
-    puts ""
-    puts "Subcommands:"
-    puts "  shell <server>        Open an interactive shell in a temporary container"
-    puts "  exec <server>         Run a command in a new container (requires --command)"
-    puts "  console <server>      Start a custom console (e.g., rails c, irb)"
-    puts ""
-    puts "Options:"
-    puts "  --config FILE         Path to deploy.yml (default: deploy.yml)"
-    puts "  --command CMD         Command to execute (exec only)"
-    puts "  --cmd CMD             Console command (console only, default: /bin/sh)"
+    puts 'Usage: odysseus app <subcommand> <server> [options]'
+    puts ''
+    puts 'Subcommands:'
+    puts '  shell <server>        Open an interactive shell in a temporary container'
+    puts '  exec <server>         Run a command in a new container (requires --command)'
+    puts '  console <server>      Start a custom console (e.g., rails c, irb)'
+    puts ''
+    puts 'Options:'
+    puts '  --config FILE         Path to deploy.yml (default: deploy.yml)'
+    puts '  --role ROLE           Role whose image to run: web, jobs, ... (default: web)'
+    puts '  --command CMD         Command to execute (exec only)'
+    puts '  --cmd CMD             Console command (console only, default: /bin/sh)'
     exit 1
   end
 
@@ -190,6 +221,7 @@ def handle_app_command(cli, args)
 
   OptionParser.new do |opts|
     opts.on('--config FILE', 'Path to deploy.yml') { |v| options[:config] = v }
+    opts.on('--role ROLE', 'Server role: web, jobs, worker, ... (default: web)') { |v| options[:role] = v }
     opts.on('--command CMD', 'Command to execute') { |v| options[:command] = v }
     opts.on('--cmd CMD', 'Console command') { |v| options[:cmd] = v }
   end.parse!(subcommand_args)
@@ -205,7 +237,7 @@ end
 
 def handle_secrets_command(cli, args)
   subcommand = args[0]
-  subcommand_args = args[1..-1] || []
+  subcommand_args = args[1..] || []
 
   secrets_commands = {
     'generate-key' => :secrets_generate_key,
@@ -215,20 +247,20 @@ def handle_secrets_command(cli, args)
   }
 
   unless subcommand && secrets_commands[subcommand]
-    puts "Usage: odysseus secrets <subcommand> [options]"
-    puts ""
-    puts "Subcommands:"
-    puts "  generate-key          Generate a new master key"
-    puts "  encrypt               Encrypt a secrets file"
-    puts "  decrypt               Decrypt and display secrets"
-    puts "  edit                  Edit encrypted secrets"
-    puts ""
-    puts "Options:"
-    puts "  --file FILE           Path to secrets file (default: secrets.yml.enc)"
-    puts "  --input FILE          Input file to encrypt (encrypt only)"
-    puts ""
-    puts "Environment:"
-    puts "  ODYSSEUS_MASTER_KEY   Master key for encryption/decryption"
+    puts 'Usage: odysseus secrets <subcommand> [options]'
+    puts ''
+    puts 'Subcommands:'
+    puts '  generate-key          Generate a new master key'
+    puts '  encrypt               Encrypt a secrets file'
+    puts '  decrypt               Decrypt and display secrets'
+    puts '  edit                  Edit encrypted secrets'
+    puts ''
+    puts 'Options:'
+    puts '  --file FILE           Path to secrets file (default: secrets.yml.enc)'
+    puts '  --input FILE          Input file to encrypt (encrypt only)'
+    puts ''
+    puts 'Environment:'
+    puts '  ODYSSEUS_MASTER_KEY   Master key for encryption/decryption'
     exit 1
   end
 
@@ -242,52 +274,78 @@ def handle_secrets_command(cli, args)
   cli.send(secrets_commands[subcommand], options)
 end
 
+def print_version
+  puts "odysseus #{Odysseus::CLI::VERSION} (odysseus-core #{Odysseus::Core::VERSION})"
+  puts "ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL} [#{RUBY_PLATFORM}]"
+end
+
 def print_help
-  puts "Usage: odysseus <command> [options]"
-  puts ""
-  puts "Global options:"
-  puts "  --debug                   Verbose output (show all commands and details)"
-  puts "                            Or set ODYSSEUS_DEBUG=1 environment variable"
-  puts ""
-  puts "Commands:"
-  puts "  deploy                    Deploy all roles to servers defined in config"
-  puts "  build                     Build Docker image (locally or on build host)"
-  puts "  pussh                     Push image to hosts via SSH (no registry needed)"
-  puts "  status <server>           Show service status on server"
-  puts "  containers <server>       List containers for service on server"
-  puts "  logs <server>             Show logs for a service"
-  puts "  cleanup <server>          Clean up old containers and images"
-  puts "  validate                  Validate deploy.yml"
-  puts "  accessory <subcommand>    Manage accessories"
-  puts "  app <subcommand>          Run commands in app containers"
-  puts "  secrets <subcommand>      Manage encrypted secrets"
-  puts ""
-  puts "Options:"
-  puts "  --config FILE             Path to deploy.yml (default: deploy.yml)"
-  puts "  --image TAG               Docker image tag (default: latest)"
-  puts "  --service NAME            Service name (for containers command)"
+  puts 'Usage: odysseus <command> [options]'
+  puts ''
+  puts 'Global options:'
+  puts '  --debug                   Verbose output (show all commands and details)'
+  puts '                            Or set ODYSSEUS_DEBUG=1 environment variable'
+  puts '  --version                 Show odysseus, odysseus-core and ruby versions'
+  puts ''
+  puts 'Commands:'
+  puts '  deploy                    Deploy all roles to servers defined in config'
+  puts '  rollback [VERSION]        Roll every role back to a previously deployed version'
+  puts '  build                     Build Docker image (locally or on build host)'
+  puts '  pussh                     Push image to hosts via SSH (no registry needed)'
+  puts '  status <server>           Show service status on server'
+  puts '  containers <server>       List containers for service on server'
+  puts '  logs <server>             Show logs for a service'
+  puts '  cleanup <server>          Remove the service from a server: all its containers,'
+  puts '                            dependencies included, and its proxy routes'
+  puts '  validate                  Validate deploy.yml'
+  puts '  doctor                    Check that hosts are ready to deploy to (changes nothing)'
+  puts '  setup                     Prepare hosts: deploy user, docker group, key, state dir, Docker'
+  puts '  dependency <subcommand>    Manage dependencies (db, redis, ...); alias: dep'
+  puts '  app <subcommand>          Run commands in app containers'
+  puts '  secrets <subcommand>      Manage encrypted secrets'
+  puts '  version                   Show version information'
+  puts ''
+  puts 'Options:'
+  puts '  --config FILE             Path to deploy.yml (default: deploy.yml)'
+  puts '  --image TAG               Docker image tag (default: the git commit being deployed;'
+  puts '                            required outside a clean git repository)'
+  puts '  --service NAME            Service name (for containers command)'
   puts "  --dry-run                 Don't actually deploy"
-  puts "  -v, --verbose             Show commands being executed"
-  puts ""
-  puts "Deploy options:"
-  puts "  --build                   Build and distribute image before deploying"
-  puts "                            (uses registry if configured, otherwise pussh)"
-  puts ""
-  puts "Build options:"
-  puts "  --push                    Push image to registry after build"
-  puts "  --context PATH            Build context path (default: . relative to deploy.yml)"
-  puts ""
-  puts "Pussh options:"
-  puts "  --build                   Build image before pushing via SSH"
-  puts ""
-  puts "Logs options:"
-  puts "  --role ROLE               Role for logs: web, jobs, worker, etc (default: web)"
-  puts "  -f, --follow              Follow log output"
-  puts "  -n, --lines N             Number of lines to show (default: 100)"
+  puts '  -v, --verbose             Show commands being executed'
+  puts ''
+  puts 'Deploy options:'
+  puts '  --build                   Build and distribute image before deploying'
+  puts '                            (uses registry if configured, otherwise pussh)'
+  puts ''
+  puts 'Rollback options:'
+  puts '  --list                    Show each host: versions deployed, which images remain,'
+  puts '                            and what is serving. Changes nothing.'
+  puts ''
+  puts 'Build options:'
+  puts '  --push                    Push image to registry after build'
+  puts '  --context PATH            Build context path (default: . relative to deploy.yml)'
+  puts ''
+  puts 'Pussh options:'
+  puts '  --build                   Build image before pushing via SSH'
+  puts ''
+  puts 'App options:'
+  puts '  --role ROLE               Role whose running image to run: web, jobs, etc (default: web)'
+  puts '                            A service with no web role needs this on every host'
+  puts '  --command CMD             Command to run (app exec)'
+  puts '  --cmd CMD                 Console command (app console, default: /bin/sh)'
+  puts ''
+  puts 'Logs options:'
+  puts '  --role ROLE               Role to read logs from: web, jobs, worker, etc (default: web)'
+  puts '  -f, --follow              Follow log output'
+  puts '  -n, --lines N             Number of lines to show (default: 100)'
   puts "  --since TIME              Show logs since timestamp (e.g., '10m', '2h')"
-  puts ""
-  puts "Cleanup options:"
-  puts "  --prune-images            Also prune dangling images after removing containers"
+  puts ''
+  puts 'Cleanup options:'
+  puts '  --prune-images            Also prune dangling images after removing containers'
+  puts ''
+  puts 'Setup options:'
+  puts '  --as USER                 Bootstrap identity for setup (default: ubuntu)'
+  puts '  --key PATH                Public key to install (repeatable; default: ssh.keys siblings)'
 end
 
 main