cloudformation

README

This provides an interface for CloudFormation Custom Resources so that Empire can provision things for CloudFormation. It supports the following resources:

• Custom::InstancePort: Allocates an instance port from the pool of instance ports.

Documentation

Overview

Package cloudformation provides a server for the CloudFormation interface to Empire.

Index

• Variables
• type AppProperties
• type ContainerDefinition
• type CustomResourceProvisioner
  • func NewCustomResourceProvisioner(empire *empire.Empire, config client.ConfigProvider) *CustomResourceProvisioner
  • func (c *CustomResourceProvisioner) Handle(ctx context.Context, message *sqs.Message) error
  • func (c *CustomResourceProvisioner) Start()
• type ECSEnvironmentProperties
  • func (p *ECSEnvironmentProperties) ReplacementHash() (uint64, error)
• type ECSEnvironmentResource
  • func (p *ECSEnvironmentResource) Create(ctx context.Context, req customresources.Request) (string, interface{}, error)
  • func (p *ECSEnvironmentResource) Delete(ctx context.Context, req customresources.Request) error
• type ECSPlacementConstraint
• type ECSPlacementStrategy
• type ECSServiceProperties
  • func (p *ECSServiceProperties) ReplacementHash() (uint64, error)
• type ECSServiceResource
  • func (p *ECSServiceResource) Create(ctx context.Context, req customresources.Request) (string, interface{}, error)
  • func (p *ECSServiceResource) Delete(ctx context.Context, req customresources.Request) error
  • func (p *ECSServiceResource) Update(ctx context.Context, req customresources.Request) (interface{}, error)
• type ECSTaskDefinitionProperties
  • func (p *ECSTaskDefinitionProperties) ReplacementHash() (uint64, error)
• type ECSTaskDefinitionResource
  • func (p *ECSTaskDefinitionResource) Create(ctx context.Context, req customresources.Request) (string, interface{}, error)
  • func (p *ECSTaskDefinitionResource) Delete(ctx context.Context, req customresources.Request) error
• type EmpireAppEnvironmentResource
  • func (p *EmpireAppEnvironmentResource) Properties() interface{}
  • func (p *EmpireAppEnvironmentResource) Provision(ctx context.Context, req customresources.Request) (id string, data interface{}, err error)
• type EmpireAppResource
  • func (p *EmpireAppResource) Properties() interface{}
  • func (p *EmpireAppResource) Provision(ctx context.Context, req customresources.Request) (id string, data interface{}, err error)
• type EnvironmentProperties
• type InstancePortsResource
  • func (p *InstancePortsResource) Create(_ context.Context, req customresources.Request) (string, interface{}, error)
  • func (p *InstancePortsResource) Delete(_ context.Context, req customresources.Request) error
  • func (p *InstancePortsResource) Properties() interface{}
• type LoadBalancer
• type Message
• type PortMapping
• type SQSDispatcher
  • func (q *SQSDispatcher) Start(handle func(context.Context, *sqs.Message) error)
  • func (q *SQSDispatcher) Stop()
• type Ulimit
• type Variable
• type VariableError
  • func (v *VariableError) Error() string

Variables

var (
	// Allow custom resource provisioners this amount of time do their
	// thing.
	ProvisioningTimeout = time.Duration(20 * time.Minute)

	// And this amount of time to cleanup when they're canceled.
	ProvisioningGraceTimeout = time.Duration(1 * time.Minute)
)

Types

type AppProperties

type AppProperties struct {
	Name *string
}

AppProperties represents the properties for the Custom::EmpireApp

type ContainerDefinition

type ContainerDefinition struct {
	Name             *string
	Command          []*string
	Cpu              *customresources.IntValue
	Image            *string
	Essential        *string
	Memory           *customresources.IntValue
	PortMappings     []PortMapping
	DockerLabels     map[string]*string
	Ulimits          []Ulimit
	Environment      []string
	LogConfiguration *ecs.LogConfiguration
}

