cc

Documentation

Index

• Constants
• func Container(registry, image, tag string) string
• func ContainerImage() string
• func ContainerName() string
• func ContainerPlatform() string
• func ContainerRegistry() string
• func ContainerTag() string
• func ContainerVersionTag(version, tag string) string
• func GetTopazCertsDir() string
• func GetTopazCfgDir() string
• func GetTopazDataDir() string
• func GetTopazDir() string
• type CommonCtx
  • func NewCommonContext(noCheck bool) (*CommonCtx, error)
  • func (c *CommonCtx) CheckRunStatus(containerName string, expectedStatus runStatus) bool
  • func (c *CommonCtx) IsServing(grpcAddress string) bool

Constants

const (
	StatusNotRunning runStatus = iota
	StatusRunning
)

const (
	DefaultValue string = ""
)

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() 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 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).

Types

type CommonCtx

type CommonCtx struct {
	Context context.Context
	UI      *clui.UI
	NoCheck bool
}

func NewCommonContext

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

func (*CommonCtx) CheckRunStatus

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

func (*CommonCtx) IsServing

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