iamauth

Documentation

Overview

Package iamauth provides a way to interact with AWS IAM.

Index

• Constants
• Variables
• type AuthenticatorBackend
  • func NewBackend(backendType BackendType, client crclient.Client) (AuthenticatorBackend, error)
• type BackendType
• type Service
  • func NewService(iamScope scope.IAMAuthScope, backend BackendType, client client.Client) *Service
  • func (s *Service) ReconcileIAMAuthenticator(ctx context.Context) error

Constants

const (
	// EC2NodeUserName is the username required for EC2 nodes.
	EC2NodeUserName = "system:node:{{EC2PrivateDNSName}}"
)

Variables

var (
	// ErrInvalidBackendType defines an error for an invalid backend type.
	ErrInvalidBackendType = errors.New("invalid backend type")

	// ErrClientRequired defines an error for when a k8s client is required but
	// not supplied.
	ErrClientRequired = errors.New("k8s client required")
)

var (
	// BackendTypeConfigMap is the Kubernetes config map backend.
	BackendTypeConfigMap = BackendType("config-map")
	// BackendTypeCRD is the CRD based backend.
	BackendTypeCRD = BackendType("crd")
)

var (
	// NodeGroups is the groups that are required for a node.
	NodeGroups = []string{"system:bootstrappers", "system:nodes"}
)

Types

type AuthenticatorBackend

type AuthenticatorBackend interface {
	// MapRole is used to map a role ARN to a user and set of groups
	MapRole(mapping ekscontrolplanev1.RoleMapping) error
	// MapUser is used to map a user ARN to a user and set of groups
	MapUser(mapping ekscontrolplanev1.UserMapping) error
}

AuthenticatorBackend is the interface that represents an aws-iam-authenticator backend.

func NewBackend

func NewBackend(backendType BackendType, client crclient.Client) (AuthenticatorBackend, error)

NewBackend will create a new authenticate backend for a given type. Only use BackendTypeConfigMap with EKS.

type BackendType

type BackendType string

BackendType is a type that represents the different aws-iam-authenticator backends.

type Service

type Service struct {
	IAMClient iamiface.IAMAPI
	// contains filtered or unexported fields
}

Service defines the specs for a service.

func NewService

func NewService(iamScope scope.IAMAuthScope, backend BackendType, client client.Client) *Service

NewService will create a new Service object.

func (*Service) ReconcileIAMAuthenticator

func (s *Service) ReconcileIAMAuthenticator(ctx context.Context) error

ReconcileIAMAuthenticator is used to create the aws-iam-authenticator in a cluster.