type CustomResourceProvisioner

type CustomResourceProvisioner struct {
	*SQSDispatcher

	// Provisioners routes a custom resource to the thing that should do the
	// provisioning.
	Provisioners map[string]customresources.Provisioner
	// contains filtered or unexported fields
}

CustomResourceProvisioner polls for CloudFormation Custom Resource requests from an sqs queue, provisions them, then responds back.

func NewCustomResourceProvisioner

func NewCustomResourceProvisioner(empire *empire.Empire, config client.ConfigProvider) *CustomResourceProvisioner

NewCustomResourceProvisioner returns a new CustomResourceProvisioner with an sqs client configured from config.

func (*CustomResourceProvisioner) Handle

func (c *CustomResourceProvisioner) Handle(ctx context.Context, message *sqs.Message) error

Handle handles a single sqs.Message to perform the provisioning.

func (*CustomResourceProvisioner) Start

func (c *CustomResourceProvisioner) Start()

type ECSEnvironmentProperties

type ECSEnvironmentProperties struct {
	Environment []*ecs.KeyValuePair
}

ECSEnvironmentProperties are the properties provided to the Custom::ECSEnvironment custom resource.

func (*ECSEnvironmentProperties) ReplacementHash

func (p *ECSEnvironmentProperties) ReplacementHash() (uint64, error)

type ECSEnvironmentResource

type ECSEnvironmentResource struct {
	// contains filtered or unexported fields
}

ECSEnvironmentResource is a custom resource that takes some environment variables, stores them, then returns a unique identifier to represent the environment, which can be used with the ECSTaskDefinitionResource.

func (*ECSEnvironmentResource) Create

func (p *ECSEnvironmentResource) Create(ctx context.Context, req customresources.Request) (string, interface{}, error)

func (*ECSEnvironmentResource) Delete

func (p *ECSEnvironmentResource) Delete(ctx context.Context, req customresources.Request) error

type ECSPlacementConstraint

type ECSPlacementConstraint struct {
	Type       *string
	Expression *string
}

type ECSPlacementStrategy

type ECSPlacementStrategy struct {
	Type  *string
	Field *string
}

type ECSServiceProperties

type ECSServiceProperties struct {
	ServiceName          *string
	Cluster              *string
	DesiredCount         *customresources.IntValue `hash:"ignore"`
	LoadBalancers        []LoadBalancer
	Role                 *string
	TaskDefinition       *string `hash:"ignore"`
	PlacementConstraints []ECSPlacementConstraint
	PlacementStrategy    []ECSPlacementStrategy
}

ECSServiceProperties represents the properties for the Custom::ECSService resource.

func (*ECSServiceProperties) ReplacementHash

func (p *ECSServiceProperties) ReplacementHash() (uint64, error)

type ECSServiceResource

type ECSServiceResource struct {
	// contains filtered or unexported fields
}

ECSServiceResource is a Provisioner that creates and updates ECS services.

func (*ECSServiceResource) Create

func (p *ECSServiceResource) Create(ctx context.Context, req customresources.Request) (string, interface{}, error)

func (*ECSServiceResource) Delete

func (p *ECSServiceResource) Delete(ctx context.Context, req customresources.Request) error

func (*ECSServiceResource) Update

func (p *ECSServiceResource) Update(ctx context.Context, req customresources.Request) (interface{}, error)

type ECSTaskDefinitionProperties

type ECSTaskDefinitionProperties struct {
	Family               *string
	TaskRoleArn          *string
	ContainerDefinitions []ContainerDefinition
	PlacementConstraints []ECSPlacementConstraint
}

TaskDefinitionProperties are properties passed to the Custom::ECSTaskDefinition custom resource.

func (*ECSTaskDefinitionProperties) ReplacementHash

func (p *ECSTaskDefinitionProperties) ReplacementHash() (uint64, error)

type ECSTaskDefinitionResource

type ECSTaskDefinitionResource struct {
	// contains filtered or unexported fields
}

