[CAFV-175] Create developer guide for CAPVCD Upgrade

[ymo24]

Description

Please provide a brief description of the changes proposed in this Pull Request

• Create developer guide for CAPVCD Upgrade

Checklist

• tested locally
• updated any relevant dependencies
• updated any relevant documentation or examples

API Changes

Are there API changes?

• Yes
• No

If yes, please fill in the below

1. Updated conversions?
   • Yes
   • No
   • N/A
2. Updated CRDs?
   • Yes
   • No
   • N/A
3. Updated infrastructure-components.yaml?
   • Yes
   • No
   • N/A
4. Updated ./examples/capi-quickstart.yaml?
   • Yes
   • No
   • N/A
5. Updated necessary files under ./infrastructure-vcd/v1.0.0/?
   • Yes
   • No
   • N/A

Issue

If applicable, please reference the relevant issue

Fixes #

---

This change is 

[sahithi]

Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @Anirudh9794 and @ymo24)

---

docs/DEVELOPER_GUIDE.md line 1 at r1 (raw file):

## RDE

Can you mention that developers must evaluate RDE upgrades and CAPVCD API upgrades right every a minor version of capvcd is shipped?

---

docs/DEVELOPER_GUIDE.md line 19 at r1 (raw file):

## CAPVCD Upgrade
1. RDE schema registration: Ensure the correct runtime RDE version is chosen and register the appropriate schema if necessary.
2. Use [CAPVCD UPGRADE GUIDE](./UPGRADES.md) to upgrade CAPVCD to the desired version.

This section must be about capvcd API upgrades NOT capvcd upgrades itself.
The steps mentioned in this document must be evaluated and run - https://confluence.eng.vmware.com/display/VCD/CAPVCD+upgrades

[sahithi]

Yan,, I Just noticed that the developer guide is under the docs folder. This should not be part of official capvcd docs.
There is a placeholder file that I created sometime ago - https://github.com/vmware/cluster-api-provider-cloud-director/blob/main/developer_guide.md

Please move the content there and follow the sections mentioned there.

Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @Anirudh9794 and @ymo24)

[sahithi]

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Anirudh9794 and @ymo24)

---

developer_guide.md line 7 at r2 (raw file):

### Steps to Create New APIs with Version `v1beta1`

1. Create new API files with the desired version (e.g., `v1beta1`) in the `api` directory of your project. 

We need not mention the details here, Yan. Just mention that API upgrades need to be evaluated and performed after every release and before beginning ne w release.
You can add a confluence link, that is good enough (it will be inaccessible from out of vmware though)

[ymo24]

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Anirudh9794 and @sahithi)

---

developer_guide.md line 7 at r2 (raw file):

Previously, sahithi (Sahithi Ayloo) wrote…

We need not mention the details here, Yan. Just mention that API upgrades need to be evaluated and performed after every release and before beginning ne w release.
You can add a confluence link, that is good enough (it will be inaccessible from out of vmware though)

Thanks Sahithi, already pushed the fix

---

docs/DEVELOPER_GUIDE.md line 1 at r1 (raw file):

Previously, sahithi (Sahithi Ayloo) wrote…

Can you mention that developers must evaluate RDE upgrades and CAPVCD API upgrades right every a minor version of capvcd is shipped?

Done.

---

docs/DEVELOPER_GUIDE.md line 19 at r1 (raw file):

Previously, sahithi (Sahithi Ayloo) wrote…

This section must be about capvcd API upgrades NOT capvcd upgrades itself.
The steps mentioned in this document must be evaluated and run - https://confluence.eng.vmware.com/display/VCD/CAPVCD+upgrades

Thanks Sahithi, already pushed the fix

[sahithi]

Reviewed 1 of 2 files at r2, 1 of 1 files at r3, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @Anirudh9794)

[Anirudh9794]

with a few comments.

Reviewed 1 of 2 files at r2, 1 of 1 files at r3.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @sahithi and @ymo24)

---

developer_guide.md line 14 at r3 (raw file):

### opening Upgrade path (for minor/patch upgrade )
1. Create new schema file under /schemas/schema_x_y_z.json
2. Locate the function ConvertToLatestRDEVersionFormat in the vcdcluster_controller.go.

The definition of ConvertToLatestRDEVersionFormat() is in /pkg/capisdk/defined_entity.go.
I think having this path makes more sense as the following steps say that we need to add another convertFromXFormat()

Code quote:

ocate the function ConvertToLatestRDEVersionFormat in the vcdcluster_controller.go.

---

developer_guide.md line 22 at r3 (raw file):

- Call the API update call to update CAPVCD entity and persist data into VCD.

## API Upgrade

I think this should be called CAPVCD API upgrade

---

developer_guide.md line 27 at r3 (raw file):

* Create New APIs with the new Version (e.g., `v1beta1`).
* Enable clusterctl upgrade command and do the upgrade to the new version.
* Enable CAPVCD handle other supported versions.

Can we change this to "Enable CAPVCD handle other supported API versions " ?

Code quote:

Enable CAPVCD handle other supported versions.

[ymo24]

Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @Anirudh9794 and @sahithi)

---

developer_guide.md line 14 at r3 (raw file):

Previously, Anirudh9794 wrote…

The definition of ConvertToLatestRDEVersionFormat() is in /pkg/capisdk/defined_entity.go.
I think having this path makes more sense as the following steps say that we need to add another convertFromXFormat()

Thanks, Aniruddha! Already pushed the fix

---

developer_guide.md line 22 at r3 (raw file):

Previously, Anirudh9794 wrote…

I think this should be called CAPVCD API upgrade

Thanks, Aniruddha! Already pushed the fix

---

developer_guide.md line 27 at r3 (raw file):

Previously, Anirudh9794 wrote…

Can we change this to "Enable CAPVCD handle other supported API versions " ?

Done.