v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the sync v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/open-policy-agent/gatekeeper/pkg/apis/sync +k8s:defaulter-gen=TypeMeta +groupName=config.gatekeeper.sh

Package v1alpha1 contains API Schema definitions for the sync v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/open-policy-agent/gatekeeper/pkg/apis/sync +k8s:defaulter-gen=TypeMeta +groupName=config.gatekeeper.sh

Index

• Variables
• func Resource(resource string) schema.GroupResource
• func ToGVK(gvk GVK) schema.GroupVersionKind
• type ByPod
  • func (in *ByPod) DeepCopy() *ByPod
  • func (in *ByPod) DeepCopyInto(out *ByPod)
• type Config
  • func (in *Config) DeepCopy() *Config
  • func (in *Config) DeepCopyInto(out *Config)
  • func (in *Config) DeepCopyObject() runtime.Object
• type ConfigList
  • func (in *ConfigList) DeepCopy() *ConfigList
  • func (in *ConfigList) DeepCopyInto(out *ConfigList)
  • func (in *ConfigList) DeepCopyObject() runtime.Object
• type ConfigSpec
  • func (in *ConfigSpec) DeepCopy() *ConfigSpec
  • func (in *ConfigSpec) DeepCopyInto(out *ConfigSpec)
• type ConfigStatus
  • func (in *ConfigStatus) DeepCopy() *ConfigStatus
  • func (in *ConfigStatus) DeepCopyInto(out *ConfigStatus)
• type GVK
  • func ToAPIGVK(gvk schema.GroupVersionKind) GVK
  • func (in *GVK) DeepCopy() *GVK
  • func (in *GVK) DeepCopyInto(out *GVK)
• type Sync
  • func (in *Sync) DeepCopy() *Sync
  • func (in *Sync) DeepCopyInto(out *Sync)
• type SyncOnlyEntry
  • func (in *SyncOnlyEntry) DeepCopy() *SyncOnlyEntry
  • func (in *SyncOnlyEntry) DeepCopyInto(out *SyncOnlyEntry)
• type Trace
  • func (in *Trace) DeepCopy() *Trace
  • func (in *Trace) DeepCopyInto(out *Trace)
• type Validation
  • func (in *Validation) DeepCopy() *Validation
  • func (in *Validation) DeepCopyInto(out *Validation)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "config.gatekeeper.sh", Version: "v1alpha1"}

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

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

func ToGVK

func ToGVK(gvk GVK) schema.GroupVersionKind

Types

type ByPod

type ByPod struct {
	// a unique identifier for the pod that wrote the status
	ID string `json:"id,omitempty"`
	// List of Group/Version/Kinds with finalizers
	AllFinalizers []GVK `json:"allFinalizers,omitempty"`
}

func (*ByPod) DeepCopy

func (in *ByPod) DeepCopy() *ByPod

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

func (*ByPod) DeepCopyInto

func (in *ByPod) DeepCopyInto(out *ByPod)

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

type Config

type Config struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ConfigSpec   `json:"spec,omitempty"`
	Status ConfigStatus `json:"status,omitempty"`
}

Config is the Schema for the configs API +k8s:openapi-gen=true

func (*Config) DeepCopy

func (in *Config) DeepCopy() *Config

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

func (*Config) DeepCopyInto

func (in *Config) DeepCopyInto(out *Config)

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

func (*Config) DeepCopyObject

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

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

type ConfigList

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

ConfigList contains a list of Config

func (*ConfigList) DeepCopy

func (in *ConfigList) DeepCopy() *ConfigList

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

func (*ConfigList) DeepCopyInto

func (in *ConfigList) DeepCopyInto(out *ConfigList)

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

func (*ConfigList) DeepCopyObject

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

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

type ConfigSpec

type ConfigSpec struct {

	// Configuration for syncing k8s objects
	Sync Sync `json:"sync,omitempty"`

	// Configuration for validation
	Validation Validation `json:"validation,omitempty"`
}

ConfigSpec defines the desired state of Config

func (*ConfigSpec) DeepCopy

func (in *ConfigSpec) DeepCopy() *ConfigSpec

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

func (*ConfigSpec) DeepCopyInto

func (in *ConfigSpec) DeepCopyInto(out *ConfigSpec)

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

type ConfigStatus

type ConfigStatus struct {

	// List of statuses as seen by individual pods
	ByPod []*ByPod `json:"byPod,omitempty"`
}

ConfigStatus defines the observed state of Config

func (*ConfigStatus) DeepCopy

func (in *ConfigStatus) DeepCopy() *ConfigStatus

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

func (*ConfigStatus) DeepCopyInto

func (in *ConfigStatus) DeepCopyInto(out *ConfigStatus)

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

type GVK

type GVK struct {
	Group   string `json:"group,omitempty"`
	Version string `json:"version,omitempty"`
	Kind    string `json:"kind,omitempty"`
}

func ToAPIGVK

func ToAPIGVK(gvk schema.GroupVersionKind) GVK

func (*GVK) DeepCopy

func (in *GVK) DeepCopy() *GVK

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

func (*GVK) DeepCopyInto

func (in *GVK) DeepCopyInto(out *GVK)

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

type Sync

type Sync struct {
	// If non-empty, only entries on this list will be replicated into OPA
	SyncOnly []SyncOnlyEntry `json:"syncOnly,omitempty"`
}

func (*Sync) DeepCopy

func (in *Sync) DeepCopy() *Sync

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

func (*Sync) DeepCopyInto

func (in *Sync) DeepCopyInto(out *Sync)

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

type SyncOnlyEntry

type SyncOnlyEntry struct {
	Group   string `json:"group,omitempty"`
	Version string `json:"version,omitempty"`
	Kind    string `json:"kind,omitempty"`
}

func (*SyncOnlyEntry) DeepCopy

func (in *SyncOnlyEntry) DeepCopy() *SyncOnlyEntry

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

func (*SyncOnlyEntry) DeepCopyInto

func (in *SyncOnlyEntry) DeepCopyInto(out *SyncOnlyEntry)

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

type Trace

type Trace struct {
	// Only trace requests from the specified user
	User string `json:"user,omitempty"`
	// Only trace requests of the following GroupVersionKind
	Kind GVK `json:"kind,omitempty"`
	// Also dump the state of OPA with the trace. Set to `All` to dump everything.
	Dump string `json:"dump,omitempty"`
}

func (*Trace) DeepCopy

func (in *Trace) DeepCopy() *Trace

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

func (*Trace) DeepCopyInto

func (in *Trace) DeepCopyInto(out *Trace)

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

type Validation

type Validation struct {
	// List of requests to trace. Both "user" and "kinds" must be specified
	Traces []Trace `json:"traces,omitempty"`
}

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 an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.