image

Documentation

Index

• func MetaDataFile() string
• func ReadCellImageYaml(repo, cellImage string) ([]byte, error)
• func ValidateImageTag(imageTag string) error
• func ValidateImageTagWithRegistry(imageTag string) error
• type Cell
• type CellAnnotations
• type CellImage
  • func ParseImageTag(cellImageString string) (parsedCellImage *CellImage, err error)
• type CellImageName
• type CellMetaData
• type CellSpec
• type CellStatus
• type ClusterIngress
• type Component
• type ComponentDependencies
• type ComponentMetaData
• type ComponentMetadata
• type ComponentPort
• type ComponentSpec
• type Destination
• type Extensions
• type Gateway
• type GatewaySpec
• type GrpcIngress
• type HttpIngress
• type Ingress
• type MetaData
  • func ReadMetaData(repo, organization, project, version string) (*MetaData, error)
• type TcpIngress

Functions

func MetaDataFile

func MetaDataFile() string

func ReadCellImageYaml

func ReadCellImageYaml(repo, cellImage string) ([]byte, error)

func ValidateImageTag

func ValidateImageTag(imageTag string) error

ValidateImageTag validates the image tag (without the registry in it).

func ValidateImageTagWithRegistry

func ValidateImageTagWithRegistry(imageTag string) error

ValidateImageTag validates the image tag (with the registry in it). The registry is an option element in this validation.

Types

type Cell

type Cell struct {
	Kind     string       `json:"kind"`
	MetaData CellMetaData `json:"metadata"`
	Spec     CellSpec     `json:"spec"`
	Status   CellStatus   `json:"status"`
}

type CellAnnotations

type CellAnnotations struct {
	Organization string `json:"mesh.cellery.io/cell-image-org"`
	Name         string `json:"mesh.cellery.io/cell-image-name"`
	Version      string `json:"mesh.cellery.io/cell-image-version"`
}

type CellImage

type CellImage struct {
	Registry     string
	Organization string
	ImageName    string
	ImageVersion string
}

func ParseImageTag

func ParseImageTag(cellImageString string) (parsedCellImage *CellImage, err error)

ParseImageTag parses the given image name string and returns a CellImage struct with the relevant information.

type CellImageName

type CellImageName struct {
	Organization string `json:"org"`
	Name         string `json:"name"`
	Version      string `json:"ver"`
}

type CellMetaData

type CellMetaData struct {
	CreationTimestamp string          `json:"creationTimestamp"`
	Annotations       CellAnnotations `json:"annotations"`
	Name              string          `json:"name"`
}

type CellSpec

type CellSpec struct {
	Components []Component `json:"components"`
	Gateway    Gateway     `json:"gateway,omitempty"`
}

type CellStatus

type CellStatus struct {
	Status         string `json:"status"`
	Gateway        string `json:"gatewayServiceName"`
	ComponentCount int    `json:"componentCount"`
}

type ClusterIngress

type ClusterIngress struct {
	Host string `json:"host"`
}

type Component

type Component struct {
	Metadata ComponentMetadata `json:"metadata"`
	Spec     ComponentSpec     `json:"spec"`
}

type ComponentDependencies

type ComponentDependencies struct {
	Cells      map[string]*MetaData `json:"cells"`
	Composites map[string]*MetaData `json:"composites"`
	Components []string             `json:"components"`
}

type ComponentMetaData

type ComponentMetaData struct {
	DockerImage          string                 `json:"dockerImage"`
	IsDockerPushRequired bool                   `json:"isDockerPushRequired"`
	Labels               map[string]string      `json:"labels"`
	IngressTypes         []string               `json:"ingressTypes"`
	Dependencies         *ComponentDependencies `json:"dependencies"`
}

type ComponentMetadata

type ComponentMetadata struct {
	Name string `json:"name"`
}

type ComponentPort

type ComponentPort struct {
	Protocol string `json:"protocol"`
	Port     string `json:"port"`
}

type ComponentSpec

type ComponentSpec struct {
	Ports []ComponentPort `json:"ports"`
}

type Destination

type Destination struct {
	Host string `json:"host"`
}

type Extensions

type Extensions struct {
	ClusterIngress ClusterIngress `json:"clusterIngress"`
}

type Gateway

type Gateway struct {
	Spec GatewaySpec `json:"spec"`
}

type GatewaySpec

type GatewaySpec struct {
	Ingress Ingress `json:"ingress"`
}

type GrpcIngress

type GrpcIngress struct {
	Port        int         `json:"port"`
	Destination Destination `json:"destination"`
}

type HttpIngress

type HttpIngress struct {
	Context     string      `json:"context"`
	Version     string      `json:"version"`
	Global      bool        `json:"global"`
	Port        int         `json:"port"`
	Destination Destination `json:"destination"`
}

type Ingress

type Ingress struct {
	Extensions Extensions    `json:"extensions"`
	HTTP       []HttpIngress `json:"http"`
	GRPC       []GrpcIngress `json:"grpc"`
	TCP        []TcpIngress  `json:"tcp"`
}

type MetaData

type MetaData struct {
	CellImageName
	SchemaVersion       string                        `json:"schemaVersion"`
	Kind                string                        `json:"kind"`
	Components          map[string]*ComponentMetaData `json:"components"`
	BuildTimestamp      int64                         `json:"buildTimestamp"`
	BuildCelleryVersion string                        `json:"buildCelleryVersion"`
	ZeroScalingRequired bool                          `json:"zeroScalingRequired"`
	AutoScalingRequired bool                          `json:"autoScalingRequired"`
}

func ReadMetaData

func ReadMetaData(repo, organization, project, version string) (*MetaData, error)

type TcpIngress

type TcpIngress struct {
	Port        int         `json:"port"`
	Destination Destination `json:"destination"`
}