v1alpha1

Documentation

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type CloneFrom
  • func (in *CloneFrom) DeepCopy() *CloneFrom
  • func (in *CloneFrom) DeepCopyInto(out *CloneFrom)
• type Generation
  • func (in *Generation) DeepCopy() *Generation
  • func (in *Generation) DeepCopyInto(out *Generation)
  • func (pcg *Generation) Validate() error
• type Mutation
  • func (in *Mutation) DeepCopy() *Mutation
  • func (in *Mutation) DeepCopyInto(out *Mutation)
• type Patch
  • func (pp *Patch) DeepCopyInto(out *Patch)
  • func (pp *Patch) Validate() error
• type Policy
  • func (in *Policy) DeepCopy() *Policy
  • func (in *Policy) DeepCopyInto(out *Policy)
  • func (in *Policy) DeepCopyObject() runtime.Object
• type PolicyList
  • func (in *PolicyList) DeepCopy() *PolicyList
  • func (in *PolicyList) DeepCopyInto(out *PolicyList)
  • func (in *PolicyList) DeepCopyObject() runtime.Object
• type ResourceDescription
  • func (in *ResourceDescription) DeepCopy() *ResourceDescription
  • func (in *ResourceDescription) DeepCopyInto(out *ResourceDescription)
  • func (pr *ResourceDescription) Validate() error
• type Rule
  • func (in *Rule) DeepCopy() *Rule
  • func (in *Rule) DeepCopyInto(out *Rule)
  • func (r *Rule) Validate() error
• type Spec
  • func (in *Spec) DeepCopy() *Spec
  • func (in *Spec) DeepCopyInto(out *Spec)
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
• type Validation
  • func (in *Validation) DeepCopy() *Validation
  • func (in *Validation) DeepCopyInto(out *Validation)
• type Violation
  • func (in *Violation) DeepCopy() *Violation
  • func (in *Violation) DeepCopyInto(out *Violation)

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: policy.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CloneFrom

type CloneFrom struct {
	Namespace string `json:"namespace"`
	Name      string `json:"name"`
}

CloneFrom - location of a Secret or a ConfigMap which will be used as source when applying 'generate'

func (*CloneFrom) DeepCopy

func (in *CloneFrom) DeepCopy() *CloneFrom

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloneFrom.

func (*CloneFrom) DeepCopyInto

func (in *CloneFrom) DeepCopyInto(out *CloneFrom)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Generation

type Generation struct {
	Kind  string      `json:"kind"`
	Name  string      `json:"name"`
	Data  interface{} `json:"data"`
	Clone *CloneFrom  `json:"clone"`
}

Generation describes which resources will be created when other resource is created

func (*Generation) DeepCopy

func (in *Generation) DeepCopy() *Generation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Generation.

func (*Generation) DeepCopyInto

func (in *Generation) DeepCopyInto(out *Generation)

DeepCopyInto is declared because k8s:deepcopy-gen is not able to generate this method for interface{} member

func (*Generation) Validate

func (pcg *Generation) Validate() error

Validate returns error if generator is configured incompletely

type Mutation

type Mutation struct {
	Overlay *interface{} `json:"overlay"`
	Patches []Patch      `json:"patches"`
}

Mutation describes the way how Mutating Webhook will react on resource creation

func (*Mutation) DeepCopy

func (in *Mutation) DeepCopy() *Mutation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Mutation.

func (*Mutation) DeepCopyInto

func (in *Mutation) DeepCopyInto(out *Mutation)

DeepCopyInto is declared because k8s:deepcopy-gen is not able to generate this method for interface{} member

type Patch

type Patch struct {
	Path      string      `json:"path"`
	Operation string      `json:"op"`
	Value     interface{} `json:"value"`
}

Patch declares patch operation for created object according to RFC 6902

func (*Patch) DeepCopyInto

func (pp *Patch) DeepCopyInto(out *Patch)

DeepCopyInto is declared because k8s:deepcopy-gen is not able to generate this method for interface{} member

func (*Patch) Validate

func (pp *Patch) Validate() error

Validate if all mandatory PolicyPatch fields are set

type Policy

type Policy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              Spec   `json:"spec"`
	Status            Status `json:"status"`
}

Policy contains rules to be applied to created resources

func (*Policy) DeepCopy

func (in *Policy) DeepCopy() *Policy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.

func (*Policy) DeepCopyInto

func (in *Policy) DeepCopyInto(out *Policy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Policy) DeepCopyObject

func (in *Policy) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PolicyList

type PolicyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Policy `json:"items"`
}

PolicyList is a list of Policy resources

func (*PolicyList) DeepCopy

func (in *PolicyList) DeepCopy() *PolicyList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyList.

func (*PolicyList) DeepCopyInto

func (in *PolicyList) DeepCopyInto(out *PolicyList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PolicyList) DeepCopyObject

func (in *PolicyList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceDescription

type ResourceDescription struct {
	Kinds    []string              `json:"kinds"`
	Name     *string               `json:"name"`
	Selector *metav1.LabelSelector `json:"selector"`
}

ResourceDescription describes the resource to which the PolicyRule will be applied.

func (*ResourceDescription) DeepCopy

func (in *ResourceDescription) DeepCopy() *ResourceDescription

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceDescription.

func (*ResourceDescription) DeepCopyInto

func (in *ResourceDescription) DeepCopyInto(out *ResourceDescription)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceDescription) Validate

func (pr *ResourceDescription) Validate() error

Validate checks if all necesarry fields are present and have values. Also checks a Selector. Returns error if - kinds is not defined

type Rule

type Rule struct {
	Name                string `json:"name"`
	ResourceDescription `json:"resource"`
	Mutation            *Mutation   `json:"mutate"`
	Validation          *Validation `json:"validate"`
	Generation          *Generation `json:"generate"`
}

Rule is set of mutation, validation and generation actions for the single resource description

func (*Rule) DeepCopy

func (in *Rule) DeepCopy() *Rule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rule.

func (*Rule) DeepCopyInto

func (in *Rule) DeepCopyInto(out *Rule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Rule) Validate

func (r *Rule) Validate() error

Validate checks if rule is not empty and all substructures are valid

type Spec

type Spec struct {
	Rules []Rule `json:"rules"`
}

Spec describes policy behavior by its rules

func (*Spec) DeepCopy

func (in *Spec) DeepCopy() *Spec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Spec.

func (*Spec) DeepCopyInto

func (in *Spec) DeepCopyInto(out *Spec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Status

type Status struct {
	Violations []Violation `json:"violations,omitempty"`
}

Status contains violations for existing resources

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Validation

type Validation struct {
	Message *string     `json:"message"`
	Pattern interface{} `json:"pattern"`
}

Validation describes the way how Validating Webhook will check the resource on creation

func (*Validation) DeepCopy

func (in *Validation) DeepCopy() *Validation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Validation.

func (*Validation) DeepCopyInto

func (in *Validation) DeepCopyInto(out *Validation)

DeepCopyInto is declared because k8s:deepcopy-gen is not able to generate this method for interface{} member

type Violation

type Violation struct {
	Kind     string `json:"kind,omitempty"`
	Resource string `json:"resource,omitempty"`
	Rule     string `json:"rule,omitempty"`
	Reason   string `json:"reason,omitempty"`
	Message  string `json:"message,omitempty"`
}

Violation for the policy

func (*Violation) DeepCopy

func (in *Violation) DeepCopy() *Violation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Violation.

func (*Violation) DeepCopyInto

func (in *Violation) DeepCopyInto(out *Violation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.