beckermj/vaguerent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Extract container plugin

Browse Source
This commit is contained in:
sophia 2020-03-30 12:09:33 -04:00
parent 4c74f8a112
commit 0c0c361386
16 changed files with 388 additions and 363 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

203
plugins/provisioners/container/client.rb Normal file
View File

@ -0,0 +1,203 @@
require 'digest/sha1'
module VagrantPlugins
module ContainerProvisioner
class Client
def initialize(machine, container_command)
@machine = machine
@container_command = container_command
end
# Build an image given a path to a Dockerfile
#
# @param [String] - Path to the Dockerfile to pass to
# container build command
def build_images(images)
@machine.communicate.tap do |comm|
images.each do |path, opts|
@machine.ui.info(I18n.t("vagrant.container_building_single", path: path))
comm.sudo("#{@container_command} build #{opts[:args]} #{path}") do |type, data|
handle_comm(type, data)
end
end
end
end
# Pull image given a list of images
#
# @param [String] - Image name
def pull_images(*images)
@machine.communicate.tap do |comm|
images.each do |image|
@machine.ui.info(I18n.t("vagrant.container_pulling_single", name: image))
comm.sudo("#{@container_command} pull #{image}") do |type, data|
handle_comm(type, data)
end
end
end
end
def run(containers)
containers.each do |name, config|
cids_dir = "/var/lib/vagrant/cids"
config[:cidfile] ||= "#{cids_dir}/#{Digest::SHA1.hexdigest name}"
@machine.ui.info(I18n.t("vagrant.container_running", name: name))
@machine.communicate.sudo("mkdir -p #{cids_dir}")
run_container({
name: name,
original_name: name,
}.merge(config))
end
end
# Run a OCI container. If the container does not exist it will be
# created. If the image is stale it will be recreated and restarted
def run_container(config)
raise "Container's cidfile was not provided!" if !config[:cidfile]
id = "$(cat #{config[:cidfile]})"
if container_exists?(id)
if container_args_changed?(config)
@machine.ui.info(I18n.t("vagrant.container_restarting_container_args",
name: config[:name],
))
stop_container(id)
create_container(config)
elsif container_image_changed?(config)
@machine.ui.info(I18n.t("vagrant.container_restarting_container_image",
name: config[:name],
))
stop_container(id)
create_container(config)
else
start_container(id)
end
else
create_container(config)
end
end
def container_exists?(id)
lookup_container(id, true)
end
# Start container
#
# @param String - Image id
def start_container(id)
if !container_running?(id)
@machine.communicate.sudo("#{@container_command} start #{id}")
end
end
# Stop and remove container
#
# @param String - Image id
def stop_container(id)
@machine.communicate.sudo %[
#{@container_command} stop #{id}
#{@container_command} rm #{id}
]
end
def container_running?(id)
lookup_container(id)
end
def container_image_changed?(config)
# Returns true if there is a container running with the given :name,
# and the container is not using the latest :image.
# Here, "<cmd> inspect <container>" returns the id of the image
# that the container is using. We check that the latest image that
# has been built with that name (:image) matches the one that the
# container is running.
cmd = ("#{@container_command} inspect --format='{{.Image}}' #{config[:name]} |" +
" grep $(#{@container_command} images -q #{config[:image]})")
return !@machine.communicate.test(cmd)
end
def container_args_changed?(config)
path = container_data_path(config)
return true if !path.exist?
args = container_run_args(config)
sha = Digest::SHA1.hexdigest(args)
return true if path.read.chomp != sha
return false
end
def create_container(config)
args = container_run_args(config)
@machine.communicate.sudo %[rm -f "#{config[:cidfile]}"]
@machine.communicate.sudo %[#{@container_command} run #{args}]
sha = Digest::SHA1.hexdigest(args)
container_data_path(config).open("w+") do |f|
f.write(sha)
end
end
# Looks up if a container with a given id exists using the
# `ps` command. Returns Boolean
#
# @param String - Image id
def lookup_container(id, list_all = false)
container_ps = "sudo #{@container_command} ps -q"
container_ps << " -a" if list_all
@machine.communicate.tap do |comm|
return comm.test("#{container_ps} --no-trunc | grep -wFq #{id}")
end
end
def container_name(config)
name = config[:name]
# If the name is the automatically assigned name, then
# replace the "/" with "-" because "/" is not a valid
# character for a container name.
name = name.gsub("/", "-") if name == config[:original_name]
name
end
# Compiles run arguments to be appended to command string.
# Returns String
def container_run_args(config)
name = container_name(config)
args = "--cidfile=#{config[:cidfile]} "
args << "-d " if config[:daemonize]
args << "--name #{name} " if name && config[:auto_assign_name]
args << "--restart=#{config[:restart]}" if config[:restart]
args << " #{config[:args]}" if config[:args]
"#{args} #{config[:image]} #{config[:cmd]}".strip
end
def container_data_path(config)
name = container_name(config)
@machine.data_dir.join("#{@container_command}-#{name}")
end
protected
# This handles outputting the communication data back to the UI
def handle_comm(type, data)
if [:stderr, :stdout].include?(type)
# Clear out the newline since we add one
data = data.chomp
return if data.empty?
options = {}
#options[:color] = color if !config.keep_color
@machine.ui.info(data.chomp, options)
end
end
end
end
end

83
plugins/provisioners/container/config.rb Normal file
View File

@ -0,0 +1,83 @@
require 'set'
module VagrantPlugins
module ContainerProvisioner
class Config < Vagrant.plugin("2", :config)
attr_reader :images
attr_accessor :post_install_provisioner
def initialize
@images = Set.new
@post_install_provisioner = nil
@__build_images = []
@__containers = Hash.new { |h, k| h[k] = {} }
end
# Accessor for internal state.
def build_images
@__build_images
end
# Accessor for the internal state.
def containers
@__containers
end
# Defines an image to build using `<cmd> build` within the machine.
#
# @param [String] path Path to the Dockerfile to pass to
# container build command
def build_image(path, **opts)
@__build_images << [path, opts]
end
def images=(images)
@images = Set.new(images)
end
def pull_images(*images)
@images += images.map(&:to_s)
end
def post_install_provision(name, **options, &block)
proxy = VagrantPlugins::Kernel_V2::VMConfig.new
proxy.provision(name, **options, &block)
@post_install_provisioner = proxy.provisioners.first
end
def run(name, **options)
@__containers[name.to_s] = options.dup
end
def merge(other)
super.tap do |result|
result.pull_images(*(other.images + self.images))
build_images = @__build_images.dup
build_images += other.build_images
result.instance_variable_set(:@__build_images, build_images)
containers = {}
@__containers.each do |name, params|
containers[name] = params.dup
end
other.containers.each do |name, params|
containers[name] = @__containers[name].merge(params)
end
result.instance_variable_set(:@__containers, containers)
end
end
def finalize!
@__containers.each do |name, params|
params[:image] ||= name
params[:auto_assign_name] = true if !params.key?(:auto_assign_name)
params[:daemonize] = true if !params.key?(:daemonize)
params[:restart] = "always" if !params.key?(:restart)
end
end
end
end
end

13
plugins/provisioners/container/installer.rb Normal file
View File

@ -0,0 +1,13 @@
module VagrantPlugins
module ContainerProvisioner
class Installer
def initialize(machine)
@machine = machine
end
def ensure_installed
# nothing to do
end
end
end
end

23
plugins/provisioners/container/plugin.rb Normal file
View File

@ -0,0 +1,23 @@
require "vagrant"
module VagrantPlugins
module ContainerProvisioner
class Plugin < Vagrant.plugin("2")
name "container"
description <<-DESC
Provides support for provisioning your virtual machines with
OCI images and containers.
DESC
config(:container, :provisioner) do
require_relative "config"
Config
end
provisioner(:container) do
require_relative "provisioner"
Provisioner
end
end
end
end

28
plugins/provisioners/container/provisioner.rb Normal file
View File

@ -0,0 +1,28 @@
require_relative "client"
require_relative "installer"
module VagrantPlugins
module ContainerProvisioner
class Provisioner < Vagrant.plugin("2", :provisioner)
def initialize(machine, config, installer = nil, client = nil)
super(machine, config)
@installer = installer || Installer.new(@machine)
@client = client || Client.new(@machine, "")
@logger = Log4r::Logger.new("vagrant::provisioners::container")
end
def provision
# nothing to do
end
def run_provisioner(env)
klass = Vagrant.plugin("2").manager.provisioners[env[:provisioner].type]
result = klass.new(env[:machine], env[:provisioner].config)
result.config.finalize!
result.provision
end
end
end
end

179
plugins/provisioners/docker/client.rb
View File

@ -1,32 +1,11 @@
require 'digest/sha1'
require_relative "../container/client"
module VagrantPlugins
module DockerProvisioner
class Client
class Client < VagrantPlugins::ContainerProvisioner::Client
def initialize(machine)
@machine = machine
end
def build_images(images)
@machine.communicate.tap do |comm|
images.each do |path, opts|
@machine.ui.info(I18n.t("vagrant.docker_building_single", path: path))
comm.sudo("docker build #{opts[:args]} #{path}") do |type, data|
handle_comm(type, data)
end
end
end
end
def pull_images(*images)
@machine.communicate.tap do |comm|
images.each do |image|
@machine.ui.info(I18n.t("vagrant.docker_pulling_single", name: image))
comm.sudo("docker pull #{image}") do |type, data|
handle_comm(type, data)
end
end
end
super(machine, "docker")
@container_command = "docker"
end
def start_service
@ -39,156 +18,6 @@ module VagrantPlugins
@machine.guest.capability(:docker_daemon_running)
end
def run(containers)
containers.each do |name, config|
cids_dir = "/var/lib/vagrant/cids"
config[:cidfile] ||= "#{cids_dir}/#{Digest::SHA1.hexdigest name}"
@machine.ui.info(I18n.t("vagrant.docker_running", name: name))
@machine.communicate.sudo("mkdir -p #{cids_dir}")
run_container({
name: name,
original_name: name,
}.merge(config))
end
end
def run_container(config)
raise "Container's cidfile was not provided!" if !config[:cidfile]
id = "$(cat #{config[:cidfile]})"
if container_exists?(id)
if container_args_changed?(config)
@machine.ui.info(I18n.t("vagrant.docker_restarting_container_args",
name: config[:name],
))
stop_container(id)
create_container(config)
elsif container_image_changed?(config)
@machine.ui.info(I18n.t("vagrant.docker_restarting_container_image",
name: config[:name],
))
stop_container(id)
create_container(config)
else
start_container(id)
end
else
create_container(config)
end
end
def container_exists?(id)
lookup_container(id, true)
end
def start_container(id)
if !container_running?(id)
@machine.communicate.sudo("docker start #{id}")
end
end
def stop_container(id)
@machine.communicate.sudo %[
docker stop #{id}
docker rm #{id}
]
end
def container_running?(id)
lookup_container(id)
end
def container_image_changed?(config)
# Returns true if there is a container running with the given :name,
# and the container is not using the latest :image.
# Here, "docker inspect <container>" returns the id of the image
# that the container is using. We check that the latest image that
# has been built with that name (:image) matches the one that the
# container is running.
cmd = ("docker inspect --format='{{.Image}}' #{config[:name]} |" +
" grep $(docker images -q #{config[:image]})")
return !@machine.communicate.test(cmd)
end
def container_args_changed?(config)
path = container_data_path(config)
return true if !path.exist?
args = container_run_args(config)
sha = Digest::SHA1.hexdigest(args)
return true if path.read.chomp != sha
return false
end
def create_container(config)
args = container_run_args(config)
@machine.communicate.sudo %[rm -f "#{config[:cidfile]}"]
@machine.communicate.sudo %[docker run #{args}]
sha = Digest::SHA1.hexdigest(args)
container_data_path(config).open("w+") do |f|
f.write(sha)
end
end
def lookup_container(id, list_all = false)
docker_ps = "sudo docker ps -q"
docker_ps << " -a" if list_all
@machine.communicate.tap do |comm|
# Docker < 0.7.0 stores container IDs using its short version while
# recent versions use the full container ID
# using full container ID from now on.
return comm.test("#{docker_ps} --no-trunc | grep -wFq #{id}")
end
end
def container_name(config)
name = config[:name]
# If the name is the automatically assigned name, then
# replace the "/" with "-" because "/" is not a valid
# character for a docker container name.
name = name.gsub("/", "-") if name == config[:original_name]
name
end
def container_run_args(config)
name = container_name(config)
args = "--cidfile=#{config[:cidfile]} "
args << "-d " if config[:daemonize]
args << "--name #{name} " if name && config[:auto_assign_name]
args << "--restart=#{config[:restart]}" if config[:restart]
args << " #{config[:args]}" if config[:args]
"#{args} #{config[:image]} #{config[:cmd]}".strip
end
def container_data_path(config)
name = container_name(config)
@machine.data_dir.join("docker-#{name}")
end
protected
# This handles outputting the communication data back to the UI
def handle_comm(type, data)
if [:stderr, :stdout].include?(type)
# Clear out the newline since we add one
data = data.chomp
return if data.empty?
options = {}
#options[:color] = color if !config.keep_color
@machine.ui.info(data.chomp, options)
end
end
end
end
end

74
plugins/provisioners/docker/config.rb
View File

@ -1,45 +1,8 @@
require 'set'
require_relative "../container/config"
module VagrantPlugins
module DockerProvisioner
class Config < Vagrant.plugin("2", :config)
attr_reader :images
attr_accessor :post_install_provisioner
def initialize
@images = Set.new
@post_install_provisioner = nil
@__build_images = []
@__containers = Hash.new { |h, k| h[k] = {} }
end
# Accessor for internal state.
def build_images
@__build_images
end
# Accessor for the internal state.
def containers
@__containers
end
# Defines an image to build using `docker build` within the machine.
#
# @param [String] path Path to the Dockerfile to pass to
# `docker build`.
def build_image(path, **opts)
@__build_images << [path, opts]
end
def images=(images)
@images = Set.new(images)
end
def pull_images(*images)
@images += images.map(&:to_s)
end
class Config < VagrantPlugins::ContainerProvisioner::Config
def post_install_provision(name, **options, &block)
# Abort
raise DockerError, :wrong_provisioner if options[:type] == "docker"
@ -48,39 +11,6 @@ module VagrantPlugins
proxy.provision(name, **options, &block)
@post_install_provisioner = proxy.provisioners.first
end
def run(name, **options)
@__containers[name.to_s] = options.dup
end
def merge(other)
super.tap do |result|
result.pull_images(*(other.images + self.images))
build_images = @__build_images.dup
build_images += other.build_images
result.instance_variable_set(:@__build_images, build_images)
containers = {}
@__containers.each do |name, params|
containers[name] = params.dup
end
other.containers.each do |name, params|
containers[name] = @__containers[name].merge(params)
end
result.instance_variable_set(:@__containers, containers)
end
end
def finalize!
@__containers.each do |name, params|
params[:image] ||= name
params[:auto_assign_name] = true if !params.key?(:auto_assign_name)
params[:daemonize] = true if !params.key?(:daemonize)
params[:restart] = "always" if !params.key?(:restart)
end
end
end
end
end

8
plugins/provisioners/docker/installer.rb
View File

@ -1,10 +1,8 @@
require_relative "../container/installer"
module VagrantPlugins
module DockerProvisioner
class Installer
def initialize(machine)
@machine = machine
end
class Installer < VagrantPlugins::ContainerProvisioner::Installer
# This handles verifying the Docker installation, installing it if it was
# requested, and so on. This method will raise exceptions if things are
# wrong.

11
plugins/provisioners/docker/provisioner.rb
View File

@ -1,3 +1,5 @@
require_relative "../container/provisioner"
require_relative "client"
require_relative "installer"
@ -7,7 +9,7 @@ module VagrantPlugins
error_namespace("vagrant.provisioners.docker")
end
class Provisioner < Vagrant.plugin("2", :provisioner)
class Provisioner < VagrantPlugins::ContainerProvisioner::Provisioner
def initialize(machine, config, installer = nil, client = nil)
super(machine, config)
@ -49,13 +51,6 @@ module VagrantPlugins
end
end
def run_provisioner(env)
klass = Vagrant.plugin("2").manager.provisioners[env[:provisioner].type]
result = klass.new(env[:machine], env[:provisioner].config)
result.config.finalize!
result.provision
end
end
end
end

15
plugins/provisioners/podman/cap/linux/podman_installed.rb
View File

@ -4,20 +4,7 @@ module VagrantPlugins
module Linux
module PodmanInstalled
def self.podman_installed(machine)
paths = [
"/bin/podman",
"/usr/bin/podman",
"/usr/local/bin/podman",
"/usr/sbin/podman",
]
paths.each do |p|
if machine.communicate.test("test -f #{p}", sudo: true)
return true
end
end
return false
machine.communicate.test("command -v podman")
end
end
end

4
plugins/provisioners/podman/cap/redhat/podman_install.rb
View File

@ -9,7 +9,7 @@ module VagrantPlugins
case machine.guest.capability("flavor")
when :rhel_7
machine.communicate.tap do |comm|
comm.sudo("curl -sSL https://download.opensuse.org/repositories/devel:kubic:libcontainers:stable/CentOS_7/devel:kubic:libcontainers:stable.repo -o /etc/yum.repos.d/")
comm.sudo("curl curl -L -o /etc/yum.repos.d/devel:kubic:libcontainers:stable.repo https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/CentOS_7/devel:kubic:libcontainers:stable.repo")
comm.sudo("yum -q -y install podman")
end
when :rhel_8
@ -17,7 +17,7 @@ module VagrantPlugins
comm.sudo("dnf -y module disable container-tools")
comm.sudo("dnf -y install 'dnf-command(copr)'")
comm.sudo("dnf -y copr enable rhcontainerbot/container-selinux")
comm.sudo("curl -sSL https://download.opensuse.org/repositories/devel:kubic:libcontainers:stable/CentOS_8/devel:kubic:libcontainers:stable.repo -o /etc/yum.repos.d/")
comm.sudo("curl -L -o /etc/yum.repos.d/devel:kubic:libcontainers:stable.repo https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/CentOS_8/devel:kubic:libcontainers:stable.repo")
comm.sudo("dnf -y install podman")
end
else

83
plugins/provisioners/podman/client.rb
View File

@ -1,85 +1,12 @@
require_relative "../docker/client"
require_relative "../container/client"
module VagrantPlugins
module PodmanProvisioner
class Client < VagrantPlugins::DockerProvisioner::Client
def build_images(images)
@machine.communicate.tap do |comm|
images.each do |path, opts|
@machine.ui.info(I18n.t("vagrant.docker_building_single", path: path))
comm.sudo("podman build #{opts[:args]} #{path}") do |type, data|
handle_comm(type, data)
end
end
end
class Client < VagrantPlugins::ContainerProvisioner::Client
def initialize(machine)
super(machine, "podman")
@container_command = "podman"
end
def pull_images(*images)
@machine.communicate.tap do |comm|
images.each do |image|
@machine.ui.info(I18n.t("vagrant.docker_pulling_single", name: image))
comm.sudo("podman pull #{image}") do |type, data|
handle_comm(type, data)
end
end
end
end
def start_container(id)
if !container_running?(id)
@machine.communicate.sudo("podman start #{id}")
end
end
def stop_container(id)
@machine.communicate.sudo %[
podman stop #{id}
podman rm #{id}
]
end
def container_image_changed?(config)
# Returns true if there is a container running with the given :name,
# and the container is not using the latest :image.
# Here, "podman inspect <container>" returns the id of the image
# that the container is using. We check that the latest image that
# has been built with that name (:image) matches the one that the
# container is running.
cmd = ("podman inspect --format='{{.Image}}' #{config[:name]} |" +
" grep $(podman images -q #{config[:image]})")
return !@machine.communicate.test(cmd)
end
def create_container(config)
args = container_run_args(config)
@machine.communicate.sudo %[rm -f "#{config[:cidfile]}"]
@machine.communicate.sudo %[podman run #{args}]
sha = Digest::SHA1.hexdigest(args)
container_data_path(config).open("w+") do |f|
f.write(sha)
end
end
def lookup_container(id, list_all = false)
podman_ps = "sudo podman ps -q"
podman_ps << " -a" if list_all
@machine.communicate.tap do |comm|
# Docker < 0.7.0 stores container IDs using its short version while
# recent versions use the full container ID
# using full container ID from now on.
return comm.test("#{podman_ps} --no-trunc | grep -wFq #{id}")
end
end
def container_data_path(config)
name = container_name(config)
@machine.data_dir.join("podman-#{name}")
end
end
end
end

4
plugins/provisioners/podman/config.rb
View File

@ -1,8 +1,8 @@
require_relative "../docker/config"
require_relative "../container/config"
module VagrantPlugins
module PodmanProvisioner
class Config < VagrantPlugins::DockerProvisioner::Config
class Config < VagrantPlugins::ContainerProvisioner::Config
def post_install_provision(name, **options, &block)
# Abort
raise PodmanError, :wrong_provisioner if options[:type] == "podman"

8
plugins/provisioners/podman/installer.rb
View File

@ -1,10 +1,8 @@
require_relative "../container/installer"
module VagrantPlugins
module PodmanProvisioner
class Installer
def initialize(machine)
@machine = machine
end
class Installer < VagrantPlugins::ContainerProvisioner::Installer
# This handles verifying the Podman installation, installing it if it was
# requested, and so on. This method will raise exceptions if things are
# wrong.

5
plugins/provisioners/podman/provisioner.rb
View File

@ -1,4 +1,5 @@
require_relative "../docker/provisioner"
require_relative "../container/provisioner"
require_relative "installer"
require_relative "client"
@ -8,7 +9,7 @@ module VagrantPlugins
error_namespace("vagrant.provisioners.podman")
end
class Provisioner < VagrantPlugins::DockerProvisioner::Provisioner
class Provisioner < VagrantPlugins::ContainerProvisioner::Provisioner
def initialize(machine, config, installer = nil, client = nil)
super(machine, config, installer, client)

10
templates/locales/en.yml
View File

@ -127,6 +127,16 @@ en:
Warning: Chef run list is empty. This may not be what you want.
cli_interrupt: |-
Exiting due to interrupt.
container_pulling_single: |-
-- Image: %{name}
container_building_single: |-
-- Path: %{path}
container_running: |-
-- Container: %{name}
container_restarting_container_args: |-
-- Detected changes to container '%{name}' args, restarting...
container_restarting_container_image: |-
-- Detected newer image for container '%{name}', restarting...
docker_auto_start_not_available: |-
Unable to configure automatic restart of Docker containers on
the guest machine