docs: Add upgrade note regarding v1 storage version migration

The following PR recently merged moving the storage version of all core objects to `v1`: kubevirt#9628 To accommodate the eventual removal of the original `v1alpha3` version this change adds a note to the updates document recommending the use of the kube-storage-version-migrator tool to automate the upgrade of all stored core objects to v1 ahead of the removal of v1alpha3. An older note suggesting new CRD versions are not allowed is also removed as this is no longer the case. Signed-off-by: Lee Yarwood <[email protected]>
rayees0012 · May 17, 2023 · b82938e · b82938e
1 parent e969a02
commit b82938e
Showing 1 changed file with 12 additions and 6 deletions.
diff --git a/docs/updates.md b/docs/updates.md
@@ -117,9 +117,15 @@ New APIs are not available until after the entire update process has completed.
 This ensures that a new API object can't be posted to the cluster until every
 component within the cluster is updated to learn of the object.
 
-### API version field changes
-
-Changes to the CRD's version field are not currently supported. We do not intend
-to change the version field of any of our APIs until we have the ability to
-support multiple versions in parallel. 
-
+## Notes
+
+### `v1.0.0` Migration To New Storage Versions
+
+With the `v1.0.0` release of KubeVirt the storage version of all core
+`kubevirt.io` APIs will be moving to version `v1`. To
+accommodate the eventual removal of the `v1alpha3` version with KubeVirt >=
+`v1.2.0` it is recommended that operators deploy the
+[`kube-storage-version-migrator`](https://github.com/kubernetes-sigs/kube-storage-version-migrator)
+tool within their environment. This will ensure any existing `v1alpha3`
+stored objects are migrated to `v1` well in advance of the removal of the
+underlying `v1alpha3` version.