tanzu package

Manages Tanzu packages.

Usage

CLI plugin: package | Plugin version: v0.32.1 | Target: kubernetes

Syntax:

tanzu package [FLAGS]
tanzu package [COMMAND]

You can run tanzu package commands in either of the following modes:

kctrl mode activated (default)
kctrl mode deactivated (deprecated)

The sections below document the tanzu package command group in the default mode.

Global Flags

--column

Filter to show only specific columns from tables. For example, --column=namespaces, name.

--debug

Includes debug output.

-h, --help

Help text.

--kube-api-burst

Sets the Kubernetes API client burst limit. Default value is 1000.

--kube-api-qps

Sets the Kubernetes API client QPS limit. Default value is 1000.

--kubeconfig

Path to the kubeconfig file.

--kubeconfig-context

Overrides the current kubeconfig context.

--kubeconfig-yaml

Passes the contents of the kubeconfig file as YAML.

-y, --yes

When --yes is specified, the command skips the confirmation step.

tanzu package available

Manages available packages. For more information, see Packages.

Available commands:

get
list

Flags

-h, --help

Help text.

tanzu package available get

Shows the details of an available package.

Usage

tanzu package available get AVAILABLE-PACKAGE-NAME [FLAGS]

And:

tanzu package available get AVAILABLE-PACKAGE-NAME/AVAILABLE-PACKAGE-VERSION [FLAGS]

Examples

To get the details of the contour.tanzu.vmware.com package in the example-namespace:

tanzu package available get contour.tanzu.vmware.com --namespace example-namespace

To get the details of v1.17.1+vmware.1-tkg.1 of the contour.tanzu.vmware.com package in the example-namespace:

tanzu package available get contour.tanzu.vmware.com/1.17.1+vmware.1-tkg.1 --namespace example-namespace

To get the OpenAPI schema of v1.17.1+vmware.1-tkg.1 of the contour.tanzu.vmware.com package in example-namespace:

tanzu package available get contour.tanzu.vmware.com/1.17.1+vmware.1-tkg.1 --namespace example-namespace --values-schema

Flags

--default-values-file-output

The location to which you want to save the default configuration of the package, for example, --default-values-file-output contour-data-values.yaml. You edit and then pass this file to tanzu package install when installing the package.

-h, --help

Help text.

-n, --namespace

The target namespace. If this flag is not specified, the Tanzu CLI targets the namespace set in kubeconfig, which is set to default by default.

-o, --output

Output format. Supported values are yaml, json, and table.

--tty

Forces TTY-like output.

--values-schema

The OpenAPI schema of the package.

tanzu package available list

Lists all available packages and package versions.

Usage

tanzu package available list [FLAGS]

And:

tanzu package list AVAILABLE-PACKAGE-NAME [FLAGS]

Examples

To list available packages across all namespaces:

tanzu package available list --all-namespaces

To list available packages only in the default namespace:

tanzu package available list

To list all versions of the contour.tanzu.vmware.com package in the example-namespace:

tanzu package available list contour.tanzu.vmware.com --namespace example-namespace

Flags

-A, --all-namespaces

When --all-namespaces is specified, the command lists available packages from all namespaces.

-h, --help

Help text.

-n, --namespace

The target namespace. If this flag is not specified, the Tanzu CLI targets the namespace set in kubeconfig, which is set to default by default.

-o, --output

Output format. Supported values are yaml, json, and table.

--summary

Shows a summarized list of available packages.

--tty

Forces TTY-like output.

--wide

Shows additional information about available packages.

tanzu package init

Initializes the specified package. This is an experimental feature. For more information about experimental features, see TKG Feature States.

tanzu package install

Installs the specified package. For more information, see Packages.

Usage

tanzu package install INSTALLED-PACKAGE-NAME --package AVAILABLE-PACKAGE-NAME --version AVAILABLE-PACKAGE-VERSION [FLAGS]

Examples

To install v1.17.1+vmware.1-tkg.1 of the contour.tanzu.vmware.com package into example-namespace, without waiting for package reconciliation to complete:

tanzu package install my-contour --package contour.tanzu.vmware.com --namespace example-namespace --version 1.17.1+vmware.1-tkg.1 --wait=false

To install v1.17.1+vmware.1-tkg.1 of the contour.tanzu.vmware.com package into example-namespace with the kubeconfig option:

tanzu package install my-contour --package contour.tanzu.vmware.com --namespace example-namespace --version 1.17.1+vmware.1-tkg.1 --kubeconfig /tmp/my-cluster-kubeconfig

Flags

--dangerous-allow-use-of-shared-namespace

Lets you install packages into default and other shared namespaces.

--dry-run

Generates a preview of the YAML configuration that will be applied to the cluster.

-h, --help

Help text.

-n, --namespace

The namespace in which to install the package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

-p, --package

The name of the package that you are installing.

--service-account-name

The name of an existing service account. This service account is used instead of the default service account to install the package.

--tty

Forces TTY-like output.

--values

