Skip to content

📖 Reviewed and tested getting-started guide #5388

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📖 Reviewed and tested getting-started guide #5388

wants to merge 1 commit into from
+702 −1

Conversation

faermanj
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Reviewed getting started guide for reliability and clarity:

  • Removed other providers, focused on AWS
  • Tested to work with explicit versions and devbox configuration
  • Added troubleshooting for load balancers
  • Reviwed text with grammarly

Special notes for your reviewer:

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 release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 12, 2025
@k8s-ci-robot k8s-ci-robot requested review from fiunchinho and nrb March 12, 2025 13:13
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign neolit123 for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Mar 12, 2025
@faermanj faermanj changed the title Reviewed and tested getting-started.md 📖 Reviewed and tested getting-started guide Mar 12, 2025
richardcase
richardcase reviewed Mar 17, 2025
View reviewed changes
docs/book/src/getting-started.md

### Setup a Kubernetes Cluster for Management

Cluster API requires a Kubernetes cluster ready and accessible via `kubectl`. During the installation process, this
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Cluster API requires a Kubernetes cluster ready and accessible via `kubectl`. During the installation process, this
Cluster API requires a Kubernetes cluster ready and accessible via `kubectl`. During the installation process,

docs/book/src/getting-started.md
### Setup a Kubernetes Cluster for Management

Cluster API requires a Kubernetes cluster ready and accessible via `kubectl`. During the installation process, this
Installing the Cluster API [provider components] will configure the Kubernetes cluster as a [management cluster]. It is recommended that this cluster be used exclusively to manage other clusters, isolating it from any application workload.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Installing the Cluster API [provider components] will configure the Kubernetes cluster as a [management cluster]. It is recommended that this cluster be used exclusively to manage other clusters, isolating it from any application workload.
installing the Cluster API [provider components] will configure the Kubernetes cluster as a [management cluster]. It is recommended that this cluster be used exclusively to manage other clusters, isolating it from any application workload.

docs/book/src/getting-started.md

It is a common practice to create a temporary, local bootstrap cluster, which is then used to provision
a target [management cluster] for the selected [infrastructure provider], especially for development.
A reliable and secure Kubernetes cluster should be used for production use cases, with appropriate backup and disaster recovery policies and procedures in place. The management Kubernetes cluster must be at least version v1.20.0.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A reliable and secure Kubernetes cluster should be used for production use cases, with appropriate backup and disaster recovery policies and procedures in place. The management Kubernetes cluster must be at least version v1.20.0.
A reliable and secure Kubernetes cluster should be used for production use cases, with appropriate backup and disaster recovery policies and procedures in place.

docs/book/src/getting-started.md
Installing Provider="cluster-api" Version="v1.0.0" TargetNamespace="capi-system"
Installing Provider="bootstrap-kubeadm" Version="v1.0.0" TargetNamespace="capi-kubeadm-bootstrap-system"
Installing Provider="control-plane-kubeadm" Version="v1.0.0" TargetNamespace="capi-kubeadm-control-plane-system"
Installing Provider="infrastructure-docker" Version="v1.0.0" TargetNamespace="capd-system"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wes should update this to show capa. Perhaps just replace capd with capa?

docs/book/src/getting-started.md

#### Troubleshooting load balancers
If the default load balancer fails, using a network load balancer instead may solve the issue:
In the `AWSCLuster` section of the manifests, add the `loadBalancerType` attribute like so:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the `AWSCLuster` section of the manifests, add the `loadBalancerType` attribute like so:
In the `AWSCluster` section of the manifests, add the `loadBalancerType` attribute like so:

@k8s-ci-robot
Copy link
Contributor

@faermanj: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-provider-aws-e2e-blocking 19f6b69 link true /test pull-cluster-api-provider-aws-e2e-blocking

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 27, 2025
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@richardcase richardcase richardcase left review comments

@fiunchinho fiunchinho Awaiting requested review from fiunchinho

@nrb nrb Awaiting requested review from nrb

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. needs-priority needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@faermanj @k8s-ci-robot @richardcase