Português:
Por favor, não use este projeto diretamente. Caso você necessite gerar containers docker, controlados por código golang e gerar senários de caos, use o projeto Docker Builder.
English:
Please do not use this project directly. If you need to generate docker containers, controlled by golang code and generate chaos scenarios, use the Docker Builder project.
Português:
Nota: todos os testes estão processando com sucesso, porém, os testes geram containers e ferramentas on-line de testes não deixam containers gerarem containers, por isto, rode os testes na mão em máquina local (um a um, não rode todos ao mesmo tempo), caso queira.
Emglish:
Note: all tests are processing successfully, however, the tests generate containers and online testing tools do not let containers generate containers, so run the tests by hand on a local machine (one by one, do not run them all at the same time), if you want.
Este projeto é uma forma simples de gerenciar containers por código Golang.
Para saber como usar, basta seguir os códigos de testes na forma de exemplos. Todos eles são funcionais.
O código tem em torno de 90% de cobertura com testes e documentação em português e inglês.
This project is a simple way to manage containers by code Golang.
To learn how to use, just follow the test codes as examples. All examples are functional.
The code has around 90% coverage with tests and documentation in Portuguese and English.
Português: Monta um servidor baseado em um diretório local:
English: Build a small server based on a local directory:
package main
import (
"bytes"
"errors"
"fmt"
"github.com/docker/docker/api/types/mount"
"github.com/docker/docker/api/types/network"
"github.com/docker/go-connections/nat"
"github.com/helmutkemper/iotmaker.docker/util"
iotmakerDocker "github.com/helmutkemper/iotmaker.docker/v1.0.0.0-RC"
"io/ioutil"
"net/http"
"os"
"path/filepath"
)
func main() {
var err error
var containerId string
var imageId string
var networkId string
var dockerSys *iotmakerDocker.DockerSystem
var networkAutoConfiguration *iotmakerDocker.NextNetworkAutoConfiguration
var networkNextAddress *network.NetworkingConfig
// English: make a channel to end goroutine
// Português: monta um canal para terminar a goroutine
var chProcessEnd = make(chan bool, 1)
// English: make a channel [optional] to print build output
// Português: monta o canal [opcional] para imprimir a saída do build
var chStatus = make(chan iotmakerDocker.ContainerPullStatusSendToChannel, 1)
// English: make a thread to monitoring and print channel data
// Português: monta uma thread para imprimir os dados do canal
go func(chStatus chan iotmakerDocker.ContainerPullStatusSendToChannel, chProcessEnd chan bool) {
for {
select {
case <-chProcessEnd:
return
case status := <-chStatus:
// English: remove this comment to see all build status
// Português: remova este comentário para vê todo o status da criação da imagem
fmt.Printf("image pull status: %+v\n", status)
if status.Closed == true {
fmt.Println("image pull complete!")
// English: Eliminate this goroutine after process end
// Português: Elimina a goroutine após o fim do processo
return
}
}
}
}(chStatus, chProcessEnd)
// English: searches for the folder containing the test server
// Português: procura pela pasta contendo o servidor de teste
var smallServerPath string
smallServerPath, err = util.FileFindRecursively("small_server_p3000")
if err != nil {
panic(err)
}
// English: turns the path into an absolute path
// Português: transforma o caminho em caminho absoluto
smallServerPath, err = filepath.Abs(smallServerPath)
if err != nil {
panic(err)
}
// English: 'static' folder path
// Português: caminho da pasta 'static'
var smallServerPathStatic string
smallServerPathStatic = smallServerPath + string(os.PathSeparator) + "static"
// English: 'index.html' file path
// Português: caminho do arquivo 'index.html'
var smallServerPathStaticContent string
smallServerPathStaticContent = smallServerPathStatic + string(os.PathSeparator) + "index.html"
// English: create a new default client. Please, use: err, dockerSys = factoryDocker.NewClient()
// Português: cria um novo cliente com configurações padrão. Por favor, usr: err, dockerSys = factoryDocker.NewClient()
dockerSys = &iotmakerDocker.DockerSystem{}
dockerSys.ContextCreate()
err = dockerSys.ClientCreate()
if err != nil {
panic(err)
}
// English: garbage collector and deletes networks and images whose name contains the term 'delete'
// Português: coletor de lixo e apaga redes e imagens cujo o nome contém o temo 'delete'
err = dockerSys.RemoveAllByNameContains("delete")
if err != nil {
panic(err)
}
// English: create a network named 'network_delete_before_test'
// Português: cria uma nova rede de nome 'network_delete_before_test'
networkId, networkAutoConfiguration, err = dockerSys.NetworkCreate(
"network_delete_before_test",
iotmakerDocker.KNetworkDriveBridge,
"local",
"10.0.0.0/16",
"10.0.0.1",
)
if err != nil {
panic(err)
}
if networkId == "" {
err = errors.New("network id was not generated")
panic(err)
}
// English: get next ip address from network, '10.0.0.2'
// Português: pega o próxima endereço da rede, '10.0.0.2'
err, networkNextAddress = networkAutoConfiguration.GetNext()
if err != nil {
panic(err)
}
// English: build a new image from folder 'small_test_server_port_3000'
// Português: monta uma imagem a partir da pasta 'small_test_server_port_3000'
imageId, err = dockerSys.ImageBuildFromFolder(
smallServerPath,
[]string{
"image_server_delete_before_test:latest", // image name
},
&chStatus, // [channel|nil]
)
if err != nil {
panic(err)
}
if imageId == "" {
err = errors.New("image ID was not generated")
panic(err)
}
// English: building a multi-step image leaves large and useless images, taking up space on the HD.
// Português: construir uma imagem de múltiplas etapas deixa imagens grandes e sem serventia, ocupando espaço no HD.
err = dockerSys.ImageGarbageCollector()
if err != nil {
panic(err)
}
// English: mount and start a container
// Português: monta i inicializa o container
containerId, err = dockerSys.ContainerCreate(
// image name
"image_server_delete_before_test:latest",
// container name
"container_delete_before_test",
// restart policy
iotmakerDocker.KRestartPolicyUnlessStopped,
// portMap
nat.PortMap{
// container port number/protocol [tpc/udp]
"3000/tcp": []nat.PortBinding{ // server original port
{
// server output port number
HostPort: "9002",
},
},
},
// mount volumes
[]mount.Mount{
{
// bind - is the type for mounting host dir (real folder inside computer where
// this code work)
Type: iotmakerDocker.KVolumeMountTypeBindString,
// path inside host machine
Source: smallServerPathStatic,
// path inside image
Target: "/static",
},
},
// nil or container network configuration
networkNextAddress,
)
if err != nil {
panic(err)
}
if containerId == "" {
err = errors.New("container id was not generated")
panic(err)
}
// English: container start
// Português: inicia o container
err = dockerSys.ContainerStart(containerId)
if err != nil {
panic(err)
}
// English: ends a goroutine
// Português: termina a goroutine
chProcessEnd <- true
var page []byte
var found int
var response *http.Response
// English: contents of the static server index.html page
// Português: conteúdo da página index.html do servidor estático
var htmlIndexContent1 = []byte("<!DOCTYPE html><html><body><p>I'm alive!</p></body></html>")
err = ioutil.WriteFile(smallServerPathStaticContent, htmlIndexContent1, os.ModePerm)
if err != nil {
panic(err)
}
// English: takes the content from the server for testing
// Português: pega o conteúdo do servidor para teste
response, err = http.Get("http://localhost:9002")
if err != nil {
panic(err)
}
page, err = ioutil.ReadAll(response.Body)
if err != nil {
panic(err)
}
// English: compare content
// Português: compara o conteúdo
found = bytes.Compare(page, htmlIndexContent1)
if found == 1 {
err = errors.New("small server content error")
panic(err)
}
// English: contents of the static server index.html page
// Português: conteúdo da página index.html do servidor estático
htmlIndexContent1 = []byte("<!DOCTYPE html><html><body><p>I'm alive Dr. Frankenstein!</p></body></html>")
err = ioutil.WriteFile(smallServerPathStaticContent, htmlIndexContent1, os.ModePerm)
if err != nil {
panic(err)
}
// English: takes the content from the server for testing
// Português: pega o conteúdo do servidor para teste
response, err = http.Get("http://localhost:9002")
if err != nil {
panic(err)
}
page, err = ioutil.ReadAll(response.Body)
if err != nil {
panic(err)
}
// English: compare content
// Português: compara o conteúdo
found = bytes.Compare(page, htmlIndexContent1)
if found == 1 {
err = errors.New("small server content error")
panic(err)
}
// English: garbage collector and deletes networks and images whose name contains the term 'delete'
// Português: coletor de lixo e apaga redes e imagens cujo o nome contém o temo 'delete'
err = dockerSys.RemoveAllByNameContains("delete")
if err != nil {
panic(err)
}
}Português: Monta o mesmo exemplo de servidor baseado em um repositório do github.
English: Build a small server based on a github repository:
package main
import (
"errors"
"fmt"
"github.com/docker/docker/api/types/mount"
"github.com/docker/docker/api/types/network"
"github.com/docker/go-connections/nat"
"github.com/helmutkemper/iotmaker.docker/util"
iotmakerDocker "github.com/helmutkemper/iotmaker.docker/v1.0.0.0-RC"
"os"
"path/filepath"
)
func main() {
var err error
var containerId string
var imageId string
var networkId string
var dockerSys *iotmakerDocker.DockerSystem
var networkAutoConfiguration *iotmakerDocker.NextNetworkAutoConfiguration
var networkNextAddress *network.NetworkingConfig
// English: make a channel to end goroutine
// Português: monta um canal para terminar a goroutine
var chProcessEnd = make(chan bool, 1)
// English: make a channel [optional] to print build output
// Português: monta o canal [opcional] para imprimir a saída do build
var chStatus = make(chan iotmakerDocker.ContainerPullStatusSendToChannel, 1)
// English: make a thread to monitoring and print channel data
// Português: monta uma thread para imprimir os dados do canal
go func(chStatus chan iotmakerDocker.ContainerPullStatusSendToChannel, chProcessEnd chan bool) {
for {
select {
case <-chProcessEnd:
return
case status := <-chStatus:
// English: remove this comment to see all build status
// Português: remova este comentário para vê todo o status da criação da imagem
fmt.Printf("image pull status: %+v\n", status)
if status.Closed == true {
fmt.Println("image pull complete!")
// English: Eliminate this goroutine after process end
// Português: Elimina a goroutine após o fim do processo
return
}
}
}
}(chStatus, chProcessEnd)
// English: searches for the folder containing the test server
// Português: procura pela pasta contendo o servidor de teste
var smallServerPath string
smallServerPath, err = util.FileFindRecursively("small_test_server_port_3000")
if err != nil {
panic(err)
}
// English: turns the path into an absolute path
// Português: transforma o caminho em caminho absoluto
smallServerPath, err = filepath.Abs(smallServerPath)
if err != nil {
panic(err)
}
// English: 'static' folder path
// Português: caminho da pasta 'static'
var smallServerPathStatic string
smallServerPathStatic = smallServerPath + string(os.PathSeparator) + "static"
// English: create a new default client. Please, use: err, dockerSys =
// factoryDocker.NewClient()
// Português: cria um novo cliente com configurações padrão. Por favor, usr: err,
// dockerSys = factoryDocker.NewClient()
dockerSys = &iotmakerDocker.DockerSystem{}
dockerSys.ContextCreate()
err = dockerSys.ClientCreate()
if err != nil {
panic(err)
}
// English: garbage collector and deletes networks and images whose name contains the
// term 'delete'
// Português: coletor de lixo e apaga redes e imagens cujo o nome contém o temo
// 'delete'
err = dockerSys.RemoveAllByNameContains("delete")
if err != nil {
panic(err)
}
// English: create a network named 'network_delete_before_test'
// Português: cria uma nova rede de nome 'network_delete_before_test'
networkId, networkAutoConfiguration, err = dockerSys.NetworkCreate(
"network_delete_before_test",
iotmakerDocker.KNetworkDriveBridge,
"local",
"10.0.0.0/16",
"10.0.0.1",
)
if err != nil {
panic(err)
}
if networkId == "" {
err = errors.New("network id was not generated")
panic(err)
}
// English: get next ip address from network, '10.0.0.2'
// Português: pega o próxima endereço da rede, '10.0.0.2'
err, networkNextAddress = networkAutoConfiguration.GetNext()
if err != nil {
panic(err)
}
// English: build a new image from folder 'small_test_server_port_3000'
// Português: monta uma imagem a partir da pasta 'small_test_server_port_3000'
imageId, err = dockerSys.ImageBuildFromRemoteServer(
"https://github.com/helmutkemper/iotmaker.docker.util.whaleAquarium.sample.git",
"image_server_delete_before_test:latest", // image name
[]string{},
&chStatus, // [channel|nil]
)
if err != nil {
panic(err)
}
if imageId == "" {
err = errors.New("image ID was not generated")
panic(err)
}
// English: building a multi-step image leaves large and useless images, taking up
// space on the HD.
// Português: construir uma imagem de múltiplas etapas deixa imagens grandes e sem
// serventia, ocupando espaço no HD.
err = dockerSys.ImageGarbageCollector()
if err != nil {
panic(err)
}
// English: mount and start a container
// Português: monta i inicializa o container
containerId, err = dockerSys.ContainerCreate(
// image name
"image_server_delete_before_test:latest",
// container name
"container_delete_before_test",
// restart policy
iotmakerDocker.KRestartPolicyUnlessStopped,
// port list
nat.PortMap{
// server original port
"3000/tcp": []nat.PortBinding{
{
// new output port
HostPort: "9002",
},
},
},
// mount volumes
[]mount.Mount{
{
// bind - is the type for mounting host dir
// (real folder inside computer where this
// code work)
Type: iotmakerDocker.KVolumeMountTypeBindString,
// path inside host machine
Source: smallServerPathStatic,
// path inside image
Target: "/static",
},
},
networkNextAddress, // [optional] container network
)
if err != nil {
panic(err)
}
if containerId == "" {
err = errors.New("container id was not generated")
panic(err)
}
// English: container start
// Português: inicia o container
err = dockerSys.ContainerStart(containerId)
if err != nil {
panic(err)
}
// English: ends a goroutine
// Português: termina a goroutine
chProcessEnd <- true
err = dockerSys.ContainerStop(containerId)
if err != nil {
panic(err)
}
err = dockerSys.ContainerRemove(containerId, true, false, false)
if err != nil {
panic(err)
}
// English: garbage collector and deletes networks and images whose name contains the
// term 'delete'
// Português: coletor de lixo e apaga redes e imagens cujo o nome contém o temo
// 'delete'
err = dockerSys.RemoveAllByNameContains("delete")
if err != nil {
panic(err)
}
}