Documentation
¶
Index ¶
- Constants
- type AppHealthCheckType
- type AppLifecycle
- type AppManifest
- type AppManifestDocker
- type AppManifestProcess
- type AppManifestProcesses
- type AppManifestRoute
- type AppManifestRoutes
- type AppManifestService
- type AppManifestServices
- type AppManifestSideCar
- type AppManifestSideCars
- type AppProcessType
- type AppPushOperation
- func (p *AppPushOperation) Push(ctx context.Context, appManifest *AppManifest, zipFile io.Reader) (*resource.App, error)
- func (p *AppPushOperation) WithBlueGreenStrategy(timeout uint, checkInterval uint)
- func (p *AppPushOperation) WithNoStart(stopped bool)
- func (p *AppPushOperation) WithStrategy(s StrategyMode)
- type AppRouteProtocol
- type Manifest
- type StrategyMode
Constants ¶
View Source
const ( AppDeployedRunningCheckIntervalSecondsDefault = 5 AppDeployedRunningTimeoutMinutesDefault = 5 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppHealthCheckType ¶
type AppHealthCheckType string
const ( Http AppHealthCheckType = "http" Port AppHealthCheckType = "port" Process AppHealthCheckType = "process" )
type AppLifecycle ¶
type AppLifecycle string
const ( Buildpack AppLifecycle = "buildpack" Docker AppLifecycle = "docker" CNB AppLifecycle = "cnb" )
type AppManifest ¶
type AppManifest struct {
Name string `yaml:"name"`
Path string `yaml:"path,omitempty"`
Buildpacks []string `yaml:"buildpacks,omitempty"`
Docker *AppManifestDocker `yaml:"docker,omitempty"`
Lifecycle AppLifecycle `yaml:"lifecycle,omitempty"`
Env map[string]string `yaml:"env,omitempty"`
RandomRoute bool `yaml:"random-route,omitempty"`
NoRoute bool `yaml:"no-route,omitempty"`
DefaultRoute bool `yaml:"default-route,omitempty"`
Routes *AppManifestRoutes `yaml:"routes,omitempty"`
Services *AppManifestServices `yaml:"services,omitempty"`
Sidecars *AppManifestSideCars `yaml:"sidecars,omitempty"`
Processes *AppManifestProcesses `yaml:"processes,omitempty"`
Stack string `yaml:"stack,omitempty"`
Metadata *resource.Metadata `yaml:"metadata,omitempty"`
AppManifestProcess `yaml:",inline"`
}
func NewAppManifest ¶
func NewAppManifest(appName string) *AppManifest
type AppManifestDocker ¶
type AppManifestProcess ¶
type AppManifestProcess struct {
Type AppProcessType `yaml:"type,omitempty"`
Command string `yaml:"command,omitempty"`
DiskQuota string `yaml:"disk_quota,omitempty"`
HealthCheckType AppHealthCheckType `yaml:"health-check-type,omitempty"`
HealthCheckHTTPEndpoint string `yaml:"health-check-http-endpoint,omitempty"`
HealthCheckInvocationTimeout uint `yaml:"health-check-invocation-timeout,omitempty"`
Instances *uint `yaml:"instances,omitempty"`
LogRateLimitPerSecond string `yaml:"log-rate-limit-per-second,omitempty"`
Memory string `yaml:"memory,omitempty"`
Timeout uint `yaml:"timeout,omitempty"`
HealthCheckInterval uint `yaml:"health-check-interval,omitempty"`
ReadinessHealthCheckType string `yaml:"readiness-health-check-type,omitempty"`
ReadinessHealthCheckHttpEndpoint string `yaml:"readiness-health-check-http-endpoint,omitempty"`
ReadinessHealthInvocationTimeout uint `yaml:"readiness-health-invocation-timeout,omitempty"`
ReadinessHealthCheckInterval uint `yaml:"readiness-health-check-interval,omitempty"`
}
type AppManifestProcesses ¶
type AppManifestProcesses []AppManifestProcess
type AppManifestRoute ¶
type AppManifestRoute struct {
Route string `yaml:"route"`
Protocol AppRouteProtocol `yaml:"protocol,omitempty"`
}
type AppManifestRoutes ¶
type AppManifestRoutes []AppManifestRoute
type AppManifestService ¶
type AppManifestService struct {
Name string `yaml:"name"`
BindingName string `yaml:"binding_name,omitempty"`
Parameters map[string]interface{} `yaml:"parameters,omitempty"`
}
func (*AppManifestService) UnmarshalYAML ¶
func (ams *AppManifestService) UnmarshalYAML(unmarshal func(interface{}) error) error
type AppManifestServices ¶
type AppManifestServices []AppManifestService
type AppManifestSideCar ¶
type AppManifestSideCars ¶
type AppManifestSideCars []AppManifestSideCar
type AppProcessType ¶
type AppProcessType string
const ( Web AppProcessType = "web" Worker AppProcessType = "worker" )
type AppPushOperation ¶
type AppPushOperation struct {
// contains filtered or unexported fields
}
AppPushOperation can be used to push buildpack apps
func NewAppPushOperation ¶
func NewAppPushOperation(client *client.Client, orgName, spaceName string) *AppPushOperation
NewAppPushOperation creates a new AppPushOperation
func (*AppPushOperation) Push ¶
func (p *AppPushOperation) Push(ctx context.Context, appManifest *AppManifest, zipFile io.Reader) (*resource.App, error)
Push creates or updates an application using the specified manifest and zipped source files
func (*AppPushOperation) WithBlueGreenStrategy ¶
func (p *AppPushOperation) WithBlueGreenStrategy(timeout uint, checkInterval uint)
func (*AppPushOperation) WithNoStart ¶
func (p *AppPushOperation) WithNoStart(stopped bool)
func (*AppPushOperation) WithStrategy ¶
func (p *AppPushOperation) WithStrategy(s StrategyMode)
type AppRouteProtocol ¶
type AppRouteProtocol string
const ( HTTP1 AppRouteProtocol = "http1" HTTP2 AppRouteProtocol = "http2" TCP AppRouteProtocol = "tcp" )
type Manifest ¶
type Manifest struct {
Version string `yaml:"version,omitempty"`
Applications []*AppManifest `yaml:"applications"`
}
func NewManifest ¶
func NewManifest(applications ...*AppManifest) *Manifest
type StrategyMode ¶
type StrategyMode int
const ( StrategyNone StrategyMode = iota StrategyBlueGreen StrategyRolling )
Click to show internal directories.
Click to hide internal directories.