scope

Documentation

Index

• func NewCloudformationClient(session aws.Session, arn string, target runtime.Object) *cloudformation.CloudFormation
• func NewEC2Client(session aws.Session, arn string, target runtime.Object) *ec2.EC2
• type AWSClients
• type CloudformationScope
• type ClusterScope
  • func NewClusterScope(params ClusterScopeParams) (*ClusterScope, error)
  • func (s *ClusterScope) ARN() string
  • func (s *ClusterScope) Cluster() runtime.Object
  • func (s *ClusterScope) ClusterName() string
  • func (s *ClusterScope) ClusterNamespace() string
  • func (s *ClusterScope) Region() string
  • func (s *ClusterScope) Session() awsclient.ConfigProvider
• type ClusterScopeParams
• type ServiceEndpoint
• type VPCScope

Functions

func NewCloudformationClient

func NewCloudformationClient(session aws.Session, arn string, target runtime.Object) *cloudformation.CloudFormation

NewCloudformationClient creates a new Cloudformation API client for a given session

func NewEC2Client

func NewEC2Client(session aws.Session, arn string, target runtime.Object) *ec2.EC2

NewEC2Client creates a new EC2 API client for a given session

Types

type AWSClients

type AWSClients struct {
	Clouformation *cloudformation.CloudFormation
	EC2           *ec2.EC2
}

AWSClients contains all the aws clients used by the scopes

type CloudformationScope

type CloudformationScope interface {
	aws.ClusterScoper
}

CloudformationScope is a scope for use with the Cloudformation reconciling service in cluster

type ClusterScope

type ClusterScope struct {
	logr.Logger
	// contains filtered or unexported fields
}

ClusterScope defines the basic context for an actuator to operate upon.

func NewClusterScope

func NewClusterScope(params ClusterScopeParams) (*ClusterScope, error)

NewClusterScope creates a new Scope from the supplied parameters. This is meant to be called for each reconcile iteration.

func (*ClusterScope) ARN

func (s *ClusterScope) ARN() string

ARN returns the AWS SDK assumed role.

func (*ClusterScope) Cluster

func (s *ClusterScope) Cluster() runtime.Object

Cluster returns the AWS infrastructure cluster object.

func (*ClusterScope) ClusterName

func (s *ClusterScope) ClusterName() string

ClusterName returns the name of AWS infrastructure cluster object.

func (*ClusterScope) ClusterNamespace

func (s *ClusterScope) ClusterNamespace() string

ClusterNameSpace returns the namespace of AWS infrastructure cluster object.

func (*ClusterScope) Region

func (s *ClusterScope) Region() string

Region returns the region of the AWS infrastructure cluster object.

func (*ClusterScope) Session

func (s *ClusterScope) Session() awsclient.ConfigProvider

Session returns the AWS SDK session.

type ClusterScopeParams

type ClusterScopeParams struct {
	ARN              string
	Cluster          runtime.Object
	ClusterName      string
	ClusterNamespace string
	Region           string

	Logger  logr.Logger
	Session awsclient.ConfigProvider
}

ClusterScopeParams defines the input parameters used to create a new Scope.

type ServiceEndpoint

type ServiceEndpoint struct {
	ServiceID     string
	URL           string
	SigningRegion string
}

ServiceEndpoint defines a tuple containing AWS Service resolution information

type VPCScope

type VPCScope interface {
	aws.ClusterScoper
}

VPCScope is a scope for use with the NetworkManager reconciling service in cluster