Documentation
¶
Index ¶
- func CannotDeleteNonOrphanedEnvironment(appName, envName string) error
- func CannotResetScaledComponent(appName, componentName string) error
- func CannotRestartAuxiliaryResource(appName, componentName string) error
- func CannotRestartComponent(appName, componentName, state string) error
- func CannotScaleComponent(appName, envName, componentName, state string) error
- func CannotScaleComponentToMoreThanMaxReplicas(appName, envName, componentName string, maxScaleReplicas int) error
- func CannotScaleComponentToNegativeReplicas(appName, envName, componentName string) error
- func CannotStopComponent(appName, componentName, state string) error
- func JobComponentCanOnlyBeRestarted() 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
- func ScheduledJobPayloadNotFoundError(appName, jobName string) error
- func ScheduledJobPayloadUnexpectedError(message, appName, jobName string) error
- type ConfigurationStatus
- type Environment
- type EnvironmentSummary
- type ScheduledBatchRequest
- type ScheduledJobRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CannotDeleteNonOrphanedEnvironment ¶
CannotDeleteNonOrphanedEnvironment Can only delete orphaned environments
func CannotResetScaledComponent ¶
CannotResetScaledComponent Component cannot be started
func CannotRestartAuxiliaryResource ¶
CannotRestartAuxiliaryResource Auxiliary resource cannot be restarted
func CannotRestartComponent ¶
CannotRestartComponent Component cannot be restarted
func CannotScaleComponent ¶
CannotScaleComponent Component cannot be scaled
func CannotScaleComponentToMoreThanMaxReplicas ¶
func CannotScaleComponentToMoreThanMaxReplicas(appName, envName, componentName string, maxScaleReplicas int) error
CannotScaleComponentToMoreThanMaxReplicas Component cannot be scaled to more than max replicas
func CannotScaleComponentToNegativeReplicas ¶
CannotScaleComponentToNegativeReplicas Component cannot be scaled to negative replica amount
func CannotStopComponent ¶
CannotStopComponent Component cannot be stopped
func JobComponentCanOnlyBeRestarted ¶
func JobComponentCanOnlyBeRestarted() error
JobComponentCanOnlyBeRestarted Job component cannot be started or stopped, but only restarted
func MissingAuxiliaryResourceDeployment ¶
MissingAuxiliaryResourceDeployment Auxiliary resource cannot be found
func NonExistingComponent ¶
NonExistingComponent No component found by name
func NonExistingComponentAuxiliaryType ¶
NonExistingComponentAuxiliaryType Auxiliary resource for component component not found
func NonExistingEnvironment ¶
NonExistingEnvironment No application found by name
func ScheduledJobPayloadNotFoundError ¶
ScheduledJobPayloadNotFoundError Payload for the scheduled job not found
func ScheduledJobPayloadUnexpectedError ¶
ScheduledJobPayloadUnexpectedError Scheduled job has unexpected error
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: true
// 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: true
// 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 ScheduledBatchRequest ¶
type ScheduledBatchRequest struct {
// Name of the Radix deployment for a batch
DeploymentName string `json:"deploymentName"`
}
ScheduledBatchRequest holds information about a creating scheduled batch request swagger:model ScheduledBatchRequest
type ScheduledJobRequest ¶
type ScheduledJobRequest struct {
// Name of the Radix deployment for a job
DeploymentName string `json:"deploymentName"`
}
ScheduledJobRequest holds information about a creating scheduled job request swagger:model ScheduledJobRequest
Source Files