Cluster-api: Add documentation for clusterctl sub-command `get kubeconfig`

Created on 27 Aug 2020  路  10Comments  路  Source: kubernetes-sigs/cluster-api

What steps did you take and what happened:
[A clear and concise description on how to REPRODUCE the bug.]
Clusterctl added subcomand get kubeconfig command via #3460 .
Although the documentation for the same is missing in the cluster-api book.

What did you expect to happen:

Anything else you would like to add:
[Miscellaneous information that will assist in solving the issue.]

Environment:

  • Cluster-api version:
  • Minikube/KIND version:
  • Kubernetes version: (use kubectl version):
  • OS (e.g. from /etc/os-release):

/kind documentation
[One or more /area label. See https://github.com/kubernetes-sigs/cluster-api/labels?q=area for the list of labels]

areclusterctl good first issue help wanted kindocumentation

All 10 comments

/area clusterctl

/milestone v0.3.10

/help

@vincepri:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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/test-infra repository.

/good-first-issue

@wfernandes:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

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/test-infra repository.

/assign

@wfernandes, I was just reading through the quick start, and it seems like the most logical place to add this would be in the clusterctl overview docs linked in the next steps at the end. I just wanted to verify that this makes sense.

IMO the new command should be documented with a new link in clusterctl commands opening a page under this folder that already hosts the reference for all the other commands.
It will be great to link the page from the quick start where we are calling the command at the end of the accessing-the-workload-cluster paragraph.

@fabriziopandini Thank you for clarification.

IMO the new command should be documented with a new link in clusterctl commands opening a page under this folder that already hosts the reference for all the other commands.

@iamemilio I guess this is all I had in mind :)

Was this page helpful?
0 / 5 - 0 ratings