class LXC

@param [Hash] options Options hash. @option options [Boolean] :use_sudo (false) Whether or not to prefix all

commands with 'sudo'.

@option options [Net::SSH,ZTK::SSH,nil] :use_ssh (nil) Whether or not to

execute all commands remotely via an SSH connection.

# File lib/lxc.rb, line 38
def initialize(options={})
  @ui       = (options[:ui] || ZTK::UI.new)
  @runner   = (options[:runner] || LXC::Runner::Shell.new(:ui => @ui))
end

Linux container configuration check

Runs the “lxc-checkconfig” command.

@param [Array] args Additional command-line arguments. @return [Array<String>] Output text of the “lxc-checkconfig” command.

# File lib/lxc.rb, line 126
def checkconfig(*args)
  ZTK::ANSI.uncolor(self.exec("lxc-checkconfig", *args)).split("\n")
end

LXC configuration class

Gets the LXC configuration class object

@return [LXC::Config] Returns the LXC configuration object.

# File lib/lxc.rb, line 48
def config
  @config ||= LXC::Config.new(self, "/etc/lxc/lxc.conf")
end

Initialize container object

Initalizes an LXC::Container class for the supplied container name.

@param [String] name The container name to initalize. @return [LXC::Container] Returns the container object.

# File lib/lxc.rb, line 58
def container(name)
  LXC::Container.new(:lxc => self, :name => name)
end

Current containers

Initalizes an LXC::Container object for all containers and returns them in an Array.

@return [Array<LXC::Container>]

# File lib/lxc.rb, line 68
def containers
  container_names = self.ls
  container_names.map do |container_name|
    LXC::Container.new(:lxc => self, :name => container_name)
  end
end

Linux container command execution wrapper

Runs the supplied LXC command. The first element in the “args” splat is the command to be execute, the rest of the elements are treated as command line arguments.

If use_sudo is true then all commands will be prefix with “sudo”. If use_ssh is non-nil then all commands will be execute via the assigned Net::SSH Session.

@param [Array] args Additional command-line arguments. @return [Array<String>] Stripped output text of the executed command.

# File lib/lxc.rb, line 156
def exec(*args)
  @runner.exec(*args)
end

Check if a container exists

Checks the container name list to see if the name supplied is an existing container.

@param [String] name The name of the container to check. @return [Boolean] Returns true of the container exists, false otherwise.

# File lib/lxc.rb, line 92
def exists?(name)
  self.ls(%(-1)).include?(name)
end

Provides a concise string representation of the class @return [String]

# File lib/lxc.rb, line 162
def inspect
  tags = Array.new
  tags << "version=#{self.version.inspect}"
  tags << "runner=#{@runner.inspect}" if @runner
  tags = tags.join(' ')

  "#<LXC #{tags}>"
end

Linux containers installed?

Checks the output of “lxc-checkconfig” to see if it returns a 'command not found' error.

@return [Boolean] True if LXC is installed; false otherwise.

# File lib/lxc.rb, line 136
def installed?
  if !!(self.checkconfig.join =~ /command not found/)
    false
  else
    true
  end
end

List of containers

Runs the “lxc-ls” command.

@param [Array] args Additional command-line arguments. @return [Array<String>] A list of container names.

# File lib/lxc.rb, line 81
def ls(*args)
  self.exec("lxc-ls", *args).split("\n").join(' ').split.uniq
end

Linux container processes

Runs the “lxc-ps” command.

@param [Array] args Additional command-line arguments. @return [Array<String>] Output text of the “lxc-ps” command.

# File lib/lxc.rb, line 102
def ps(*args)
  self.exec("lxc-ps", *args).split("\n")
end

Linux container version

Runs the “lxc-version” command.

@param [Array] args Additional command-line arguments. @return [String] The installed version of LXC. Returns nil if lxc-version

is not found.

# File lib/lxc.rb, line 113
def version(*args)
  result = self.exec("lxc-version", *args).scan(REGEX_VERSION).flatten.compact
  result.first.strip
rescue
  nil
end