container

Documentation

Overview

Copyright © 2022 Joel D. Elkins <joel@elkins.co>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Container
  • func (c *Container) CreateCommands() command.Commands
  • func (c *Container) DestroyCommands() command.Commands
  • func (c *Container) Init(conn context.Context, nets []network.Network) error
  • func (c *Container) IsCreated() bool
  • func (c *Container) IsRunning() bool
  • func (c *Container) LogEntry() *log.Entry
  • func (c *Container) Pid() int
  • func (c *Container) PullCommands() command.Commands
  • func (c *Container) RecreateCommands() command.Commands
  • func (c *Container) RestartCommands() command.Commands
  • func (c *Container) StartCommands() command.Commands
  • func (c *Container) StopCommands() command.Commands
  • func (c *Container) UpdateCommands() command.Commands

Types

type Container

type Container struct {
	Category  string            `toml:"category"`
	Name      string            `toml:"name"`
	Image     string            `toml:"image"`
	Hostname  string            `toml:"hostname,omitempty"`
	Command   []string          `toml:"command,omitempty"`
	Arguments string            `toml:"arguments,omitempty"`
	Networks  []network.Network `toml:"networks,omitempty"`
	Env       map[string]string `toml:"env,omitempty"`
	Mounts    []spec.Mount      `toml:"mounts,omitempty"`
	Restart   string            `toml:"restart,omitempty"`
	Umask     null.Int          `toml:"umask,omitempty"`
	User      string            `toml:"user,omitempty"`
	// contains filtered or unexported fields
}

func (*Container) CreateCommands

func (c *Container) CreateCommands() command.Commands

func (*Container) DestroyCommands

func (c *Container) DestroyCommands() command.Commands

func (*Container) Init

func (c *Container) Init(conn context.Context, nets []network.Network) error

func (*Container) IsCreated

func (c *Container) IsCreated() bool

func (*Container) IsRunning

func (c *Container) IsRunning() bool

func (*Container) LogEntry

func (c *Container) LogEntry() *log.Entry

func (*Container) Pid

func (c *Container) Pid() int

func (*Container) PullCommands

func (c *Container) PullCommands() command.Commands

func (*Container) RecreateCommands

func (c *Container) RecreateCommands() command.Commands

func (*Container) RestartCommands

func (c *Container) RestartCommands() command.Commands

func (*Container) StartCommands

func (c *Container) StartCommands() command.Commands

func (*Container) StopCommands

func (c *Container) StopCommands() command.Commands

func (*Container) UpdateCommands

func (c *Container) UpdateCommands() command.Commands