containerator

module
v0.0.0-...-a38a202 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 18, 2024 License: MIT

README

CI

containerator

core

Functions to work with docker containers.

Several most common and basic operations are supported.

// import "github.com/docker/docker/client"
cli, _ = client.NewEnvClient()

// docker image ls -aq
core.ListAllImageIDs(cli)

// docker ps -aq
core.ListAllContainerIDs(cli)

// docker inspect 8b5a55df88ec
core.FindImageByShortID(cli, "0123456789ab")

// docker inspect 8b5a55df88ec
core.FindContainerByShortID(cli, "0123456789ab")

// docker run -it -d --name my-container-1 --network my-network-1 -v /tmp:/usr/app -p 50001:3000 -e A=1 my-image:1
core.RunContainer(cli, &core.RunContainerOptions{
    Image: "my-image:1",
    Name: "my-container-1",
    RestartPolicy: RestartAlways,
    Network: "my-network-1",
    Volumes: []Mapping{
        {"/tmp", "/usr/app"},
    },
    Ports: []Mapping{
        {"50001", "3000"},
    },
    Env: []Mapping{
        {"A", "1"},
    },
})

manage

Functions to run, suspend, resume, remove containers.

// import "github.com/docker/docker/client"
cli, _ = client.NewEnvClient()

config = &manage.Config{
	ImageName: "my-umage",
	ContainerName: "my-container",
    Network: "my-network",
    Volumes: []core.Mapping{
        // ...
    },
    Ports: []core.Mapping{
        // ...
    },
    Env: []core.Mapping{
        // ...
    },
}

manage.RunContainer(cli, config, &manage.Options{
    Postfix: "dev"
	Tag: "latest",
	EnvFilePath: "./env-dev.list",
})
manage.RunContainer(cli, config, &manage.Options{
    Postfix: "test"
	Tag: "latest",
    Portoffset: 10,
	EnvFilePath: "./env-test.list",
})
manage.RunContainer(cli, config, &manage.Options{
    Postfix: "prod"
	Tag: "2",
    Portoffset: 20,
	EnvFilePath: "./env-prod.list",
})

Examples

Directories

Path Synopsis
Package core contains functions to work with docker containers.
Package core contains functions to work with docker containers.
examples
find_container command
Program find_container shows usage of *containerator* functions that find docker containers.
Program find_container shows usage of *containerator* functions that find docker containers.
find_image command
Program find_image shows usage of *containerator* functions that find docker images.
Program find_image shows usage of *containerator* functions that find docker images.
manage_container command
Program manage_container shows usage of *containerator* functions that run and remove containers.
Program manage_container shows usage of *containerator* functions that run and remove containers.
manage_container_server command
Program manage_container_server is an example of http server that manages several container projects.
Program manage_container_server is an example of http server that manages several container projects.
run_container command
Program run_container shows usage of *containerator.RunContainer* function.
Program run_container shows usage of *containerator.RunContainer* function.
Package manage contains function to run, suspend, resume, remove containers.
Package manage contains function to run, suspend, resume, remove containers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL