Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #44 from wking/readme-purpose-docs
README: Stub in brief purpose docs
- Loading branch information
Showing
1 changed file
with
9 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,9 @@ | ||
# cluster-kube-storage-version-migrator-operator | ||
# kube-storage-version-migrator operator | ||
|
||
This operator manages the [kube-storage-version-migrator][migrator], which: | ||
|
||
* Detects changes of the default storage version of a resource type by polling the API server's discovery document. | ||
* Creates migration requests for resource types whose storage version changes. | ||
* Processes migration requests by geting all objects of the migrated type and writing them back the API server without modification. The purpose is to trigger the API server to encode the object in the latest storage version before storing it. | ||
|
||
[migrator]: https://github.com/openshift/kubernetes-kube-storage-version-migrator |