kubernetes-sigs / cluster-api-operator

Home for Cluster API Operator, a subproject of sig-cluster-lifecycle
https://cluster-api-operator.sigs.k8s.io
Apache License 2.0
146 stars 60 forks source link

📖 Correct Helm chart install instructions in docs + add warnings about --wait being required #550

Closed willie-yao closed 3 weeks ago

willie-yao commented 3 weeks ago

What this PR does / why we need it: This PR adds some fixes to the helm chart install commands in the docs. It also adds some warnings regarding the --wait flag being required when installing providers with the helm chart.

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 #532

netlify[bot] commented 3 weeks ago

Deploy Preview for kubernetes-sigs-cluster-api-operator ready!

Name Link
Latest commit ecbefe63a0d21996f84d5cbbf01b73ac2c1e5b28
Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cluster-api-operator/deploys/665f8c9140b93700080b8162
Deploy Preview https://deploy-preview-550--kubernetes-sigs-cluster-api-operator.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

k8s-ci-robot commented 3 weeks ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alexander-demicev

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](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/OWNERS)~~ [alexander-demicev] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
Danil-Grigorev commented 3 weeks ago

The docs improvements are always good. Thank you @willie-yao /lgtm

k8s-ci-robot commented 3 weeks ago

LGTM label has been added.

Git tree hash: 23288f303dcf1e80a6451341d70fef4a4ed1c87d

furkatgofurov7 commented 3 weeks ago

/cherry-pick release-0.11

k8s-infra-cherrypick-robot commented 3 weeks ago

@furkatgofurov7: once the present PR merges, I will cherry-pick it on top of release-0.11 in a new PR and assign it to you.

In response to [this](https://github.com/kubernetes-sigs/cluster-api-operator/pull/550#issuecomment-2151798320): >/cherry-pick release-0.11 Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
k8s-infra-cherrypick-robot commented 3 weeks ago

@furkatgofurov7: new pull request created: #552

In response to [this](https://github.com/kubernetes-sigs/cluster-api-operator/pull/550#issuecomment-2151798320): >/cherry-pick release-0.11 Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.