Skip to content

📖 docs: add missing operator quick start guide #5557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2025

Conversation

maxsxu
Copy link
Contributor

@maxsxu maxsxu commented Jun 18, 2025

What type of PR is this?

/kind documentation

Which issue(s) this PR fixes :
Fixes #5556

Special notes for your reviewer:

Reusing the https://cluster-api.sigs.k8s.io/user/quick-start-operator

I've verified locally via make serve as shown below:

image

Checklist:

  • squashed commits
  • includes documentation
  • includes emoji in title
  • adds unit tests
  • adds or updates e2e tests

Release note:

NONE

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesn't merit a release note. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 18, 2025
@k8s-ci-robot k8s-ci-robot requested review from cnmcavoy and damdo June 18, 2025 06:18
@k8s-ci-robot
Copy link
Contributor

Welcome @maxsxu!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-aws 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-aws has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 18, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @maxsxu. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@richardcase
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 19, 2025
@maxsxu
Copy link
Contributor Author

maxsxu commented Jun 24, 2025

Thanks @richardcase do you think we're good to merge?

This is pure docs so should not affect any E2E tests.

@richardcase
Copy link
Member

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 26, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 110074fb7fd43a7cdeb72307bc79a1ef5c3f19a2

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: richardcase

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 26, 2025
@maxsxu
Copy link
Contributor Author

maxsxu commented Jun 26, 2025

The AWS Account for CI has reached the maximum number of VPCs.

E0626 13:41:15.990138   45924 awscluster_controller.go:333] "failed to reconcile network" err="failed to create new managed VPC: failed to create vpc: The maximum number of VPCs has been reached"

Note: we should update the CI config, there is no need to run CI against PR which only contain docs change.

@damdo
Copy link
Member

damdo commented Jun 26, 2025

/test pull-cluster-api-provider-aws-test

@k8s-ci-robot k8s-ci-robot merged commit 34b5147 into kubernetes-sigs:main Jun 26, 2025
24 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v2.8 milestone Jun 26, 2025
@maxsxu maxsxu deleted the max/docs branch June 26, 2025 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Broken link of CAPI Operator quickstart
4 participants