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.

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

📖 Add Docker specific get kubeconfig to quickstart #7392

Merged
merged 1 commit into from
Oct 12, 2022
Merged

📖 Add Docker specific get kubeconfig to quickstart #7392

merged 1 commit into from
Oct 12, 2022

Conversation

killianmuldoon
Copy link
Contributor

Signed-off-by: killianmuldoon [email protected]

Update the quick start to point Docker provider users to kind when retrieving the kubeconfig for their workload cluster. This will avoid users, especially on Windows and MacOS, from having to use the sed script (or Windows alternative) to update the config retrieved by clusterctl.

Related to #5263

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 11, 2022
@killianmuldoon killianmuldoon mentioned this pull request Oct 11, 2022
Closed
oscr
oscr approved these changes Oct 11, 2022
View reviewed changes
Copy link
Contributor

@oscr oscr left a comment

Choose a reason for hiding this comment

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

Some suggestions. Otherwise lgtm

docs/book/src/clusterctl/developers.md Outdated
@@ -183,16 +183,20 @@ image for version `vX.Y.Z`, therefore creating a CAPD workload cluster with

### Get the kubeconfig for the workload cluster

The command for getting the kubeconfig file for connecting to a workload cluster is the following:
The command for getting the kubeconfig file for connecting to a workload cluster with Docker Desktop should use kind:
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: consider rewriting this sentence. Maybe reformulated or two sentences?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to "When using Docker Desktop macOS or Windows or Docker Desktop (Docker Engine works fine) on Linux, use kind to retrieve the kubeconfig:"

docs/book/src/clusterctl/developers.md Outdated
@@ -183,16 +183,20 @@ image for version `vX.Y.Z`, therefore creating a CAPD workload cluster with

### Get the kubeconfig for the workload cluster
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: consider updating the title to reflect the updated content. This is a specific for when using kind + DD

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to: "Get the kubeconfig for the workload cluster when using Docker Desktop"

@killianmuldoon killianmuldoon force-pushed the docs/add-kind-kubeconfig-for-docker branch from 6109d20 to 759ad04 Compare October 12, 2022 11:25
oscr
oscr approved these changes Oct 12, 2022
View reviewed changes
Copy link
Contributor

@oscr oscr left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you for improving this

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 12, 2022
@killianmuldoon killianmuldoon force-pushed the docs/add-kind-kubeconfig-for-docker branch from 759ad04 to d94af52 Compare October 12, 2022 13:15
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 12, 2022
@killianmuldoon killianmuldoon force-pushed the docs/add-kind-kubeconfig-for-docker branch from d94af52 to b14fac4 Compare October 12, 2022 13:16
sbueringer
sbueringer reviewed Oct 12, 2022
View reviewed changes
docs/book/src/user/quick-start.md Outdated Show resolved Hide resolved
docs/book/src/user/quick-start.md Outdated Show resolved Hide resolved
@killianmuldoon killianmuldoon force-pushed the docs/add-kind-kubeconfig-for-docker branch from b14fac4 to fe84250 Compare October 12, 2022 15:09
@sbueringer
Copy link
Member

Thx!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 12, 2022
fabriziopandini
fabriziopandini reviewed Oct 12, 2022
View reviewed changes
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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 Oct 12, 2022
@k8s-ci-robot k8s-ci-robot merged commit 84b1728 into kubernetes-sigs:main Oct 12, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Oct 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabriziopandini fabriziopandini fabriziopandini left review comments

@sbueringer sbueringer sbueringer left review comments

@oscr oscr oscr approved these changes

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

Assignees

@oscr oscr

@sbueringer sbueringer

@fabriziopandini fabriziopandini

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.3
Development

Successfully merging this pull request may close these issues.
5 participants
@killianmuldoon @sbueringer @k8s-ci-robot @oscr @fabriziopandini