deploy

Documentation

Overview

Package deploy holds the structures to deploy a workload.

Index

• func NewBackendDeployer(in *WorkloadDeployerInput) (*backendSvcDeployer, error)
• func NewEnvDeployer(in *NewEnvDeployerInput) (*envDeployer, error)
• func NewJobDeployer(in *WorkloadDeployerInput) (*jobDeployer, error)
• func NewLBWSDeployer(in *WorkloadDeployerInput) (*lbWebSvcDeployer, error)
• func NewRDWSDeployer(in *WorkloadDeployerInput) (*rdwsDeployer, error)
• func NewWorkerSvcDeployer(in *WorkloadDeployerInput) (*workerSvcDeployer, error)
• type ActionRecommender
• type DeployEnvironmentInput
• type DeployWorkloadInput
• type GenerateCloudFormationTemplateInput
• type GenerateCloudFormationTemplateOutput
• type NewEnvDeployerInput
• type Options
• type Overrider
  • func NewOverrider(pathToOverridesDir, app, env string, fs afero.Fs, sess UserAgentAdder) (Overrider, error)
• type StackRuntimeConfiguration
• type UploadArtifactsOutput
• type UploadEnvArtifactsOutput
• type UserAgentAdder
• type WorkloadDeployerInput
• type WorkspaceAddonsReaderPathGetter

Functions

func NewBackendDeployer

func NewBackendDeployer(in *WorkloadDeployerInput) (*backendSvcDeployer, error)

NewBackendDeployer is the constructor for backendSvcDeployer.

func NewEnvDeployer

func NewEnvDeployer(in *NewEnvDeployerInput) (*envDeployer, error)

NewEnvDeployer constructs an environment deployer.

func NewJobDeployer

func NewJobDeployer(in *WorkloadDeployerInput) (*jobDeployer, error)

NewJobDeployer is the constructor for jobDeployer.

func NewLBWSDeployer

func NewLBWSDeployer(in *WorkloadDeployerInput) (*lbWebSvcDeployer, error)

NewLBWSDeployer is the constructor for lbWebSvcDeployer.

func NewRDWSDeployer

func NewRDWSDeployer(in *WorkloadDeployerInput) (*rdwsDeployer, error)

NewRDWSDeployer is the constructor for RDWSDeployer.

func NewWorkerSvcDeployer

func NewWorkerSvcDeployer(in *WorkloadDeployerInput) (*workerSvcDeployer, error)

NewWorkerSvcDeployer is the constructor for workerSvcDeployer.

Types

type ActionRecommender

type ActionRecommender interface {
	RecommendedActions() []string
}

ActionRecommender contains methods that output action recommendation.

type DeployEnvironmentInput

type DeployEnvironmentInput struct {
	RootUserARN         string
	AddonsURL           string
	CustomResourcesURLs map[string]string
	Manifest            *manifest.Environment
	ForceNewUpdate      bool
	RawManifest         []byte
	PermissionsBoundary string
	DisableRollback     bool
}

DeployEnvironmentInput contains information used to deploy the environment.

type DeployWorkloadInput

type DeployWorkloadInput struct {
	StackRuntimeConfiguration
	Options
}

DeployWorkloadInput is the input of DeployWorkload.

type GenerateCloudFormationTemplateInput

type GenerateCloudFormationTemplateInput struct {
	StackRuntimeConfiguration
}

GenerateCloudFormationTemplateInput is the input of GenerateCloudFormationTemplate.

type GenerateCloudFormationTemplateOutput

type GenerateCloudFormationTemplateOutput struct {
	Template   string
	Parameters string
}

GenerateCloudFormationTemplateOutput is the output of GenerateCloudFormationTemplate.

type NewEnvDeployerInput

type NewEnvDeployerInput struct {
	App             *config.Application
	Env             *config.Environment
	SessionProvider *sessions.Provider
	ConfigStore     describe.ConfigStoreSvc
	Workspace       WorkspaceAddonsReaderPathGetter
	Overrider       Overrider
}

NewEnvDeployerInput contains information needed to construct an environment deployer.

type Options

type Options struct {
	ForceNewUpdate  bool
	DisableRollback bool
}

Options specifies options for the deployment.

type Overrider

type Overrider interface {
	Override(body []byte) (out []byte, err error)
}

An Overrider transforms the content in body to out.

func NewOverrider

func NewOverrider(pathToOverridesDir, app, env string, fs afero.Fs, sess UserAgentAdder) (Overrider, error)

NewOverrider looks up if a CDK or YAMLPatch Overrider exists at pathsToOverriderDir and initializes the respective Overrider. If the directory is empty, then returns a noop Overrider.

type StackRuntimeConfiguration

type StackRuntimeConfiguration struct {
	// Use *string for three states (see https://github.com/aws/copilot-cli/pull/3268#discussion_r806060230)
	// This is mainly to keep the `workload package` behavior backward-compatible, otherwise our old pipeline buildspec would break,
	// since previously we parsed the env region from a mock ECR URL that we generated from `workload package“.
	ImageDigest        *string
	EnvFileARN         string
	AddonsURL          string
	RootUserARN        string
	Tags               map[string]string
	CustomResourceURLs map[string]string
}

StackRuntimeConfiguration contains runtime configuration for a workload CloudFormation stack.

type UploadArtifactsOutput

type UploadArtifactsOutput struct {
	ImageDigest        *string
	EnvFileARN         string
	AddonsURL          string
	CustomResourceURLs map[string]string
}

UploadArtifactsOutput is the output of UploadArtifacts.

type UploadEnvArtifactsOutput

type UploadEnvArtifactsOutput struct {
	AddonsURL          string
	CustomResourceURLs map[string]string
}

UploadEnvArtifactsOutput holds URLs of artifacts pushed to S3 buckets.

type UserAgentAdder

type UserAgentAdder interface {
	UserAgentExtras(extras ...string)
}

UserAgentAdder is the interface that adds values to the User-Agent HTTP request header.

type WorkloadDeployerInput

type WorkloadDeployerInput struct {
	SessionProvider  *sessions.Provider
	Name             string
	App              *config.Application
	Env              *config.Environment
	ImageTag         string
	Mft              interface{} // Interpolated, applied, and unmarshaled manifest.
	RawMft           []byte      // Content of the manifest file without any transformations.
	EnvVersionGetter versionGetter
	Overrider        Overrider
	// contains filtered or unexported fields
}

WorkloadDeployerInput is the input to for workloadDeployer constructor.

type WorkspaceAddonsReaderPathGetter

type WorkspaceAddonsReaderPathGetter interface {
	addon.WorkspaceAddonsReader
	Path() string
}

WorkspaceAddonsReaderPathGetter reads addons from a workspace and the path of a workspace.