region

Documentation

Index

• Constants
• func GetAWSRegion(r MachineRegion) string
• func IsValid(region MachineRegion, u universe.Universe) bool
• type DataRegion
  • func DataRegionsForUniverse(u universe.Universe) []DataRegion
  • func (r DataRegion) Validate() error
• type MachineRegion
  • func Current() MachineRegion
  • func FromAWSRegion(awsRegion string) MachineRegion
  • func MachineRegionsForUniverse(u universe.Universe) []MachineRegion
  • func (r MachineRegion) Validate() error

Constants

const RegionEnvVar = "UC_REGION"

RegionEnvVar is the environment variable that contains the region

Functions

func GetAWSRegion

func GetAWSRegion(r MachineRegion) string

GetAWSRegion returns the AWS name of the region and blank if region is not in AWS

func IsValid

func IsValid(region MachineRegion, u universe.Universe) bool

IsValid returns true if the region is a valid region for a given universe

Types

type DataRegion

type DataRegion string

DataRegion represents a region for where user data should be hosted

func DataRegionsForUniverse

func DataRegionsForUniverse(u universe.Universe) []DataRegion

DataRegionsForUniverse returns the list of regions for a given universe

func (DataRegion) Validate

func (r DataRegion) Validate() error

Validate implements Validateable

type MachineRegion

type MachineRegion string

MachineRegion represents a region for our systems or located

func Current

func Current() MachineRegion

Current returns the current region, or empty string TODO: error check against known list?

func FromAWSRegion

func FromAWSRegion(awsRegion string) MachineRegion

FromAWSRegion returns a region from a aws region string. e.g. us-east-1, us-west-2

func MachineRegionsForUniverse

func MachineRegionsForUniverse(u universe.Universe) []MachineRegion

MachineRegionsForUniverse returns the list of regions for a given universe

func (MachineRegion) Validate

func (r MachineRegion) Validate() error

Validate implements Validateable