Adds or keeps values passed to the PackageInstall resource by specifying --values-file. Set to true by default.

--values-file

The path to the package configuration file.

-v, --version

The version of the package that you are installing.

--wait

Waits for package reconciliation to complete. The default setting is true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The time interval between two package reconciliation status checks. The default setting is 1s.

--wait-timeout

The timeout value for --wait. The default setting is 30m0s.

--ytt-overlay-file

The path to a ytt overlay file or directory.

--ytt-overlays

Adds or keeps ytt overlays. Set to true be default.

tanzu package installed

Manages installed packages. For more information, see Packages.

tanzu package installed create
tanzu package installed delete
tanzu package installed get
tanzu package installed kick
tanzu package installed list
tanzu package installed pause
tanzu package installed status
tanzu package installed update

Additionally, with the integration kctrl with Tanzu CLI, new commands are tanzu package installed commands can be used that manage your package installation. For more information, see kctrl Integration to learn more.

Flags

-h, --help

Help text.

tanzu package installed create

Same as tanzu package install.

tanzu package installed delete

Deletes the specified package.

Usage

tanzu package installed delete INSTALLED-PACKAGE-NAME [FLAGS]

Example

To delete the my-contour package from my-package-namespace:

tanzu package installed delete my-contour -n my-package-namespace

Flags

-h, --help

Help text.

-n, --namespace

The namespace of the package that you are deleting. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

--wait-check-interval

The time interval between two package deletion status checks. The default setting is 1s.

--wait-timeout

The timeout value for package deletion status checks. The default setting is 5m0s.

tanzu package installed get

Shows the details of the specified package.

Usage

tanzu package installed get INSTALLED-PACKAGE-NAME [FLAGS]

Example

To get the details of the my-contour package installed in my-package-namespace:

tanzu package installed get my-contour --namespace my-package-namespace

Flags

-h, --help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

-o, --output

Output format. Supported values are yaml, json, and table.

--tty

Forces TTY-like output.

--values

Gets values for the package.

--values-file-output

The path to which you want to save the configuration values file.

tanzu package installed kick

Activates the reconciliation of the target PackageInstall.

Usage

tanzu package installed kick INSTALLED-PACKAGE-NAME [FLAGS]

Example

To activate the reconciliation of the my-contour package:

tanzu package installed kick my-contour

Flags

-h, help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

--wait

Wait for reconciliation to complete. The default setting is true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The wait time between checks during package reconciliation. The default setting is 2s.

--wait-timeout

The timeout value for --wait. The default setting is 5m0s.

tanzu package installed list

Lists installed packages.

Usage

tanzu package installed list [FLAGS]

Examples

To list installed packages across all namespaces:

tanzu package installed list --all-namespaces

To list installed packages only in the default namespace:

tanzu package installed list

To list installed packages in my-package-namespace:

tanzu package installed list --namespace my-package-namespace

Flags

-A, --all-namespaces

When --all-namespaces is specified, the command lists installed packages from all namespaces.

-h, --help

Help text.

-n, --namespace

The namespace of the installed package. If not specified, tanzu package installed list targets the namespace set in kubeconfig, which is set to default by default.

-o, --output

Output format. Supported values are yaml, json, and table.

--tty

Forces TTY-like output.

tanzu package installed pause

Pauses the reconciliation of the target PackageInstall.

Usage

tanzu package installed pause INSTALLED-PACKAGE-NAME [FLAGS]

Example

To pause the reconciliation of the my-contour package:

tanzu package installed pause my-contour

Flags

-h, help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

tanzu package installed status

Shows the status of the app created by the target PackageInstall.

Usage

tanzu package installed status INSTALLED-PACKAGE-NAME [FLAGS]

Example

To see the status for the my-contour package:

tanzu package installed status my-contour

Flags

-h, help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

tanzu package installed update

Updates the current version or configuration of the specified package.

Usage

tanzu package installed update INSTALLED-PACKAGE-NAME [FLAGS]

Examples

To update the my-contour package installed in my-package-namespace to v1.17.1+vmware.1-tkg.1:

tanzu package installed update my-contour --version 1.17.1+vmware.1-tkg.1 --namespace my-package-namespace

To update both the my-contour package version and configuration:

tanzu package installed update my-contour -v 1.17.1+vmware.1-tkg.1 --values-file contour-default-values.yaml --namespace my-package-namespace

Flags

--dangerous-allow-use-of-shared-namespace

Lets you update packages in default and other shared namespaces.

-h, --help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

-p, --package-name

The name of the package that you are updating.

--tty

Forces TTY-like output.

--values

Adds or keeps values passed to the PackageInstall resource by specifying --values-file. Set to true by default. When you update the version of the package only, the Tanzu CLI does not change the existing values for the package. If you want to delete the existing values when updating the version of the package, set the flag to false.

--values-file

The path to the package configuration file.

-v, --version

The version that you are updating the package to.

--wait

Waits for package reconciliation to complete. The default setting is true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The time interval between two package reconciliation status checks. The default setting is 1s.

--wait-timeout

