config

package
v0.0.23 Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

Constants

View Source
const GroupName = "config.sdcio.dev"

Variables

View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

Functions

func Kind

func Kind(kind string) schema.GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Types

type Condition

type Condition struct {
	metav1.Condition `json:",inline" protobuf:"bytes,1,opt,name=condition"`
}

func Creating

func Creating() Condition

Creating returns a condition that indicates a create transaction is ongoing

func Deleting

func Deleting() Condition

Creating returns a condition that indicates a delete transaction is ongoing

func Failed

func Failed(msg string) Condition

Failed returns a condition that indicates the resource failed to get reconciled.

func Ready

func Ready() Condition

Ready returns a condition that indicates the resource is ready for use.

func Unknown

func Unknown() Condition

Unknown returns a condition that indicates the resource is in an unknown status.

func Updating

func Updating() Condition

Creating returns a condition that indicates a update transaction is ongoing

func (*Condition) DeepCopy

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto

func (in *Condition) DeepCopyInto(out *Condition)

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

func (Condition) Equal

func (c Condition) Equal(other Condition) bool

Equal returns true if the condition is identical to the supplied condition, ignoring the LastTransitionTime.

func (Condition) WithMessage

func (c Condition) WithMessage(msg string) Condition

WithMessage returns a condition by adding the provided message to existing condition.

type ConditionReason

type ConditionReason string

A ConditionReason represents the reason a resource is in a condition.

const (
	ConditionReasonReady          ConditionReason = "ready"
	ConditionReasonNotReady       ConditionReason = "notReady"
	ConditionReasonFailed         ConditionReason = "failed"
	ConditionReasonUnknown        ConditionReason = "unknown"
	ConditionReasonDeleting       ConditionReason = "deleting"
	ConditionReasonCreating       ConditionReason = "creating"
	ConditionReasonUpdating       ConditionReason = "updating"
	ConditionReasonTargetDeleted  ConditionReason = "target Deleted"
	ConditionReasonTargetNotReady ConditionReason = "target not ready"
	ConditionReasonTargetNotFound ConditionReason = "target not found"
)

Reasons a resource is ready or not

type ConditionType

type ConditionType string

A ConditionType represents a condition type for a given KRM resource

const (
	// ConditionTypeReady represents the resource ready condition
	ConditionTypeReady ConditionType = "Ready"
)

Condition Types.

type ConditionedStatus

type ConditionedStatus struct {
	// Conditions of the resource.
	// +optional
	Conditions []Condition `json:"conditions,omitempty" protobuf:"bytes,1,rep,name=conditions"`
}

A ConditionedStatus reflects the observed status of a resource. Only one condition of each type may exist.

func NewConditionedStatus

func NewConditionedStatus(c ...Condition) *ConditionedStatus

NewConditionedStatus returns a stat with the supplied conditions set.

func (*ConditionedStatus) DeepCopy

func (in *ConditionedStatus) DeepCopy() *ConditionedStatus

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

func (*ConditionedStatus) DeepCopyInto

func (in *ConditionedStatus) DeepCopyInto(out *ConditionedStatus)

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

func (*ConditionedStatus) Equal

func (r *ConditionedStatus) Equal(other *ConditionedStatus) bool

Equal returns true if the status is identical to the supplied status, ignoring the LastTransitionTimes and order of statuses.

func (*ConditionedStatus) GetCondition

func (r *ConditionedStatus) GetCondition(t ConditionType) Condition

GetCondition returns the condition for the given ConditionKind if exists, otherwise returns nil

func (*ConditionedStatus) SetConditions

func (r *ConditionedStatus) SetConditions(c ...Condition)

SetConditions sets the supplied conditions, replacing any existing conditions of the same type. This is a no-op if all supplied conditions are identical, ignoring the last transition time, to those already set.

type Config

type Config struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec   ConfigSpec   `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	Status ConfigStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
Config is the Schema for the Config 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 ConfigBlob

type ConfigBlob struct {
	// Path defines the path relative to which the value is applicable
	Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=config"`
	//+kubebuilder:pruning:PreserveUnknownFields
	Value runtime.RawExtension `json:"value" protobuf:"bytes,2,opt,name=value"`
}

func (*ConfigBlob) DeepCopy

func (in *ConfigBlob) DeepCopy() *ConfigBlob

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

func (*ConfigBlob) DeepCopyInto

func (in *ConfigBlob) DeepCopyInto(out *ConfigBlob)

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

type ConfigList

type ConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Items           []Config `json:"items" protobuf:"bytes,2,rep,name=items"`
}

ConfigList contains a list of Configs +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

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 ConfigSet

