Documentation ¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +groupName=stork.libopenstorage.org
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type ClusterPair
- type ClusterPairList
- type ClusterPairSpec
- type ClusterPairStatus
- type ClusterPairStatusType
- type GroupVolumeSnapshot
- type GroupVolumeSnapshotList
- type GroupVolumeSnapshotSpec
- type GroupVolumeSnapshotStageType
- type GroupVolumeSnapshotStatus
- type GroupVolumeSnapshotStatusType
- type Migration
- type MigrationList
- type MigrationSpec
- type MigrationStageType
- type MigrationStatus
- type MigrationStatusType
- type PVCSelectorSpec
- type ResourceInfo
- type Rule
- type RuleAction
- type RuleActionType
- type RuleItem
- type RuleList
- type VolumeInfo
- type VolumeSnapshotStatus
Constants ¶
const ( // RuleActionCommand is a command action RuleActionCommand RuleActionType = "command" // ClusterPairResourceName is name for "clusterpair" resource ClusterPairResourceName = "clusterpair" // ClusterPairResourcePlural is plural for "clusterpair" resource ClusterPairResourcePlural = "clusterpairs" // MigrationResourceName is name for "migration" resource MigrationResourceName = "migration" // MigrationResourcePlural is plural for "migration" resource MigrationResourcePlural = "migrations" // GroupVolumeSnapshotResourceName is name for "groupvolumesnapshot" resource GroupVolumeSnapshotResourceName = "groupvolumesnapshot" // GroupVolumeSnapshotResourcePlural is plural for the "groupvolumesnapshot" resource GroupVolumeSnapshotResourcePlural = "groupvolumesnapshots" )
Variables ¶
var ( // SchemeBuilder is the scheme builder for the types SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme applies all the stored functions to the scheme AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: stork.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 ClusterPair ¶
type ClusterPair struct { meta.TypeMeta `json:",inline"` meta.ObjectMeta `json:"metadata,omitempty"` Spec ClusterPairSpec `json:"spec"` Status ClusterPairStatus `json:"status,omitempty"` }
ClusterPair represents pairing with other clusters
func (*ClusterPair) DeepCopy ¶
func (in *ClusterPair) DeepCopy() *ClusterPair
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterPair.
func (*ClusterPair) DeepCopyInto ¶
func (in *ClusterPair) DeepCopyInto(out *ClusterPair)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterPair) DeepCopyObject ¶
func (in *ClusterPair) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterPairList ¶
type ClusterPairList struct { meta.TypeMeta `json:",inline"` meta.ListMeta `json:"metadata,omitempty"` Items []ClusterPair `json:"items"` }
ClusterPairList is a list of cluster pairs
func (*ClusterPairList) DeepCopy ¶
func (in *ClusterPairList) DeepCopy() *ClusterPairList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterPairList.
func (*ClusterPairList) DeepCopyInto ¶
func (in *ClusterPairList) DeepCopyInto(out *ClusterPairList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterPairList) DeepCopyObject ¶
func (in *ClusterPairList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterPairSpec ¶
type ClusterPairSpec struct { Config api.Config `json:"config"` Options map[string]string `json:"options"` }
ClusterPairSpec is the spec to create the cluster pair
func (*ClusterPairSpec) DeepCopy ¶
func (in *ClusterPairSpec) DeepCopy() *ClusterPairSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterPairSpec.
func (*ClusterPairSpec) DeepCopyInto ¶
func (in *ClusterPairSpec) DeepCopyInto(out *ClusterPairSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterPairStatus ¶
type ClusterPairStatus struct { // Status of the pairing with the scheduler // +optional SchedulerStatus ClusterPairStatusType `json:"schedulerStatus"` // Status of pairing with the storage driver // +optional StorageStatus ClusterPairStatusType `json:"storageStatus"` // ID of the remote storage which is paired // +optional RemoteStorageID string `json:"remoteStorageId"` }
ClusterPairStatus is the status of the cluster pair
func (*ClusterPairStatus) DeepCopy ¶
func (in *ClusterPairStatus) DeepCopy() *ClusterPairStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterPairStatus.
func (*ClusterPairStatus) DeepCopyInto ¶
func (in *ClusterPairStatus) DeepCopyInto(out *ClusterPairStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterPairStatusType ¶
type ClusterPairStatusType string
ClusterPairStatusType is the status of the pair
const ( // ClusterPairStatusInitial is the initial state when pairing is created ClusterPairStatusInitial ClusterPairStatusType = "" // ClusterPairStatusPending for when pairing is still pending ClusterPairStatusPending ClusterPairStatusType = "Pending" // ClusterPairStatusReady for when pair is ready ClusterPairStatusReady ClusterPairStatusType = "Ready" // ClusterPairStatusError for when pairing is in error state ClusterPairStatusError ClusterPairStatusType = "Error" // ClusterPairStatusDegraded for when pairing is degraded ClusterPairStatusDegraded ClusterPairStatusType = "Degraded" // ClusterPairStatusDeleting for when pairing is being deleted ClusterPairStatusDeleting ClusterPairStatusType = "Deleting" )
type GroupVolumeSnapshot ¶
type GroupVolumeSnapshot struct { meta.TypeMeta `json:",inline"` meta.ObjectMeta `json:"metadata,omitempty"` Spec GroupVolumeSnapshotSpec `json:"spec"` Status GroupVolumeSnapshotStatus `json:"status"` }
GroupVolumeSnapshot represents a group snapshot
func (*GroupVolumeSnapshot) DeepCopy ¶
func (in *GroupVolumeSnapshot) DeepCopy() *GroupVolumeSnapshot
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVolumeSnapshot.
func (*GroupVolumeSnapshot) DeepCopyInto ¶
func (in *GroupVolumeSnapshot) DeepCopyInto(out *GroupVolumeSnapshot)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GroupVolumeSnapshot) DeepCopyObject ¶
func (in *GroupVolumeSnapshot) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GroupVolumeSnapshotList ¶
type GroupVolumeSnapshotList struct { meta.TypeMeta `json:",inline"` meta.ListMeta `json:"metadata,omitempty"` Items []GroupVolumeSnapshot `json:"items"` }
GroupVolumeSnapshotList is a list of group volume snapshots
func (*GroupVolumeSnapshotList) DeepCopy ¶
func (in *GroupVolumeSnapshotList) DeepCopy() *GroupVolumeSnapshotList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVolumeSnapshotList.
func (*GroupVolumeSnapshotList) DeepCopyInto ¶
func (in *GroupVolumeSnapshotList) DeepCopyInto(out *GroupVolumeSnapshotList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GroupVolumeSnapshotList) DeepCopyObject ¶
func (in *GroupVolumeSnapshotList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GroupVolumeSnapshotSpec ¶
type GroupVolumeSnapshotSpec struct { // PreExecRule is the name of rule applied before taking the snapshot. The rule needs to be // in the same namespace as the group volumesnapshot PreExecRule string `json:"preExecRule"` // PreExecRule is the name of rule applied after taking the snapshot. The rule needs to be // in the same namespace as the group volumesnapshot PostExecRule string `json:"postExecRule"` // PVCSelector selects the PVCs that are part of the group snapshot PVCSelector PVCSelectorSpec `json:"pvcSelector"` // RestoreNamespaces is a list of namespaces to which the snapshots can be restored to RestoreNamespaces []string `json:"restoreNamespaces"` // MaxRetries is the number of times to retry the groupvolumesnapshot on failure. default: 0 MaxRetries int `json:"maxRetries"` // Options are pass-through parameters that are passed to the driver handling the group snapshot Options map[string]string `json:"options"` }
GroupVolumeSnapshotSpec represents the spec for a group snapshot
func (*GroupVolumeSnapshotSpec) DeepCopy ¶
func (in *GroupVolumeSnapshotSpec) DeepCopy() *GroupVolumeSnapshotSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVolumeSnapshotSpec.
func (*GroupVolumeSnapshotSpec) DeepCopyInto ¶
func (in *GroupVolumeSnapshotSpec) DeepCopyInto(out *GroupVolumeSnapshotSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GroupVolumeSnapshotStageType ¶
type GroupVolumeSnapshotStageType string
GroupVolumeSnapshotStageType is the stage of the group snapshot
const ( // GroupSnapshotStageInitial is when the group snapshot is just created GroupSnapshotStageInitial GroupVolumeSnapshotStageType = "" // GroupSnapshotStagePreChecks is when the group snapshot is going through prechecks GroupSnapshotStagePreChecks GroupVolumeSnapshotStageType = "PreChecks" // GroupSnapshotStagePreSnapshot is when the pre-snapshot rule is executing for the group snapshot GroupSnapshotStagePreSnapshot GroupVolumeSnapshotStageType = "PreSnapshot" // GroupSnapshotStageSnapshot is when the snapshots are being taken for the group snapshot GroupSnapshotStageSnapshot GroupVolumeSnapshotStageType = "Snapshot" // GroupSnapshotStagePostSnapshot is when the post-snapshot rule is executing for the group snapshot GroupSnapshotStagePostSnapshot GroupVolumeSnapshotStageType = "PostSnapshot" // GroupSnapshotStageFinal is when all stages are done for the group snapshot GroupSnapshotStageFinal GroupVolumeSnapshotStageType = "Final" )
type GroupVolumeSnapshotStatus ¶
type GroupVolumeSnapshotStatus struct { Stage GroupVolumeSnapshotStageType `json:"stage"` Status GroupVolumeSnapshotStatusType `json:"status"` NumRetries int `json:"numRetries"` VolumeSnapshots []*VolumeSnapshotStatus `json:"volumeSnapshots"` }
GroupVolumeSnapshotStatus is status for the group snapshot
func (*GroupVolumeSnapshotStatus) DeepCopy ¶
func (in *GroupVolumeSnapshotStatus) DeepCopy() *GroupVolumeSnapshotStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVolumeSnapshotStatus.
func (*GroupVolumeSnapshotStatus) DeepCopyInto ¶
func (in *GroupVolumeSnapshotStatus) DeepCopyInto(out *GroupVolumeSnapshotStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GroupVolumeSnapshotStatusType ¶
type GroupVolumeSnapshotStatusType string
GroupVolumeSnapshotStatusType is types of statuses of a group snapshot operation
const ( // GroupSnapshotInitial is when the group snapshot is created and no action has yet been performed GroupSnapshotInitial GroupVolumeSnapshotStatusType = "" // GroupSnapshotPending is when the group snapshot is in pending state waiting for another event GroupSnapshotPending GroupVolumeSnapshotStatusType = "Pending" // GroupSnapshotInProgress is when the group snapshot is in progress GroupSnapshotInProgress GroupVolumeSnapshotStatusType = "InProgress" // GroupSnapshotFailed is when the group snapshot has failed GroupSnapshotFailed GroupVolumeSnapshotStatusType = "Failed" // GroupSnapshotSuccessful is when the group snapshot has succeeded GroupSnapshotSuccessful GroupVolumeSnapshotStatusType = "Successful" )
type Migration ¶
type Migration struct { meta.TypeMeta `json:",inline"` meta.ObjectMeta `json:"metadata,omitempty"` Spec MigrationSpec `json:"spec"` Status MigrationStatus `json:"status"` }
Migration represents migration status
func (*Migration) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Migration.
func (*Migration) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Migration) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MigrationList ¶
type MigrationList struct { meta.TypeMeta `json:",inline"` meta.ListMeta `json:"metadata,omitempty"` Items []Migration `json:"items"` }
MigrationList is a list of Migrations
func (*MigrationList) DeepCopy ¶
func (in *MigrationList) DeepCopy() *MigrationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MigrationList.
func (*MigrationList) DeepCopyInto ¶
func (in *MigrationList) DeepCopyInto(out *MigrationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MigrationList) DeepCopyObject ¶
func (in *MigrationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MigrationSpec ¶
type MigrationSpec struct { ClusterPair string `json:"clusterPair"` Namespaces []string `json:"namespaces"` IncludeResources bool `json:"includeResources"` StartApplications bool `json:"startApplications"` Selectors map[string]string `json:"selectors"` }
MigrationSpec is the spec used to migrate apps between clusterpairs
func (*MigrationSpec) DeepCopy ¶
func (in *MigrationSpec) DeepCopy() *MigrationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MigrationSpec.
func (*MigrationSpec) DeepCopyInto ¶
func (in *MigrationSpec) DeepCopyInto(out *MigrationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MigrationStageType ¶
type MigrationStageType string
MigrationStageType is the stage of the migration
const ( // MigrationStageInitial for when migration is created MigrationStageInitial MigrationStageType = "" // MigrationStageVolumes for when volumes are being migrated MigrationStageVolumes MigrationStageType = "Volumes" // MigrationStageApplications for when applications are being migrated MigrationStageApplications MigrationStageType = "Applications" // MigrationStageFinal is the final stage for migration MigrationStageFinal MigrationStageType = "Final" )
type MigrationStatus ¶
type MigrationStatus struct { Stage MigrationStageType `json:"stage"` Status MigrationStatusType `json:"status"` Resources []*ResourceInfo `json:"resources"` Volumes []*VolumeInfo `json:"volumes"` }
MigrationStatus is the status of a migration operation
func (*MigrationStatus) DeepCopy ¶
func (in *MigrationStatus) DeepCopy() *MigrationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MigrationStatus.
func (*MigrationStatus) DeepCopyInto ¶
func (in *MigrationStatus) DeepCopyInto(out *MigrationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MigrationStatusType ¶
type MigrationStatusType string
MigrationStatusType is the status of the migration
const ( // MigrationStatusInitial is the initial state when migration is created MigrationStatusInitial MigrationStatusType = "" // MigrationStatusPending for when migration is still pending MigrationStatusPending MigrationStatusType = "Pending" // MigrationStatusCaptured for when migration specs have been captured MigrationStatusCaptured MigrationStatusType = "Captured" // MigrationStatusInProgress for when migration is in progress MigrationStatusInProgress MigrationStatusType = "InProgress" // MigrationStatusFailed for when migration has failed MigrationStatusFailed MigrationStatusType = "Failed" // MigrationStatusPartialSuccess for when migration was partially successful MigrationStatusPartialSuccess MigrationStatusType = "PartialSuccess" // MigrationStatusSuccessful for when migration has completed successfully MigrationStatusSuccessful MigrationStatusType = "Successful" )
type PVCSelectorSpec ¶
type PVCSelectorSpec struct {
meta.LabelSelector
}
PVCSelectorSpec is the spec to select the PVCs for group snapshot
func (*PVCSelectorSpec) DeepCopy ¶
func (in *PVCSelectorSpec) DeepCopy() *PVCSelectorSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PVCSelectorSpec.
func (*PVCSelectorSpec) DeepCopyInto ¶
func (in *PVCSelectorSpec) DeepCopyInto(out *PVCSelectorSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceInfo ¶
type ResourceInfo struct { Name string `json:"name"` Namespace string `json:"namespace"` meta.GroupVersionKind `json:",inline"` Status MigrationStatusType `json:"status"` Reason string `json:"reason"` }
ResourceInfo is the info for the migration of a resource
func (*ResourceInfo) DeepCopy ¶
func (in *ResourceInfo) DeepCopy() *ResourceInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceInfo.
func (*ResourceInfo) DeepCopyInto ¶
func (in *ResourceInfo) DeepCopyInto(out *ResourceInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Rule ¶
type Rule struct { meta.TypeMeta `json:",inline"` meta.ObjectMeta `json:"metadata,omitempty"` Rules []RuleItem `json:"rules"` }
Rule denotes an object to declare a rule that performs actions on pods
func (*Rule) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rule.
func (*Rule) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Rule) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleAction ¶
type RuleAction struct { // Type is a type of the stork rule action Type RuleActionType `json:"type"` // Background indicates that the action needs to be performed in the background // +optional Background bool `json:"background,omitempty"` // RunInSinglePod indicates that the action needs to be performed in a single pod // from the list of pods that match the selector // +optional RunInSinglePod bool `json:"runInSinglePod,omitempty"` // Value is the actual action value for e.g the command to run Value string `json:"value"` }
RuleAction represents an action in a stork rule item
func (*RuleAction) DeepCopy ¶
func (in *RuleAction) DeepCopy() *RuleAction
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleAction.
func (*RuleAction) DeepCopyInto ¶
func (in *RuleAction) DeepCopyInto(out *RuleAction)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RuleActionType ¶
type RuleActionType string
RuleActionType is a type for actions that are supported in a stork rule
type RuleItem ¶
type RuleItem struct { // PodSelector is a map of key value pairs that are used to select the pods using their labels PodSelector map[string]string `json:"podSelector"` // Actions are actions to be performed on the pods selected using the selector Actions []RuleAction `json:"actions"` }
RuleItem represents one items in a stork rule spec
func (*RuleItem) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleItem.
func (*RuleItem) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RuleList ¶
type RuleList struct { meta.TypeMeta `json:",inline"` meta.ListMeta `json:"metadata,omitempty"` Items []Rule `json:"items"` }
RuleList is a list of stork rules
func (*RuleList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleList.
func (*RuleList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RuleList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VolumeInfo ¶
type VolumeInfo struct { PersistentVolumeClaim string `json:"persistentVolumeClaim"` Namespace string `json:"namespace"` Volume string `json:"volume"` Status MigrationStatusType `json:"status"` Reason string `json:"reason"` }
VolumeInfo is the info for the migration of a volume
func (*VolumeInfo) DeepCopy ¶
func (in *VolumeInfo) DeepCopy() *VolumeInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeInfo.
func (*VolumeInfo) DeepCopyInto ¶
func (in *VolumeInfo) DeepCopyInto(out *VolumeInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VolumeSnapshotStatus ¶
type VolumeSnapshotStatus struct { VolumeSnapshotName string TaskID string ParentVolumeID string DataSource *crdv1.VolumeSnapshotDataSource Conditions []crdv1.VolumeSnapshotCondition }
VolumeSnapshotStatus captures the status of a volume snapshot operation
func (*VolumeSnapshotStatus) DeepCopy ¶
func (in *VolumeSnapshotStatus) DeepCopy() *VolumeSnapshotStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotStatus.
func (*VolumeSnapshotStatus) DeepCopyInto ¶
func (in *VolumeSnapshotStatus) DeepCopyInto(out *VolumeSnapshotStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.