apps

Documentation

Index

• Variables
• type AppDiff
  • func (diff *AppDiff) CalculateDiff() ([]diffmatchpatch.Diff, error)
• type AppLint
• type AppSpec
  • func NewAppSpec() *AppSpec
  • func (spec *AppSpec) SetDefaultValues()
  • func (spec *AppSpec) Validate() []error
• type AppStatus
• type Appfile
  • func NewAppfileFromAppSpec(spec *AppSpec, token string) (*Appfile, error)
  • func NewAppfileFromSpec(spec *AppfileSpec, envName string, token string) (*Appfile, error)
  • func (appfile *Appfile) Destroy() error
  • func (appfile *Appfile) Diff() ([]*AppDiff, error)
  • func (appfile *Appfile) Lint() ([]AppLint, error)
  • func (appfile *Appfile) Status() ([]*AppStatus, error)
  • func (appfile *Appfile) Sync() error
• type AppfileSpec
  • func (spec *AppfileSpec) IsValid() bool
  • func (spec *AppfileSpec) Path() string
  • func (spec *AppfileSpec) ReadEnvironment(name string) (*env.Environment, error)
  • func (spec *AppfileSpec) SetPath(path string) error
• type DeploymentStatus
• type EnvMetadata
• type StateData

Variables

var (
	SpecRegexes = &regexes{
		Name:   regexp.MustCompile(`^[a-z][a-z0-9-]{0,30}[a-z0-9]$`),
		Domain: regexp.MustCompile(`^((xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,}\.?$`),
		Repo:   regexp.MustCompile(`^[^/]+/[^/]+$`),
		EnvKey: regexp.MustCompile(`^[_A-Za-z][_A-Za-z0-9]*$`),
	}

	RegistryTypes = &registryTypes{
		DOCR:       "DOCR",
		DOCKER_HUB: "DOCKER_HUB",
	}

	WorkloadTypes = &workloadTypes{
		ServiceType:    "Service",
		JobType:        "Job",
		StaticSiteType: "Static Site",
		WorkerType:     "Worker",
	}
)

Types

type AppDiff

type AppDiff struct {
	Name string
	// contains filtered or unexported fields
}

func (*AppDiff) CalculateDiff

func (diff *AppDiff) CalculateDiff() ([]diffmatchpatch.Diff, error)

type AppLint

type AppLint struct {
	FileName string
	Name     string
	Errors   []error
}

type AppSpec

type AppSpec struct {
	*godo.AppSpec

	FileName string
	// contains filtered or unexported fields
}

func NewAppSpec

func NewAppSpec() *AppSpec

func (*AppSpec) SetDefaultValues

func (spec *AppSpec) SetDefaultValues()

func (*AppSpec) Validate

func (spec *AppSpec) Validate() []error

type AppStatus

type AppStatus struct {
	Name         string
	Status       DeploymentStatus
	DeploymentID string
	UpdatedAt    string
	URL          string
}

type Appfile

type Appfile struct {
	Spec     *AppfileSpec
	AppSpecs []*AppSpec
	State    *StateData
	// contains filtered or unexported fields
}

func NewAppfileFromAppSpec

func NewAppfileFromAppSpec(spec *AppSpec, token string) (*Appfile, error)

func NewAppfileFromSpec

func NewAppfileFromSpec(spec *AppfileSpec, envName string, token string) (*Appfile, error)

func (*Appfile) Destroy

func (appfile *Appfile) Destroy() error

func (*Appfile) Diff

func (appfile *Appfile) Diff() ([]*AppDiff, error)

func (*Appfile) Lint

func (appfile *Appfile) Lint() ([]AppLint, error)

func (*Appfile) Status

func (appfile *Appfile) Status() ([]*AppStatus, error)

func (*Appfile) Sync

func (appfile *Appfile) Sync() error

type AppfileSpec

type AppfileSpec struct {
	AppSpecs     []string            `yaml:"specs"`
	Environments map[string][]string `yaml:"environments"`
	// contains filtered or unexported fields
}

func (*AppfileSpec) IsValid

func (spec *AppfileSpec) IsValid() bool

func (*AppfileSpec) Path

func (spec *AppfileSpec) Path() string

func (*AppfileSpec) ReadEnvironment

func (spec *AppfileSpec) ReadEnvironment(name string) (*env.Environment, error)

func (*AppfileSpec) SetPath

func (spec *AppfileSpec) SetPath(path string) error

type DeploymentStatus

type DeploymentStatus string

const (
	DeploymentStatusUnknown    DeploymentStatus = "unknown"
	DeploymentStatusDeployed   DeploymentStatus = "deployed"
	DeploymentStatusInProgress DeploymentStatus = "in progress"
)

type EnvMetadata

type EnvMetadata struct {
	Name string
}

type StateData

type StateData struct {
	Environment EnvMetadata
	Values      map[string]interface{}
}