ebs

Documentation

Index

• Constants
• func BackCompat(config gofig.Config)

Constants

const (
	// Name is the provider's name.
	Name = "ebs"

	// NameEC2 is the provider's old EC2 name.
	NameEC2 = "ec2"

	// NameAWS is the provider's old AWS name.
	NameAWS = "aws"

	// TagDelimiter separates tags from volume or snapshot names
	TagDelimiter = "/"

	// DefaultMaxRetries is the max number of times to retry failed operations
	DefaultMaxRetries = 10

	// InstanceIDFieldRegion is the key to retrieve the region value from the
	// InstanceID Field map.
	InstanceIDFieldRegion = "region"

	// InstanceIDFieldAvailabilityZone is the key to retrieve the availability
	// zone value from the InstanceID Field map.
	InstanceIDFieldAvailabilityZone = "availabilityZone"

	// AccessKey is a key constant.
	AccessKey = "accessKey"

	// SecretKey is a key constant.
	SecretKey = "secretKey"

	// Region is a key constant.
	Region = "region"

	// Endpoint is a key constant.
	Endpoint = "endpoint"

	// MaxRetries is a key constant.
	MaxRetries = "maxRetries"

	// Tag is a key constant.
	Tag = "tag"

	// KmsKeyID is the full ARN of the AWS Key Management Service (AWS KMS)
	// customer master key (CMK) to use when creating the encrypted volume.
	//
	// This parameter is only required if you want to use a non-default CMK;
	// if this parameter is not specified, the default CMK for EBS is used.
	// The ARN contains the arn:aws:kms namespace, followed by the region of
	// the CMK, the AWS account ID of the CMK owner, the key namespace, and
	// then the CMK ID. For example,
	// arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
	//
	// If a KmsKeyID is specified, all volumes will be created with their
	// Encrypted flag set to true.
	KmsKeyID = "kmsKeyID"

	// ConfigUseLargeDeviceRange defines if Rex-RAY should use device mapping
	// recommended by AWS (default), or a larger device ange that is
	// supported but will not work on all instance types
	ConfigUseLargeDeviceRange = Name + ".useLargeDeviceRange"

	// ConfigStatusMaxAttempts is the key for the maximum number of times
	// a volume status will be queried when waiting for an action to finish
	ConfigStatusMaxAttempts = Name + ".statusMaxAttempts"

	// ConfigStatusInitDelay is the key for the initial time duration
	// for exponential backoff
	ConfigStatusInitDelay = Name + ".statusInitialDelay"

	// ConfigStatusTimeout is the key for the time duration for a timeout
	// on how long to wait for a desired volume status to appears
	ConfigStatusTimeout = Name + ".statusTimeout"

	// ConfigNvmeBinPath is the key for the path to the nvme binary used by
	// the executor on nvme-enabled instances.
	ConfigNvmeBinPath = Name + ".nvmeBinPath"
)

const (
	// ConfigEBS is a config key.
	ConfigEBS = "ebs"

	// ConfigEBSAccessKey is a config key.
	ConfigEBSAccessKey = ConfigEBS + "." + AccessKey

	// ConfigEBSSecretKey is a config key.
	ConfigEBSSecretKey = ConfigEBS + "." + SecretKey

	// ConfigEBSRegion is a config key.
	ConfigEBSRegion = ConfigEBS + "." + Region

	// ConfigEBSEndpoint is a config key.
	ConfigEBSEndpoint = ConfigEBS + "." + Endpoint

	// ConfigEBSMaxRetries is a config key.
	ConfigEBSMaxRetries = ConfigEBS + "." + MaxRetries

	// ConfigEBSTag is a config key.
	ConfigEBSTag = ConfigEBS + "." + Tag

	// ConfigEBSRexrayTag is a config key.
	ConfigEBSRexrayTag = ConfigEBS + ".rexrayTag"

	// ConfigEBSKmsKeyID is a config key.
	ConfigEBSKmsKeyID = ConfigEBS + "." + KmsKeyID

	// ConfigEC2 is a config key.
	ConfigEC2 = "ec2"

	// ConfigEC2AccessKey is a config key.
	ConfigEC2AccessKey = ConfigEC2 + "." + AccessKey

	// ConfigEC2SecretKey is a config key.
	ConfigEC2SecretKey = ConfigEC2 + "." + SecretKey

	// ConfigEC2Region is a config key.
	ConfigEC2Region = ConfigEC2 + "." + Region

	// ConfigEC2Endpoint is a config key.
	ConfigEC2Endpoint = ConfigEC2 + "." + Endpoint

	// ConfigEC2MaxRetries is a config key.
	ConfigEC2MaxRetries = ConfigEC2 + "." + MaxRetries

	// ConfigEC2Tag is a config key.
	ConfigEC2Tag = ConfigEC2 + "." + Tag

	// ConfigEC2RexrayTag is a config key.
	ConfigEC2RexrayTag = ConfigEC2 + ".rexrayTag"

	// ConfigEC2KmsKeyID is a config key.
	ConfigEC2KmsKeyID = ConfigEC2 + "." + KmsKeyID

	// ConfigAWS is a config key.
	ConfigAWS = "aws"

	// ConfigAWSAccessKey is a config key.
	ConfigAWSAccessKey = ConfigAWS + "." + AccessKey

	// ConfigAWSSecretKey is a config key.
	ConfigAWSSecretKey = ConfigAWS + "." + SecretKey

	// ConfigAWSRegion is a config key.
	ConfigAWSRegion = ConfigAWS + "." + Region

	// ConfigAWSEndpoint is a config key.
	ConfigAWSEndpoint = ConfigAWS + "." + Endpoint

	// ConfigAWSMaxRetries is a config key.
	ConfigAWSMaxRetries = ConfigAWS + "." + MaxRetries

	// ConfigAWSTag is a config key.
	ConfigAWSTag = ConfigAWS + "." + Tag

	// ConfigAWSRexrayTag is a config key.
	ConfigAWSRexrayTag = ConfigAWS + ".rexrayTag"

	// ConfigAWSKmsKeyID is a config key.
	ConfigAWSKmsKeyID = ConfigAWS + "." + KmsKeyID
)

Functions

func BackCompat

func BackCompat(config gofig.Config)

BackCompat ensures keys can be used from old configurations.