v2alpha1

package
v2.0.0-alpha.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v2alpha1 contains API Schema definitions for the config v2alpha1 API group. +kubebuilder:object:generate=true +groupName=config.ratify.dev

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "config.ratify.dev", Version: "v2alpha1"}

	// 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
)

Functions

This section is empty.

Types

type Executor

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

	Spec   ExecutorSpec   `json:"spec,omitempty"`
	Status ExecutorStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope="Cluster" +kubebuilder:storageversion +kubebuilder:printcolumn:name="Succeeded",type=boolean,JSONPath=`.status.succeeded` +kubebuilder:printcolumn:name="Error",type=string,JSONPath=`.status.briefError` Executor is the Schema for the executors API.

func (*Executor) DeepCopy

func (in *Executor) DeepCopy() *Executor

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

func (*Executor) DeepCopyInto

func (in *Executor) DeepCopyInto(out *Executor)

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

func (*Executor) DeepCopyObject

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

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

type ExecutorList

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

ExecutorList contains a list of Executor.

func (*ExecutorList) DeepCopy

func (in *ExecutorList) DeepCopy() *ExecutorList

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

func (*ExecutorList) DeepCopyInto

func (in *ExecutorList) DeepCopyInto(out *ExecutorList)

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

func (*ExecutorList) DeepCopyObject

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

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

type ExecutorSpec

type ExecutorSpec struct {

	// Scopes defines the scopes for which this executor is responsible. At
	// least one non-empty scope must be provided. Required.
	// +kubebuilder:validation:MinItems=1
	Scopes []string `json:"scopes"`

	// Verifiers contains the configuration options for the verifiers. At least
	// one verifier must be provided. Required.
	// +kubebuilder:validation:MinItems=1
	Verifiers []*VerifierOptions `json:"verifiers"`

	// Stores contains the configuration options for the stores. At least one
	// store must be provided. Required.
	// +kubebuilder:validation:MinItems=1
	Stores []*StoreOptions `json:"stores"`

	// PolicyEnforcer contains the configuration options for the policy
	// enforcer. Optional.
	PolicyEnforcer *PolicyEnforcerOptions `json:"policyEnforcer,omitempty"`

	// Concurrency limits the maximum number of concurrent execution per
	// validation request. If less than or equal to 0, a default (currently 3)
	// will be used. Optional.
	Concurrency int `json:"concurrency,omitempty"`
}

ExecutorSpec defines the desired state of Executor.

func (*ExecutorSpec) DeepCopy

func (in *ExecutorSpec) DeepCopy() *ExecutorSpec

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

func (*ExecutorSpec) DeepCopyInto

func (in *ExecutorSpec) DeepCopyInto(out *ExecutorSpec)

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

type ExecutorStatus

type ExecutorStatus struct {

	// Succeeded indicates whether the executor has successfully started and is
	// ready to process requests. Required.
	Succeeded bool `json:"succeeded"`

	// Error is the error message if the executor failed to start.
	// +optional
	Error string `json:"error,omitempty"`

	// Truncated error message if the message is too long.
	// +optional
	BriefError string `json:"briefError,omitempty"`
}

ExecutorStatus defines the observed state of Executor.

func (*ExecutorStatus) DeepCopy

func (in *ExecutorStatus) DeepCopy() *ExecutorStatus

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

func (*ExecutorStatus) DeepCopyInto

func (in *ExecutorStatus) DeepCopyInto(out *ExecutorStatus)

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

type PolicyEnforcerOptions

type PolicyEnforcerOptions struct {
	// Type represents a specific implementation of a policy enforcer. Required.
	// +kubebuilder:validation:MinLength=1
	Type string `json:"type"`

	// Parameters is additional parameters for the policy enforcer. Optional.
	Parameters runtime.RawExtension `json:"parameters,omitempty"`
}

func (*PolicyEnforcerOptions) DeepCopy

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

func (*PolicyEnforcerOptions) DeepCopyInto

func (in *PolicyEnforcerOptions) DeepCopyInto(out *PolicyEnforcerOptions)

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

type StoreOptions

type StoreOptions struct {
	// Type represents a specific implementation of a store. Required.
	// +kubebuilder:validation:MinLength=1
	Type string `json:"type"`

	// Parameters is additional parameters for the store. Optional.
	Parameters runtime.RawExtension `json:"parameters,omitempty"`
}

func (*StoreOptions) DeepCopy

func (in *StoreOptions) DeepCopy() *StoreOptions

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

func (*StoreOptions) DeepCopyInto

func (in *StoreOptions) DeepCopyInto(out *StoreOptions)

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

type VerifierOptions

type VerifierOptions struct {
	// Name is the unique identifier of a verifier instance. Required.
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name"`

	// Type represents a specific implementation of a verifier. Required.
	// Note: there could be multiple verifiers of the same type with different
	//       names.
	// +kubebuilder:validation:MinLength=1
	Type string `json:"type"`

	// Parameters is additional parameters of the verifier. Optional.
	Parameters runtime.RawExtension `json:"parameters,omitempty"`
}

func (*VerifierOptions) DeepCopy

func (in *VerifierOptions) DeepCopy() *VerifierOptions

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

func (*VerifierOptions) DeepCopyInto

func (in *VerifierOptions) DeepCopyInto(out *VerifierOptions)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL