uffizzi-cli 2.0.32 → 2.0.34

data/man/uffizzi-account.ronn

@@ -1,23 +0,0 @@
-  uffizzi-account - manage Uffizzi accounts
-================================================================
-
-## SYNOPSIS
-    uffizzi account COMMAND [UFFIZZI_WIDE_FLAG ...]
-
-## DESCRIPTION
-    Manage Uffizzi accounts
-
-    For more information on Uffizzi accounts, see:
-    https://docs.uffizzi.com/references/cli/
-
-## COMMANDS
-    COMMAND is one of the following:
-
-     list
-        List all accounts associated with the user's credentials
-
-     set-default
-        Set the default account in the uffizzi configuration. Also see
-        $ uffizzi config help for details.
-
-Run $ uffizzi account COMMAND --help for more information on a command.

data/man/uffizzi-cluster

@@ -1,37 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-cluster\fR \- manage clusters
-.SH "SYNOPSIS"
-.nf
-uffizzi cluster COMMAND
-.fi
-.SH "DESCRIPTION"
-.nf
-Manage Uffizzi clusters
-
-For more information on Uffizzi clusters, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "COMMANDS"
-.nf
-COMMAND is one of the following:
-
- create
-    Create a cluster
-
- delete
-    Delete a cluster
-
- describe
-    Display details of a cluster
-
- list
-    List all clusters
-
- update\-kubeconfig
-    Update kubeconfig file
-.fi
-.SH "Run \'uffizzi cluster COMMAND \-\-help\' for more information on a command\."
-

data/man/uffizzi-cluster-create

@@ -1,49 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-CREATE" "" "September 2023" ""
-.SH "NAME"
-\fBuffizzi\-cluster\-create\fR \- create a cluster
-.SH "SYNOPSIS"
-.nf
-uffizzi cluster create
-.fi
-.SH "DESCRIPTION"
-.nf
-Creates a new cluster\.
-
-For more information on Uffizzi clusters, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "FLAGS"
-.nf
-\-\-name=CLUSTER\-NAME
-    Set cluster name
-
-\-\-kubeconfig="/path/to/your/kubeconfig"
-    Path to kubeconfig file
-
-\-\-manifest="/path/to/your/manifest"
-    Path to manifest file
-
-\-\-update\-current\-context
-    Update current\-context in kubeconfig file
-
-\-\-output=pretty\-json
-\-\-output=json
-    Use this option for formatting output\.
-.fi
-.SH "EXAMPLES"
-.nf
-To create a cluster with the auto generated name, run:
-
-    $ uffizzi cluster create
-
-To create a cluster with name, run:
-
-    $ uffizzi cluster create \-\-name="my\-cluster"
-
-To create a cluster from a manifests directory, run:
-
-    $ uffizzi cluster create \-\-name="my\-cluster" \-\-manifest=manifests/
-.fi
-

data/man/uffizzi-cluster-create.ronn

@@ -1,41 +0,0 @@
-uffizzi-cluster-create - create a cluster
-================================================================
-
-## SYNOPSIS
-    uffizzi cluster create
-
-## DESCRIPTION
-    Creates a new cluster.
-
-    For more information on Uffizzi clusters, see:
-    https://docs.uffizzi.com/references/cli/
-
-## FLAGS
-    --name=CLUSTER-NAME
-        Set cluster name
-
-    --kubeconfig="/path/to/your/kubeconfig"
-        Path to kubeconfig file
-
-    --manifest="/path/to/your/manifest"
-        Path to manifest file
-
-    --update-current-context
-        Update current-context in kubeconfig file
-
-    --output=pretty-json
-    --output=json
-        Use this option for formatting output.
-
-## EXAMPLES
-    To create a cluster with the auto generated name, run:
-
-        $ uffizzi cluster create
-
-    To create a cluster with name, run:
-
-        $ uffizzi cluster create --name="my-cluster"
-
-    To create a cluster from a manifests directory, run:
-
-        $ uffizzi cluster create --name="my-cluster" --manifest=manifests/

data/man/uffizzi-cluster-delete

@@ -1,32 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-DELETE" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-cluster\-delete\fR \- delete a cluster
-.SH "SYNOPSIS"
-.nf
-uffizzi cluster delete [CLUSTER_NAME]
-.fi
-.SH "DESCRIPTION"
-.nf
-Deletes a cluster with the given cluster name\.
-
-This command can fail for the following reasons:
-    \- The cluster specified does not exist\.
-    \- The cluster specified belongs to a different project\.
-
-For more information on Uffizzi clusters, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
-[CLUSTER_NAME]
-    Name for the cluster you want to delete\.
-.fi
-.SH "EXAMPLES"
-.nf
-The following command deletes the cluster with CLUSTER_NAME my\-cluster:
-
-    $ uffizzi cluster delete my\-cluster
-.fi
-

data/man/uffizzi-cluster-delete.ronn

@@ -1,24 +0,0 @@
-uffizzi-cluster-delete - delete a cluster
-================================================================
-
-## SYNOPSIS
-    uffizzi cluster delete [CLUSTER_NAME]
-
-## DESCRIPTION
-    Deletes a cluster with the given cluster name.
-
-    This command can fail for the following reasons:
-        - The cluster specified does not exist.
-        - The cluster specified belongs to a different project.
-
-    For more information on Uffizzi clusters, see:
-    https://docs.uffizzi.com/references/cli/
-
-## POSITIONAL ARGUMENTS
-    [CLUSTER_NAME]
-        Name for the cluster you want to delete.
-
-## EXAMPLES
-    The following command deletes the cluster with CLUSTER_NAME my-cluster:
-
-        $ uffizzi cluster delete my-cluster

data/man/uffizzi-cluster-describe

@@ -1,39 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-DESCRIBE" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-cluster\-describe\fR \- show metadata for a cluster
-.SH "SYNOPSIS"
-.nf
-uffizzi cluster describe [CLUSTER_NAME] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
-.fi
-.SH "DESCRIPTION"
-.nf
-Shows metadata for a cluster given a valid cluster NAME
-
-This command can fail for the following reasons:
-    \- The cluster specified does not exist\.
-    \- The cluster specified belongs to a different project\.
-
-For more information on Uffizzi clusters, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
-[CLUSTER_NAME]
-    NAME for the cluster you want to describe\.
-.fi
-.SH "FLAGS"
-.nf
-\-\-output=pretty\-json
-\-\-output=json
-    Use this option for formatting output\.
-.fi
-.SH "EXAMPLES"
-.nf
-The following command prints metadata for the cluster with NAME
-my\-cluster:
-
-    $ uffizzi cluster describe my\-cluster
-.fi
-

data/man/uffizzi-cluster-describe.ronn

@@ -1,30 +0,0 @@
-uffizzi-cluster-describe - show metadata for a cluster
-================================================================
-
-## SYNOPSIS
-    uffizzi cluster describe [CLUSTER_NAME] [UFFIZZI_WIDE_FLAG ...]
-
-## DESCRIPTION
-    Shows metadata for a cluster given a valid cluster NAME
-
-    This command can fail for the following reasons:
-        - The cluster specified does not exist.
-        - The cluster specified belongs to a different project.
-
-    For more information on Uffizzi clusters, see:
-    https://docs.uffizzi.com/references/cli/
-
-## POSITIONAL ARGUMENTS
-    [CLUSTER_NAME]
-        NAME for the cluster you want to describe.
-
-## FLAGS
-    --output=pretty-json
-    --output=json
-        Use this option for formatting output.
-
-## EXAMPLES
-    The following command prints metadata for the cluster with NAME
-    my-cluster:
-
-        $ uffizzi cluster describe my-cluster

data/man/uffizzi-cluster-list

@@ -1,34 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-LIST" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-cluster\-list\fR \- list clusters in a project
-.SH "SYNOPSIS"
-.nf
-uffizzi cluster list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
-.fi
-.SH "DESCRIPTION"
-.nf
-Lists all clusters for a project, including active,
-deploying and failed clusters\.
-
-For more information on Uffizzi clusters, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "FLAGS"
-.nf
-\-\-output=pretty\-json
-\-\-output=json
-    Use this option for formatting output\.
-.fi
-.SH "EXAMPLES"
-.nf
-To list all clusters, run:
-
-    $ uffizzi cluster list
-
-To list all clusters in json format, run:
-
-    $ uffizzi cluster list \-\-output="pretty\-json"
-.fi
-

data/man/uffizzi-cluster-list.ronn

@@ -1,26 +0,0 @@
-uffizzi-cluster-list - list clusters in a project
-================================================================
-
-## SYNOPSIS
-    uffizzi cluster list [UFFIZZI_WIDE_FLAG ...]
-
-## DESCRIPTION
-    Lists all clusters for a project, including active,
-    deploying and failed clusters.
-
-    For more information on Uffizzi clusters, see:
-    https://docs.uffizzi.com/references/cli/
-
-## FLAGS
-    --output=pretty-json
-    --output=json
-        Use this option for formatting output.
-
-## EXAMPLES
-    To list all clusters, run:
-
-        $ uffizzi cluster list
-
-    To list all clusters in json format, run:
-
-        $ uffizzi cluster list --output="pretty-json"

