docker

Documentation

Index

• Constants
• func ClientOptsWithSSHConn(_ context.Context, workDir string, keys *utils.SSHKeyPair, ...) ([]client.Opt, error)
• type DockerHelper
  • func New(opts []client.Opt) (*DockerHelper, error)
  • func (e *DockerHelper) Services(ctx context.Context) (envtypes.Services, error)
  • func (e *DockerHelper) ServicesReady(ctx context.Context) (bool, error)
  • func (e *DockerHelper) WaitForDockerReady(ctx context.Context) error
• type Service
  • func (s Service) GetApplicationName() string
  • func (s Service) GetComponentName() string
  • func (s Service) GetID() string
  • func (s Service) GetNamespace() string
  • func (s Service) GetState() envtypes.ServiceState
  • func (s Service) String() string
• type ServiceCollection
  • func (c ServiceCollection) AsServices() envtypes.Services
  • func (c ServiceCollection) ServiceNames() []string

Constants

const (
	DockerTimeout  = 5 * time.Minute
	TickerInterval = 5 * time.Second
)

const (
	ApplicationName = "openclarity"

	ContainerStateRunning = "running"
	ContainerStateExited  = "exited"
	ContainerStateDead    = "dead"
	ContainerStateHealthy = "healthy"
)

Functions

func ClientOptsWithSSHConn

func ClientOptsWithSSHConn(_ context.Context, workDir string, keys *utils.SSHKeyPair, input *utils.SSHForwardInput) ([]client.Opt, error)

Types

type DockerHelper

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

func New

func New(opts []client.Opt) (*DockerHelper, error)

func (*DockerHelper) Services

func (e *DockerHelper) Services(ctx context.Context) (envtypes.Services, error)

func (*DockerHelper) ServicesReady

func (e *DockerHelper) ServicesReady(ctx context.Context) (bool, error)

func (*DockerHelper) WaitForDockerReady

func (e *DockerHelper) WaitForDockerReady(ctx context.Context) error

type Service

type Service struct {
	ID          string
	Namespace   string
	Application string
	Component   string
	State       envtypes.ServiceState
}

Service is the types.Service interface implementation.

func (Service) GetApplicationName

func (s Service) GetApplicationName() string

func (Service) GetComponentName

func (s Service) GetComponentName() string

func (Service) GetID

func (s Service) GetID() string

func (Service) GetNamespace

func (s Service) GetNamespace() string

func (Service) GetState

func (s Service) GetState() envtypes.ServiceState

func (Service) String

func (s Service) String() string

type ServiceCollection

type ServiceCollection map[string]*Service

func (ServiceCollection) AsServices

func (c ServiceCollection) AsServices() envtypes.Services

func (ServiceCollection) ServiceNames

func (c ServiceCollection) ServiceNames() []string