scope

Documentation

Index

• func NewIAMClient(session aws.Session, arn string, target runtime.Object) *iam.IAM
• func NewS3Client(session aws.Session, arn string, target runtime.Object) *s3.S3
• type AWSClients
• type ClusterScope
  • func NewClusterScope(params ClusterScopeParams) (*ClusterScope, error)
  • func (s *ClusterScope) ARN() string
  • func (s *ClusterScope) AccountID() string
  • func (s *ClusterScope) BucketName() string
  • func (s *ClusterScope) Cluster() runtime.Object
  • func (s *ClusterScope) ClusterName() string
  • func (s *ClusterScope) ClusterNamespace() string
  • func (s *ClusterScope) Installation() string
  • func (s *ClusterScope) Region() string
  • func (s *ClusterScope) SecretName() string
  • func (s *ClusterScope) Session() awsclient.ConfigProvider
• type ClusterScopeParams
• type IAMScope
• type S3Scope
• type ServiceEndpoint

Functions

func NewIAMClient

func NewIAMClient(session aws.Session, arn string, target runtime.Object) *iam.IAM

NewIAMClient creates a new IAM API client for a given session

func NewS3Client

func NewS3Client(session aws.Session, arn string, target runtime.Object) *s3.S3

NewS3Client creates a new S3 API client for a given session

Types

type AWSClients

type AWSClients struct {
	S3  *s3.S3
	IAM *iam.IAM
}

AWSClients contains all the aws clients used by the scopes

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) AccountID

func (s *ClusterScope) AccountID() string

AccountID returns the account ID of the assumed role.

func (*ClusterScope) BucketName

func (s *ClusterScope) BucketName() string

BucketName returns the name of the OIDC S3 bucket.

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) Installation

func (s *ClusterScope) Installation() string

Installation returns the name of the installation where the cluster object is located.

func (*ClusterScope) Region

func (s *ClusterScope) Region() string

Region returns the region of the AWS infrastructure cluster object.

func (*ClusterScope) SecretName

func (s *ClusterScope) SecretName() string

SecretName returns the name of the OIDC secret from the cluster.

func (*ClusterScope) Session

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

Session returns the AWS SDK session.

type ClusterScopeParams

type ClusterScopeParams struct {
	AccountID        string
	ARN              string
	BucketName       string
	Cluster          runtime.Object
	ClusterName      string
	ClusterNamespace string
	Installation     string
	Region           string
	SecretName       string

	Logger  logr.Logger
	Session awsclient.ConfigProvider
}

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

type IAMScope

type IAMScope interface {
	aws.ClusterScoper
}

IAMScope is a scope for use with the IAM reconciling service in cluster

type S3Scope

type S3Scope interface {
	aws.ClusterScoper
}

S3Scope is a scope for use with the S3 reconciling service in cluster

type ServiceEndpoint

type ServiceEndpoint struct {
	ServiceID     string
	URL           string
	SigningRegion string
}

ServiceEndpoint defines a tuple containing AWS Service resolution information