aws

Documentation

Overview

Package aws contains AWS-specific structures for installer configuration and management.

Index

• Constants
• Variables
• type EC2RootVolume
• type MachinePool
  • func (a *MachinePool) Set(required *MachinePool)
• type Metadata
• type Platform

Constants

const Name string = "aws"

Name is name for the AWS platform.

Variables

var (
	// ValidRegions is a map of the known AWS regions. The key of the map is
	// the short name of the region. The value of the map is the long name of
	// the region.
	ValidRegions = map[string]string{
		"ap-northeast-1": "Tokyo",
		"ap-northeast-2": "Seoul",
		"ap-northeast-3": "Osaka-Local",
		"ap-south-1":     "Mumbai",
		"ap-southeast-1": "Singapore",
		"ap-southeast-2": "Sydney",
		"ca-central-1":   "Central",
		"cn-north-1":     "Beijing",
		"cn-northwest-1": "Ningxia",
		"eu-central-1":   "Frankfurt",
		"eu-west-1":      "Ireland",
		"eu-west-2":      "London",
		"eu-west-3":      "Paris",
		"sa-east-1":      "São Paulo",
		"us-east-1":      "N. Virginia",
		"us-east-2":      "Ohio",
		"us-west-1":      "N. California",
		"us-west-2":      "Oregon",
	}
)

Types

type EC2RootVolume

type EC2RootVolume struct {
	// IOPS defines the iops for the storage.
	IOPS int `json:"iops"`
	// Size defines the size of the storage.
	Size int `json:"size"`
	// Type defines the type of the storage.
	Type string `json:"type"`
}

EC2RootVolume defines the storage for an ec2 instance.

type MachinePool

type MachinePool struct {
	// Zones is list of availability zones that can be used.
	Zones []string `json:"zones,omitempty"`

	// AMIID defines the AMI that should be used.
	AMIID string `json:"amiID,omitempty"`

	// InstanceType defines the ec2 instance type.
	// eg. m4-large
	InstanceType string `json:"type"`

	// IAMRoleName defines the IAM role associated
	// with the ec2 instance.
	IAMRoleName string `json:"iamRoleName"`

	// EC2RootVolume defines the storage for ec2 instance.
	EC2RootVolume `json:"rootVolume"`
}

MachinePool stores the configuration for a machine pool installed on AWS.

func (*MachinePool) Set

func (a *MachinePool) Set(required *MachinePool)

Set sets the values from `required` to `a`.

type Metadata

type Metadata struct {
	Region string `json:"region"`

	// Identifier holds a slice of filter maps.  The maps hold the
	// key/value pairs for the tags we will be matching against.  A
	// resource matches the map if all of the key/value pairs are in its
	// tags.  A resource matches Identifier if it matches any of the maps.
	Identifier []map[string]string `json:"identifier"`
}

Metadata contains AWS metadata (e.g. for uninstalling the cluster).

type Platform

type Platform struct {
	// Region specifies the AWS region where the cluster will be created.
	Region string `json:"region"`

	// UserTags specifies additional tags for AWS resources created for the cluster.
	UserTags map[string]string `json:"userTags,omitempty"`

	// DefaultMachinePlatform is the default configuration used when
	// installing on AWS for machine pools which do not define their own
	// platform configuration.
	DefaultMachinePlatform *MachinePool `json:"defaultMachinePlatform,omitempty"`

	// VPCCIDRBlock
	// +optional
	VPCCIDRBlock *ipnet.IPNet `json:"vpcCIDRBlock,omitempty"`
}

Platform stores all the global configuration that all machinesets use.