Class: Subspace::Cli

Inherits:
Object
  • Object
show all
Includes:
Commander::Methods
Defined in:
lib/subspace/cli.rb

Instance Method Summary collapse

Instance Method Details

#run ⇒ Object

include whatever modules you need



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/subspace/cli.rb', line 25

def run
  program :name, 'subspace'
  program :version, Subspace::VERSION
  program :description, 'Ansible-backed server provisioning tool for rails'

  unless system("which ansible > /dev/null")
    puts "*** Subspace depends on ansible being on your PATH. Please install it: https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html"
    exit 1
  end

  command :init do |c|
    c.syntax = 'subspace init'
    c.summary = 'Run without options to initialize subspace.'
    c.description = 'Some initialization routines can be run indiviaully, useful for upgrading'
    c.example 'init a new project with one default environment (default staging)', 'subspace init'
    c.example 'create a new fully automated production environment configuration', 'subspace init --terraform --env production'
    c.option '--ansible', 'initialize ansible for managing individual servers'
    c.option '--terraform', 'Initialize terraform for managing infrastructure'
    c.option '--env STRING', 'Initialize configuration for a new environment'
    c.option '--template [staging|production]', 'Use non-default template for this environment (default=staging)'
    c.when_called Subspace::Commands::Init
  end

  command :bootstrap do |c|
    c.syntax = 'subspace boostrap [host]'
    c.summary = 'Install ansible requirements (python) and authorized_keys file'
    c.description = 'Ansible has very few dependencies, but python is one that is not installed by
    default on many linux images.  The bootstrap command will install python on a host as well as
    copy the authorized_keys file.  You will possibly need to type a password here.'
    c.option '--password', "Ask for a password instead of using ssh keys"
    c.option '--yum', "Use yum instead of apt to install python"
    c.option "-i", "--private-key PRIVATE-KEY", "Alias for private-key"
    c.when_called Subspace::Commands::Bootstrap
  end

  command :provision do |c|
    c.syntax = 'subspace provision [options]'
    c.summary = ''
    c.description = ''
    c.option "-i", "--private-key PRIVATE-KEY", "Alias for private-key"
    Subspace::Commands::Provision::PASS_THROUGH_PARAMS.each do |param_name|
      c.option "--#{param_name} #{param_name.upcase}", "Passed directly through to ansible-playbook command"
    end
    c.when_called Subspace::Commands::Provision
  end

  command :tf do |c|
    c.syntax = 'subspace tf [environment]'
    c.summary = "Execute a terraform plan with the option to apply the plan after review"
    c.when_called Subspace::Commands::Terraform
  end

  command :ssh do |c|
    c.syntax = 'subspace ssh [options]'
    c.summary = 'ssh to the remote server as the administrative user'
    c.description = ''
    c.option '--user USER', "Use a different user (eg deploy).  Default is the ansible_user"
    Subspace::Commands::Ssh::PASS_THROUGH_PARAMS.each do |param_name|
      c.option "-#{param_name} #{param_name.upcase}", "Passed directly through to ssh command"
    end
    c.when_called Subspace::Commands::Ssh
  end

  command :exec do |c|
    c.syntax = 'subspace exec <host-spec> "<statement>" [options]'
    c.summary = 'execute <statement> on all hosts matching <host-spec>'
    c.description = ''
    c.option '--user USER', "Use a different user (eg deploy).  Default is the ansible_user"
    Subspace::Commands::Exec::PASS_THROUGH_PARAMS.each do |param_name|
      c.option "-#{param_name} #{param_name.upcase}", "Passed directly through to ssh command"
    end
    c.when_called Subspace::Commands::Exec
  end

  command :configure do |c, args|
    c.syntax = 'subspace configure'
    c.summary = "Regenerate all of the ansible configuration files. You don't normally need to run this."
    c.description = ''
    c.when_called Subspace::Commands::Configure
  end

  command :override do |c, args|
    c.syntax = 'subspace override [role]'
    c.summary = 'Override a role configuration by copying the configuration locally'
    c.description = 'Copies the default role configuration to config/provision/<role> where it can be modified.'
    c.when_called Subspace::Commands::Override
  end

  command :secrets do |c, args|
    c.syntax = 'subspace secrets [environment]'
    c.summary = 'View or edit the encrypted variables for an environment'
    c.description = <<~EOS
      By default, this will simply show the variables for a specific environemnt.
      You can also edit variables, and we expect the functionality here to grow in the future.
      Running `subspace secrets development --create` is usually a great way to bootstrap a new development environment.
      EOS
    c.option '--edit', "Edit the variables instead of view"
    c.option '--create', "Create config/application.yml with the variables from the specified environment"
    c.when_called Subspace::Commands::Secrets
  end

  command :maintain do |c, args|
    c.syntax = 'subspace maintain [options]'
    c.summary = 'Runs provision with --tags=maintenance'
    c.description = ''
    c.option "-i", "--private-key PRIVATE-KEY", "Alias for private-key"
    Subspace::Commands::Maintain::PASS_THROUGH_PARAMS.each do |param_name|
      c.option "--#{param_name} #{param_name.upcase}", "Passed directly through to ansible-playbook command"
    end
    c.when_called Subspace::Commands::Maintain
  end

  command :maintenance_mode do |c, args|
    c.syntax = 'subspace maintenance_mode [options]'
    c.summary = 'Turns on or off maintenance mode'
    c.description = ''
    c.option "-i", "--private-key PRIVATE-KEY", "Alias for private-key"
    c.option "--on", "Turns on maintenance mode"
    c.option "--off", "Turns off maintenance mode"
    Subspace::Commands::MaintenanceMode::PASS_THROUGH_PARAMS.each do |param_name|
      c.option "--#{param_name} #{param_name.upcase}", "Passed directly through to ansible-playbook command"
    end
    c.when_called Subspace::Commands::MaintenanceMode
  end

  command :inventory do |c, args|
    c.syntax = 'subspace inventory <command>'
    c.summary = 'Manage, manipulate, and other useful inventory-related functions'
    c.description = <<~EOS
      Available inventory commands:

      capistrano - generate config/deploy/[env].rb.  Requires the --env option.
      list       - list the current inventory as understood by subspace.
      keyscan    - Update ~/.known_hosts with new host key fingerprints
      EOS
    c.option "--env ENVIRONMENT", "Optional: Limit function to a specific environment (aka group)"
    c.when_called Subspace::Commands::Inventory
  end

  run!
end