v1beta1

Documentation

Overview

Package v1beta1 contains API Schema definitions for the policy v1beta1 API group +kubebuilder:object:generate=true +groupName=policy.open-cluster-management.io

Index

• Variables
• type AutomationDef
  • func (in *AutomationDef) DeepCopy() *AutomationDef
  • func (in *AutomationDef) DeepCopyInto(out *AutomationDef)
• type NonEmptyString
• type PolicyAutomation
  • func (in *PolicyAutomation) DeepCopy() *PolicyAutomation
  • func (in *PolicyAutomation) DeepCopyInto(out *PolicyAutomation)
  • func (in *PolicyAutomation) DeepCopyObject() runtime.Object
• type PolicyAutomationList
  • func (in *PolicyAutomationList) DeepCopy() *PolicyAutomationList
  • func (in *PolicyAutomationList) DeepCopyInto(out *PolicyAutomationList)
  • func (in *PolicyAutomationList) DeepCopyObject() runtime.Object
• type PolicyAutomationSpec
  • func (in *PolicyAutomationSpec) DeepCopy() *PolicyAutomationSpec
  • func (in *PolicyAutomationSpec) DeepCopyInto(out *PolicyAutomationSpec)
• type PolicyAutomationStatus
  • func (in *PolicyAutomationStatus) DeepCopy() *PolicyAutomationStatus
  • func (in *PolicyAutomationStatus) DeepCopyInto(out *PolicyAutomationStatus)
• type PolicySet
  • func (in *PolicySet) DeepCopy() *PolicySet
  • func (in *PolicySet) DeepCopyInto(out *PolicySet)
  • func (in *PolicySet) DeepCopyObject() runtime.Object
• type PolicySetList
  • func (in *PolicySetList) DeepCopy() *PolicySetList
  • func (in *PolicySetList) DeepCopyInto(out *PolicySetList)
  • func (in *PolicySetList) DeepCopyObject() runtime.Object
• type PolicySetSpec
  • func (in *PolicySetSpec) DeepCopy() *PolicySetSpec
  • func (in *PolicySetSpec) DeepCopyInto(out *PolicySetSpec)
• type PolicySetStatus
  • func (in *PolicySetStatus) DeepCopy() *PolicySetStatus
  • func (in *PolicySetStatus) DeepCopyInto(out *PolicySetStatus)
• type PolicySetStatusPlacement
  • func (in *PolicySetStatusPlacement) DeepCopy() *PolicySetStatusPlacement
  • func (in *PolicySetStatusPlacement) DeepCopyInto(out *PolicySetStatusPlacement)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "policy.open-cluster-management.io", Version: "v1beta1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type AutomationDef

type AutomationDef struct {
	// Type of the automation to invoke
	Type string `json:"type,omitempty"`
	// Name of the Ansible Template to run in Tower as a job
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name"`
	// ExtraVars is passed to the Ansible job at execution time and is a known Ansible entity.
	// +kubebuilder:pruning:PreserveUnknownFields
	ExtraVars *runtime.RawExtension `json:"extra_vars,omitempty"`
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	TowerSecret string `json:"secret"`
}

AutomationDef defines the automation to invoke

func (*AutomationDef) DeepCopy

func (in *AutomationDef) DeepCopy() *AutomationDef

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

func (*AutomationDef) DeepCopyInto

func (in *AutomationDef) DeepCopyInto(out *AutomationDef)

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

type NonEmptyString

type NonEmptyString string

+kubebuilder:validation:MinLength=1

type PolicyAutomation

type PolicyAutomation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:Required
	Spec   PolicyAutomationSpec   `json:"spec"`
	Status PolicyAutomationStatus `json:"status,omitempty"`
}

PolicyAutomation is the Schema for the policyautomations API +kubebuilder:subresource:status +kubebuilder:resource:path=policyautomations,scope=Namespaced +kubebuilder:resource:path=policyautomations,shortName=plca

func (*PolicyAutomation) DeepCopy

func (in *PolicyAutomation) DeepCopy() *PolicyAutomation

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

func (*PolicyAutomation) DeepCopyInto

func (in *PolicyAutomation) DeepCopyInto(out *PolicyAutomation)

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

func (*PolicyAutomation) DeepCopyObject

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

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

type PolicyAutomationList

type PolicyAutomationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PolicyAutomation `json:"items"`
}

PolicyAutomationList contains a list of PolicyAutomation

func (*PolicyAutomationList) DeepCopy

func (in *PolicyAutomationList) DeepCopy() *PolicyAutomationList

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

func (*PolicyAutomationList) DeepCopyInto

