models

Documentation

Index

• func CannotDeleteNonOrphanedEnvironment(appName, envName string) error
• func CannotRestartAuxiliaryResource(appName, componentName string) error
• func CannotRestartComponent(appName, componentName, state string) error
• func CannotStartComponent(appName, componentName, state string) error
• func CannotStopComponent(appName, componentName, state string) error
• func MissingAuxiliaryResourceDeployment(appName, componentName string) error
• func NonExistingComponent(appName, componentName string) error
• func NonExistingComponentAuxiliaryType(appName, componentName, auxType string) error
• func NonExistingEnvironment(underlyingError error, appName, envName string) error
• type ConfigurationStatus
  • func (p ConfigurationStatus) String() string
• type Environment
• type EnvironmentSummary

Functions

func CannotDeleteNonOrphanedEnvironment

func CannotDeleteNonOrphanedEnvironment(appName, envName string) error

CannotDeleteNonOrphanedEnvironment Can only delete orphaned environments

func CannotRestartAuxiliaryResource

func CannotRestartAuxiliaryResource(appName, componentName string) error

CannotRestartAuxiliaryResource Auxiliary resource cannot be restarted

func CannotRestartComponent

func CannotRestartComponent(appName, componentName, state string) error

CannotRestartComponent Component cannot be restarted

func CannotStartComponent

func CannotStartComponent(appName, componentName, state string) error

CannotStartComponent Component cannot be started

func CannotStopComponent

func CannotStopComponent(appName, componentName, state string) error

CannotStopComponent Component cannot be stopped

func MissingAuxiliaryResourceDeployment

func MissingAuxiliaryResourceDeployment(appName, componentName string) error

CannotRestartAuxiliaryResource Auxiliary resource cannot be restarted

func NonExistingComponent

func NonExistingComponent(appName, componentName string) error

NonExistingComponent No component found by name

func NonExistingComponentAuxiliaryType

func NonExistingComponentAuxiliaryType(appName, componentName, auxType string) error

NonExistingComponentAuxiliaryType Auxiliary resource for component component not found

func NonExistingEnvironment

func NonExistingEnvironment(underlyingError error, appName, envName string) error

NonExistingEnvironment No application found by name

Types

type ConfigurationStatus

type ConfigurationStatus int

ConfigurationStatus Enumeration of the statuses of configuration

const (
	// Pending In configuration but not in cluster
	Pending ConfigurationStatus = iota

	// Consistent In configuration and in cluster
	Consistent

	// Orphan In cluster and not in configuration
	Orphan
)

func (ConfigurationStatus) String

func (p ConfigurationStatus) String() string

type Environment

type Environment struct {
	// Name of the environment
	//
	// required: false
	// example: prod
	Name string `json:"name"`

	// Status of the environment
	// - Pending = Environment exists in Radix config, but not in cluster
	// - Consistent = Environment exists in Radix config and in cluster
	// - Orphan = Environment does not exist in Radix config, but exists in cluster
	//
	// required: false
	// Enum: Pending,Consistent,Orphan
	// example: Consistent
	Status string `json:"status"`

	// Deployments All deployments in environment
	//
	// required: false
	Deployments []*deployModels.DeploymentSummary `json:"deployments,omitempty"`

	// Secrets All secrets in environment
	//
	// required: false
	Secrets []models.Secret `json:"secrets,omitempty"`

	// ActiveDeployment The latest deployment in the environment
	//
	// required: false
	ActiveDeployment *deployModels.Deployment `json:"activeDeployment,omitempty"`

	// BranchMapping The branch mapped to this environment
	//
	// required: false
	// example: master
	BranchMapping string `json:"branchMapping,omitempty"`
}

Environment holds detail information about environment swagger:model Environment

type EnvironmentSummary

type EnvironmentSummary struct {
	// Name of the environment
	//
	// required: false
	// example: prod
	Name string `json:"name"`

	// Status of the environment
	// - Pending = Environment exists in Radix config, but not in cluster
	// - Consistent = Environment exists in Radix config and in cluster
	// - Orphan = Environment does not exist in Radix config, but exists in cluster
	//
	// required: false
	// Enum: Pending,Consistent,Orphan
	// example: Consistent
	Status string `json:"status"`

	// ActiveDeployment The latest deployment in the environment
	//
	// required: false
	ActiveDeployment *deployModels.DeploymentSummary `json:"activeDeployment,omitempty"`

	// BranchMapping The branch mapped to this environment
	//
	// required: false
	BranchMapping string `json:"branchMapping,omitempty"`
}

EnvironmentSummary holds general information about environment swagger:model EnvironmentSummary