You are viewing documentation for Kubernetes version: v1.31
Kubernetes v1.31 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date information, see the latest version.
StorageVersionMigration v1alpha1
apiVersion: storagemigration.k8s.io/v1alpha1
import "k8s.io/api/storagemigration/v1alpha1"
StorageVersionMigration
StorageVersionMigration represents a migration of stored data to the latest storage version.
-
apiVersion: storagemigration.k8s.io/v1alpha1
-
kind: StorageVersionMigration
-
metadata (ObjectMeta)
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-
spec (StorageVersionMigrationSpec)
Specification of the migration.
-
status (StorageVersionMigrationStatus)
Status of the migration.
StorageVersionMigrationSpec
Spec of the storage version migration.
-
continueToken (string)
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.
-
resource (GroupVersionResource), required
The resource that is being migrated. The migrator sends requests to the endpoint serving the resource. Immutable.
The names of the group, the version, and the resource.
-
resource.group (string)
The name of the group.
-
resource.resource (string)
The name of the resource.
-
resource.version (string)
The name of the version.
-
StorageVersionMigrationStatus
Status of the storage version migration.
-
conditions ([]MigrationCondition)
Patch strategy: merge on key
type
Map: unique values on key type will be kept during a merge
The latest available observations of the migration's current state.
Describes the state of a migration at a certain point.
-
conditions.status (string), required
Status of the condition, one of True, False, Unknown.
-
conditions.type (string), required
Type of the condition.
-
conditions.lastUpdateTime (Time)
The last time this condition was updated.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
-
conditions.message (string)
A human readable message indicating details about the transition.
-
conditions.reason (string)
The reason for the condition's last transition.
-
-
resourceVersion (string)
ResourceVersion to compare with the GC cache for performing the migration. This is the current resource version of given group, version and resource when kube-controller-manager first observes this StorageVersionMigration resource.
StorageVersionMigrationList
StorageVersionMigrationList is a collection of storage version migrations.
-
apiVersion: storagemigration.k8s.io/v1alpha1
-
kind: StorageVersionMigrationList
-
metadata (ListMeta)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-
items ([]StorageVersionMigration), required
Patch strategy: merge on key
type
Map: unique values on key type will be kept during a merge
Items is the list of StorageVersionMigration
Operations
get
read the specified StorageVersionMigration
HTTP Request
GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
401: Unauthorized
get
read status of the specified StorageVersionMigration
HTTP Request
GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
401: Unauthorized
list
list or watch objects of kind StorageVersionMigration
HTTP Request
GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations
Parameters
-
allowWatchBookmarks (in query): boolean
-
continue (in query): string
-
fieldSelector (in query): string
-
labelSelector (in query): string
-
limit (in query): integer
-
pretty (in query): string
-
resourceVersion (in query): string
-
resourceVersionMatch (in query): string
-
sendInitialEvents (in query): boolean
-
timeoutSeconds (in query): integer
-
watch (in query): boolean
Response
200 (StorageVersionMigrationList): OK
401: Unauthorized
create
create a StorageVersionMigration
HTTP Request
POST /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations
Parameters
-
body: StorageVersionMigration, required
-
dryRun (in query): string
-
fieldManager (in query): string
-
fieldValidation (in query): string
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
201 (StorageVersionMigration): Created
202 (StorageVersionMigration): Accepted
401: Unauthorized
update
replace the specified StorageVersionMigration
HTTP Request
PUT /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
body: StorageVersionMigration, required
-
dryRun (in query): string
-
fieldManager (in query): string
-
fieldValidation (in query): string
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
201 (StorageVersionMigration): Created
401: Unauthorized
update
replace status of the specified StorageVersionMigration
HTTP Request
PUT /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
body: StorageVersionMigration, required
-
dryRun (in query): string
-
fieldManager (in query): string
-
fieldValidation (in query): string
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
201 (StorageVersionMigration): Created
401: Unauthorized
patch
partially update the specified StorageVersionMigration
HTTP Request
PATCH /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
body: Patch, required
-
dryRun (in query): string
-
fieldManager (in query): string
-
fieldValidation (in query): string
-
force (in query): boolean
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
201 (StorageVersionMigration): Created
401: Unauthorized
patch
partially update status of the specified StorageVersionMigration
HTTP Request
PATCH /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
body: Patch, required
-
dryRun (in query): string
-
fieldManager (in query): string
-
fieldValidation (in query): string
-
force (in query): boolean
-
pretty (in query): string
Response
200 (StorageVersionMigration): OK
201 (StorageVersionMigration): Created
401: Unauthorized
delete
delete a StorageVersionMigration
HTTP Request
DELETE /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
Parameters
-
name (in path): string, required
name of the StorageVersionMigration
-
body: DeleteOptions
-
dryRun (in query): string
-
gracePeriodSeconds (in query): integer
-
pretty (in query): string
-
propagationPolicy (in query): string
Response
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection
delete collection of StorageVersionMigration
HTTP Request
DELETE /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations
Parameters
-
body: DeleteOptions
-
continue (in query): string
-
dryRun (in query): string
-
fieldSelector (in query): string
-
gracePeriodSeconds (in query): integer
-
labelSelector (in query): string
-
limit (in query): integer
-
pretty (in query): string
-
propagationPolicy (in query): string
-
resourceVersion (in query): string
-
resourceVersionMatch (in query): string
-
sendInitialEvents (in query): boolean
-
timeoutSeconds (in query): integer
Response
200 (Status): OK
401: Unauthorized
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.