Documentation
¶
Index ¶
- Constants
- func RulesAppName() []validation.Rule
- func RulesNamingIdentifier() []validation.Rule
- type APIResponse
- type App
- type AppConfig
- type AppConfigAutoscale
- type AppConfigExpose
- type AppConfigHealthCheck
- type AppConfigResources
- type AppConfigWithOverrides
- type AppName
- type AppStatus
- type DeploymentDocker
- type DeploymentMeta
- type DeploymentRevisionStatus
- type DeploymentStatus
- type DeploymentStatusMutable
- type DeploymentTrafficStatus
- type DryRunCommit
- type DryRunFile
- type EnvironmentConfig
- type EnvironmentMeta
- type EnvironmentStatus
- type Namespace
- type NamespaceName
- type NewApp
- type OverrideableAppConfig
- type RolloutRequest
- type SaveDeploymentRequest
- type SaveDeploymentResponse
- type SecretMeta
- type SecretMetaStatus
- type TrafficRule
- type UnsealedSecret
Constants ¶
View Source
const ( AppExposeScope_External = "external" AppExposeScope_Cluster = "cluster" )
View Source
const ( RevisionStatusWaiting = "Waiting" RevisionStatusReady = "Ready" RevisionStatusUnhealthy = "Unhealthy" RevisionStatusUnknown = "Unknown" )
Variables ¶
This section is empty.
Functions ¶
func RulesAppName ¶
func RulesAppName() []validation.Rule
func RulesNamingIdentifier ¶
func RulesNamingIdentifier() []validation.Rule
RulesNamingIdentifier returns rules for naming things (e.g. an app, environment) that are RFC 1035 subdomain compatible.
Types ¶
type APIResponse ¶
type APIResponse struct {
Message string `json:"message"`
}
type App ¶
type App struct {
Id uuid.UUID `json:"id"`
Name AppName `json:"name"`
Namespace NamespaceName `json:"namespace"`
}
type AppConfig ¶
type AppConfig struct {
Id uuid.UUID `json:"id"`
Name AppName `json:"name"`
Namespace NamespaceName `json:"namespace"`
Expose *AppConfigExpose `json:"expose,omitempty"`
HealthCheck *AppConfigHealthCheck `json:"healthcheck,omitempty"`
Image string `json:"image"`
OverrideableAppConfig `json:",inline"`
}
AppConfig is the root of the application config object graph without environment overrides
func (*AppConfig) ApplyDefaults ¶ added in v0.0.10
ApplyDefaults sets any unset values with their defaults
type AppConfigAutoscale ¶
type AppConfigExpose ¶
type AppConfigHealthCheck ¶
type AppConfigHealthCheck struct {
Path string `json:"path,omitempty"`
}
Mode is not yet implemented (httpGet = default)
type AppConfigResources ¶
type AppConfigWithOverrides ¶
type AppConfigWithOverrides struct {
AppConfig `json:",inline"`
Overrides map[string]OverrideableAppConfig `json:"environmentOverrides,omitempty"`
}
AppConfigWithOverrides contains an app with environment level overrides
func (*AppConfigWithOverrides) ApplyOverrides ¶
func (cfg *AppConfigWithOverrides) ApplyOverrides(envName string) (*AppConfig, error)
type AppStatus ¶
type AppStatus struct {
AppId uuid.UUID `json:"appId"`
Environments []EnvironmentStatus `json:"environments"`
Deployments []DeploymentStatus `json:"deployments"`
}
type DeploymentDocker ¶
type DeploymentDocker struct {
Tag string `json:"tag"`
}
type DeploymentMeta ¶
type DeploymentMeta struct {
Name string `json:"name"`
// Namespace is an intentional omission. We always use the app's namespace as we do not allow an app to deploy to multiple namespaces at
// this time.
Environment string `json:"environment"`
Docker DeploymentDocker `json:"docker"`
ManualRollout bool `json:"manualRollout"`
}
func (DeploymentMeta) Validate ¶ added in v0.0.10
func (d DeploymentMeta) Validate() error
type DeploymentStatus ¶
type DeploymentStatusMutable ¶
type DeploymentStatusMutable struct {
ObservedRiserRevision int64 `json:"observedRiserRevision"`
Revisions []DeploymentRevisionStatus `json:"revisions,omitempty"`
Traffic []DeploymentTrafficStatus `json:"traffic,omitempty"`
LatestCreatedRevisionName string `json:"latestCreatedRevisionName"`
LatestReadyRevisionName string `json:"latestReadyRevisionName"`
}
type DeploymentTrafficStatus ¶
type DryRunCommit ¶
type DryRunCommit struct {
Message string `json:"message"`
Files []DryRunFile `json:"files"`
}
type DryRunFile ¶
type EnvironmentConfig ¶ added in v0.0.12
type EnvironmentMeta ¶ added in v0.0.12
type EnvironmentMeta struct {
Name string
}
type EnvironmentStatus ¶ added in v0.0.12
type Namespace ¶ added in v0.0.10
type Namespace struct {
Name NamespaceName `json:"name"`
}
type NamespaceName ¶ added in v0.0.10
type NamespaceName string
func (NamespaceName) Validate ¶ added in v0.0.10
func (v NamespaceName) Validate() error
type NewApp ¶
type NewApp struct {
Name AppName `json:"name"`
Namespace NamespaceName `json:"namespace"`
}
type OverrideableAppConfig ¶ added in v0.0.12
type OverrideableAppConfig struct {
Autoscale *AppConfigAutoscale `json:"autoscale,omitempty"`
Environment map[string]intstr.IntOrString `json:"env,omitempty"`
Resources *AppConfigResources `json:"resources,omitempty"`
}
OverrideableAppConfig contains properties that are overrideable
type RolloutRequest ¶
type RolloutRequest struct {
Traffic []TrafficRule `json:"traffic"`
}
func (*RolloutRequest) Validate ¶
func (rolloutRequest *RolloutRequest) Validate() error
type SaveDeploymentRequest ¶ added in v0.0.21
type SaveDeploymentRequest struct {
DeploymentMeta `json:",inline"`
App *AppConfigWithOverrides `json:"app"`
}
func (*SaveDeploymentRequest) ApplyDefaults ¶ added in v0.0.21
func (d *SaveDeploymentRequest) ApplyDefaults() error
func (SaveDeploymentRequest) Validate ¶ added in v0.0.21
func (d SaveDeploymentRequest) Validate() error
type SaveDeploymentResponse ¶ added in v0.0.21
type SaveDeploymentResponse struct {
RiserRevision int64 `json:"riserRevision"`
Message string `json:"message"`
DryRunCommits []DryRunCommit `json:"dryRunCommits,omitempty"`
}
type SecretMeta ¶
type SecretMeta struct {
Name string `json:"name"`
AppName AppName `json:"app"`
Namespace NamespaceName `json:"namespace"`
Environment string `json:"environment"`
}
func (SecretMeta) Validate ¶ added in v0.0.10
func (v SecretMeta) Validate() error
type SecretMetaStatus ¶
type SecretMetaStatus struct {
SecretMeta `json:",inline"`
Revision int64 `json:"revision"`
}
type TrafficRule ¶
func (*TrafficRule) Validate ¶
func (trafficRule *TrafficRule) Validate() error
type UnsealedSecret ¶
type UnsealedSecret struct {
SecretMeta `json:",inline"`
PlainText string `json:"plainTextValue"`
}
func (UnsealedSecret) Validate ¶ added in v0.0.10
func (v UnsealedSecret) Validate() error
Click to show internal directories.
Click to hide internal directories.