faaso/src/funko.cr

285 lines
8.7 KiB
Crystal
Raw Normal View History

require "crinja"
require "file_utils"
require "yaml"
2024-06-30 03:36:25 +00:00
# A funko, built from its source metadata
2024-07-02 22:08:14 +00:00
module Funko
extend self
2024-07-02 22:08:14 +00:00
class Funko
include YAML::Serializable
2024-07-02 22:08:14 +00:00
# Required, the name of the funko. Must be unique across FaaSO
property name : String
2024-07-02 22:08:14 +00:00
# if Nil, it has no template whatsoever
property runtime : (String | Nil)? = nil
2024-07-02 22:08:14 +00:00
# Extra operating system packages shipped with the runtime's Docker image
property ship_packages : Array(String) = [] of String
2024-07-02 22:08:14 +00:00
# Extra operating system packages used only when *building* the funko
property devel_packages : Array(String) = [] of String
2024-07-02 22:08:14 +00:00
# Where this is located in the filesystem
@[YAML::Field(ignore: true)]
property path : String = ""
2024-07-02 22:08:14 +00:00
# Healthcheck properties
property healthcheck_options : String = "--interval=1m --timeout=2s --start-period=2s --retries=3"
property healthcheck_command : String = "curl --fail http://localhost:3000/ping || exit 1"
2024-07-02 22:08:14 +00:00
def _to_context
{
"name" => name,
"ship_packages" => ship_packages,
"devel_packages" => devel_packages,
"healthcheck_options" => healthcheck_options,
"healthcheck_command" => healthcheck_command,
}
end
2024-07-02 22:08:14 +00:00
def to_json(json : JSON::Builder)
json.object do
json.field("name", name)
json.field("ship_packages", ship_packages)
json.field("devel_packages", devel_packages)
json.field("healthcheck_options", healthcheck_options)
json.field("healthcheck_command", healthcheck_command)
end
end
2024-07-02 22:08:14 +00:00
# Create an Array of funkos from an Array of folders containing definitions
def self.from_paths(paths : Array(String | Path)) : Array(Funko)
paths.map { |path| Path.new(path, "funko.yml") }
.select { |path| File.exists?(path) }
.map { |path|
f = Funko.from_yaml(File.read(path.to_s))
f.path = path.parent.to_s
f
}
end
2024-06-30 18:38:51 +00:00
2024-07-02 22:08:14 +00:00
# Create an array of funkos just from names. These are limited in function
# and can't call `prepare_build` or some other functionality
def self.from_names(names : Array(String)) : Array(Funko)
names.map { |name|
Funko.from_yaml("name: #{name}")
}
2024-07-02 22:08:14 +00:00
end
2024-07-02 22:08:14 +00:00
# Get all the funkos docker knows about.
def self.from_docker : Array(Funko)
docker_api = Docr::API.new(Docr::Client.new)
names = [] of String
2024-07-02 22:37:08 +00:00
# Get all containers that look like funkos
docker_api.containers.list(
2024-07-02 22:08:14 +00:00
all: true,
).each { |container|
container.@names.each { |name|
names << name.split("-", 2)[1].lstrip("/") if name.starts_with?("/faaso-")
}
}
2024-07-02 22:08:14 +00:00
2024-07-02 22:37:08 +00:00
# Now get all images that look like funkos, since
# we can start them just fine.
docker_api.images.list.each { |image|
next if image.@repo_tags.nil?
image.@repo_tags.as(Array(String)).each { |tag|
names << tag.split("-", 2)[1].split(":", 2)[0] if tag.starts_with?("faaso-")
}
}
from_names(names.to_set.to_a.sort!)
2024-07-02 22:08:14 +00:00
end
# Setup the target directory `path` with all the files needed
# to build a docker image
def prepare_build(path : Path)
# Copy runtime if requested
if !runtime.nil?
runtime_dir = Path.new("runtimes", runtime.as(String))
raise Exception.new("Error: runtime #{runtime} not found for funko #{name} in #{path}") unless File.exists?(runtime_dir)
Dir.glob("#{runtime_dir}/*").each { |src|
FileUtils.cp_r(src, path)
}
# Replace templates with processed files
context = _to_context
Dir.glob("#{path}/**/*.j2").each { |template|
dst = template[..-4]
File.open(dst, "w") do |file|
file << Crinja.render(File.read(template), context)
end
File.delete template
}
end
# Copy funko
raise Exception.new("Internal error: empty funko path for #{name}") if self.path.empty?
Dir.glob("#{self.path}/*").each { |src|
FileUtils.cp_r(src, path)
}
end
2024-07-02 22:08:14 +00:00
# Build image using docker in path previously prepared using `prepare_build`
def build(path : Path)
docker_api = Docr::API.new(Docr::Client.new)
docker_api.images.build(
context: path.to_s,
tags: ["faaso-#{name}:latest"]) { |x| Log.info { x } }
end
2024-07-02 22:08:14 +00:00
# Return a list of image IDs for this funko, most recent first
def image_history
docker_api = Docr::API.new(Docr::Client.new)
begin
docker_api.images.history(
name: "faaso-#{name}"
).sort { |i, j| j.@created <=> i.@created }.map(&.@id)
rescue ex : Docr::Errors::DockerAPIError
Log.error { "#{ex}" }
[] of String
end
end
2024-07-02 22:08:14 +00:00
# Get all containers related to this funko
def containers
docker_api = Docr::API.new(Docr::Client.new)
docker_api.containers.list(
all: true,
filters: {"name" => ["faaso-#{name}"]}
)
end
2024-07-02 22:08:14 +00:00
# Descriptive status for the funko
def status
status = self.containers.map { |container|
container.@status
}.join(", ")
status.empty? ? "Stopped" : status
end
2024-07-02 22:08:14 +00:00
# Is any instance of this funko running?
def running?
self.containers.any? { |container|
container.@state == "running"
}
end
2024-07-02 22:08:14 +00:00
# Is any instance of this funko paused?
def paused?
self.containers.any? { |container|
container.@state == "paused"
}
end
# Pause running container
def pause
docker_api = Docr::API.new(Docr::Client.new)
images = self.image_history
running = self.containers.select { |container|
container.@state == "running"
}.sort! { |i, j|
(images.index(j.@image_id) || 9999) <=> (images.index(i.@image_id) || 9999)
}
docker_api.containers.pause(running[0].@id) unless running.empty?
end
2024-07-02 22:08:14 +00:00
# Unpause paused container with the newer image
def unpause
docker_api = Docr::API.new(Docr::Client.new)
images = self.image_history
paused = self.containers.select { |container|
container.@state == "paused"
}.sort! { |i, j|
(images.index(j.@image_id) || 9999) <=> (images.index(i.@image_id) || 9999)
}
docker_api.containers.unpause(paused[0].@id) unless paused.empty?
end
2024-07-02 22:08:14 +00:00
# Is any instance of this funko exited?
def exited?
self.containers.any? { |container|
container.@state == "exited"
}
end
# Start exited container with the newer image
# or unpause paused container
2024-07-02 22:08:14 +00:00
def start
if self.exited?
docker_api = Docr::API.new(Docr::Client.new)
images = self.image_history
exited = self.containers.select { |container|
container.@state == "exited"
}.sort! { |i, j|
(images.index(j.@image_id) || 9999) <=> (images.index(i.@image_id) || 9999)
}
docker_api.containers.restart(exited[0].@id) unless exited.empty?
elsif self.paused?
self.unpause
end
end
# Stop container with the newer image
def stop
2024-07-02 22:08:14 +00:00
docker_api = Docr::API.new(Docr::Client.new)
images = self.image_history
containers = self.containers.sort! { |i, j|
2024-07-02 22:08:14 +00:00
(images.index(j.@image_id) || 9999) <=> (images.index(i.@image_id) || 9999)
}
return docker_api.containers.stop(containers[0].@id) unless containers.empty?
nil
end
# Wait up to `t` seconds for the funko to reach the requested `state`
def wait_for(state : String, t)
channel = Channel(Nil).new
spawn do
sleep 0.1.seconds
case state
when "exited"
if self.exited?
channel.send(nil)
end
when "running"
if self.running?
channel.send(nil)
end
when "paused"
if self.paused?
channel.send(nil)
end
end
end
2024-07-02 22:08:14 +00:00
end
2024-06-30 03:49:48 +00:00
2024-07-02 22:08:14 +00:00
# Create a container for this funko
def create_container(autostart : Bool = true) : String
secrets_mount = "#{Dir.current}/secrets/#{name}"
Dir.mkdir_p(secrets_mount)
conf = Docr::Types::CreateContainerConfig.new(
image: "faaso-#{name}:latest",
hostname: name,
# Port in the container side
host_config: Docr::Types::HostConfig.new(
network_mode: "faaso-net",
mounts: [
Docr::Types::Mount.new(
source: secrets_mount,
target: "/secrets",
type: "bind"
),
]
)
2024-06-30 03:49:48 +00:00
)
2024-07-02 22:08:14 +00:00
docker_api = Docr::API.new(Docr::Client.new)
response = docker_api.containers.create(name: "faaso-#{name}", config: conf)
response.@warnings.each { |msg| Log.warn { msg } }
docker_api.containers.start(response.@id) if autostart
response.@id
end
2024-06-30 03:49:48 +00:00
end
end