class Funko::Funko
- Funko::Funko
- Reference
- Object
Included Modules
- YAML::Serializable
Defined in:
funko.crConstructors
Class Method Summary
-
.from_docker : Array(Funko)
Get all the funkos docker knows about.
-
.from_names(names : Array(String)) : Array(Funko)
Create an array of funkos just from names.
-
.from_paths(paths : Array(String | Path)) : Array(Funko)
Create an Array of funkos from an Array of folders containing definitions
Instance Method Summary
- #after_initialize
-
#build(path : Path, no_cache : Bool = false, _name : String | Nil = nil)
Build image using docker in path previously prepared using
#prepare_build
-
#containers(status : String | Nil = "running")
Get all containers related to this funko in the desired state
-
#create_container : String
Create a container for this funko
-
#docker_status
A comprehensive status for the funko:
-
#image_history
Return a list of image IDs for this funko, most recent first
- #images
- #latest_image
-
#name : String
Required, the name of the funko.
-
#name=(name : String)
Required, the name of the funko.
- #options : Hash(String, String | Array(String))
- #options=(options : Hash(String, String | Array(String)))
-
#path : String
Where this is located in the filesystem
-
#path=(path : String)
Where this is located in the filesystem
-
#prepare_build(path : Path)
Setup the target directory
#path
with all the files needed to build a docker image -
#remove_all_containers
Remove all containers related to this funko
-
#remove_all_images
Remove all images related to this funko
-
#runtime : String | Nil | Nil
if Nil, it has no template whatsoever
-
#runtime=(runtime : String | Nil | Nil)
if Nil, it has no template whatsoever
-
#scale(new_scale : Int) : Array(String)
Set the number of running instances of this funko Returns the list of IDs started or stopped
-
#scale
Get the number of running instances of this funko
-
#scale=(scale : Int32)
Scale: how many instances of this funko should be running
-
#start(id : String)
Start container with given id
- #valid? : Bool
-
#wait_for(new_scale : Int, t : Int, healthy : Bool = false)
Wait up to
t
seconds for the funko to reach the desired scale Ifhealthy
is true, it will wait for the container to be declared healthy by the healthcheck - #wait_for_container_started(id : String, t : Int)
Constructor Detail
Class Method Detail
Create an array of funkos just from names. These are limited in function
and can't call #prepare_build
or some other functionality
Create an Array of funkos from an Array of folders containing definitions
Instance Method Detail
Build image using docker in path previously prepared using #prepare_build
Get all containers related to this funko in the desired state
Setup the target directory #path
with all the files needed
to build a docker image
Set the number of running instances of this funko Returns the list of IDs started or stopped
Wait up to t
seconds for the funko to reach the desired scale
If healthy
is true, it will wait for the container to be declared
healthy by the healthcheck