Documentation ¶
Overview ¶
+groupName=migration.k8s.io
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type GroupResource
- type GroupVersionResource
- type MigrationCondition
- type MigrationConditionType
- type StorageState
- type StorageStateList
- type StorageStateSpec
- type StorageStateStatus
- type StorageVersionMigration
- type StorageVersionMigrationList
- type StorageVersionMigrationSpec
- type StorageVersionMigrationStatus
Constants ¶
const GroupName = "migration.k8s.io"
GroupName is the group name use in this package
const Unknown = "Unknown"
Unknown is a valid value in persistedStorageVersionHashes.
Variables ¶
var ( // TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api. // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type GroupResource ¶
type GroupResource struct { // The name of the group. Group string `json:"group,omitempty"` // The name of the resource. Resource string `json:"resource,omitempty"` }
The names of the group and the resource.
func (*GroupResource) DeepCopy ¶
func (in *GroupResource) DeepCopy() *GroupResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupResource.
func (*GroupResource) DeepCopyInto ¶
func (in *GroupResource) DeepCopyInto(out *GroupResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GroupVersionResource ¶
type GroupVersionResource struct { // The name of the group. Group string `json:"group,omitempty"` // The name of the version. Version string `json:"version,omitempty"` // The name of the resource. Resource string `json:"resource,omitempty"` }
The names of the group, the version, and the resource.
func (*GroupVersionResource) DeepCopy ¶
func (in *GroupVersionResource) DeepCopy() *GroupVersionResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVersionResource.
func (*GroupVersionResource) DeepCopyInto ¶
func (in *GroupVersionResource) DeepCopyInto(out *GroupVersionResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MigrationCondition ¶
type MigrationCondition struct { // Type of the condition. Type MigrationConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // The last time this condition was updated. // +optional LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"` // The reason for the condition's last transition. // +optional Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. // +optional Message string `json:"message,omitempty"` }
Describes the state of a migration at a certain point.
func (*MigrationCondition) DeepCopy ¶
func (in *MigrationCondition) DeepCopy() *MigrationCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MigrationCondition.
func (*MigrationCondition) DeepCopyInto ¶
func (in *MigrationCondition) DeepCopyInto(out *MigrationCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MigrationConditionType ¶
type MigrationConditionType string
const ( // Indicates that the migration is running. MigrationRunning MigrationConditionType = "Running" // Indicates that the migration has completed successfully. MigrationSucceeded MigrationConditionType = "Succeeded" // Indicates that the migration has failed. MigrationFailed MigrationConditionType = "Failed" )
type StorageState ¶
type StorageState struct { metav1.TypeMeta `json:",inline"` // The name must be "<.spec.resource.resouce>.<.spec.resource.group>". // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Specification of the storage state. // +optional Spec StorageStateSpec `json:"spec,omitempty"` // Status of the storage state. // +optional Status StorageStateStatus `json:"status,omitempty"` }
The state of the storage of a specific resource.
func (*StorageState) DeepCopy ¶
func (in *StorageState) DeepCopy() *StorageState
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageState.
func (*StorageState) DeepCopyInto ¶
func (in *StorageState) DeepCopyInto(out *StorageState)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StorageState) DeepCopyObject ¶
func (in *StorageState) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StorageStateList ¶
type StorageStateList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` // Items is the list of StorageState Items []StorageState `json:"items"` }
StorageStateList is a collection of storage state.
func (*StorageStateList) DeepCopy ¶
func (in *StorageStateList) DeepCopy() *StorageStateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageStateList.
func (*StorageStateList) DeepCopyInto ¶
func (in *StorageStateList) DeepCopyInto(out *StorageStateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StorageStateList) DeepCopyObject ¶
func (in *StorageStateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StorageStateSpec ¶
type StorageStateSpec struct { // The resource this storageState is about. Resource GroupResource `json:"resource,omitempty"` }
Specification of the storage state.
func (*StorageStateSpec) DeepCopy ¶
func (in *StorageStateSpec) DeepCopy() *StorageStateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageStateSpec.
func (*StorageStateSpec) DeepCopyInto ¶
func (in *StorageStateSpec) DeepCopyInto(out *StorageStateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StorageStateStatus ¶
type StorageStateStatus struct { // The hash values of storage versions that persisted instances of // spec.resource might still be encoded in. // "Unknown" is a valid value in the list, and is the default value. // It is not safe to upgrade or downgrade to an apiserver binary that does not // support all versions listed in this field, or if "Unknown" is listed. // Once the storage version migration for this resource has completed, the // value of this field is refined to only contain the // currentStorageVersionHash. // Once the apiserver has changed the storage version, the new storage version // is appended to the list. // +optional PersistedStorageVersionHashes []string `json:"persistedStorageVersionHashes,omitempty"` // The hash value of the current storage version, as shown in the discovery // document served by the API server. // Storage Version is the version to which objects are converted to // before persisted. // +optional CurrentStorageVersionHash string `json:"currentStorageVersionHash,omitempty"` // LastHeartbeatTime is the last time the storage migration triggering // controller checks the storage version hash of this resource in the // discovery document and updates this field. // +optional LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime,omitempty"` }
Status of the storage state.
func (*StorageStateStatus) DeepCopy ¶
func (in *StorageStateStatus) DeepCopy() *StorageStateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageStateStatus.
func (*StorageStateStatus) DeepCopyInto ¶
func (in *StorageStateStatus) DeepCopyInto(out *StorageStateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StorageVersionMigration ¶
type StorageVersionMigration struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Specification of the migration. // +optional Spec StorageVersionMigrationSpec `json:"spec,omitempty"` // Status of the migration. // +optional Status StorageVersionMigrationStatus `json:"status,omitempty"` }
StorageVersionMigration represents a migration of stored data to the latest storage version.
func (*StorageVersionMigration) DeepCopy ¶
func (in *StorageVersionMigration) DeepCopy() *StorageVersionMigration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageVersionMigration.
func (*StorageVersionMigration) DeepCopyInto ¶
func (in *StorageVersionMigration) DeepCopyInto(out *StorageVersionMigration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StorageVersionMigration) DeepCopyObject ¶
func (in *StorageVersionMigration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StorageVersionMigrationList ¶
type StorageVersionMigrationList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` // Items is the list of StorageVersionMigration Items []StorageVersionMigration `json:"items"` }
StorageVersionMigrationList is a collection of storage version migrations.
func (*StorageVersionMigrationList) DeepCopy ¶
func (in *StorageVersionMigrationList) DeepCopy() *StorageVersionMigrationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageVersionMigrationList.
func (*StorageVersionMigrationList) DeepCopyInto ¶
func (in *StorageVersionMigrationList) DeepCopyInto(out *StorageVersionMigrationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StorageVersionMigrationList) DeepCopyObject ¶
func (in *StorageVersionMigrationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StorageVersionMigrationSpec ¶
type StorageVersionMigrationSpec struct { // The resource that is being migrated. The migrator sends requests to // the endpoint serving the resource. // Immutable. Resource GroupVersionResource `json:"resource"` // The token used in the list options to get the next chunk of objects // to migrate. When the .status.conditions indicates the migration is // "Running", users can use this token to check the progress of the // migration. // +optional ContinueToken string `json:"continueToken,omitempty"` }
Spec of the storage version migration.
func (*StorageVersionMigrationSpec) DeepCopy ¶
func (in *StorageVersionMigrationSpec) DeepCopy() *StorageVersionMigrationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageVersionMigrationSpec.
func (*StorageVersionMigrationSpec) DeepCopyInto ¶
func (in *StorageVersionMigrationSpec) DeepCopyInto(out *StorageVersionMigrationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StorageVersionMigrationStatus ¶
type StorageVersionMigrationStatus struct { // The latest available observations of the migration's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions []MigrationCondition `json:"conditions,omitempty"` }
Status of the storage version migration.
func (*StorageVersionMigrationStatus) DeepCopy ¶
func (in *StorageVersionMigrationStatus) DeepCopy() *StorageVersionMigrationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageVersionMigrationStatus.
func (*StorageVersionMigrationStatus) DeepCopyInto ¶
func (in *StorageVersionMigrationStatus) DeepCopyInto(out *StorageVersionMigrationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.