📖 Doc for updating v1a1 provider to v1a2

[akutz]

What this PR does / why we need it:
This patch includes developer documentation to assist with updating a v1alpha1 provider to v1alpha2.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

* Developer documentation for updating a v1alpha1 provider to v1alpha2

[akutz]

/kind documentation

[detiber]

Thanks for starting on this, picked some nits related to terminology and some other minor comments.

[akutz]

Thanks for starting on this, picked some nits related to terminology and some other minor comments.

Hi @detiber,

You're welcome. After @ncdc so generously walked me through v1alpha2, I figured I should pay it forward and write things down before I forget.

[ykakarap]

@akutz I would like to help with this migration for CAPV.

The first item is creating branches in the repo as detailed. I am afraid I will not have the needed permissions to do so.
Therefore I would like to start working on the second item: creating the provider's v1alpha2 resources.

Please let me know if I can take it up.

[ncdc]

@akutz are you still interested & would you have time to port this over to the book content?

[akutz]

Hi @ncdc,

Yes sir, I just haven't had time. I've got to prep for something this morning, but I should be able to address this before the end of the week.

[ncdc]

Fantastic, thank you!

[vincepri]

@akutz Will you have time to address the comments and port the content to the book?

[vincepri]

@akutz Do you have time to address the comments?

[akutz]

Hi @ncdc & @detiber,

I've addressed the feedback, but now I wonder the following:

1. Should this be added to the CAPI book? If so, where? @vincepri indicated there is a developer page, but it's more about getting started with the project as a developer, and less about what this document is attempting to capture.
2. Should I retarget this at master? It may be good to have for the historical record. It could also be closed as it's largely no longer relevant. It's up to y'all. It's my fault I took so long with this.

Thanks!

[ncdc]

I would keep it in master, move it perhaps into docs/book/src/providers/v1alpha1-to-v1alpha2.md, and also backport to release-0.2.

[ncdc]

Or we could just do this in release-0.2 if that's preferable.

[akutz]

Hi @ncdc,

I merged the two developer docs into the requested location.

[ncdc]

Thanks @akutz!

/assign @chuckha
as he wrote the initial doc

[chuckha]

This looks fine to me. This is a very streamlined version of the process we went through to get here.

One addition that might be nice to have but not necessary are moving to kubebuilder v2 as mentioned to in the intro, but that's a fairly invasive upgrade iirc, so it's definitely fine to omit.

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: akutz, chuckha

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [chuckha]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[akutz]

Hi @chuckha,

I'm happy to add something about kubebuilder v2, but I'm wondering what you're thinking that isn't part of the kubebuilder section already?

[chuckha]

Kubebuilder went through a lot of changes with the Makefile, main.go, directory structure. But that's actually all covered in the kubebuilder book! Maybe we should add a link out to this: https://book.kubebuilder.io/migration/v1vsv2.html and leave it at that? What do you think?

[akutz]

Ah, I see. Yes, that sounds good. I'll make a note that if you move to kubebuilder v2, the changes are more than just code-based, and that a full review of the aforementioned link is a good idea.

[akutz]

Hi @chuckha,

Done and done. Thank you for the suggestion.

[chuckha]

/assign @ncdc

for last review

[ncdc]

/lgtm