Module: Vagrant::LXC::Action

Defined in:
lib/vagrant-lxc/action.rb,
lib/vagrant-lxc/action/boot.rb,
lib/vagrant-lxc/action/create.rb,
lib/vagrant-lxc/action/created.rb,
lib/vagrant-lxc/action/destroy.rb,
lib/vagrant-lxc/action/message.rb,
lib/vagrant-lxc/action/disconnect.rb,
lib/vagrant-lxc/action/is_running.rb,
lib/vagrant-lxc/action/forced_halt.rb,
lib/vagrant-lxc/action/check_created.rb,
lib/vagrant-lxc/action/check_running.rb,
lib/vagrant-lxc/action/forward_ports.rb,
lib/vagrant-lxc/action/share_folders.rb,
lib/vagrant-lxc/action/warn_networks.rb,
lib/vagrant-lxc/action/compress_rootfs.rb,
lib/vagrant-lxc/action/destroy_confirm.rb,
lib/vagrant-lxc/action/handle_box_metadata.rb,
lib/vagrant-lxc/action/setup_package_files.rb,
lib/vagrant-lxc/action/clear_forwarded_ports.rb,
lib/vagrant-lxc/action/wait_for_communicator.rb,
lib/vagrant-lxc/action/remove_temporary_files.rb,
lib/vagrant-lxc/action/fetch_ip_with_lxc_attach.rb,
lib/vagrant-lxc/action/fetch_ip_from_dnsmasq_leases.rb

Defined Under Namespace

Classes: Boot, CheckCreated, CheckRunning, ClearForwardedPorts, CompressRootFS, Create, Created, Destroy, DestroyConfirm, Disconnect, FetchIpFromDnsmasqLeases, FetchIpWithLxcAttach, ForcedHalt, ForwardPorts, HandleBoxMetadata, IsRunning, Message, RemoveTemporaryFiles, SetupPackageFiles, ShareFolders, WaitForCommunicator, WarnNetworks

Constant Summary collapse

Builtin =

Shortcuts

Vagrant::Action::Builtin
Builder = 
Vagrant::Action::Builder

Class Method Summary collapse

Class Method Details

.action_boot ⇒ Object

This action boots the VM, assuming the VM is in a state that requires a bootup (i.e. not saved).



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/vagrant-lxc/action.rb', line 55

def self.action_boot
  Builder.new.tap do |b|
    b.use Builtin::Provision
    b.use Builtin::EnvSet, :port_collision_repair => true
    b.use Builtin::HandleForwardedPortCollisions
    b.use ShareFolders
    b.use Builtin::SetHostname
    b.use WarnNetworks
    b.use ForwardPorts
    b.use Boot
    b.use Builtin::WaitForCommunicator
  end
end

.action_destroy ⇒ Object

This is the action that is primarily responsible for completely freeing the resources of the underlying virtual machine.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/vagrant-lxc/action.rb', line 145

def self.action_destroy
  Builder.new.tap do |b|
    b.use Builtin::Call, Created do |env1, b2|
      if !env1[:result]
        b2.use Message, :not_created
        next
      end

      # TODO: Use Vagrant's built in action once we drop support for vagrant 1.2
      b2.use Builtin::Call, DestroyConfirm do |env2, b3|
        if env2[:result]
          b3.use Builtin::ConfigValidate
          b3.use Builtin::EnvSet, :force_halt => true
          b3.use action_halt
          b3.use Destroy
          if Vagrant::LXC.vagrant_1_3_or_later
            b3.use Builtin::ProvisionerCleanup
          end
        else
          b3.use Message, :will_not_destroy
        end
      end
    end
  end
end

.action_fetch_ip ⇒ Object

