cc

Documentation

Index

• Constants
• Variables
• func Container(registry, image, tag string) string
• func ContainerImage() string
• func ContainerName(defaultConfigFile string) string
• func ContainerPlatform() string
• func ContainerRegistry() string
• func ContainerTag() string
• func ContainerVersionTag(version, tag string) string
• func EnsureDirs() error
• func EnsureTopazCertsDir() error
• func EnsureTopazCfgDir() error
• func EnsureTopazDataDir() error
• func GetTopazCertsDir() string
• func GetTopazCfgDir() string
• func GetTopazDataDir() string
• func GetTopazDir() string
• func Retry(timeout, interval time.Duration, f func() error) (err error)
• func ServiceHealthStatus(addr, service string) bool
• func WaitForPorts(ports []string, expectedStatus PortStatus) error
• type ActiveConfig
• type CLIConfig
• type CommonCtx
  • func NewCommonContext(noCheck bool, configFilePath string) (*CommonCtx, error)
  • func (c *CommonCtx) CheckRunStatus(containerName string, expectedStatus runStatus) bool
  • func (c *CommonCtx) GetRunningContainers() ([]*types.Container, error)
  • func (c *CommonCtx) IsServing(grpcAddress string) bool
  • func (c *CommonCtx) SaveContextConfig(configurationFile string) error
• type DefaultsConfig
• type PortStatus
  • func (p PortStatus) String() string
• type RunningConfig

Constants

const (
	StatusNotRunning runStatus = iota
	StatusRunning
)

const (
	DefaultValue string = ""
)

Variables

var (
	ErrNotRunning = errors.New("topaz is not running, use 'topaz start' or 'topaz run' to start")
	ErrIsRunning  = errors.New("topaz is already running, use 'topaz stop' to stop")
	ErrNotServing = errors.New("topaz gRPC endpoint not SERVING")
)

Functions

func Container

func Container(registry, image, tag string) string

Container returns the fully qualified container name (registry/image:tag).

func ContainerImage

func ContainerImage() string

ContainerImage returns the container image name.

func ContainerName

func ContainerName(defaultConfigFile string) string

ContainerName returns the container instance name (docker run --name CONTAINER_NAME).

func ContainerPlatform

func ContainerPlatform() string

ContainerPlatform, returns the container platform for multi-platform capable servers.

func ContainerRegistry

func ContainerRegistry() string

ContainerRegistry returns the container registry (host[:port]/repo).

func ContainerTag

func ContainerTag() string

ContainerTag returns the container tag (label or semantic version).

func ContainerVersionTag

func ContainerVersionTag(version, tag string) string

ContainerVersionTag consolidates the old --container-version with the --container-tag value, the command handlers will read the environment variable versions $CONTAINER_VERSION and $CONTAINER_TAG, which is why they are not explicitly handled in this function.

func EnsureDirs

func EnsureDirs() error

func EnsureTopazCertsDir

func EnsureTopazCertsDir() error

func EnsureTopazCfgDir

func EnsureTopazCfgDir() error

func EnsureTopazDataDir

func EnsureTopazDataDir() error

func GetTopazCertsDir

func GetTopazCertsDir() string

GetTopazCertsDir returns the topaz certs directory ($TOPAZ_DIR/certs).

func GetTopazCfgDir

func GetTopazCfgDir() string

GetTopazCfgDir returns the topaz config directory ($TOPAZ_DIR/cfg).

func GetTopazDataDir

func GetTopazDataDir() string

GetTopazDataDir returns the topaz db directory ($TOPAZ_DIR/db).

func GetTopazDir

func GetTopazDir() string

GetTopazDir returns the topaz root directory ($TOPAZ_DIR).

func Retry

func Retry(timeout, interval time.Duration, f func() error) (err error)

func ServiceHealthStatus

func ServiceHealthStatus(addr, service string) bool

ServiceHealthStatus adopted from grpc-health-probe cli implementation https://github.com/grpc-ecosystem/grpc-health-probe/blob/master/main.go.

func WaitForPorts

func WaitForPorts(ports []string, expectedStatus PortStatus) error

Types

type ActiveConfig

type ActiveConfig struct {
	Config     string `json:"config"`
	ConfigFile string `json:"config_file"`
}

type CLIConfig

type CLIConfig struct {
	Version  int            `json:"version"`
	Active   ActiveConfig   `json:"active"`
	Running  RunningConfig  `json:"running"`
	Defaults DefaultsConfig `json:"defaults"`
}

type CommonCtx

type CommonCtx struct {
	Context context.Context
	UI      *clui.UI
	Config  *CLIConfig
}

func NewCommonContext

func NewCommonContext(noCheck bool, configFilePath string) (*CommonCtx, error)

func (*CommonCtx) CheckRunStatus

func (c *CommonCtx) CheckRunStatus(containerName string, expectedStatus runStatus) bool

func (*CommonCtx) GetRunningContainers

func (c *CommonCtx) GetRunningContainers() ([]*types.Container, error)

func (*CommonCtx) IsServing

func (c *CommonCtx) IsServing(grpcAddress string) bool

func (*CommonCtx) SaveContextConfig

func (c *CommonCtx) SaveContextConfig(configurationFile string) error

type DefaultsConfig

type DefaultsConfig struct {
	NoCheck           bool   `json:"no_check"`
	ContainerRegistry string `json:"container_registry"`
	ContainerImage    string `json:"container_image"`
	ContainerTag      string `json:"container_tag"`
	ContainerPlatform string `json:"container_platform"`
}

type PortStatus

type PortStatus int

const (
	PortOpened PortStatus = iota
	PortClosed
)

func (PortStatus) String

func (p PortStatus) String() string

type RunningConfig

type RunningConfig struct {
	ActiveConfig
	ContainerName string `json:"container_name"`
}