The timeout value for --wait. The default setting is 30m0s.

--ytt-overlay-file

The path to a ytt overlay file or directory.

--ytt-overlays

Adds or keeps ytt overlays. Set to true be default.

tanzu package release

Releases the specified package. This is an experimental feature. For more information about experimental features, see TKG Feature States.

tanzu package repository

Manages package repositories. For more information, see Package Repositories.

Available commands:

add
delete
get
kick
list
release
update

Flags

-h, --help

Help text.

tanzu package repository add

Adds a package repository.

Usage

tanzu package repository add REPOSITORY-NAME --url REPOSITORY-URL [FLAGS]

Example

To add the repository named my-repository to my-repository-namespace:

tanzu package repository add my-repository --url projects.registry.vmware.com/tkg/my-repo:v1.0.0 --namespace my-repository-namespace

The repository URL used above is an example.

Flags

--create-namespace

Creates the package repository namespace if it does not exist.

--dangerous-allow-use-of-shared-namespace

Lets you add package repositories to default and other shared namespaces.

--dry-run

Generates a preview of the YAML configuration that will be applied to the cluster.

-h, --help

Help text.

-n, --namespace

The target namespace. If this flag is not specified, the Tanzu CLI targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

--url

The OCI registry URL of the package repository bundle.

--wait

Waits for package repository reconciliation to complete. The default setting is true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The time interval between two checks of the package repository reconciliation status. The default setting is 1s.

--wait-timeout

The timeout value for --wait. The default setting is 5m0s.

tanzu package repository delete

Deletes the specified package repository.

Usage

tanzu package repository delete REPOSITORY-NAME [FLAGS]

Example

To delete my-repository from my-repository-namespace:

tanzu package repository delete my-repository --namespace my-repository-namespace

Flags

-h, --help

Help text.

-n, --namespace

The target namespace. If this flag is not specified, the Tanzu CLI targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

--wait

Waits for package repository reconciliation to complete. Defaults to true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The time interval between two checks of the package repository reconciliation status. The default setting is 1s.

--wait-timeout

The timeout value for --wait. The default setting is 5m0s.

tanzu package repository get

Shows the details of a package repository.

Usage

tanzu package repository get REPOSITORY-NAME [FLAGS]

Example

To get the details of my-repository from my-repository-namespace:

tanzu package repository get my-repository --namespace my-repository-namespace

Flags

-h, --help

Help text.

-n, --namespace

The target namespace. If this flag is not specified, the Tanzu CLI targets the namespace set in kubeconfig, which is set to default by default.

-o, --output

Output format. Supported values are yaml, json, and table.

--tty

Forces TTY-like output.

tanzu package repository kick

Activates the reconciliation of the target repository.

Usage

tanzu package repository kick [FLAGS]

Example

To activate the reconciliation of my-repository:

tanzu package repository kick --repository my-repository

Flags

-h, help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

-r, --repository

Sets the repository name (required).

--tty

Forces TTY-like output.

--wait

Wait for reconciliation to complete. The default setting is true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The wait time between checks during package repository reconciliation. The default setting is 1s.

--wait-timeout

The timeout value for --wait. The default setting is 5m0s.

tanzu package repository list

Lists all package repositories.

Usage

tanzu package repository list [FLAGS]

Examples

To list package repositories across all namespaces:

tanzu package repository list --all-namespaces

To list package repositories only in the default namespace:

tanzu package repository list

Flags

-A, --all-namespaces

When --all-namespaces is not specified, the command lists package repositories from all namespaces.

-h, --help

Help text.

-n, --namespace

The namespace of the installed package. If --namespace is not specified, the command targets the namespace set in kubeconfig, which is set to default by default.

-o, --output

Output format. Supported values are yaml, json, and table.

--tty

Forces TTY-like output.

tanzu package repository release

Builds and creates a package repository. This is an experimental feature. For more information about experimental features, see TKG Feature States.

tanzu package repository update

Updates the URL of a package repository.

Note
Do not update the URL of the tanzu-standard package repository if the target cluster is connected to VMware Tanzu Mission Control.

Usage

tanzu package repository update REPOSITORY-NAME --url REPOSITORY-URL [FLAGS]

Example

To update the URL of my-repository in the default namespace:

tanzu package repository update my-repository --url projects.registry.vmware.com/tkg/my-repo:v1.0.1

The repository URL used above is an example.

Flags

--dangerous-allow-use-of-shared-namespace

Lets you update package repositories in default and other shared namespaces.

-h, --help

Help text.

-n, --namespace

The target namespace. If this flag is not specified, the Tanzu CLI targets the namespace set in kubeconfig, which is set to default by default.

--tty

Forces TTY-like output.

--url

The OCI registry URL of the package repository bundle.

--wait

Waits for package repository reconciliation to complete. The default setting is true. To deactivate the default setting, specify --wait=false.

--wait-check-interval

The time interval between two checks of the package repository reconciliation status. The default setting is 1s.

--wait-timeout

The timeout value for --wait. The default setting is 5m0s.