📖 Update new provider docs to be more current #12085
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
area/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
- created by default since kubebuilder 3.0 in 2020 Signed-off-by: cprivitere <[email protected]>
- referencing deleted comments is very confusing to understand Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
- Consistently refer to cluster as mailgunCluster - Add that you need to import the cluster-api package to your project before you can use the util function - Use mailgunCluster.ObjectMeta instead of a pointer in GetOwnerCluster call - Add explanation that we need to wait for the Cluster API controller to set the ownerref before we can use the cluster object, update code to do that - Show entire Reconcile function again after adding many lines to it Signed-off-by: cprivitere <[email protected]>
…vided scaffold Signed-off-by: cprivitere <[email protected]>
Signed-off-by: cprivitere <[email protected]>
- Provide directions that work with current kubebuilder output - Provide simpler example overriding of image name - Drop old no longer working example of image name patching - Providing a more current example of how providers actually do this would involve teaching about CI/CD setups which seems out of scope for this document Signed-off-by: cprivitere <[email protected]>
- Old section didn't work anymore - replace it with a link to the quick start guide - Suggest/note that we assume the user will use kind and clusterctl init, which will install cert-manager automatically. - Update Condition status example to match what a kubectl describe currently shows Signed-off-by: cprivitere <[email protected]>
- Show how to load the image into kind - Use a tag that isn't latest so kubernetes won't try to pull it from docker hub - Update Conditions fields to current kubernetes output Signed-off-by: cprivitere <[email protected]>
- Tilt example wasn't functional as it was - Added go_main to point to where kubebuilder puts main.go - Use make tilt-up instead of trying to build your own kind cluster to proerly set up tilt to use the local registry config showin in the example tilt files Signed-off-by: cprivitere <[email protected]>
cprivitere
force-pushed
the
new-provider-docs-review
branch
from
65f07fd to
a84e84a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it: This PR attempts to update the Developing providers section of the Cluster API Book. It updates examples to reflect the current scaffolding provided by kubebuilder, be in line with current cluster api conventions, and fix errors and inconsistencies.
/area documentation