Skip to content
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

docs: add provider section with examples #124

Merged
merged 2 commits into from
Jun 28, 2024

Conversation

salasberryfin
Copy link
Contributor

@salasberryfin salasberryfin commented Jun 12, 2024

Description

This change restructures the providers section under Reference Guides which now contains, apart from the table with supported providers, provisioning examples for the most important providers: CAPA and Kubeadm+CAPD. This is added to the Getting Started example based on CAPRKE2+CAPD.

These two new examples include pre-configured sample templates so users can test CAPI provisioning with a basic cluster deployment.

Addresses some of the requirements from #117. Documenting RKE2+EC2 is still pending.

@salasberryfin salasberryfin added the area/documentation Improvements or additions to documentation label Jun 12, 2024
@salasberryfin salasberryfin requested a review from a team June 12, 2024 14:01
Copy link
Member

@alexander-demicev alexander-demicev left a comment

Choose a reason for hiding this comment

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

Looks good, can you remove "fixes # 81"? We will need to add RKE2+EC2 based later when CAPA release is done #117.

@salasberryfin
Copy link
Contributor Author

Thanks @alexander-demicev. Rebased PR and addressed suggestions.

@salasberryfin
Copy link
Contributor Author

Thanks for the review @yiannistri. The PR is now updated and ready to be reviewed again.

@salasberryfin salasberryfin requested review from yiannistri and a team June 26, 2024 08:06
@salasberryfin salasberryfin enabled auto-merge June 26, 2024 08:06
@salasberryfin
Copy link
Contributor Author

Thanks @furkatgofurov7 @yiannistri. I merged CAPI Providers guides into a single page and used tabs for some steps while keeping the common parts (like cluster/namespace import).

Copy link
Contributor

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

Thanks @salasberryfin LGTM, one small suggestion

docs/reference-guides/providers/howto.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yiannistri yiannistri left a comment

Choose a reason for hiding this comment

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

Nice work @salasberryfin 👍 Just one tiny suggestion to keep things consistent.

> cluster1.yaml
```

2. View **cluster1.yaml** to ensure there are no tokens. You can make any changes you want as well.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
2. View **cluster1.yaml** to ensure there are no tokens. You can make any changes you want as well.
2. View **cluster1.yaml** to ensure there are no tokens (i.e. SSH keys or cloud credentials). You can make any changes you want as well.

Mostly for consistency reasons, although it's fairly unlikely for the Docker provider.

Copy link
Contributor

Choose a reason for hiding this comment

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

@yiannistri you should not need those for docker provider

@salasberryfin salasberryfin merged commit c92d867 into rancher:main Jun 28, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants