aws

Documentation

Overview

Package aws provides some higher level Amazon Web Services abstractions for access to common resources.

The exported Adapter can be used to orchestrate and obtain information about Elastic Compute Cloud (EC2), EC2 Metadata, Elastic Load Balancing (ELB v2, also known as Application Load Balancer - ALB), Auto Scaling (ASG) and CloudFormation.

Index

• Constants
• Variables
• type Adapter
  • func NewAdapter() (adapter *Adapter, err error)
  • func (a *Adapter) AutoScalingGroupName() string
  • func (a *Adapter) ClusterID() string
  • func (a *Adapter) CreateStack(certificateARN string) (string, error)
  • func (a *Adapter) DeleteStack(stack *Stack) error
  • func (a *Adapter) FindManagedStacks() ([]*Stack, error)
  • func (a *Adapter) GetStack(stackID string) (*Stack, error)
  • func (a *Adapter) InstanceID() string
  • func (a *Adapter) MarkToDeleteStack(stack *Stack) (time.Time, error)
  • func (a *Adapter) NewACMCertificateProvider() certs.CertificatesProvider
  • func (a *Adapter) NewIAMCertificateProvider() certs.CertificatesProvider
  • func (a *Adapter) PrivateSubnetIDs() []string
  • func (a *Adapter) PublicSubnetIDs() []string
  • func (a *Adapter) SecurityGroupID() string
  • func (a *Adapter) UpdateStack(certificateARN string) (string, error)
  • func (a *Adapter) VpcID() string
  • func (a *Adapter) WithCreationTimeout(interval time.Duration) *Adapter
  • func (a *Adapter) WithCustomTemplate(template string) *Adapter
  • func (a *Adapter) WithHealthCheckInterval(interval time.Duration) *Adapter
  • func (a *Adapter) WithHealthCheckPath(path string) *Adapter
  • func (a *Adapter) WithHealthCheckPort(port uint) *Adapter
• type Namer
• type Stack
  • func (s *Stack) CertificateARN() string
  • func (s *Stack) DNSName() string
  • func (s *Stack) IsDeleteInProgress() bool
  • func (s *Stack) Name() string
  • func (s *Stack) ShouldDelete() bool
  • func (s *Stack) TargetGroupARN() string

Constants

const (
	DefaultHealthCheckPath           = "/kube-system/healthz"
	DefaultHealthCheckPort           = 9999
	DefaultHealthCheckInterval       = 10 * time.Second
	DefaultCertificateUpdateInterval = 30 * time.Minute
	DefaultCreationTimeout           = 5 * time.Minute
	DefaultStackTTL                  = 5 * time.Minute
)

Variables

var (
	// ErrMissingSecurityGroup is used to signal that the required security group couldn't be found.
	ErrMissingSecurityGroup = errors.New("required security group was not found")
	// ErrLoadBalancerStackNotFound is used to signal that a given load balancer CF stack was not found.
	ErrLoadBalancerStackNotFound = errors.New("load balancer stack not found")
	// ErrLoadBalancerStackNotReady is used to signal that a given load balancer CF stack is not ready to be used.
	ErrLoadBalancerStackNotReady = errors.New("existing load balancer stack not ready")
	// ErrMissingNameTag is used to signal that the Name tag on a given resource is missing.
	ErrMissingNameTag = errors.New("Name tag not found")
	// ErrMissingTag is used to signal that a tag on a given resource is missing.
	ErrMissingTag = errors.New("missing tag")
	// ErrNoSubnets is used to signal that no subnets were found in the current VPC
	ErrNoSubnets = errors.New("unable to find VPC subnets")
	// ErrMissingAutoScalingGroupTag is used to signal that the auto scaling group tag is not present in the list of tags.
	ErrMissingAutoScalingGroupTag = errors.New(`instance is missing the "` + autoScalingGroupNameTag + `" tag`)
	// ErrNoRunningInstances is used to signal that no instances were found in the running state
	ErrNoRunningInstances = errors.New("no reservations or instances in the running state")
	// ErrFailedToParsePEM is used to signal that the PEM block for a certificate failed to be parsed
	ErrFailedToParsePEM = errors.New("failed to parse certificate PEM")
)

Types

type Adapter

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

An Adapter can be used to orchestrate and obtain information from Amazon Web Services.

func NewAdapter

func NewAdapter() (adapter *Adapter, err error)

NewAdapter returns a new Adapter that can be used to orchestrate and obtain information from Amazon Web Services. Before returning there is a discovery process for VPC and EC2 details. It tries to find the Auto Scaling Group and Security Group that should be used for newly created Load Balancers. If any of those critical steps fail an appropriate error is returned.

func (*Adapter) AutoScalingGroupName

func (a *Adapter) AutoScalingGroupName() string

AutoScalingGroupName returns the name of the Auto Scaling Group the current node belongs to

func (*Adapter) ClusterID

func (a *Adapter) ClusterID() string

ClusterStackName returns the ClusterID tag that all resources from the same Kubernetes cluster share. It's taken from the current ec2 instance.

func (*Adapter) CreateStack

func (a *Adapter) CreateStack(certificateARN string) (string, error)

CreateStack creates a new Application Load Balancer using CloudFormation. The stack name is derived from the Cluster ID and the certificate ARN (when available). All the required resources (listeners and target group) are created in a transactional fashion. Failure to create the stack causes it to be deleted automatically.

func (*Adapter) DeleteStack

func (a *Adapter) DeleteStack(stack *Stack) error

DeleteStack deletes the CloudFormation stack with the given name

func (*Adapter) FindManagedStacks

func (a *Adapter) FindManagedStacks() ([]*Stack, error)

FindManagedStacks returns all CloudFormation stacks containing the controller management tags that match the current cluster and are ready to be used. The stack status is used to filter.

func (*Adapter) GetStack

func (a *Adapter) GetStack(stackID string) (*Stack, error)

GetStack returns the CloudFormation stack details with the name or ID from the argument

func (*Adapter) InstanceID

func (a *Adapter) InstanceID() string

InstanceID returns the instance ID the current node is running on.

func (*Adapter) MarkToDeleteStack

func (a *Adapter) MarkToDeleteStack(stack *Stack) (time.Time, error)

MarkToDeleteStack adds a "deleteScheduled" Tag to the CloudFormation stack with the given name

func (*Adapter) NewACMCertificateProvider

func (a *Adapter) NewACMCertificateProvider() certs.CertificatesProvider

func (*Adapter) NewIAMCertificateProvider

func (a *Adapter) NewIAMCertificateProvider() certs.CertificatesProvider

func (*Adapter) PrivateSubnetIDs

func (a *Adapter) PrivateSubnetIDs() []string

PrivateSubnetIDs returns a slice with the private subnet IDs discovered by the adapter.

func (*Adapter) PublicSubnetIDs

func (a *Adapter) PublicSubnetIDs() []string

PublicSubnetIDs returns a slice with the public subnet IDs discovered by the adapter.

func (*Adapter) SecurityGroupID

func (a *Adapter) SecurityGroupID() string

SecurityGroupID returns the security group ID that should be used to create Load Balancers.

func (*Adapter) UpdateStack

func (a *Adapter) UpdateStack(certificateARN string) (string, error)

func (*Adapter) VpcID

func (a *Adapter) VpcID() string

VpcID returns the VPC ID the current node belongs to.

func (*Adapter) WithCreationTimeout

func (a *Adapter) WithCreationTimeout(interval time.Duration) *Adapter

WithCreationTimeout returns the receiver adapter after changing the creation timeout that is used as the max wait time for the creation of all the required AWS resources for a given Ingress

func (*Adapter) WithCustomTemplate

func (a *Adapter) WithCustomTemplate(template string) *Adapter

WithCustomTemplate returns the receiver adapter after changing the CloudFormation template that should be used to create Load Balancer stacks

func (*Adapter) WithHealthCheckInterval

func (a *Adapter) WithHealthCheckInterval(interval time.Duration) *Adapter

WithHealthCheckInterval returns the receiver adapter after changing the health check interval that will be used by the resources created by the adapter

func (*Adapter) WithHealthCheckPath

func (a *Adapter) WithHealthCheckPath(path string) *Adapter

WithHealthCheckPath returns the receiver adapter after changing the health check path that will be used by the resources created by the adapter.

func (*Adapter) WithHealthCheckPort

func (a *Adapter) WithHealthCheckPort(port uint) *Adapter

WithHealthCheckPort returns the receiver adapter after changing the health check port that will be used by the resources created by the adapter

type Namer

type Namer interface {
	// Returns a normalized name from the combination of both arguments
	Normalize(clusterID, certificateARN string) string
}

The Namer interface defines the behavior of types that are able to apply custom constraints to names of resources

type Stack

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

Stack is a simple wrapper around a CloudFormation Stack.

func (*Stack) CertificateARN

func (s *Stack) CertificateARN() string

func (*Stack) DNSName

func (s *Stack) DNSName() string

func (*Stack) IsDeleteInProgress

func (s *Stack) IsDeleteInProgress() bool

IsDeleteInProgress returns true if the stack has already a tag deleteScheduled.

func (*Stack) Name

func (s *Stack) Name() string

func (*Stack) ShouldDelete

func (s *Stack) ShouldDelete() bool

ShouldDelete returns true if stack is marked to delete and the deleteScheduled tag is after time.Now(). In all other cases it returns false.

func (*Stack) TargetGroupARN

func (s *Stack) TargetGroupARN() string