🌱 Improved the usage to reflect the required arguments in generate cluster, describe cluster and get kubeconfig

[chiukapoor]

Signed-off-by: Chirayu Kapoor [email protected]

What this PR does / why we need it:

For example when running clusterctl generate cluster --help, usage is described as:

Usage:
  clusterctl generate cluster [flags]

However, if you attempt to run the given example you will get an error.

clusterctl generate cluster
Error: accepts 1 arg(s), received 0

Since the command has a required argument, updated the usage to reflect the required arguments. For example:

Usage:
  clusterctl generate cluster NAME [flags]

Similar improvement has been applied in the usage text of generate cluster, describe cluster and get kubeconfig

Which issue(s) this PR fixes:
Fixes #6867

[k8s-ci-robot]

Welcome @chiukapoor!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @chiukapoor. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[oscr]

/ok-to-test

[oscr]

Great work @chiukapoor! This looks good to me!

/lgtm

New output:

./bin/clusterctl generate cluster --help
Generate templates for creating workload clusters.

(...)

Usage:
  clusterctl generate cluster NAME [flags]

Examples:
  # Generates a yaml file for creating workload clusters using
  # the pre-installed infrastructure and bootstrap providers.
  clusterctl generate cluster my-cluster

./bin/clusterctl describe cluster --help
Provide an "at glance" view of a Cluster API cluster designed to help the user in quickly
understanding if there are problems and where.
.

Usage:
  clusterctl describe cluster NAME [flags]

Examples:
  # Describe the cluster named test-1.
  clusterctl describe cluster test-1

./bin/clusterctl get kubeconfig --help
Gets the kubeconfig file for accessing a workload cluster

Usage:
  clusterctl get kubeconfig NAME [flags]

Examples:
  # Get the workload cluster's kubeconfig.
  clusterctl get kubeconfig <name of workload cluster>

[fabriziopandini]

thanks @chiukapoor for this nice PR, looking forward to seeing more of your work!
/lgtm
/approve

[k8s-ci-robot]

[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:

• OWNERS [fabriziopandini]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[sbueringer]

Approved GitHub actions to run manually now.