Module: VagrantPlugins::Libvirt::Action

Includes:
Vagrant::Action::Builtin
Defined in:
lib/vagrant-libvirt/action.rb,
lib/vagrant-libvirt/action/is_created.rb,
lib/vagrant-libvirt/action/is_running.rb,
lib/vagrant-libvirt/action/read_state.rb,
lib/vagrant-libvirt/action/halt_domain.rb,
lib/vagrant-libvirt/action/is_suspended.rb,
lib/vagrant-libvirt/action/start_domain.rb,
lib/vagrant-libvirt/action/sync_folders.rb,
lib/vagrant-libvirt/action/wait_till_up.rb,
lib/vagrant-libvirt/action/create_domain.rb,
lib/vagrant-libvirt/action/read_ssh_info.rb,
lib/vagrant-libvirt/action/resume_domain.rb,
lib/vagrant-libvirt/action/destroy_domain.rb,
lib/vagrant-libvirt/action/suspend_domain.rb,
lib/vagrant-libvirt/action/connect_libvirt.rb,
lib/vagrant-libvirt/action/timed_provision.rb,
lib/vagrant-libvirt/action/cleanup_data_dir.rb,
lib/vagrant-libvirt/action/handle_box_image.rb,
lib/vagrant-libvirt/action/set_name_of_domain.rb,
lib/vagrant-libvirt/action/handle_storage_pool.rb,
lib/vagrant-libvirt/action/message_not_created.rb,
lib/vagrant-libvirt/action/message_not_running.rb,
lib/vagrant-libvirt/action/create_domain_volume.rb,
lib/vagrant-libvirt/action/message_not_suspended.rb,
lib/vagrant-libvirt/action/message_already_created.rb,
lib/vagrant-libvirt/action/create_network_interfaces.rb

Defined Under Namespace

Classes: CleanupDataDir, ConnectLibvirt, CreateDomain, CreateDomainVolume, CreateNetworkInterfaces, DestroyDomain, HaltDomain, HandleBoxImage, HandleStoragePool, IsCreated, IsRunning, IsSuspended, MessageAlreadyCreated, MessageNotCreated, MessageNotRunning, MessageNotSuspended, ReadSSHInfo, ReadState, ResumeDomain, SetNameOfDomain, StartDomain, SuspendDomain, SyncFolders, TimedProvision, WaitTillUp

Class Method Summary collapse

Class Method Details

.action_destroy ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/vagrant-libvirt/action.rb', line 92

def self.action_destroy
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      if !env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use ConnectLibvirt
      b2.use DestroyDomain

      # Cleanup running instance data. Now only IP address is stored.
      b2.use CleanupDataDir
    end
  end
end

.action_halt ⇒ Object

This is the action that is primarily responsible for halting the virtual machine.



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
 
# File 'lib/vagrant-libvirt/action.rb', line 64

def self.action_halt
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use ConnectLibvirt
    b.use Call, IsCreated do |env, b2|
      if !env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsSuspended do |env2, b3|
        b3.use ResumeDomain if env2[:result]
      end

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

        # VM is running, halt it.. Cleanup running instance data. Now
        # only IP address is stored.
        b3.use HaltDomain
        b3.use CleanupDataDir
      end
    end
  end
end

.action_provision ⇒ Object

This action is called when ‘vagrant provision` is called.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/vagrant-libvirt/action.rb', line 134

def self.action_provision
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      if !env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use ConnectLibvirt
      b2.use Call, IsRunning do |env2, b3|
        if !env2[:result]
          b3.use MessageNotRunning
          next
        end

        b3.use Provision
        b3.use SyncFolders
      end
    end
  end
end

.action_read_ssh_info ⇒ Object

This action is called to read the SSH info of the machine. The resulting state is expected to be put into the ‘:machine_ssh_info` key.



216
217
218
219
220
221
222
 
# File 'lib/vagrant-libvirt/action.rb', line 216

def self.action_read_ssh_info
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use ConnectLibvirt
    b.use ReadSSHInfo
  end
end

.action_read_state ⇒ Object

This action is called to read the state of the machine. The resulting state is expected to be put into the ‘:machine_state_id` key.



205
206
207
208
209
210
211
 
# File 'lib/vagrant-libvirt/action.rb', line 205

def self.action_read_state
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use ConnectLibvirt
    b.use ReadState
  end
end

.action_resume ⇒ Object

This is the action that is primarily responsible for resuming suspended machines.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/vagrant-libvirt/action.rb', line 182

def self.action_resume
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      if !env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use ConnectLibvirt
      b2.use Call, IsSuspended do |env2, b3|
        if !env2[:result]
          b3.use MessageNotSuspended
          next
        end
        b3.use ResumeDomain
      end
    end
  end
end

.action_ssh ⇒ Object

This action is called to SSH into the machine.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/vagrant-libvirt/action.rb', line 111

def self.action_ssh
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      if !env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use ConnectLibvirt
      b2.use Call, IsRunning do |env2, b3|
        if !env2[:result]
          b3.use MessageNotRunning
          next
        end

        b3.use SSHExec
      end
    end
  end
end

.action_start ⇒ Object

Assuming VM is created, just start it. This action is not called directly by any subcommand. VM can be suspended, already running or in poweroff state.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/vagrant-libvirt/action.rb', line 38

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

      b2.use Call, IsSuspended do |env2, b3|
        if env2[:result]
          b3.use ResumeDomain
          next
        end

        # VM is not running or suspended. Start it.. Machine should gain
        # IP address when comming up, so wait for dhcp lease and store IP
        # into machines data_dir.
        b3.use StartDomain
        b3.use WaitTillUp
      end
    end
  end
end

.action_suspend ⇒ Object

This is the action that is primarily responsible for suspending the virtual machine.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/vagrant-libvirt/action.rb', line 159

def self.action_suspend
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      if !env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use ConnectLibvirt
      b2.use Call, IsRunning do |env2, b3|
        if !env2[:result]
          b3.use MessageNotRunning
          next
        end
        b3.use SuspendDomain
      end
    end
  end
end

.action_up ⇒ Object

This action is called to bring the box up from nothing.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/vagrant-libvirt/action.rb', line 10

def self.action_up
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use ConnectLibvirt
    b.use Call, IsCreated do |env, b2|
      # Create VM if not yet created.
      if !env[:result]
        b2.use SetNameOfDomain
        b2.use HandleStoragePool
        b2.use HandleBoxImage
        b2.use CreateDomainVolume
        b2.use CreateDomain
        b2.use CreateNetworkInterfaces

        b2.use TimedProvision
        b2.use StartDomain
        b2.use WaitTillUp
        b2.use SyncFolders
      else
        b2.use action_start
      end
    end
  end
end