Documentation
¶
Overview ¶
Package provider defines deployment adapters shared by the CLI and workbench.
Index ¶
- Variables
- type BundleRelocator
- type DestroyOptions
- type EnvRef
- type Event
- type ExportOnly
- func (ExportOnly) Apply(context.Context, *plan.Plan, *state.Store, map[string]string, chan<- Event) error
- func (ExportOnly) Capabilities(context.Context, spec.Target) (model.Capabilities, error)
- func (ExportOnly) Destroy(context.Context, *plan.Plan, *state.Store, DestroyOptions) error
- func (ExportOnly) Logs(context.Context, ServiceRef, LogOptions) (io.ReadCloser, error)
- func (e ExportOnly) Name() string
- func (ExportOnly) Observe(context.Context, EnvRef, *state.Store) (Status, error)
- func (ExportOnly) Operations(context.Context, *model.Deployment, *render.Bundle, state.Snapshot) ([]plan.Operation, error)
- func (ExportOnly) Render(context.Context, *model.Deployment) (*render.Bundle, error)
- func (ExportOnly) Rollback(context.Context, EnvRef, *state.Store, string) error
- func (ExportOnly) Validate(context.Context, *model.Deployment) output.Diagnostics
- type Factory
- type IdentityObserver
- type LogOptions
- type Preflighter
- type Provider
- type Registry
- type ServiceRef
- type ServiceStatus
- type Status
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrUnsupported = errors.New("not supported by this provider")
Functions ¶
This section is empty.
Types ¶
type BundleRelocator ¶
type BundleRelocator interface {
Relocate(deployment *model.Deployment, bundle *render.Bundle, directory string) (*render.Bundle, error)
}
BundleRelocator adjusts build paths in an approved export for another directory.
type DestroyOptions ¶
type DestroyOptions struct{ DeleteData bool }
type ExportOnly ¶
type ExportOnly struct{ ProviderName string }
ExportOnly gives adapters explicit unsupported defaults for unimplemented operations.
func (ExportOnly) Capabilities ¶
func (ExportOnly) Capabilities(context.Context, spec.Target) (model.Capabilities, error)
func (ExportOnly) Destroy ¶
func (ExportOnly) Destroy(context.Context, *plan.Plan, *state.Store, DestroyOptions) error
func (ExportOnly) Logs ¶
func (ExportOnly) Logs(context.Context, ServiceRef, LogOptions) (io.ReadCloser, error)
func (ExportOnly) Name ¶
func (e ExportOnly) Name() string
func (ExportOnly) Operations ¶
func (ExportOnly) Render ¶
func (ExportOnly) Render(context.Context, *model.Deployment) (*render.Bundle, error)
func (ExportOnly) Validate ¶
func (ExportOnly) Validate(context.Context, *model.Deployment) output.Diagnostics
type IdentityObserver ¶
type IdentityObserver interface {
SnapshotIDs(ctx context.Context, deployment *model.Deployment) (map[string][]string, error)
}
IdentityObserver reads current remote identities without changing workloads.
type LogOptions ¶
type Preflighter ¶
type Preflighter interface {
Preflight(ctx context.Context, deployment *model.Deployment) error
}
Preflighter checks target access and delivery before mutations.
type Provider ¶
type Provider interface {
Name() string
Capabilities(ctx context.Context, target spec.Target) (model.Capabilities, error)
Validate(ctx context.Context, deployment *model.Deployment) output.Diagnostics
Render(ctx context.Context, deployment *model.Deployment) (*render.Bundle, error)
Operations(ctx context.Context, deployment *model.Deployment, bundle *render.Bundle, snapshot state.Snapshot) ([]plan.Operation, error)
Apply(ctx context.Context, p *plan.Plan, store *state.Store, values map[string]string, events chan<- Event) error
Observe(ctx context.Context, ref EnvRef, store *state.Store) (Status, error)
Logs(ctx context.Context, ref ServiceRef, options LogOptions) (io.ReadCloser, error)
Rollback(ctx context.Context, ref EnvRef, store *state.Store, release string) error
Destroy(ctx context.Context, p *plan.Plan, store *state.Store, options DestroyOptions) error
}
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
func NewRegistry ¶
type ServiceRef ¶
type ServiceRef struct{ Target, Env, Service string }
type ServiceStatus ¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package compose deploys and observes services with Docker Compose v2.
|
Package compose deploys and observes services with Docker Compose v2. |
|
Package handoff exports portable Compose graphs for platforms without a qualified native adapter.
|
Package handoff exports portable Compose graphs for platforms without a qualified native adapter. |
|
Package hosted exports ctrlplane-compatible workload contracts without account-side mutation.
|
Package hosted exports ctrlplane-compatible workload contracts without account-side mutation. |
|
Package kubernetes renders and deploys approved graphs to an explicit cluster context.
|
Package kubernetes renders and deploys approved graphs to an explicit cluster context. |
|
Package managed generates schema-validated cloud provider handoffs.
|
Package managed generates schema-validated cloud provider handoffs. |
Click to show internal directories.
Click to hide internal directories.