type ConfigSet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec   ConfigSetSpec   `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	Status ConfigSetStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
ConfigSet is the Schema for the ConfigSet API

+k8s:openapi-gen=true

func (*ConfigSet) DeepCopy

func (in *ConfigSet) DeepCopy() *ConfigSet

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

func (*ConfigSet) DeepCopyInto

func (in *ConfigSet) DeepCopyInto(out *ConfigSet)

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

func (*ConfigSet) DeepCopyObject

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

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

type ConfigSetList

type ConfigSetList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Items           []ConfigSet `json:"items" protobuf:"bytes,2,rep,name=items"`
}

ConfigSetList contains a list of ConfigSets +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ConfigSetList) DeepCopy

func (in *ConfigSetList) DeepCopy() *ConfigSetList

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

func (*ConfigSetList) DeepCopyInto

func (in *ConfigSetList) DeepCopyInto(out *ConfigSetList)

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

func (*ConfigSetList) DeepCopyObject

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

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

type ConfigSetSpec

type ConfigSetSpec struct {
	// Targets defines the targets on which this configSet applies
	Target Target `json:"target" protobuf:"bytes,1,opt,name=target"`
	// Lifecycle determines the lifecycle policies the resource e.g. delete is orphan or delete
	// will follow
	Lifecycle Lifecycle `json:"lifecycle,omitempty" protobuf:"bytes,2,opt,name=lifecycle"`
	// Priority defines the priority of this config
	Priority int64 `json:"priority,omitempty" protobuf:"bytes,3,opt,name=priority"`
	// Config defines the configuration to be applied to a target device
	//+kubebuilder:pruning:PreserveUnknownFields
	Config []ConfigBlob `json:"config" protobuf:"bytes,4,rep,name=config"`
}

ConfigSetSpec defines the desired state of Config

func (*ConfigSetSpec) DeepCopy

func (in *ConfigSetSpec) DeepCopy() *ConfigSetSpec

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

func (*ConfigSetSpec) DeepCopyInto

func (in *ConfigSetSpec) DeepCopyInto(out *ConfigSetSpec)

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

type ConfigSetStatus

type ConfigSetStatus struct {
	// ConditionedStatus provides the status of the Readiness using conditions
	// if the condition is true the other attributes in the status are meaningful
	ConditionedStatus `json:",inline" protobuf:"bytes,1,opt,name=conditionedStatus"`
	// Targets defines the status of the configSet resource on the respective target
	Targets []TargetStatus `json:"targets,omitempty" protobuf:"bytes,2,rep,name=targets"`
}

ConfigSetStatus defines the observed state of Config

func (*ConfigSetStatus) DeepCopy

func (in *ConfigSetStatus) DeepCopy() *ConfigSetStatus

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

func (*ConfigSetStatus) DeepCopyInto

func (in *ConfigSetStatus) DeepCopyInto(out *ConfigSetStatus)

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

type ConfigSpec

type ConfigSpec struct {
	// Lifecycle determines the lifecycle policies the resource e.g. delete is orphan or delete
	// will follow
	Lifecycle Lifecycle `json:"lifecycle,omitempty" protobuf:"bytes,1,opt,name=lifecycle"`
	// Priority defines the priority of this config
	Priority int64 `json:"priority,omitempty" protobuf:"bytes,2,opt,name=priority"`
	// Config defines the configuration to be applied to a target device
	//+kubebuilder:pruning:PreserveUnknownFields
	Config []ConfigBlob `json:"config" protobuf:"bytes,3,rep,name=config"`
}

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 {
	// ConditionedStatus provides the status of the Readiness using conditions
	// if the condition is true the other attributes in the status are meaningful
	ConditionedStatus `json:",inline" protobuf:"bytes,1,opt,name=conditionedStatus"`
	// LastKnownGoodSchema identifies the last known good schema used to apply the config successfully
	LastKnownGoodSchema *ConfigStatusLastKnownGoodSchema `json:"lastKnownGoodSchema,omitempty" protobuf:"bytes,2,opt,name=lastKnownGoodSchema"`
	// AppliedConfig defines the config applied to the target
	AppliedConfig *ConfigSpec `json:"appliedConfig,omitempty" protobuf:"bytes,3,opt,name=appliedConfig"`
	// Deviations identify the configuration deviation based on the last applied config
	Deviations []Deviation `json:"deviations,omitempty" protobuf:"bytes,4,rep,name=deviations"`
}

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 ConfigStatusLastKnownGoodSchema

type ConfigStatusLastKnownGoodSchema struct {
	// Schema Type
	Type string `json:"type,omitempty" protobuf:"bytes,1,opt,name=type"`
	// Schema Vendor
	Vendor string `json:"vendor,omitempty" protobuf:"bytes,2,opt,name=vendor"`
	// Schema Version
	Version string `json:"version,omitempty" protobuf:"bytes,3,opt,name=version"`
}

func (*ConfigStatusLastKnownGoodSchema) DeepCopy

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

func (*ConfigStatusLastKnownGoodSchema) DeepCopyInto

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

type DeletionPolicy

type DeletionPolicy string

A DeletionPolicy determines what should happen to the underlying external resource when a managed resource is deleted.

const (
	// DeletionOrphan means the external resource will orphaned when its managed
	// resource is deleted.
	DeletionOrphan DeletionPolicy = "orphan"

	// DeletionDelete means both the  external resource will be deleted when its
	// managed resource is deleted.
	DeletionDelete DeletionPolicy = "delete"
)

type Deviation

type Deviation struct {
	// Path of the config this deviation belongs to
	Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"`
	// DesiredValue is the desired value of the config belonging to the path
	DesiredValue string `json:"desiredValue,omitempty" protobuf:"bytes,2,opt,name=desiredValue"`
	// ActualValue defines the actual value of the config belonging to the path
	// that is actually configured on the target
	ActualValue string `json:"actualValue,omitempty" protobuf:"bytes,3,opt,name=actualValue"`
	// Reason defines the reason of the deviation
	Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
}

