auth

Documentation

Index

• func NewPermanentCredentialsError(err error) error
• type PermanentCredentialsError

Functions

func NewPermanentCredentialsError

func NewPermanentCredentialsError(err error) error

NewPermanentCredentialsError marks an auth-related error as permanent (non retryable).

Types

type PermanentCredentialsError

type PermanentCredentialsError interface {
	error
	IsPermanent()
}

PermanentCredentialsError is an error behaviour which signals that the interaction with an external service shouldn't be retried, due to credentials which are either invalid, expired, or missing permissions.

This allows callers to handle that special case if required, especially when the original error can not be asserted any other way because it is untyped. For example, Kubernetes finalizers are unlikely to be able to proceed when credentials can not be determined.

Examples of assertion:

_, ok := err.(PermanentCredentialsError)

permErr := (PermanentCredentialsError)(nil)
ok := errors.As(err, &permErr)