Documentation
¶
Index ¶
- func CannotDeleteNonOrphanedEnvironment(appName, envName string) error
- func CannotRestartComponent(appName, componentName, state string) error
- func CannotStartComponent(appName, componentName, state string) error
- func CannotStopComponent(appName, componentName, state string) error
- func NonExistingComponent(appName, componentName string) error
- func NonExistingEnvironment(underlyingError error, appName, envName string) error
- type ConfigurationStatus
- type Environment
- type EnvironmentSummary
- type Secret
- type SecretParameters
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CannotDeleteNonOrphanedEnvironment ¶
CannotDeleteNonOrphanedEnvironment Can only delete orhaned environments
func CannotRestartComponent ¶
CannotRestartComponent Component cannot be restarted
func CannotStartComponent ¶
CannotStartComponent Component cannot be started
func CannotStopComponent ¶
CannotStopComponent Component cannot be stopped
func NonExistingComponent ¶
NonExistingComponent No component found by name
func NonExistingEnvironment ¶
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 GetStatusFromName ¶
func GetStatusFromName(name string) (ConfigurationStatus, error)
GetStatusFromName Gets status from name
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 []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
type Secret ¶
type Secret struct {
// Name of the secret
//
// required: false
// example: db_password
Name string `json:"name"`
// Component name of the component having the secret
//
// required: false
// example: api
Component string `json:"component"`
// Status of the secret
// - Pending = Secret exists in Radix config, but not in cluster
// - Consistent = Secret exists in Radix config and in cluster
// - Orphan = Secret does not exist in Radix config, but exists in cluster
//
// required: false
// example: Consistent
Status string `json:"status"`
}
Secret holds general information about secret swagger:model Secret
type SecretParameters ¶
type SecretParameters struct {
// Name the unique name of the Radix application deployment
//
// required: true
// example: p4$sW0rDz
SecretValue string `json:"secretValue"`
}
SecretParameters describes a component secret swagger:model SecretParameters