iotmaker_docker_builder

package module
v0.0.1-rc013 Latest Latest
Warning

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

Go to latest
Published: May 14, 2021 License: Apache-2.0 Imports: 16 Imported by: 3

README

iotmaker.docker.builder

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ContainerBuilder

type ContainerBuilder struct {
	// contains filtered or unexported fields
}

ContainerBuilder (english):

ContainerBuilder (português): Gerenciador de containers e imagens docker

func (*ContainerBuilder) AddPortToChange

func (e *ContainerBuilder) AddPortToChange(imagePort string, newPort string)

AddPortToChange (english):

AddPortToChange (português): Define as portas a serem expostas na rede alterando o valor da porta definida na imagem e o valor exposto na rede

imagePort: porta definida na imagem, na forma de string numérica
newPort: novo valor da porta a se exposta na rede

  Nota: A omissão de definição das portas a serem expostas define automaticamente todas as portas contidas na
  imagem como portas a serem expostas.
  AddPortToOpen() e AddPortToChange() limitam as portas abertas as portas listadas.
  SetDoNotOpenContainersPorts() impede a exposição automática de portas.

func (*ContainerBuilder) AddPortToOpen

func (e *ContainerBuilder) AddPortToOpen(value string)

AddPortToOpen (english):

AddPortToOpen (português): Define as portas a serem expostas na rede

value: porta na forma de string numérica

  Nota: A omissão de definição das portas a serem expostas define automaticamente todas as portas contidas na
  imagem como portas a serem expostas.
  AddPortToOpen() e AddPortToChange() limitam as portas abertas as portas listadas.
  SetDoNotOpenContainersPorts() impede a exposição automática de portas.

func (*ContainerBuilder) ContainerBuildFromImage

func (e *ContainerBuilder) ContainerBuildFromImage() (err error)

ContainerBuildFromImage (english):

ContainerBuildFromImage (português): transforma uma imagem baixada por ImagePull() ou criada por ImageBuildFromFolder() em container

func (*ContainerBuilder) ContainerInspect

func (e *ContainerBuilder) ContainerInspect() (inspect iotmakerdocker.ContainerInspect, err error)

ContainerInspect (english):

ContainerInspect (português): inspeciona o container

func (*ContainerBuilder) ContainerPause

func (e *ContainerBuilder) ContainerPause() (err error)

ContainerPause (english):

ContainerPause (português): pausa o container

func (*ContainerBuilder) ContainerRemove

func (e *ContainerBuilder) ContainerRemove(removeVolumes bool) (err error)

ContainerRemove (english):

ContainerRemove (português): para e remove o container

func (*ContainerBuilder) ContainerStart

func (e *ContainerBuilder) ContainerStart() (err error)

ContainerStart (english):

ContainerStart (português): inicializa o container

func (*ContainerBuilder) ContainerStop

func (e *ContainerBuilder) ContainerStop() (err error)

ContainerStop (english):

ContainerStop (português): para o container

func (*ContainerBuilder) FindTextInsideContainerLog

func (e *ContainerBuilder) FindTextInsideContainerLog(value string) (contains bool, err error)

FindTextInsideContainerLog (english):

FindTextInsideContainerLog (português): procura por um texto na saída padrão do container

func (*ContainerBuilder) GetChannelEvent

func (e *ContainerBuilder) GetChannelEvent() (channel *chan iotmakerdocker.ContainerPullStatusSendToChannel)

GetChannelEvent (english):

GetChannelEvent (português): Canal disparado durante o processo de image build ou container build e retorna informações como andamento do download da imagem, processo de extração da mesma entre outras informações

Waiting: Esperando o processo ser iniciado pelo docker
Downloading: Estado do download da imagem, caso a mesma não exista na máquina host
  Count: Quantidade de blocos a serem baixados
  Current: Total de bytes baixados até o momento
  Total: Total de bytes a serem baixados
  Percent: Percentual atual do processo com uma casa decimal de precisão
DownloadComplete: todo: fazer
Extracting: Estado da extração da imagem baixada
  Count: Quantidade de blocos a serem extraídos
  Current: Total de bytes extraídos até o momento
  Total: Total de bytes a serem extraídos
  Percent: Percentual atual do processo com uma casa decimal de precisão