This action is called to read the IP of the container. The IP found is expected to be put into the ‘:machine_ip` key.



190
191
192
193
194
195
196
 
# File 'lib/vagrant-lxc/action.rb', line 190

def self.action_fetch_ip
  Builder.new.tap do |b|
    b.use Builtin::ConfigValidate
    b.use FetchIpWithLxcAttach
    b.use FetchIpFromDnsmasqLeases
  end
end

.action_halt ⇒ Object

This is the action that is primarily responsible for halting the virtual machine, gracefully or by force.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/vagrant-lxc/action.rb', line 123

def self.action_halt
  Builder.new.tap do |b|
    b.use Builtin::Call, Created do |env, b2|
      if env[:result]
        # TODO: Remove once we drop support for vagrant 1.1
        b2.use Disconnect
        b2.use ClearForwardedPorts
        b2.use RemoveTemporaryFiles
        b2.use Builtin::Call, Builtin::GracefulHalt, :stopped, :running do |env2, b3|
          if !env2[:result]
            b3.use ForcedHalt
          end
        end
      else
        b2.use Message, :not_created
      end
    end
  end
end

.action_package ⇒ Object

This action packages the virtual machine into a single box file.



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/vagrant-lxc/action.rb', line 172

def self.action_package
  Builder.new.tap do |b|
    b.use Builtin::Call, Created do |env1, b2|
      if !env1[:result]
        b2.use Message, :not_created
        next
      end

      b2.use action_halt
      b2.use CompressRootFS
      b2.use SetupPackageFiles
      b2.use Vagrant::Action::General::Package
    end
  end
end

.action_provision ⇒ Object

This action just runs the provisioners on the machine.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/vagrant-lxc/action.rb', line 70

def self.action_provision
  Builder.new.tap do |b|
    b.use Builtin::ConfigValidate
    b.use Builtin::Call, Created do |env1, b2|
      if !env1[:result]
        b2.use Message, :not_created
        next
      end

      b2.use Builtin::Call, IsRunning do |env2, b3|
        if !env2[:result]
          b3.use Message, :not_running
          next
        end

        b3.use Builtin::Provision
      end
    end
  end
end

.action_reload ⇒ Object

This action is responsible for reloading the machine, which brings it down, sucks in new configuration, and brings the machine back up with the new configuration.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vagrant-lxc/action.rb', line 38

def self.action_reload
  Builder.new.tap do |b|
    b.use Builtin::Call, Created do |env1, b2|
      if !env1[:result]
        b2.use Message, :not_created
        next
      end

      b2.use Builtin::ConfigValidate
      b2.use action_halt
      b2.use action_start
    end
  end
end

.action_ssh ⇒ Object

This is the action that will exec into an SSH shell.



199
200
201
202
203
204
205
 
# File 'lib/vagrant-lxc/action.rb', line 199

def self.action_ssh
  Builder.new.tap do |b|
    b.use CheckCreated
    b.use CheckRunning
    b.use Builtin::SSHExec
  end
end

.action_ssh_run ⇒ Object

This is the action that will run a single SSH command.



208
209
210
211
212
213
214
 
# File 'lib/vagrant-lxc/action.rb', line 208

def self.action_ssh_run
  Builder.new.tap do |b|
    b.use CheckCreated
    b.use CheckRunning
    b.use Builtin::SSHRun
  end
end

.action_start ⇒ Object

This action starts a container, assuming it is already created and exists. A precondition of this action is that the container exists.



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/vagrant-lxc/action.rb', line 93

def self.action_start
  Builder.new.tap do |b|
    b.use Builtin::ConfigValidate
    b.use Builtin::Call, IsRunning do |env, b2|
      # If the VM is running, then our work here is done, exit
      next if env[:result]
      b2.use action_boot
    end
  end
end

.action_up ⇒ Object

This action brings the machine up from nothing, including creating the container, configuring metadata, and booting.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/vagrant-lxc/action.rb', line 106

def self.action_up
  Builder.new.tap do |b|
    b.use Builtin::ConfigValidate
    b.use Builtin::Call, Created do |env, b2|
      # If the VM is NOT created yet, then do the setup steps
      if !env[:result]
        b2.use Builtin::HandleBoxUrl
        b2.use HandleBoxMetadata
        b2.use Create
      end
    end
    b.use action_start
  end
end