scope

package
v0.27.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 25, 2024 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CurrentCommit = func() string {
		if info, ok := debug.ReadBuildInfo(); ok {
			for _, setting := range info.Settings {
				if setting.Key == "vcs.revision" {
					return setting.Value
				}
			}
		}

		return ""
	}()
)

Functions

func NewACMClient added in v0.9.0 

func NewACMClient(session aws.Session, arn string, target runtime.Object) *acm.ACM

NewACMClient creates a new ACM API client for a given session

func NewCloudfrontClient added in v0.6.0 

func NewCloudfrontClient(session aws.Session, arn string, target runtime.Object) *cloudfront.CloudFront

NewCloudfrontClient creates a new Cloudfront API client for a given session

func NewEKSClient added in v0.19.0 

func NewEKSClient(session aws.Session, arn string, target runtime.Object) *eks.EKS

NewEKSClient creates a new EKS API client for a given session

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 NewRoute53Client added in v0.9.0 

func NewRoute53Client(session aws.Session, arn string, target runtime.Object) *route53.Route53

NewRoute53Client creates a new route53 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 ACMScope added in v0.9.0 

type ACMScope interface {
	aws.ClusterScoper
}

ACMScope is a scope for use with the ACM reconciling service in cluster

type AWSClients 

type AWSClients struct {
	S3         *s3.S3
	IAM        *iam.IAM
	Cloudfront *cloudfront.CloudFront
	EKS        *eks.EKS
}

AWSClients contains all the aws clients used by the scopes

type CloudfrontScope added in v0.6.0 

type CloudfrontScope interface {
	aws.ClusterScoper
}

CloudfrontScope is a scope for use with the Cloudfront reconciling service in cluster

type ClusterScope 

type ClusterScope struct {
	Logr 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) BaseDomain added in v0.19.0 

func (s *ClusterScope) BaseDomain() string

BaseDomain returns the cluster DNS zone.

func (*ClusterScope) BucketName 

func (s *ClusterScope) BucketName() string

BucketName returns the name of the OIDC S3 bucket.

func (*ClusterScope) Cache added in v0.24.0 

func (s *ClusterScope) Cache() *gocache.Cache

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) ConfigName added in v0.6.0 

func (s *ClusterScope) ConfigName() string

ConfigName returns the name of Cloudfront config from the cluster.

func (*ClusterScope) Installation added in v0.3.0 

func (s *ClusterScope) Installation() string

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

func (*ClusterScope) Logger added in v0.12.0 

func (s *ClusterScope) Logger() logr.Logger

func (*ClusterScope) MigrationNeeded added in v0.7.0 

func (s *ClusterScope) MigrationNeeded() bool

MigrationNeeded returns if the cluster object needs migration beforehand.

func (*ClusterScope) PreCloudfrontAlias added in v0.13.0 

func (s *ClusterScope) PreCloudfrontAlias() bool

PreCloudfrontAlias returns if the cloudfront alias should be used before v19.0.0.

func (*ClusterScope) Region 

func (s *ClusterScope) Region() string

Region returns the region of the AWS infrastructure cluster object.

func (*ClusterScope) Release added in v0.6.0 

func (s *ClusterScope) Release() *semver.Version

Release returns the semver version of the AWS cluster object.

func (*ClusterScope) ReleaseVersion added in v0.6.0 

func (s *ClusterScope) ReleaseVersion() string

ReleaseVersion returns the release version of the AWS 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.

func (*ClusterScope) VPCMode added in v0.19.0 

func (s *ClusterScope) VPCMode() string

VPCMode returns the VPC mode used on this cluster.

type ClusterScopeParams 

type ClusterScopeParams struct {
	AccountID          string
	ARN                string
	BaseDomain         string
	BucketName         string
	Cache              *gocache.Cache
	Cluster            runtime.Object
	ClusterName        string
	ClusterNamespace   string
	ConfigName         string
	Installation       string
	Migration          bool
	PreCloudfrontAlias bool
	Region             string
	ReleaseVersion     string
	SecretName         string
	VPCMode            string

	Logger  logr.Logger
	Session awsclient.ConfigProvider
}

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

type EKSScope added in v0.19.0 

type EKSScope interface {
	aws.ClusterScoper
}

EKSScope is a scope for use with the EKS reconciling service in cluster

type IAMScope 

type IAMScope interface {
	aws.ClusterScoper
}

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

type Route53Scope added in v0.9.0 

type Route53Scope interface {
	aws.ClusterScoper
}

Route53Scope is a scope for use with the route53 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.