policyhelper

Documentation

Index

• Constants
• Variables
• func GroupKindToObj(gk GroupKind) (client.Object, bool)
• type ConditionReason
• type ConditionType
• type GroupKind
  • func ObjToGroupKind(obj client.Object) GroupKind
  • func TargetRefGroupKind(tr *TargetRef) GroupKind
• type GroupKindSet
  • func NewGroupKindSet(objs ...k8sclient.Object) *GroupKindSet
• type IAP
• type IAPL
• type Policy
• type PolicyClient
• type PolicyHandler
  • func NewIAMAuthPolicyHandler(log gwlog.Logger, c k8sclient.Client) *PolicyHandler[*IAP]
  • func NewPolicyHandler[T, TL any, P policyPtr[T], PL policyListPtr[TL, P]](cfg PolicyHandlerConfig) *PolicyHandler[P]
  • func NewTargetGroupPolicyHandler(log gwlog.Logger, c k8sclient.Client) *PolicyHandler[*TGP]
  • func NewVpcAssociationPolicyHandler(log gwlog.Logger, c k8sclient.Client) *PolicyHandler[*VAP]
  • func (h *PolicyHandler[P]) AddWatchers(b *builder.Builder, objs ...k8sclient.Object)
  • func (h *PolicyHandler[P]) ObjPolicies(ctx context.Context, obj k8sclient.Object) ([]P, error)
  • func (h *PolicyHandler[P]) ObjResolvedPolicy(ctx context.Context, obj k8sclient.Object) (P, error)
  • func (h *PolicyHandler[P]) UpdateAcceptedCondition(ctx context.Context, policy P, reason ConditionReason, msg string) error
  • func (h *PolicyHandler[P]) ValidateAndUpdateCondition(ctx context.Context, policy P) (ConditionReason, error)
  • func (h *PolicyHandler[P]) ValidateTargetRef(ctx context.Context, policy P) error
• type PolicyHandlerConfig
• type PolicyList
• type TGP
• type TGPL
• type TargetRef
• type VAP
• type VAPL

Constants

const (
	ConditionTypeAccepted = gwv1alpha2.PolicyConditionAccepted

	ReasonAccepted       = gwv1alpha2.PolicyReasonAccepted
	ReasonInvalid        = gwv1alpha2.PolicyReasonInvalid
	ReasonTargetNotFound = gwv1alpha2.PolicyReasonTargetNotFound
	ReasonConflicted     = gwv1alpha2.PolicyReasonConflicted

	ReasonUnknown = ConditionReason("Unknown")
)

Variables

var (
	ErrGroupKind         = errors.New("group/kind error")
	ErrTargetRefNotFound = errors.New("targetRef not found")
	ErrTargetRefConflict = errors.New("targetRef has conflict")
)

Functions

func GroupKindToObj

func GroupKindToObj(gk GroupKind) (client.Object, bool)

Types

type ConditionReason

type ConditionReason = gwv1alpha2.PolicyConditionReason

type ConditionType

type ConditionType = gwv1alpha2.PolicyConditionType

type GroupKind

type GroupKind struct {
	Group string
	Kind  string
}

func ObjToGroupKind

func ObjToGroupKind(obj client.Object) GroupKind

func TargetRefGroupKind

func TargetRefGroupKind(tr *TargetRef) GroupKind

type GroupKindSet

type GroupKindSet = utils.Set[GroupKind]

func NewGroupKindSet

func NewGroupKindSet(objs ...k8sclient.Object) *GroupKindSet

type IAP

type IAP = anv1alpha1.IAMAuthPolicy

type IAPL

type IAPL = anv1alpha1.IAMAuthPolicyList

type Policy

type Policy interface {
	k8sclient.Object
	GetTargetRef() *TargetRef
	GetStatusConditions() *[]metav1.Condition
}

Policy with PolicyTargetReference

type PolicyClient

type PolicyClient[P Policy] interface {
	List(ctx context.Context, namespace string) ([]P, error)
	Get(ctx context.Context, nsname types.NamespacedName) (P, error)
	TargetRefObj(ctx context.Context, policy P) (k8sclient.Object, error)
	UpdateStatus(ctx context.Context, policy P) error
}

Strong-typed interface to work with k8s client

type PolicyHandler

type PolicyHandler[P Policy] struct {
	// contains filtered or unexported fields
}

A generic handler for common operations on particular policy type

func NewIAMAuthPolicyHandler

func NewIAMAuthPolicyHandler(log gwlog.Logger, c k8sclient.Client) *PolicyHandler[*IAP]

func NewPolicyHandler

func NewPolicyHandler[T, TL any, P policyPtr[T], PL policyListPtr[TL, P]](cfg PolicyHandlerConfig) *PolicyHandler[P]

Creates policy handler for specific policy. T and TL are type and list-type for Policy (struct type, not reference). P and PL are reference types and should derive from T and TL. P and PL do not require explicit declaration. For example:

ph := NewPolicyHandler[IAMAuthPolicy, IAMAuthPolicyList](cfg)

func NewTargetGroupPolicyHandler

func NewTargetGroupPolicyHandler(log gwlog.Logger, c k8sclient.Client) *PolicyHandler[*TGP]

func NewVpcAssociationPolicyHandler

func NewVpcAssociationPolicyHandler(log gwlog.Logger, c k8sclient.Client) *PolicyHandler[*VAP]

func (*PolicyHandler[P]) AddWatchers

func (h *PolicyHandler[P]) AddWatchers(b *builder.Builder, objs ...k8sclient.Object)

Add Watchers for configured Kinds to controller builder

func (*PolicyHandler[P]) ObjPolicies

func (h *PolicyHandler[P]) ObjPolicies(ctx context.Context, obj k8sclient.Object) ([]P, error)

Get all policies for given object, filtered by targetRef match and sorted by conflict resolution rules. First policy in the list is not-conflicting policy, but it might be in Accepted or Invalid state. Conflict resolution order uses CreationTimestamp and Name.

func (*PolicyHandler[P]) ObjResolvedPolicy

func (h *PolicyHandler[P]) ObjResolvedPolicy(ctx context.Context, obj k8sclient.Object) (P, error)

Get Accepted policy for given object. Returns policy with conflict resolution and status Accepted. Will return at most single policy.

func (*PolicyHandler[P]) UpdateAcceptedCondition

func (h *PolicyHandler[P]) UpdateAcceptedCondition(ctx context.Context, policy P, reason ConditionReason, msg string) error

func (*PolicyHandler[P]) ValidateAndUpdateCondition

func (h *PolicyHandler[P]) ValidateAndUpdateCondition(ctx context.Context, policy P) (ConditionReason, error)

Validate Policy and update Accepted status condition.

func (*PolicyHandler[P]) ValidateTargetRef

func (h *PolicyHandler[P]) ValidateTargetRef(ctx context.Context, policy P) error

type PolicyHandlerConfig

type PolicyHandlerConfig struct {
	Log            gwlog.Logger
	Client         k8sclient.Client
	TargetRefKinds *GroupKindSet
}

type PolicyList

type PolicyList[P Policy] interface {
	k8sclient.ObjectList
	GetItems() []P
}

type TGP

type TGP = anv1alpha1.TargetGroupPolicy

type TGPL

type TGPL = anv1alpha1.TargetGroupPolicyList

type TargetRef

type TargetRef = gwv1alpha2.PolicyTargetReference

type VAP

type VAP = anv1alpha1.VpcAssociationPolicy

type VAPL

type VAPL = anv1alpha1.VpcAssociationPolicyList