data/man/uffizzi-cluster-update-kubeconfig

@@ -1,37 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-UPDATE\-KUBECONFIG" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-cluster\-update\-kubeconfig\fR \- update a kubeconfig
-.SH "SYNOPSIS"
-.nf
-uffizzi cluster update\-kubeconfig [CLUSTER_NAME]
-.fi
-.SH "DESCRIPTION"
-.nf
-Update your kubeconfig file\.
-
-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/
-.fi
-.SH "FLAGS"
-.nf
-\-\-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
-.fi
-.SH "EXAMPLES"
-.nf
-To update kubeconfig file, run:
-
-    $ uffizzi cluster update\-kubeconfig \-\-kubeconfig="/file/path/to/kubeconfig"
-.fi
-

data/man/uffizzi-cluster-update-kubeconfig.ronn

@@ -1,29 +0,0 @@
-uffizzi-cluster-update-kubeconfig - update a kubeconfig
-================================================================
-
-## SYNOPSIS
-    uffizzi cluster update-kubeconfig [CLUSTER_NAME]
-
-## DESCRIPTION
-    Update your kubeconfig file.
-
-    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/
-
-## 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, run:
-
-        $ uffizzi cluster update-kubeconfig --kubeconfig="/file/path/to/kubeconfig"

data/man/uffizzi-cluster.ronn

@@ -1,32 +0,0 @@
-uffizzi-cluster - manage clusters
-================================================================
-
-## SYNOPSIS
-    uffizzi cluster COMMAND
-
-## DESCRIPTION
-    Manage Uffizzi clusters
-
-    For more information on Uffizzi clusters, see:
-    https://docs.uffizzi.com/references/cli/
-
-## COMMANDS
-    COMMAND is one of the following:
-
-     create
-        Create a cluster
-
-     delete
-        Delete a cluster
-
-     describe
-        Display details of a cluster
-
-     list
-        List all clusters
-
-     update-kubeconfig
-        Update kubeconfig file
-
-##
-Run 'uffizzi cluster COMMAND --help' for more information on a command.

data/man/uffizzi-compose

@@ -1,39 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-COMPOSE" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-compose\fR \- manage previews
-.SH "SYNOPSIS"
-.nf
-uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
-.fi
-.SH "DESCRIPTION"
-.nf
-Manage Uffizzi previews
-
-For more information on Uffizzi previews, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "UFFIZZI WIDE FLAGS"
-.nf
-These flags are available to all commands: \-\-project\. Run $ uffizzi
-help for details\.
-.fi
-.SH "COMMANDS"
-.nf
-COMMAND is one of the following:
-
- create
-    Create a compose environment (preview)
-
- delete
-    Delete a compose environment (preview)
-
- describe
-    Display details of a compose environment (preview)
-
- list
-    List all compose environments (previews)
-.fi
-.SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\."
-

data/man/uffizzi-compose-create

@@ -1,67 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-compose\-create\fR \- create a compose environment (preview)
-.SH "SYNOPSIS"
-.nf
-uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
-.fi
-.SH "DESCRIPTION"
-.nf
-Creates a new compose environment (preview)\. If no COMPOSE_FILE is specified,
-the compose environment (preview) is created with the project\'s default compose file\.
-Run $ uffizzi project compose \-\-help for details\.
-
-This command can fail for the following reasons:
-    \- The project does not have a default compose file set\. Run
-      $ uffizzi compose \-\-help for details\.
-    \- The alternate compose file is invalid\.
-
-For more information on Uffizzi previews, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
-[COMPOSE_FILE]
-    An alternate compose file to the default compose\.
-
-    You can pass a compose file to this command to create an ad hoc
-    compose environment (preview) of an alternate compose configuration\.
-    The file passed via this argument does not replace the default
-    compose file for the project\. Alternate compose files share the
-    same lifecyle as the previews they create: when the compose
-    environment (preview) is deleted, the alternate compose
-    is deleted by the Uffizzi API\.
-.fi
-.SH "FLAGS"
-.nf
-\-\-set\-labels=METADATA
-    Metadata of deployment that contains any information which can
-    be useful for filtering deployments\.
-.fi
-.SH "UFFIZZI WIDE FLAGS"
-.nf
-These flags are available to all commands: \-\-project\. Run $ uffizzi
-help for details\.
-.fi
-.SH "EXAMPLES"
-.nf
-To create a compose environment (preview) with the project\'s default compose file, run:
-
-    $ uffizzi compose create
-
-To create a compose environment (preview) with an alternate compose file, run:
-
-    $ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml
-
-To create a compose environment (preview) with single label, run:
-
-    $ uffizzi compose create \-\-set\-labels github\.repo=my_repo
-
-To create a compose environment (preview) with multiple labels, run:
-
-    $ uffizzi compose create \e
-    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
-.fi
-