ECSTaskDefinitionResource is a custom resource that provisions ECS task definitions.

func (*ECSTaskDefinitionResource) Create

func (p *ECSTaskDefinitionResource) Create(ctx context.Context, req customresources.Request) (string, interface{}, error)

func (*ECSTaskDefinitionResource) Delete

func (p *ECSTaskDefinitionResource) Delete(ctx context.Context, req customresources.Request) error

type EmpireAppEnvironmentResource

type EmpireAppEnvironmentResource struct {
	// contains filtered or unexported fields
}

EmpireAppEnvironmentResource is a Provisioner that manages environmental variables within an Empire application.

func (*EmpireAppEnvironmentResource) Properties

func (p *EmpireAppEnvironmentResource) Properties() interface{}

func (*EmpireAppEnvironmentResource) Provision

func (p *EmpireAppEnvironmentResource) Provision(ctx context.Context, req customresources.Request) (id string, data interface{}, err error)

type EmpireAppResource

type EmpireAppResource struct {
	// contains filtered or unexported fields
}

EmpireAppResource is a Provisioner that will manage an Empire application

func (*EmpireAppResource) Properties

func (p *EmpireAppResource) Properties() interface{}

func (*EmpireAppResource) Provision

func (p *EmpireAppResource) Provision(ctx context.Context, req customresources.Request) (id string, data interface{}, err error)

type EnvironmentProperties

type EnvironmentProperties struct {
	AppId     *string
	Variables []Variable
}

EnvironmentProperties represents the properties for the Custom::EmpireAppEnvironment

type InstancePortsResource

type InstancePortsResource struct {
	// contains filtered or unexported fields
}

InstancePortsResource is a Provisioner that allocates instance ports.

func (*InstancePortsResource) Create

func (p *InstancePortsResource) Create(_ context.Context, req customresources.Request) (string, interface{}, error)

func (*InstancePortsResource) Delete

func (p *InstancePortsResource) Delete(_ context.Context, req customresources.Request) error

func (*InstancePortsResource) Properties

func (p *InstancePortsResource) Properties() interface{}

type LoadBalancer

type LoadBalancer struct {
	ContainerName    *string
	ContainerPort    *customresources.IntValue
	LoadBalancerName *string
	TargetGroupArn   *string
}

type Message

type Message struct {
	Message string `json:"Message"`
}

Represents the body of the SQS message, which would have been received from SNS.

type PortMapping

type PortMapping struct {
	ContainerPort *customresources.IntValue
	HostPort      *customresources.IntValue
}

type SQSDispatcher

type SQSDispatcher struct {
	// Root context.Context to use. If a reporter.Reporter is embedded,
	// errors generated will be reporter there. If a logger.Logger is
	// embedded, logging will be logged there.
	Context context.Context

	// The SQS queue url to listen for CloudFormation Custom Resource
	// requests.
	QueueURL string

	// When a message is pulled off of sqs, the visibility timeout will be
	// extended by this much, and periodically extended while the handler
	// performs it's work. If this process crashes, then the sqs message
	// will be redelivered later.
	VisibilityHeartbeat time.Duration

	// Number of worker goroutines to start for receiving messages.
	NumWorkers int
	// contains filtered or unexported fields
}

SQSDispatcher pulls messages from SQS, and dispatches them to a handler.

func (*SQSDispatcher) Start

func (q *SQSDispatcher) Start(handle func(context.Context, *sqs.Message) error)

Start starts multiple goroutines pulling messages off of the queue.

func (*SQSDispatcher) Stop

func (q *SQSDispatcher) Stop()

type Ulimit

type Ulimit struct {
	Name      *string
	HardLimit *customresources.IntValue
	SoftLimit *customresources.IntValue
}

type Variable

type Variable struct {
	Name  *string
	Value *string
}

type VariableError

type VariableError struct {
	// contains filtered or unexported fields
}

func (*VariableError) Error

func (v *VariableError) Error() string