eksawshelper

Documentation

Overview

eksawshelper contains helper functions for accessing the AWS EKS API directly. This package exists to break cyclic dependencies between eks and kubectl.

Index

• func GetClusterArnByNameAndRegion(eksClusterName string, region string) (string, error)
• func GetClusterByArn(eksClusterArn string) (*eks.Cluster, error)
• func GetClusterNameFromArn(eksClusterArnString string) (string, error)
• func GetDockerLoginToken(region string) (string, error)
• func GetKubernetesTokenForCluster(clusterID string) (*token.Token, string, error)
• func GetRegionFromArn(eksClusterArnString string) (string, error)
• func NewAuthenticatedSession(region string) (*session.Session, error)
• func NewECRClient(region string) (*ecr.ECR, error)
• func NewEksClient(region string) (*eks.EKS, error)
• func TagExistsInRepo(token, repoDomain, repoPath, tag string) (bool, error)
• type CredentialsError
  • func (err CredentialsError) Error() string
• type ECRManifestFetchError
  • func (err ECRManifestFetchError) Error() string

Functions

func GetClusterArnByNameAndRegion

func GetClusterArnByNameAndRegion(eksClusterName string, region string) (string, error)

GetClusterArnByNameAndRegion looks up the EKS Cluster ARN using the region and EKS Cluster Name. For instances where we don't have the EKS Cluster ARN, such as within the Fargate Profile resource.

func GetClusterByArn

func GetClusterByArn(eksClusterArn string) (*eks.Cluster, error)

GetClusterByArn returns the EKS Cluster object that corresponds to the given ARN.

func GetClusterNameFromArn

func GetClusterNameFromArn(eksClusterArnString string) (string, error)

GetClusterNameFromArn extracts the EKS cluster name given the ARN for the cluster.

func GetDockerLoginToken

func GetDockerLoginToken(region string) (string, error)

GetDockerLoginToken retrieves an authorization token that can be used to access ECR via the docker APIs. The return token can directly be used as a HTTP authorization header for basic auth.

func GetKubernetesTokenForCluster

func GetKubernetesTokenForCluster(clusterID string) (*token.Token, string, error)

func GetRegionFromArn

func GetRegionFromArn(eksClusterArnString string) (string, error)

GetRegionFromArn extracts the AWS region that the EKS cluster is in from the ARN of the EKS cluster.

func NewAuthenticatedSession

func NewAuthenticatedSession(region string) (*session.Session, error)

NewAuthenticatedSession gets an AWS Session, checking that the user has credentials properly configured in their environment.

func NewECRClient

func NewECRClient(region string) (*ecr.ECR, error)

NewECRClient creates an AWS SDK client to access ECR API.

func NewEksClient

func NewEksClient(region string) (*eks.EKS, error)

NewEksClient creates an EKS client.

func TagExistsInRepo

func TagExistsInRepo(token, repoDomain, repoPath, tag string) (bool, error)

TagExistsInRepo queries the ECR repository docker API to see if the given tag exists for the given ECR repository.

Types

type CredentialsError

type CredentialsError struct {
	UnderlyingErr error
}

CredentialsError is an error that occurs because AWS credentials can't be found.

func (CredentialsError) Error

func (err CredentialsError) Error() string

type ECRManifestFetchError

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

ECRManifestFetchError is an error that occurs when retrieving information about a given tag in an ECR repository.

func (ECRManifestFetchError) Error

func (err ECRManifestFetchError) Error() string