deploy

Documentation

Overview

Package deploy holds the structures to deploy a workload.

Index

• func NewBackendDeployer(in *WorkloadDeployerInput) (*backendSvcDeployer, error)
• func NewJobDeployer(in *WorkloadDeployerInput) (*jobDeployer, error)
• func NewLBDeployer(in *WorkloadDeployerInput) (*lbSvcDeployer, error)
• func NewRDWSDeployer(in *WorkloadDeployerInput) (*rdwsDeployer, error)
• func NewWorkerSvcDeployer(in *WorkloadDeployerInput) (*workerSvcDeployer, error)
• type ActionRecommender
• type DeployWorkloadInput
• type GenerateCloudFormationTemplateInput
• type GenerateCloudFormationTemplateOutput
• type Options
• type StackRuntimeConfiguration
• type UploadArtifactsOutput
• type WorkloadDeployerInput

Functions

func NewBackendDeployer

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

NewBackendDeployer is the constructor for backendSvcDeployer.

func NewJobDeployer

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

NewJobDeployer is the constructor for jobDeployer.

func NewLBDeployer

func NewLBDeployer(in *WorkloadDeployerInput) (*lbSvcDeployer, error)

NewLBDeployer is the constructor for lbSvcDeployer.

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 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 Options

type Options struct {
	ForceNewUpdate  bool
	DisableRollback bool
}

Options specifies options for the deployment.

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
}

StackRuntimeConfiguration contains runtime configuration for a workload CloudFormation stack.

type UploadArtifactsOutput

type UploadArtifactsOutput struct {
	ImageDigest *string
	EnvFileARN  string
	AddonsURL   string
}

UploadArtifactsOutput is the output of UploadArtifacts.

type WorkloadDeployerInput

type WorkloadDeployerInput struct {
	SessionProvider *sessions.Provider
	Name            string
	App             *config.Application
	Env             *config.Environment
	ImageTag        string
	Mft             interface{}
}

WorkloadDeployerInput is the input to for workloadDeployer constructor.