Chapter 8. StorageState [migration.k8s.io/v1alpha1]


Description
The state of the storage of a specific resource.
Type
object

8.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Specification of the storage state.

status

object

Status of the storage state.

8.1.1. .spec

Description
Specification of the storage state.
Type
object
PropertyTypeDescription

resource

object

The resource this storageState is about.

8.1.2. .spec.resource

Description
The resource this storageState is about.
Type
object
PropertyTypeDescription

group

string

The name of the group.

resource

string

The name of the resource.

8.1.3. .status

Description
Status of the storage state.
Type
object
PropertyTypeDescription

currentStorageVersionHash

string

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.

lastHeartbeatTime

string

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.

persistedStorageVersionHashes

array (string)

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.

8.2. API endpoints

The following API endpoints are available:

  • /apis/migration.k8s.io/v1alpha1/storagestates

    • DELETE: delete collection of StorageState
    • GET: list objects of kind StorageState
    • POST: create a StorageState
  • /apis/migration.k8s.io/v1alpha1/storagestates/{name}

    • DELETE: delete a StorageState
    • GET: read the specified StorageState
    • PATCH: partially update the specified StorageState
    • PUT: replace the specified StorageState
  • /apis/migration.k8s.io/v1alpha1/storagestates/{name}/status

    • GET: read status of the specified StorageState
    • PATCH: partially update status of the specified StorageState
    • PUT: replace status of the specified StorageState

8.2.1. /apis/migration.k8s.io/v1alpha1/storagestates

HTTP method
DELETE
Description
delete collection of StorageState
Table 8.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind StorageState
Table 8.2. HTTP responses
HTTP codeReponse body

200 - OK

StorageStateList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a StorageState
Table 8.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.4. Body parameters
ParameterTypeDescription

body

StorageState schema

 
Table 8.5. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

201 - Created

StorageState schema

202 - Accepted

StorageState schema

401 - Unauthorized

Empty

8.2.2. /apis/migration.k8s.io/v1alpha1/storagestates/{name}

Table 8.6. Global path parameters
ParameterTypeDescription

name

string

name of the StorageState

HTTP method
DELETE
Description
delete a StorageState
Table 8.7. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified StorageState
Table 8.9. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified StorageState
Table 8.10. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.11. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified StorageState
Table 8.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.13. Body parameters
ParameterTypeDescription

body

StorageState schema

 
Table 8.14. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

201 - Created

StorageState schema

401 - Unauthorized

Empty

8.2.3. /apis/migration.k8s.io/v1alpha1/storagestates/{name}/status

Table 8.15. Global path parameters
ParameterTypeDescription

name

string

name of the StorageState

HTTP method
GET
Description
read status of the specified StorageState
Table 8.16. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified StorageState
Table 8.17. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.18. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified StorageState
Table 8.19. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.20. Body parameters
ParameterTypeDescription

body

StorageState schema

 
Table 8.21. HTTP responses
HTTP codeReponse body

200 - OK

StorageState schema

201 - Created

StorageState schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.