PullComplete: todo: fazer
ImageName: nome da imagem baixada
ImageID: ID da imagem baixada. (Cuidado: este valor só é definido ao final do processo)
ContainerID: ID do container criado. (Cuidado: este valor só é definido ao final do processo)
Closed: todo: fazer
Stream: saída padrão do container durante o processo de build
SuccessfullyBuildContainer: sucesso ao fim do processo de build do container
SuccessfullyBuildImage: sucesso ao fim do processo de build da imagem
IdAuxiliaryImages: usado pelo coletor de lixo para apagar as imagens axiliares ao fim do processo de build

func (*ContainerBuilder) GetChannelOnContainerInspect

func (e *ContainerBuilder) GetChannelOnContainerInspect() (channel *chan bool)

GetChannelOnContainerInspect (english):

GetChannelOnContainerInspect (português): Canas disparado a cada ciclo do ticker definido em SetInspectInterval()

func (*ContainerBuilder) GetChannelOnContainerReady

func (e *ContainerBuilder) GetChannelOnContainerReady() (channel *chan bool)

GetChannelOnContainerReady (english):

GetChannelOnContainerReady (português): Canal disparado quando o container está pronto para uso

Nota: Este canal espera o container sinalizar que está pronto, caso SetWaitString() não seja definido, ou espera
pelo texto definido em SetWaitString() aparecer na saída padrão

func (*ContainerBuilder) GetContainerLog

func (e *ContainerBuilder) GetContainerLog() (log []byte, err error)

GetContainerLog (english):

GetContainerLog (português): baixa a saída padrão do container

func (*ContainerBuilder) GetIdByContainerName

func (e *ContainerBuilder) GetIdByContainerName() (err error)

GetIdByContainerName (english):

GetIdByContainerName (português): retorna o ID do container definido em SetContainerName()

func (*ContainerBuilder) GetLastInspect

func (e *ContainerBuilder) GetLastInspect() (inspect iotmakerdocker.ContainerInspect)

GetLastInspect (english):

GetLastInspect (português): Retorna os dados do container baseado no último ciclo do ticker definido em SetInspectInterval()

Nota: a função GetChannelOnContainerInspect() retorna o canal disparado pelo ticker quando as informações estão
prontas para uso

func (*ContainerBuilder) GetLastLogs

func (e *ContainerBuilder) GetLastLogs() (logs string)

GetLastLogs (english):

GetLastLogs (português): Retorna a saída padrão do container baseado no último ciclo do ticker definido em SetInspectInterval()

Nota: a função GetChannelOnContainerInspect() retorna o canal disparado pelo ticker quando as informações estão
prontas para uso

func (*ContainerBuilder) ImageBuildFromFolder

func (e *ContainerBuilder) ImageBuildFromFolder() (err error)

ImageBuildFromFolder (english):

ImageBuildFromFolder (português): transforma o conteúdo da pasta definida em SetBuildFolderPath() em uma imagem

Nota: A pasta deve conter um arquivo dockerfile, mas, como diferentes usos podem ter diferentes dockerfiles,
será dada a seguinte ordem na busca pelo arquivo: "Dockerfile-iotmaker", "Dockerfile", "dockerfile" na pasta raiz.
Se não houver encontrado, será feita uma busca recusiva por "Dockerfile" e "dockerfile"

func (*ContainerBuilder) ImageBuildFromServer

func (e *ContainerBuilder) ImageBuildFromServer() (err error)

func (*ContainerBuilder) ImagePull

func (e *ContainerBuilder) ImagePull() (err error)

ImagePull (english):

ImagePull (português): baixa a imagem a ser montada. (equivale ao comando docker pull)

func (*ContainerBuilder) ImageRemove

func (e *ContainerBuilder) ImageRemove() (err error)

ImageRemove (english):

ImageRemove (português): remove a imagem se não houver containers usando a imagem (remova todos os containers antes do uso, mesmo os parados)

func (*ContainerBuilder) Init

func (e *ContainerBuilder) Init() (err error)

Init (english):

Init (português): Inicializa o objeto e deve ser chamado apenas depois de toas as configurações serem definidas

func (*ContainerBuilder) RemoveAllByNameContains

func (e *ContainerBuilder) RemoveAllByNameContains(value string) (err error)

RemoveAllByNameContains (english):

RemoveAllByNameContains (português): procuta por redes, volumes, container e imagens que contenham o termo definido em "value" no nome e tenta remover os mesmos

