eks

Documentation

Overview

Package eks implements EKS cluster operations. It implements "k8s.io/test-infra/kubetest2/pkg/types.Deployer" and "k8s.io/test-infra/kubetest2/pkg/types.Options". ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

Index

• Constants
• func ClusterDeleted(err error) bool
• func Poll(ctx context.Context, stopc chan struct{}, lg *zap.Logger, ...) <-chan ClusterStatus
• type ClusterStatus
• type Tester
  • func New(cfg *eksconfig.Config) (*Tester, error)
  • func (ts *Tester) ArtifactsDir() string
  • func (ts *Tester) Build() error
  • func (ts *Tester) Down() error
  • func (ts *Tester) DownloadClusterLogs(artifactDir, _ string) error
  • func (ts *Tester) DumpClusterLogs() error
  • func (ts *Tester) HelpRequested() bool
  • func (ts *Tester) IsUp() (up bool, err error)
  • func (ts *Tester) Kubeconfig() (string, error)
  • func (ts *Tester) KubernetesClientSet() *kubernetes.Clientset
  • func (ts *Tester) LoadConfig() (eksconfig.Config, error)
  • func (ts *Tester) Provider() string
  • func (ts *Tester) ShouldBuild() bool
  • func (ts *Tester) ShouldDown() bool
  • func (ts *Tester) ShouldTest() bool
  • func (ts *Tester) ShouldUp() bool
  • func (ts *Tester) Up() (err error)

Constants

const TemplateClusterRole = `` /* 6588-byte string literal not displayed */

TemplateClusterRole is the CloudFormation template for EKS cluster role.

e.g.

Error creating load balancer (will retry): failed to ensure load balancer for service eks-*/hello-world-service: Error creating load balancer: "AccessDenied: User: arn:aws:sts::404174646922:assumed-role/eks-*-cluster-role/* is not authorized to perform: ec2:DescribeAccountAttributes\n\tstatus code: 403"

TODO: scope down (e.g. ec2:DescribeAccountAttributes, ec2:DescribeInternetGateways) mng, fargate, etc. may use other roles

const TemplateEKSCluster = `` /* 1608-byte string literal not displayed */

TemplateEKSCluster is the CloudFormation template for EKS cluster.

const TemplateVPCPublicPrivate = `` /* 12947-byte string literal not displayed */

TemplateVPCPublicPrivate is the CloudFormation template for EKS VPC.

e.g. An error occurred (InvalidParameterException) when calling the CreateFargateProfile operation: Subnet subnet-123 provided in Fargate Profile is not a private subnet

Functions

func ClusterDeleted

func ClusterDeleted(err error) bool

ClusterDeleted returns true if error from EKS API indicates that the EKS cluster has already been deleted.

func Poll

func Poll(
	ctx context.Context,
	stopc chan struct{},
	lg *zap.Logger,
	eksAPI eksiface.EKSAPI,
	clusterName string,
	desiredClusterStatus string,
	initialWait time.Duration,
	wait time.Duration,
) <-chan ClusterStatus

Poll periodically fetches the cluster status until the cluster becomes the desired state.

Types

type ClusterStatus

type ClusterStatus struct {
	Cluster *aws_eks.Cluster
	Error   error
}

ClusterStatus represents the CloudFormation status.

type Tester

type Tester struct {
	// contains filtered or unexported fields
}

Tester implements "kubetest2" Deployer. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc

func New

func New(cfg *eksconfig.Config) (*Tester, error)

New returns a new EKS kubetest2 Deployer. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) ArtifactsDir

func (ts *Tester) ArtifactsDir() string

ArtifactsDir returns the path to the directory where artifacts should be written (including metadata files like junit_runner.xml). ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) Build

func (ts *Tester) Build() error

Build should build kubernetes and package it in whatever format the deployer consumes. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) Down

func (ts *Tester) Down() error

Down cancels the cluster creation and destroy the test cluster if any. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) DownloadClusterLogs

func (ts *Tester) DownloadClusterLogs(artifactDir, _ string) error

DownloadClusterLogs dumps all logs to artifact directory. Let default kubetest log dumper handle all artifact uploads. See https://github.com/kubernetes/test-infra/pull/9811/files#r225776067. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) DumpClusterLogs

func (ts *Tester) DumpClusterLogs() error

DumpClusterLogs should export logs from the cluster. It may be called multiple times. Options for this should come from New(...) ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) HelpRequested

func (ts *Tester) HelpRequested() bool

HelpRequested true, help text will be shown to the user after instancing the deployer and tester. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) IsUp

func (ts *Tester) IsUp() (up bool, err error)

IsUp should return true if a test cluster is successfully provisioned. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) Kubeconfig

func (ts *Tester) Kubeconfig() (string, error)

Kubeconfig returns a path to a kubeconfig file for the cluster. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) KubernetesClientSet

func (ts *Tester) KubernetesClientSet() *kubernetes.Clientset

KubernetesClientSet returns Kubernetes Go client. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) LoadConfig

func (ts *Tester) LoadConfig() (eksconfig.Config, error)

LoadConfig reloads configuration from disk to read the latest cluster configuration and its states. It's either reloaded from disk or returned from embedded EKS deployer. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) Provider

func (ts *Tester) Provider() string

Provider returns the kubernetes provider for legacy deployers. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) ShouldBuild

func (ts *Tester) ShouldBuild() bool

ShouldBuild true, kubetest2 will be calling deployer.Build. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) ShouldDown

func (ts *Tester) ShouldDown() bool

ShouldDown true, kubetest2 will be calling deployer.Down. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) ShouldTest

func (ts *Tester) ShouldTest() bool

ShouldTest true, kubetest2 will be calling tester.Test. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) ShouldUp

func (ts *Tester) ShouldUp() bool

ShouldUp true, kubetest2 will be calling deployer.Up. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options

func (*Tester) Up

func (ts *Tester) Up() (err error)

Up should provision a new cluster for testing. ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Deployer ref. https://pkg.go.dev/k8s.io/test-infra/kubetest2/pkg/types?tab=doc#Options