container_docker

README

Docker Container module

About this module

This is a module to manage Containers via Docker.

Credentials for private registries are encrypted and securely storaged via Pass.

Important note: The credentials are grouped per registry and saved per username, so only one password is assigned to the pair (registry, username). For example, this means that you can only store one passwort for your GitLab.com account named "ciuser". It is recommended to use one username per project. When using GitLab's project-based Access Tokens, the username can be freely set.

Resources

Setting up the server with this plugin will install the following:

• Docker CE
• Docker Compose Plugin
• containerd.io
• Pass (for registry credential storage)
• golang-docker-credential-helpers

Configuration

None.

Troubleshooting

I can not connect to my private Docker Registry

Make sure to configure the private Docker registry credentials in your project definition file.

container:
  registries:
    - username: gitlab
      password: glpat-12345abcdeFGHIJ12345
      url: https://registry.gitlab.com

GitLab Note: Access Tokens require the read_registry scope and at least the Reporter role.

Documentation

Index

• func InstallApt() error
• func PrepareCredentialsStore() error
• func PrepareFiles() error
• type Data
• type Module
  • func (m Module) Deploy(modulesSettings interface{}) error
  • func (m Module) Destroy(modulesSettings interface{}) error
  • func (Module) GetConfig() system.ModuleConfig
  • func (Module) GetTemplates() *embed.FS
  • func (Module) Init(moduleSettings interface{})
  • func (Module) Install(modulesSettings interface{}) error
• type RegExSettings

Functions

func InstallApt

func InstallApt() error

func PrepareCredentialsStore

func PrepareCredentialsStore() error

func PrepareFiles

func PrepareFiles() error

Types

type Data

type Data struct {
	Context     system.ContextStruct
	DockerPaths container_docker_definitions.DockerPaths
}

type Module

type Module struct {
}

func (Module) Deploy

func (m Module) Deploy(modulesSettings interface{}) error

func (Module) Destroy

func (m Module) Destroy(modulesSettings interface{}) error

func (Module) GetConfig

func (Module) GetConfig() system.ModuleConfig

func (Module) GetTemplates

func (Module) GetTemplates() *embed.FS

func (Module) Init

func (Module) Init(moduleSettings interface{})

func (Module) Install

func (Module) Install(modulesSettings interface{}) error

type RegExSettings

type RegExSettings struct {
	Pattern string
	Repl    string
}