This change implements some feedback from @ellismg. * Make backend.Stack an interface and let backends implement it, enabling dynamic type testing/casting to access information specific to that backend. For instance, the cloud.Stack conveys the cloud URL, org name, and PPC name, for each stack. * Similarly expose specialized backend.Backend interfaces, local.Backend and cloud.Backend, to convey specific information. * Redo a bunch of the commands in terms of these. * Keeping with this theme, turn the CreateStack options into an opaque interface{}, and let the specific backends expose their own structures with their own settings (like PPC name in cloud). * Show both the org and PPC names in the cloud column printed in the stack ls command, in addition to the Pulumi Cloud URL. Unrelated, but useful: * Special case the 401 HTTP response and make a friendly error, to tell the developer they must use `pulumi login`. This is better than tossing raw "401: Unauthorized" errors in their face. * Change the "Updating stack '..' in the Pulumi Cloud" message to use the correct action verb ("Previewing", "Destroying", etc).
39 lines
2 KiB
Go
39 lines
2 KiB
Go
// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
|
|
|
|
// Package backend encapsulates all extensibility points required to fully implement a new cloud provider.
|
|
package backend
|
|
|
|
import (
|
|
"github.com/pulumi/pulumi/pkg/engine"
|
|
"github.com/pulumi/pulumi/pkg/operations"
|
|
"github.com/pulumi/pulumi/pkg/tokens"
|
|
)
|
|
|
|
// Backend is an interface that represents actions the engine will interact with to manage stacks of cloud resources.
|
|
// It can be implemented any number of ways to provide pluggable backend implementations of the Pulumi Cloud.
|
|
type Backend interface {
|
|
// Name returns a friendly name for this backend.
|
|
Name() string
|
|
|
|
// GetStack returns a stack object tied to this backend with the given name, or nil if it cannot be found.
|
|
GetStack(name tokens.QName) (Stack, error)
|
|
// CreateStack creates a new stack with the given name and options that are specific to the backend provider.
|
|
CreateStack(name tokens.QName, opts interface{}) error
|
|
// RemoveStack removes a stack with the given name. If force is true, the stack will be removed even if it
|
|
// still contains resources. Otherwise, if the stack contains resources, a non-nil error is returned, and the
|
|
// first boolean return value will be set to true.
|
|
RemoveStack(name tokens.QName, force bool) (bool, error)
|
|
// ListStacks returns a list of stack summaries for all known stacks in the target backend.
|
|
ListStacks() ([]Stack, error)
|
|
|
|
// Preview initiates a preview of the current workspace's contents.
|
|
Preview(stackName tokens.QName, debug bool, opts engine.PreviewOptions) error
|
|
// Update updates the target stack with the current workspace's contents (config and code).
|
|
Update(stackName tokens.QName, debug bool, opts engine.DeployOptions) error
|
|
// Destroy destroys all of this stack's resources.
|
|
Destroy(stackName tokens.QName, debug bool, opts engine.DestroyOptions) error
|
|
|
|
// GetLogs fetches a list of log entries for the given stack, with optional filtering/querying.
|
|
GetLogs(stackName tokens.QName, query operations.LogQuery) ([]operations.LogEntry, error)
|
|
}
|