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

Issue 3535: clusterctl get kubeconfig docs added #3644

Merged
merged 1 commit into from
Sep 17, 2020
Merged

Issue 3535: clusterctl get kubeconfig docs added #3644

merged 1 commit into from
Sep 17, 2020

Conversation

iamemilio
Copy link

📖

What this PR does / why we need it: Adds documentation clusterctl get kubeconfig command

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

/cc @prankul88 @fabriziopandini @wfernandes

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 15, 2020
wfernandes
wfernandes reviewed Sep 15, 2020
View reviewed changes
Copy link
Contributor

@wfernandes wfernandes left a comment

Choose a reason for hiding this comment

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

Thanks for this PR!
When I clicked on the link in the quickstart, the page 404'd for me. So not sure what's going on there.

Also add a reference to the commands page and the index page.

docs/book/src/clusterctl/commands/get-kubeconfig.md Outdated
@@ -0,0 +1,18 @@
# clusterctl get kubeconfig

The `clusterctl get` command prints the kubeconfig of an existing workload cluster into stdout.
Copy link
Contributor

Choose a reason for hiding this comment

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

There could be more sub-commands in the future under the get verb.

Suggested change
The `clusterctl get` command prints the kubeconfig of an existing workload cluster into stdout.
This command prints the kubeconfig of an existing workload cluster into stdout.

docs/book/src/clusterctl/commands/get-kubeconfig.md Outdated
# clusterctl get kubeconfig

The `clusterctl get` command prints the kubeconfig of an existing workload cluster into stdout.
This funcitonality is available in clusterctl version 0.3.9 or newer.
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
This funcitonality is available in clusterctl version 0.3.9 or newer.
This functionality is available in clusterctl v0.3.9 or newer.

prankul88
prankul88 reviewed Sep 16, 2020
View reviewed changes
Copy link
Contributor

@prankul88 prankul88 left a comment

Choose a reason for hiding this comment

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

Thankyou for the PR!
Adding to Warren's point, the command should also be referenced in the overview page.

fabriziopandini
fabriziopandini reviewed Sep 16, 2020
View reviewed changes
docs/book/src/clusterctl/commands/get-kubeconfig.md Outdated
The `clusterctl get` command prints the kubeconfig of an existing workload cluster into stdout.
This funcitonality is available in clusterctl version 0.3.9 or newer.

## Usage:
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
## Usage:

For sake of consistency with others command's doc, we should drop Usage.
Also, I suggest to drop the list of parameters; instead, you can provide an example of calling the command with the --namespace flag

Copy link
Author

Choose a reason for hiding this comment

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

ack

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 16, 2020
wfernandes
wfernandes reviewed Sep 16, 2020
View reviewed changes
Copy link
Contributor

@wfernandes wfernandes left a comment

Choose a reason for hiding this comment

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

Lgtm except for the one nit.

docs/book/src/SUMMARY.md Outdated
@@ -20,6 +20,7 @@
- [init](clusterctl/commands/init.md)
- [config cluster](clusterctl/commands/config-cluster.md)
- [generate yaml](clusterctl/commands/generate-yaml.md)
- [clusterctl get kubeconfig](clusterctl/commands/get-kubeconfig.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: For consistency

Suggested change
- [clusterctl get kubeconfig](clusterctl/commands/get-kubeconfig.md)
- [get kubeconfig](clusterctl/commands/get-kubeconfig.md)

@prankul88
Copy link
Contributor

LGTM
Thanks

@fabriziopandini
Copy link
Member

/approve
pending fix for latest @wfernandes comment

@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 Sep 17, 2020
@wfernandes
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 17, 2020
@k8s-ci-robot k8s-ci-robot merged commit bbc7e01 into kubernetes-sigs:master Sep 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wfernandes wfernandes wfernandes left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@prankul88 prankul88 prankul88 left review comments

Assignees

@wfernandes wfernandes

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
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation for clusterctl sub-command get kubeconfig
5 participants
@iamemilio @prankul88 @fabriziopandini @k8s-ci-robot @wfernandes