apiserverinternal

package
v1.28.12 Latest Latest
Warning

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

Go to latest
Published: Jul 16, 2024 License: Apache-2.0 Imports: 3 Imported by: 10

Documentation

Overview

Package apiserverinternal contains the "internal" version of the API used by the apiservers themselves.

Index

Constants

View Source
const GroupName = "internal.apiserver.k8s.io"

GroupName is the group name use in this package

Variables

View Source
var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

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 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 ConditionStatus

type ConditionStatus string

ConditionStatus indicates status of condition from "True", "False", or "Unknown"

const (
	// ConditionTrue indicates condition as "True"
	ConditionTrue ConditionStatus = "True"
	// ConditionFalse indicates condition as "False"
	ConditionFalse ConditionStatus = "False"
	// ConditionUnknown indicates condition as "Unknown"
	ConditionUnknown ConditionStatus = "Unknown"
)

type ServerStorageVersion

type ServerStorageVersion struct {
	// The ID of the reporting API server.
	APIServerID string

	// The API server encodes the object to this version when persisting it in
	// the backend (e.g., etcd).
	EncodingVersion string

	// The API server can decode objects encoded in these versions.
	// The encodingVersion must be included in the decodableVersions.
	DecodableVersions []string

	// The API server can serve these versions.
	// DecodableVersions must include all ServedVersions.
	ServedVersions []string
}

ServerStorageVersion An API server instance reports the version it can decode and the version it encodes objects to when persisting objects in the backend.

func (*ServerStorageVersion) DeepCopy

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

func (*ServerStorageVersion) DeepCopyInto

func (in *ServerStorageVersion) DeepCopyInto(out *ServerStorageVersion)

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

type StorageVersion

type StorageVersion struct {
	metav1.TypeMeta
	// The name is <group>.<resource>.
	metav1.ObjectMeta

	// Spec is an empty spec. It is here to comply with Kubernetes API style.
	Spec StorageVersionSpec

	// API server instances report the version they can decode and the version they
	// encode objects to when persisting objects in the backend.
	Status StorageVersionStatus
}

StorageVersion of a specific resource.

func (*StorageVersion) DeepCopy

func (in *StorageVersion) DeepCopy() *StorageVersion

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

func (*StorageVersion) DeepCopyInto

func (in *StorageVersion) DeepCopyInto(out *StorageVersion)

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

func (*StorageVersion) DeepCopyObject

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

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

type StorageVersionCondition

type StorageVersionCondition struct {
	// Type of the condition.
	// +optional
	Type StorageVersionConditionType
	// Status of the condition, one of True, False, Unknown.
	// +required
	Status ConditionStatus
	// If set, this represents the .metadata.generation that the condition was set based upon.
	// +optional
	ObservedGeneration int64
	// Last time the condition transitioned from one status to another.
	// +required
	LastTransitionTime metav1.Time
	// The reason for the condition's last transition.
	// +required
	Reason string
	// A human readable message indicating details about the transition.
	// +required
	Message string
}

StorageVersionCondition Describes the state of the storageVersion at a certain point.

func (*StorageVersionCondition) DeepCopy

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

func (*StorageVersionCondition) DeepCopyInto

func (in *StorageVersionCondition) DeepCopyInto(out *StorageVersionCondition)

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

type StorageVersionConditionType

type StorageVersionConditionType string

StorageVersionConditionType Indicates the storage version condition type

const (
	//AllEncodingVersionsEqual Indicates that encoding storage versions reported by all servers are equal.
	AllEncodingVersionsEqual StorageVersionConditionType = "AllEncodingVersionsEqual"
)

type StorageVersionList

type StorageVersionList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta
	Items []StorageVersion
}

StorageVersionList A list of StorageVersions.

func (*StorageVersionList) DeepCopy

func (in *StorageVersionList) DeepCopy() *StorageVersionList

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

func (*StorageVersionList) DeepCopyInto

func (in *StorageVersionList) DeepCopyInto(out *StorageVersionList)

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

func (*StorageVersionList) DeepCopyObject

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

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

type StorageVersionSpec

type StorageVersionSpec struct{}

StorageVersionSpec is an empty spec.

func (*StorageVersionSpec) DeepCopy

func (in *StorageVersionSpec) DeepCopy() *StorageVersionSpec

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

func (*StorageVersionSpec) DeepCopyInto

func (in *StorageVersionSpec) DeepCopyInto(out *StorageVersionSpec)

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

type StorageVersionStatus

type StorageVersionStatus struct {
	// The reported versions per API server instance.
	// +optional
	StorageVersions []ServerStorageVersion
	// If all API server instances agree on the same encoding storage version,
	// then this field is set to that version. Otherwise this field is left empty.
	// API servers should finish updating its storageVersionStatus entry before
	// serving write operations, so that this field will be in sync with the reality.
	// +optional
	CommonEncodingVersion *string

	// The latest available observations of the storageVersion's state.
	// +optional
	Conditions []StorageVersionCondition
}

StorageVersionStatus API server instances report the versions they can decode and the version they encode objects to when persisting objects in the backend.

func (*StorageVersionStatus) DeepCopy

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

func (*StorageVersionStatus) DeepCopyInto

func (in *StorageVersionStatus) DeepCopyInto(out *StorageVersionStatus)

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

Directories

Path Synopsis
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
Package v1alpha1 contains the v1alpha1 version of the API used by the apiservers themselves.
Package v1alpha1 contains the v1alpha1 version of the API used by the apiservers themselves.

Jump to

Keyboard shortcuts

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