spec

Documentation

Index

• Constants
• type Container
• type ContainerLimits
• type CronArgs
• type CronJob
  • func NewCronJob(description, slugURL, schedule string, imgs *Images, a *app.App, ...) *CronJob
• type Deploy
  • func NewDeploy(imgs *Images, description, slugURL string, rhl int, a *app.App, ...) *Deploy
• type HealthCheck
• type HealthCheckProbe
• type Images
• type Labels
• type Lifecycle
• type Pod
  • func NewBuilder(name, tarBallLocation, buildDest, image string, a *app.App, fs storage.Storage, ...) *Pod
  • func NewPod(name, nginxImage, image string, a *app.App, envVars map[string]string, ...) *Pod
  • func NewRunner(name, slugURL string, imgs *Images, a *app.App, fs storage.Storage, ...) *Pod
• type Port
• type PreStop
• type RollingUpdate
• type Service
  • func NewDefaultService(appName, sType, portName string) *Service
  • func NewService(namespace, name, sType string, ports []ServicePort, labels map[string]string) *Service
• type ServicePort
  • func NewDefaultServicePort(name string) *ServicePort
  • func NewServicePort(name string, port, targetPort int) *ServicePort
• type TeresaYaml
• type Volume
• type VolumeMounts

Constants

const (
	DefaultPort = 5000

	SlugAnnotation = "teresa.io/slug"

	DefaultExternalPort = 80
)

Types

type Container

type Container struct {
	Name            string
	Image           string
	ContainerLimits *ContainerLimits
	Env             map[string]string
	VolumeMounts    []*VolumeMounts
	Command         []string
	Args            []string
	Ports           []Port
	Secrets         []string
}

type ContainerLimits

type ContainerLimits struct {
	CPU    string
	Memory string
}

type CronArgs

type CronArgs struct {
	Schedule string `yaml:"schedule",omitempty"`
}

type CronJob

type CronJob struct {
	Deploy
	Schedule                   string
	SuccessfulJobsHistoryLimit int32
	FailedJobsHistoryLimit     int32
}

func NewCronJob

func NewCronJob(description, slugURL, schedule string, imgs *Images, a *app.App, fs storage.Storage, args ...string) *CronJob

type Deploy

type Deploy struct {
	Pod
	TeresaYaml
	RevisionHistoryLimit int
	Description          string
	SlugURL              string
}

func NewDeploy

func NewDeploy(imgs *Images, description, slugURL string, rhl int, a *app.App, tYaml *TeresaYaml, fs storage.Storage) *Deploy

type HealthCheck

type HealthCheck struct {
	Liveness  *HealthCheckProbe
	Readiness *HealthCheckProbe
}

type HealthCheckProbe

type HealthCheckProbe struct {
	FailureThreshold    int32  `yaml:"failureThreshold"`
	InitialDelaySeconds int32  `yaml:"initialDelaySeconds"`
	PeriodSeconds       int32  `yaml:"periodSeconds"`
	SuccessThreshold    int32  `yaml:"successThreshold"`
	TimeoutSeconds      int32  `yaml:"timeoutSeconds"`
	Path                string `yaml:"path"`
}

type Images

type Images struct {
	SlugRunner  string
	SlugBuilder string
	SlugStore   string
	Nginx       string
}

type Labels

type Labels map[string]string

type Lifecycle

type Lifecycle struct {
	PreStop *PreStop `yaml:"preStop,omitempty"`
}

type Pod

type Pod struct {
	Name           string
	Namespace      string
	Containers     []*Container
	Volumes        []*Volume
	InitContainers []*Container
	Labels         Labels
}

func NewBuilder

func NewBuilder(name, tarBallLocation, buildDest, image string, a *app.App, fs storage.Storage, cl *ContainerLimits) *Pod

func NewPod

func NewPod(name, nginxImage, image string, a *app.App, envVars map[string]string, fs storage.Storage) *Pod

func NewRunner

func NewRunner(name, slugURL string, imgs *Images, a *app.App, fs storage.Storage, cl *ContainerLimits, command ...string) *Pod

type Port

type Port struct {
	Name          string
	ContainerPort int32
}

type PreStop

type PreStop struct {
	DrainTimeoutSeconds int `yaml:"drainTimeoutSeconds,omitempty"`
}

type RollingUpdate

type RollingUpdate struct {
	MaxSurge       string `yaml:"maxSurge,omitempty"`
	MaxUnavailable string `yaml:"maxUnavailable,omitempty"`
}

type Service

type Service struct {
	Name      string
	Namespace string
	Type      string
	Labels    map[string]string
	Ports     []ServicePort
}

func NewDefaultService

func NewDefaultService(appName, sType, portName string) *Service

func NewService

func NewService(namespace, name, sType string, ports []ServicePort, labels map[string]string) *Service

type ServicePort

type ServicePort struct {
	Name       string
	Port       int
	TargetPort int
}

func NewDefaultServicePort

func NewDefaultServicePort(name string) *ServicePort

func NewServicePort

func NewServicePort(name string, port, targetPort int) *ServicePort

type TeresaYaml

type TeresaYaml struct {
	HealthCheck   *HealthCheck   `yaml:"healthCheck,omitempty"`
	RollingUpdate *RollingUpdate `yaml:"rollingUpdate,omitempty"`
	Lifecycle     *Lifecycle     `yaml:"lifecycle,omitempty"`
	Cron          *CronArgs      `yaml:"cron,omitempty"`
}

type Volume

type Volume struct {
	Name          string
	SecretName    string
	ConfigMapName string
	EmptyDir      bool
}

type VolumeMounts

type VolumeMounts struct {
	Name      string
	MountPath string
	ReadOnly  bool
}