func (*ContainerBuilder) SetBuildFolderPath

func (e *ContainerBuilder) SetBuildFolderPath(value string)

SetBuildFolderPath (english):

SetBuildFolderPath (português): Define o caminho da pasta a ser transformada em imagem

value: caminho da pasta a ser transformada em imagem

  Nota: A pasta deve conter um arquivo dockerfile, mas, como diferentes usos podem ter diferentes dockerfiles,
  será dada a seguinte ordem na busca pelo arquivo: "Dockerfile-iotmaker", "Dockerfile", "dockerfile" na pasta raiz.
  Se não houver encontrado, será feita uma busca recusiva por "Dockerfile" e "dockerfile"

func (*ContainerBuilder) SetContainerName

func (e *ContainerBuilder) SetContainerName(value string)

SetContainerName (english):

SetContainerName (português): Define o nome do container

value: nome do container

func (*ContainerBuilder) SetDoNotOpenContainersPorts

func (e *ContainerBuilder) SetDoNotOpenContainersPorts()

SetDoNotOpenContainersPorts (english):

SetDoNotOpenContainersPorts (português): Impede a publicação de portas expostas na rede de forma automática

Nota: A omissão de definição das portas a serem expostas define automaticamente todas as portas contidas na
imagem como portas a serem expostas.
AddPortToOpen() e AddPortToChange() limitam as portas abertas as portas listadas.
SetDoNotOpenContainersPorts() impede a exposição automática de portas.

func (*ContainerBuilder) SetEnvironmentVar

func (e *ContainerBuilder) SetEnvironmentVar(value []string)

SetEnvironmentVar (english):

SetEnvironmentVar (português): Define as variáveis de ambiente

value: array de string contendo um variável de ambiente por chave

func (*ContainerBuilder) SetGitCloneToBuild

func (e *ContainerBuilder) SetGitCloneToBuild(url string)

func (*ContainerBuilder) SetGitCloneToBuildWithPrivateSshKey

func (e *ContainerBuilder) SetGitCloneToBuildWithPrivateSshKey(url, privateSshKeyPath, password string)

func (*ContainerBuilder) SetGitCloneToBuildWithPrivateToken

func (e *ContainerBuilder) SetGitCloneToBuildWithPrivateToken(url, privateToken string)

func (*ContainerBuilder) SetGitCloneToBuildWithUserPassworh

func (e *ContainerBuilder) SetGitCloneToBuildWithUserPassworh(url, user, password string)

func (*ContainerBuilder) SetImageName

func (e *ContainerBuilder) SetImageName(value string)

SetImageName (english):

SetImageName (português): Define o nome da imagem a ser usada ou criada

value: noma da imagem a ser baixada ou criada

  Nota: o nome da imagem deve ter a tag de versão

func (*ContainerBuilder) SetInspectInterval

func (e *ContainerBuilder) SetInspectInterval(value time.Duration)

SetInspectInterval (english):

SetInspectInterval (português): Define o intervalo de monitoramento do container [opcional]

value: intervalo de tempo entre os eventos de inspeção do container

  Nota: Esta função tem um custo computacional elevado e deve ser usada com moderação.
  Os valores capturados são apresentados por GetLastInspect() e GetChannelOnContainerInspect()

func (*ContainerBuilder) SetNetworkDocker

SetNetworkDocker (english):

SetNetworkDocker (português): Define o ponteiro do gerenciador de rede docker

network: ponteiro para o objeto gerenciador de rede.

  Nota: compatível com o objeto dockerBuilderNetwork.ContainerBuilderNetwork{}

func (*ContainerBuilder) SetWaitString

func (e *ContainerBuilder) SetWaitString(value string)

SetWaitString (english):

SetWaitString (português): Define um texto a ser procurado dentro da saída padrão do container e força a espera do mesmo para se considerar o container como pronto para uso

value: texto emitido na saída padrão informando por um evento esperado

func (*ContainerBuilder) WaitForTextInContainerLog

func (e *ContainerBuilder) WaitForTextInContainerLog(value string) (dockerLogs string, err error)

WaitForTextInContainerLog (english):

WaitForTextInContainerLog (português): Para a execução do objeto até o texto ser encontrado na saída padrão do container

value: texto indicativo de evento apresentado na saída padrão do container

Jump to

Keyboard shortcuts

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