util

Documentation

Index

• Variables
• func DeleteClusterIPs(clusterName, namespace string)
• func GetAutoGenTags(cluster infrav1alpha2.LinodeCluster) []string
• func GetInstanceID(providerID *string) (int, error)
• func GetNextVlanIP(ctx context.Context, clusterName, namespace string, kubeclient client.Client) (string, error)
• func IgnoreLinodeAPIError(err error, codes ...int) error
• func IsLinodePrivateIP(ipAddress string) bool
• func IsRetryableError(err error) bool
• func Pointer[T any](t T) *T
• func SetOwnerReferenceToLinodeCluster(ctx context.Context, k8sclient client.Client, cluster *clusterv1.Cluster, ...) error
• func UnwrapError(err error) error
• type ClusterIPs
• type Filter
  • func (f Filter) MarshalJSON() ([]byte, error)
  • func (f Filter) String() (string, error)
• type PostRequestCounter
  • func GetPostReqCounter(tokenHash string) *PostRequestCounter
  • func (c *PostRequestCounter) ApiResponseRatelimitCounter(resp *resty.Response) error
  • func (c *PostRequestCounter) IsPOSTLimitReached() bool
  • func (c *PostRequestCounter) RetryAfter() time.Duration

Variables

var (
	CreateError  = "CreateError"
	DeleteError  = "DeleteError"
	UpdateError  = "UpdateError"
	UnknownError = "UnknownError"
)

List of failure reasons to use in the status fields of our resources

var (
	// ErrRateLimit indicates hitting linode API rate limits
	ErrRateLimit = errors.New("rate-limit exceeded")
)

Functions

func DeleteClusterIPs

func DeleteClusterIPs(clusterName, namespace string)

func GetAutoGenTags

func GetAutoGenTags(cluster infrav1alpha2.LinodeCluster) []string

GetAutoGenTags returns tags to be added to linods when a cluster is provisioned using CAPL

func GetInstanceID

func GetInstanceID(providerID *string) (int, error)

GetInstanceID determines the instance ID from the ProviderID

func GetNextVlanIP

func GetNextVlanIP(ctx context.Context, clusterName, namespace string, kubeclient client.Client) (string, error)

GetNextVlanIP returns the next available IP for a cluster

func IgnoreLinodeAPIError

func IgnoreLinodeAPIError(err error, codes ...int) error

IgnoreLinodeAPIError returns the error except matches to status code

func IsLinodePrivateIP

func IsLinodePrivateIP(ipAddress string) bool

IsLinodePrivateIP checks if an IP address belongs to the Linode private IP range (192.168.128.0/17)

func IsRetryableError

func IsRetryableError(err error) bool

IsRetryableError determines if the error is retryable, meaning a controller that encounters this error should requeue reconciliation to try again later

func Pointer

func Pointer[T any](t T) *T

Pointer returns the pointer of any type

func SetOwnerReferenceToLinodeCluster

func SetOwnerReferenceToLinodeCluster(ctx context.Context, k8sclient client.Client, cluster *clusterv1.Cluster, obj client.Object, scheme *runtime.Scheme) error

SetOwnerReferenceToLinodeCluster fetches the LinodeCluster and sets it as the owner reference of a given object.

func UnwrapError

func UnwrapError(err error) error

UnwrapError safely unwraps an error until it can't be unwrapped.

Types

type ClusterIPs

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

type Filter

type Filter struct {
	ID                *int              // Filter on the resource's ID (most specific).
	Label             string            // Filter on the resource's label.
	Tags              []string          // Filter resources by their tags (least specific).
	AdditionalFilters map[string]string // Filter resources by additional parameters
}

Filter holds the fields used for filtering results from the Linode API.

The fields within Filter are prioritized so that only the most-specific field is present when Filter is marshaled to JSON.

func (Filter) MarshalJSON

func (f Filter) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON-encoded representation of a Filter. The resulting encoded value will have exactly 1 (one) field present. See Filter for details on the value precedence.

func (Filter) String

func (f Filter) String() (string, error)

String returns the string representation of the encoded value from Filter.MarshalJSON.

type PostRequestCounter

type PostRequestCounter struct {
	Mu           sync.RWMutex
	ReqRemaining int
	RefreshTime  time.Time
}

PostRequestCounter keeps track of rate limits for POST to /linode/instances

func GetPostReqCounter

func GetPostReqCounter(tokenHash string) *PostRequestCounter

GetPostReqCounter returns pointer to PostRequestCounter for a given token hash

func (*PostRequestCounter) ApiResponseRatelimitCounter

func (c *PostRequestCounter) ApiResponseRatelimitCounter(resp *resty.Response) error

ApiResponseRatelimitCounter updates ReqRemaining and RefreshTime when a POST call is made to /linode/instances

func (*PostRequestCounter) IsPOSTLimitReached

func (c *PostRequestCounter) IsPOSTLimitReached() bool

IsPOSTLimitReached checks whether POST limits have been reached.

func (*PostRequestCounter) RetryAfter

func (c *PostRequestCounter) RetryAfter() time.Duration

RetryAfter returns how long to wait in seconds for rate-limit to reset