func (in *PolicyAutomationList) DeepCopyInto(out *PolicyAutomationList)

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

func (*PolicyAutomationList) DeepCopyObject

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

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

type PolicyAutomationSpec

type PolicyAutomationSpec struct {
	// PolicyRef is the name of the policy automation is going to binding with.
	// +kubebuilder:validation:Required
	PolicyRef string `json:"policyRef"`
	// Mode decides how automation is going to be triggered
	// +kubebuilder:validation:Enum={once,disabled}
	// +kubebuilder:validation:Required
	Mode string `json:"mode"`
	// EventHook decides when automation is going to be triggered
	// +kubebuilder:validation:Enum={noncompliant}
	// +kubebuilder:validation:Required
	EventHook   string `json:"eventHook,omitempty"`
	RescanAfter string `json:"rescanAfter,omitempty"`
	// +kubebuilder:validation:Required
	Automation AutomationDef `json:"automationDef"`
}

PolicyAutomationSpec defines the desired state of PolicyAutomation

func (*PolicyAutomationSpec) DeepCopy

func (in *PolicyAutomationSpec) DeepCopy() *PolicyAutomationSpec

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

func (*PolicyAutomationSpec) DeepCopyInto

func (in *PolicyAutomationSpec) DeepCopyInto(out *PolicyAutomationSpec)

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

type PolicyAutomationStatus

type PolicyAutomationStatus struct{}

PolicyAutomationStatus defines the observed state of PolicyAutomation

func (*PolicyAutomationStatus) DeepCopy

func (in *PolicyAutomationStatus) DeepCopy() *PolicyAutomationStatus

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

func (*PolicyAutomationStatus) DeepCopyInto

func (in *PolicyAutomationStatus) DeepCopyInto(out *PolicyAutomationStatus)

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

type PolicySet

type PolicySet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:Required
	Spec   PolicySetSpec   `json:"spec"`
	Status PolicySetStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:path=policysets,scope=Namespaced +kubebuilder:resource:path=policysets,shortName=plcset +kubebuilder:printcolumn:name="Compliance state",type="string",JSONPath=".status.compliant" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" PolicySet is the Schema for the policysets API

func (*PolicySet) DeepCopy

func (in *PolicySet) DeepCopy() *PolicySet

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

func (*PolicySet) DeepCopyInto

func (in *PolicySet) DeepCopyInto(out *PolicySet)

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

func (*PolicySet) DeepCopyObject

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

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

type PolicySetList

type PolicySetList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PolicySet `json:"items"`
}

PolicySetList contains a list of PolicySet

func (*PolicySetList) DeepCopy

func (in *PolicySetList) DeepCopy() *PolicySetList

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

func (*PolicySetList) DeepCopyInto

func (in *PolicySetList) DeepCopyInto(out *PolicySetList)

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

func (*PolicySetList) DeepCopyObject

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

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

type PolicySetSpec

type PolicySetSpec struct {
	Description string `json:"description,omitempty"`
	// +kubebuilder:validation:Required
	Policies []NonEmptyString `json:"policies"`
}

PolicySetSpec defines the desired state of PolicySet

func (*PolicySetSpec) DeepCopy

func (in *PolicySetSpec) DeepCopy() *PolicySetSpec

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

func (*PolicySetSpec) DeepCopyInto

func (in *PolicySetSpec) DeepCopyInto(out *PolicySetSpec)

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

type PolicySetStatus

type PolicySetStatus struct {
	Placement     []PolicySetStatusPlacement `json:"placement,omitempty"`
	Compliant     string                     `json:"compliant,omitempty"`
	StatusMessage string                     `json:"statusMessage,omitempty"`
}

PolicySetStatus defines the observed state of PolicySet

func (*PolicySetStatus) DeepCopy

func (in *PolicySetStatus) DeepCopy() *PolicySetStatus

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

func (*PolicySetStatus) DeepCopyInto

func (in *PolicySetStatus) DeepCopyInto(out *PolicySetStatus)

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

type PolicySetStatusPlacement

type PolicySetStatusPlacement struct {
	PlacementBinding string `json:"placementBinding,omitempty"`
	Placement        string `json:"placement,omitempty"`
	PlacementRule    string `json:"placementRule,omitempty"`
}

PolicySetStatusPlacement defines a placement object for the status

func (*PolicySetStatusPlacement) DeepCopy

func (in *PolicySetStatusPlacement) DeepCopy() *PolicySetStatusPlacement

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

func (*PolicySetStatusPlacement) DeepCopyInto

func (in *PolicySetStatusPlacement) DeepCopyInto(out *PolicySetStatusPlacement)

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