outposts

Documentation

Index

• func WrapClusterProvider(p api.ClusterProvider) api.ClusterProvider
• type ClusterExtender
  • func (e *ClusterExtender) ExtendWithOutpostSubnetsIfRequired(ctx context.Context, cluster ClusterToExtend, clusterVPC *api.ClusterVPC) error
• type ClusterToExtend
• type OutpostInstance
• type Service
  • func (o *Service) GetOutpost(ctx context.Context) (*outpoststypes.Outpost, error)
  • func (o *Service) GetSmallestInstanceType(ctx context.Context) (string, error)
  • func (o *Service) SetOrValidateOutpostInstanceType(ctx context.Context, oi OutpostInstance) error
  • func (o *Service) ValidateInstanceType(ctx context.Context, instanceType string) error

Functions

func WrapClusterProvider

func WrapClusterProvider(p api.ClusterProvider) api.ClusterProvider

WrapClusterProvider wraps ClusterProvider with a custom EKS service that overrides operations unsupported on Outposts with no-ops.

Types

type ClusterExtender

type ClusterExtender struct {
	StackUpdater stackUpdater
	EC2API       awsapi.EC2
	OutpostsAPI  awsapi.Outposts
}

A ClusterExtender extends a cluster with resources required to support nodegroups on Outposts.

func (*ClusterExtender) ExtendWithOutpostSubnetsIfRequired

func (e *ClusterExtender) ExtendWithOutpostSubnetsIfRequired(ctx context.Context, cluster ClusterToExtend, clusterVPC *api.ClusterVPC) error

ExtendWithOutpostSubnetsIfRequired extends a cluster's stack with Outpost subnets if required.

type ClusterToExtend

type ClusterToExtend interface {
	// IsControlPlaneOnOutposts returns true if the control plane is on Outposts.
	IsControlPlaneOnOutposts() bool

	// FindNodeGroupOutpostARN checks whether any nodegroups are on Outposts and returns the Outpost ARN.
	FindNodeGroupOutpostARN() (outpostARN string, found bool)
}

ClusterToExtend represents a cluster that needs to be extended.

type OutpostInstance

type OutpostInstance interface {
	// SetInstanceType sets the instance type.
	SetInstanceType(instanceType string)

	// GetInstanceType returns the instance type.
	GetInstanceType() string
}

OutpostInstance represents an instance running on Outposts.

type Service

type Service struct {
	OutpostsAPI awsapi.Outposts
	EC2API      awsapi.EC2
	OutpostID   string
	// contains filtered or unexported fields
}

func (*Service) GetOutpost

func (o *Service) GetOutpost(ctx context.Context) (*outpoststypes.Outpost, error)

GetOutpost returns details for this Outpost.

func (*Service) GetSmallestInstanceType

func (o *Service) GetSmallestInstanceType(ctx context.Context) (string, error)

GetSmallestInstanceType retrieves the smallest available instance type on Outposts. Instance types that have a smaller vCPU are considered smaller.

func (*Service) SetOrValidateOutpostInstanceType

func (o *Service) SetOrValidateOutpostInstanceType(ctx context.Context, oi OutpostInstance) error

SetOrValidateOutpostInstanceType sets the instance type if it is not set, or validates that the specified instance type exists in Outposts.

func (*Service) ValidateInstanceType

func (o *Service) ValidateInstanceType(ctx context.Context, instanceType string) error

ValidateInstanceType validates that instanceType is a valid instance type for this Outpost.