docker

package

v0.0.0-...-c299419 Latest Latest Go to latest Published: May 31, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/openclarity/vmclarity

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ClientOptsWithSSHConn(_ context.Context, workDir string, keys *utils.SSHKeyPair, ...) ([]client.Opt, error)
type DockerHelper
- func New(opts []client.Opt) (*DockerHelper, error)
type Service
type ServiceCollection
- func (c ServiceCollection) AsServices() envtypes.Services
- func (c ServiceCollection) ServiceNames() []string

Constants ¶

View Source

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

View Source

const (
	ApplicationName = "vmclarity"

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

Variables ¶

This section is empty.

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

Source Files ¶

View all Source files

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