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

Update update-kubeconfig help page #382

Open
gadkins opened this issue Dec 12, 2023 · 0 comments
Open

Update update-kubeconfig help page #382

gadkins opened this issue Dec 12, 2023 · 0 comments
Assignees

Comments

@gadkins
Copy link
Member

gadkins commented Dec 12, 2023

Update the uffizzi cluster update-kubeconfig -h help page, as follows:

$ uffizzi cluster update-kubeconfig -h
uffizzi-cluster-update-kubeconfig - update a kubeconfig
================================================================

## SYNOPSIS
    uffizzi cluster update-kubeconfig [CLUSTER_NAME]

## DESCRIPTION
    Update your kubeconfig file such that you can use kubectl to connect 
    to a Uffizzi cluster.

    This command can fail for the following reasons:
        - Your kubeconfig file out of specification

    For more information on Uffizzi clusters, see:
    https://docs.uffizzi.com/references/cli/

## POSITIONAL ARGUMENTS
    CLUSTER_NAME
        The name of the cluster for which to create a kubeconfig entry. 
        This cluster must exist in your account.

## FLAGS
    --kubeconfig="/path/to/your/kubeconfig"
        Path to kubeconfig file you want to update

    --print
        Print kubeconfig to STDOUT without updating kubeconfig file.

    --quiet
        Quiet mode

## EXAMPLES
    To update kubeconfig file for cluster 'my-cluster', run:

        $ uffizzi cluster update-kubeconfig my-cluster --kubeconfig="/file/path/to/kubeconfig"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

3 participants
@gadkins @zipofar and others