preflight

Documentation

Overview

package preflight implements preflight checks for PKO APIs.

Index

• func NewContextWithPhase(ctx context.Context, phase corev1alpha1.ObjectSetTemplatePhase) context.Context
• type APIExistence
  • func NewAPIExistence(restMapper meta.RESTMapper) *APIExistence
  • func (p *APIExistence) Check(ctx context.Context, _, obj client.Object) (violations []Violation, err error)
• type CheckerFn
  • func (fn CheckerFn) Check(ctx context.Context, owner, obj client.Object) (violations []Violation, err error)
• type CreationDryRun
  • func NewCreationDryRun(client client.Writer) *CreationDryRun
  • func (p *CreationDryRun) Check(ctx context.Context, _, obj client.Object) (violations []Violation, err error)
• type EmptyNamespaceNoDefault
  • func NewEmptyNamespaceNoDefault(restMapper meta.RESTMapper) *EmptyNamespaceNoDefault
  • func (p *EmptyNamespaceNoDefault) Check(ctx context.Context, owner, obj client.Object) (violations []Violation, err error)
• type Error
  • func (e *Error) Error() string
• type List
  • func (l List) Check(ctx context.Context, owner, obj client.Object) (violations []Violation, err error)
• type NamespaceEscalation
  • func NewNamespaceEscalation(restMapper meta.RESTMapper) *NamespaceEscalation
  • func (p *NamespaceEscalation) Check(ctx context.Context, owner, obj client.Object) (violations []Violation, err error)
• type Violation
  • func CheckAll(ctx context.Context, checker checker, owner client.Object, ...) (violations []Violation, err error)
  • func CheckAllInPhase(ctx context.Context, checker checker, owner client.Object, ...) (violations []Violation, err error)
  • func (v *Violation) String() string

Functions

func NewContextWithPhase

func NewContextWithPhase(ctx context.Context, phase corev1alpha1.ObjectSetTemplatePhase) context.Context

Types

type APIExistence

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

Prevents the use of APIs not registered into the kube-apiserver.

func NewAPIExistence

func NewAPIExistence(restMapper meta.RESTMapper) *APIExistence

func (*APIExistence) Check

func (p *APIExistence) Check(ctx context.Context, _, obj client.Object) (violations []Violation, err error)

type CheckerFn

type CheckerFn func(
	ctx context.Context, owner, obj client.Object,
) (violations []Violation, err error)

func (CheckerFn) Check

func (fn CheckerFn) Check(
	ctx context.Context, owner,
	obj client.Object,
) (violations []Violation, err error)

type CreationDryRun

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

func NewCreationDryRun

func NewCreationDryRun(client client.Writer) *CreationDryRun

func (*CreationDryRun) Check

func (p *CreationDryRun) Check(
	ctx context.Context, _, obj client.Object,
) (violations []Violation, err error)

type EmptyNamespaceNoDefault

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

Prevents the use of APIs not registered into the kube-apiserver.

func NewEmptyNamespaceNoDefault

func NewEmptyNamespaceNoDefault(restMapper meta.RESTMapper) *EmptyNamespaceNoDefault

func (*EmptyNamespaceNoDefault) Check

func (p *EmptyNamespaceNoDefault) Check(
	ctx context.Context, owner,
	obj client.Object,
) (violations []Violation, err error)

type Error

type Error struct {
	Violations []Violation
}

func (*Error) Error

func (e *Error) Error() string

type List

type List []checker

Runs a list of preflight checks and aggregates the result into a single list of violations.

func (List) Check

func (l List) Check(
	ctx context.Context, owner,
	obj client.Object,
) (violations []Violation, err error)

type NamespaceEscalation

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

Prevents namespace escalation from users specifying cluster-scoped resources or resources in other namespaces in non-cluster-scoped APIs.

func NewNamespaceEscalation

func NewNamespaceEscalation(restMapper meta.RESTMapper) *NamespaceEscalation

func (*NamespaceEscalation) Check

func (p *NamespaceEscalation) Check(
	ctx context.Context, owner,
	obj client.Object,
) (violations []Violation, err error)

type Violation

type Violation struct {
	// Position the violation was found.
	Position string
	// Error describing the violation.
	Error string
}

func CheckAll

func CheckAll(
	ctx context.Context, checker checker,
	owner client.Object, objs []client.Object,
) (violations []Violation, err error)

func CheckAllInPhase

func CheckAllInPhase(
	ctx context.Context, checker checker,
	owner client.Object,
	phase corev1alpha1.ObjectSetTemplatePhase,
	objs []unstructured.Unstructured,
) (violations []Violation, err error)

func (*Violation) String

func (v *Violation) String() string