func (*Deviation) DeepCopy

func (in *Deviation) DeepCopy() *Deviation

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

func (*Deviation) DeepCopyInto

func (in *Deviation) DeepCopyInto(out *Deviation)

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

type Lifecycle

type Lifecycle struct {
	// DeletionPolicy specifies what will happen to the underlying resource
	// when this resource is deleted - either "delete" or "orphan" the
	// resource.
	// +kubebuilder:validation:Enum=`delete`;`orphan`
	// +kubebuilder:default=delete
	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty" protobuf:"bytes,1,opt,name=deletionPolicy,casttype=DeletionPolicy"`
}

func (*Lifecycle) DeepCopy

func (in *Lifecycle) DeepCopy() *Lifecycle

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

func (*Lifecycle) DeepCopyInto

func (in *Lifecycle) DeepCopyInto(out *Lifecycle)

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

type RunningConfig

type RunningConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec   RunningConfigSpec   `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	Status RunningConfigStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
RunningConfig is the Schema for the RunningConfig API

+k8s:openapi-gen=true

func (*RunningConfig) DeepCopy

func (in *RunningConfig) DeepCopy() *RunningConfig

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

func (*RunningConfig) DeepCopyInto

func (in *RunningConfig) DeepCopyInto(out *RunningConfig)

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

func (*RunningConfig) DeepCopyObject

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

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

type RunningConfigList

type RunningConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Items           []RunningConfig `json:"items" protobuf:"bytes,2,rep,name=items"`
}

RunningConfigList contains a list of RunningConfigs +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*RunningConfigList) DeepCopy

func (in *RunningConfigList) DeepCopy() *RunningConfigList

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

func (*RunningConfigList) DeepCopyInto

func (in *RunningConfigList) DeepCopyInto(out *RunningConfigList)

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

func (*RunningConfigList) DeepCopyObject

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

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

type RunningConfigSpec

type RunningConfigSpec struct {
}

RunningConfigSpec defines the desired state of RunningConfig

func (*RunningConfigSpec) DeepCopy

func (in *RunningConfigSpec) DeepCopy() *RunningConfigSpec

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

func (*RunningConfigSpec) DeepCopyInto

func (in *RunningConfigSpec) DeepCopyInto(out *RunningConfigSpec)

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

type RunningConfigStatus

type RunningConfigStatus struct {
	//+kubebuilder:pruning:PreserveUnknownFields
	Value runtime.RawExtension `json:"value" protobuf:"bytes,2,opt,name=value"`
}

RunningConfigStatus defines the observed state of RunningConfig

func (*RunningConfigStatus) DeepCopy

func (in *RunningConfigStatus) DeepCopy() *RunningConfigStatus

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

func (*RunningConfigStatus) DeepCopyInto

func (in *RunningConfigStatus) DeepCopyInto(out *RunningConfigStatus)

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

type Target

type Target struct {
	// TargetSelector defines the selector used to select the targets to which the config applies
	TargetSelector *metav1.LabelSelector `json:"targetSelector,omitempty" protobuf:"bytes,1,opt,name=targetSelector"`
}

func (*Target) DeepCopy

func (in *Target) DeepCopy() *Target

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

func (*Target) DeepCopyInto

func (in *Target) DeepCopyInto(out *Target)

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

type TargetStatus

type TargetStatus struct {
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
	// right now we assume the namespace of the config and target are aligned
	//NameSpace string `json:"namespace" protobuf:"bytes,2,opt,name=name"`
	// Condition of the configCR status
	Condition `json:",inline" protobuf:"bytes,3,opt,name=condition"`
}

func (*TargetStatus) DeepCopy

func (in *TargetStatus) DeepCopy() *TargetStatus

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

func (*TargetStatus) DeepCopyInto

func (in *TargetStatus) DeepCopyInto(out *TargetStatus)

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

type UnManagedConfig

type UnManagedConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec   UnManagedConfigSpec   `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	Status UnManagedConfigStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
UnManagedConfig is the Schema for the UnManagedConfig API

+k8s:openapi-gen=true

type UnManagedConfigList

type UnManagedConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Items           []UnManagedConfig `json:"items" protobuf:"bytes,2,rep,name=items"`
}

UnManagedConfigList contains a list of UnManagedConfigs +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type UnManagedConfigSpec

type UnManagedConfigSpec struct {
}

UnManagedConfigSpec defines the desired state of UnManagedConfig

type UnManagedConfigStatus

type UnManagedConfigStatus struct {
	// Deviations identify the configuration deviation based on the last applied config
	Deviations []Deviation `json:"deviations,omitempty" protobuf:"bytes,4,rep,name=deviations"`
}

UnManagedConfigStatus defines the observed state of UnManagedConfig

Directories

Path Synopsis
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.

Jump to

Keyboard shortcuts

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