Document CRD upgrade helper services. (#261)

Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>

Author: roehrich-hpe

docs/repo-guides/readme.md

@@ -3,6 +3,7 @@
 ## Management
 
 * [Releasing NNF Software](release-nnf-sw/release-all.md)
+* [CRD Upgrade Helpers](release-nnf-sw/crd-upgrade-helpers.md)
 
 ## Developer
 

docs/repo-guides/release-nnf-sw/crd-upgrade-helpers.md

@@ -0,0 +1,27 @@
+# CRD Upgrade Helpers
+
+Two services must be installed on the cluster to assist in upgrading CustomResourceDefinitions (CRD), and the resources associated with them, as the CRDs acquire new API versions or remove old API versions. The first service is [kube-storage-version-migrator](https://github.com/NearNodeFlash/kube-storage-version-migrator/tree/nnf-main) (see the `nnf-main` branch), which updates existing custom resources to ensure they are stored in the **etcd** database at the API version that is the CRD's latest `storage` version. It does this whenever a CRD is updated with a new API version. The second service is [nnf-storedversions-maint](https://github.com/NearNodeFlash/nnf-storedversions-maint), which updates the `status.storedVersions` list in the CRD to remove the unused API versions. This maintenance is necessary to allow older API versions to be removed during future upgrades of those CRDs.
+
+Together, these services implement [Upgrade existing objects to a new stored version](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#upgrade-existing-objects-to-a-new-stored-version) in the Kubernetes documentation.
+
+## ArgoCD/GitOps
+
+The ArgoCD `Application` bootstraps for the two services can be found in the [argocd-boilerplate](https://github.com/NearNodeFlash/argocd-boilerplate) repository under `environments/example-env/0-bootstrap1/`. NNF release manifests include the manifests for these services.
+
+## References
+
+### Kubernetes
+
+[Versions in CustomResourceDefinitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/)
+
+[Upgrade existing objects to a new stored version](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#upgrade-existing-objects-to-a-new-stored-version)
+
+[kube-storage-version-migrator](https://github.com/kubernetes-sigs/kube-storage-version-migrator) migrates stored data in etcd to the latest storage version.
+
+### NNF
+
+[kube-storage-version-migrator](https://github.com/NearNodeFlash/kube-storage-version-migrator/tree/nnf-main) (see the `nnf-main` branch) migrates stored data in etcd to the latest storage version.
+
+[nnf-storedversions-maint](https://github.com/NearNodeFlash/nnf-storedversions-maint) removes old API versions from a CRD's `status.storedVersions` field.
+
+[CRD Version Bumper](../crd-bumper/readme.md) tools to add a new API version to a CRD, or to remove an old API version.

docs/repo-guides/release-nnf-sw/release-all.md

@@ -92,14 +92,14 @@ other components.
        ./release-all.sh -P create-pr -R <repo>
        ```
 
-    3. Merge PR for the pushed release branch:
+    4. Merge PR for the pushed release branch:
     **Note: Do NOT manually merge the PR, let `release-all.sh` merge it.**
 
        ```bash
        ./release-all.sh -P merge-pr -R <repo>
        ```
 
-    4. Tag the release:
+    5. Tag the release:
 
        ```bash
        ./release-all.sh -P tag-release -R <repo>

mkdocs.yml

@@ -3,7 +3,7 @@ site_description: 'Near Node Flash'
 docs_dir: docs/
 repo_name: 'NearNodeFlash/NearNodeFlash.github.io'
 repo_url: https://github.com/NearNodeFlash/NearNodeFlash.github.io
-copyright: '© Copyright 2023 Hewlett Packard Enterprise Development LP'
+copyright: '© Copyright 2025 Hewlett Packard Enterprise Development LP'
 nav:
   - Home: index.md
   - 'User Guides':
@@ -31,6 +31,7 @@ nav:
       - 'Releasing NNF Software': 'repo-guides/release-nnf-sw/release-all.md'
       - 'CRD Version Bumper': 'repo-guides/crd-bumper/readme.md'
       - 'Editing APIs': 'repo-guides/crd-bumper/editing-apis.md'
+      - 'CRD Upgrade Helpers': 'repo-guides/release-nnf-sw/crd-upgrade-helpers.md'
 theme:
   name: 'material'
   custom_dir: overrides