Skip to content

Commit

Permalink
README: Stub in brief purpose docs
Browse files Browse the repository at this point in the history
Would be nice to have the README include (links to) collaboration
notes and security issue reporting and all that.  But I'm not clear on
what the operator maintainers want to use for that stuff, so this
commit just brings over and tweaks a bit of text from [1] so folks
wondering "what is this about?" don't have to think too hard.

[1]: https://github.com/openshift/kubernetes-kube-storage-version-migrator/blob/481bd04dbc78c29dad05deba0309e049fa26e4d9/USER_GUIDE.md#storage-version-migrator-in-a-nutshell
  • Loading branch information
wking committed Mar 4, 2021
1 parent f965c63 commit 06cc7bc
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
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

0 comments on commit 06cc7bc

Please sign in to comment.