data/man/uffizzi-compose-create.ronn

@@ -1,57 +0,0 @@
-uffizzi-compose-create - create a compose environment (preview)
-================================================================
-
-## SYNOPSIS
-    uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
-
-## DESCRIPTION
-    Creates a new compose environment (preview). If no COMPOSE_FILE is specified,
-    the compose environment (preview) is created with the project's default compose file.
-    Run $ uffizzi project compose --help for details.
-
-    This command can fail for the following reasons:
-        - The project does not have a default compose file set. Run
-          $ uffizzi compose --help for details.
-        - The alternate compose file is invalid.
-
-    For more information on Uffizzi previews, see:
-    https://docs.uffizzi.com/references/cli/
-
-## POSITIONAL ARGUMENTS
-    [COMPOSE_FILE]
-        An alternate compose file to the default compose.
-
-        You can pass a compose file to this command to create an ad hoc
-        compose environment (preview) of an alternate compose configuration.
-        The file passed via this argument does not replace the default
-        compose file for the project. Alternate compose files share the
-        same lifecyle as the previews they create: when the compose
-        environment (preview) is deleted, the alternate compose
-        is deleted by the Uffizzi API.
-
-## FLAGS
-    --set-labels=METADATA
-        Metadata of deployment that contains any information which can
-        be useful for filtering deployments.
-
-## UFFIZZI WIDE FLAGS
-    These flags are available to all commands: --project. Run $ uffizzi
-    help for details.
-
-## EXAMPLES
-    To create a compose environment (preview) with the project's default compose file, run:
-
-        $ uffizzi compose create
-
-    To create a compose environment (preview) with an alternate compose file, run:
-
-        $ uffizzi compose create docker-compose.uffizzi.alt.yml
-
-    To create a compose environment (preview) with single label, run:
-
-        $ uffizzi compose create --set-labels github.repo=my_repo
-
-    To create a compose environment (preview) with multiple labels, run:
-
-        $ uffizzi compose create \
-        --set-labels="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-compose-delete

@@ -1,38 +0,0 @@
-.\" generated with Ronn-NG/v0.9.1
-.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" ""
-.SH "NAME"
-\fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview)
-.SH "SYNOPSIS"
-.nf
-uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
-.fi
-.SH "DESCRIPTION"
-.nf
-Deletes a compose environment (preview) with
-the given compose environment (preview) ID\.
-
-This command can fail for the following reasons:
-    \- The compose environment (preview) specified does not exist\.
-    \- The compose environment (preview) specified belongs to a different project\.
-
-For more information on Uffizzi previews, see:
-https://docs\.uffizzi\.com/references/cli/
-.fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
-[PREVIEW_ID]
-    ID for the compose environment (preview) you want to delete\.
-.fi
-.SH "UFFIZZI WIDE FLAGS"
-.nf
-These flags are available to all commands: \-\-project\. Run $ uffizzi
-help for details\.
-.fi
-.SH "EXAMPLES"
-.nf
-The following command deletes the compose environment (preview) with ID deployment\-213:
-
-    $ uffizzi compose delete deployment\-213
-.fi
-

data/man/uffizzi-compose-delete.ronn

@@ -1,29 +0,0 @@
-uffizzi-compose-delete - delete a compose environment (preview)
-================================================================
-
-## SYNOPSIS
-    uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
-
-## DESCRIPTION
-    Deletes a compose environment (preview) with
-    the given compose environment (preview) ID.
-
-    This command can fail for the following reasons:
-        - The compose environment (preview) specified does not exist.
-        - The compose environment (preview) specified belongs to a different project.
-
-    For more information on Uffizzi previews, see:
-    https://docs.uffizzi.com/references/cli/
-
-## POSITIONAL ARGUMENTS
-    [PREVIEW_ID]
-        ID for the compose environment (preview) you want to delete.
-
-## UFFIZZI WIDE FLAGS
-    These flags are available to all commands: --project. Run $ uffizzi
-    help for details.
-
-## EXAMPLES
-    The following command deletes the compose environment (preview) with ID deployment-213:
-
-        $ uffizzi compose delete deployment-213