Skip to content

Customizing tanzu packages


This document describes how to customize tanzu packages deployments. This article uses harbor as an example. This article only covers the customization of the package deployment. For more information on how to install packages, see Installing Tanzu Packages.

Reference URLs¤


Check package availability / get versions¤

tanzu package available list -n tanzu-package-repo-global

  NAME                           DISPLAY-NAME  SHORT-DESCRIPTION                                                                                           LATEST-VERSION  cert-manager  Certificate management                                                                                      1.5.3+vmware.2-tkg.1       contour       An ingress controller                                                                                       1.18.2+vmware.1-tkg.1  external-dns  This package provides DNS synchronization functionality.                                                    0.10.0+vmware.1-tkg.1    fluent-bit    Fluent Bit is a fast Log Processor and Forwarder                                                            1.7.5+vmware.2-tkg.1       grafana       Visualization and analytics software                                                                        7.5.7+vmware.2-tkg.1        harbor        OCI Registry                                                                                                2.3.3+vmware.1-tkg.1    multus-cni    This package provides the ability for enabling attaching multiple network interfaces to pods in Kubernetes  3.7.1+vmware.2-tkg.2    prometheus    A time series database for your metrics                                                                     2.27.0+vmware.2-tkg.1
tanzu package installed list -n tanzu-package-repo-global
| Retrieving installed packages...

Try to install¤

Some packages require additional configuration. For example, harbor requires a password, and other variables, to be set. If you try to install a package without the required configuration, the installation will fail.

tanzu package install harbor --package-name  -n tanzu-package-repo-global --version 2.3.3+vmware.1-tkg.1
\ Installing package '' 

 Installing package ''

 Getting package metadata for ''

 Creating service account 'harbor-tanzu-package-repo-global-sa'

 Creating cluster admin role 'harbor-tanzu-package-repo-global-cluster-role'

 Creating cluster role binding 'harbor-tanzu-package-repo-global-cluster-rolebinding'

 Creating package resource

 Waiting for 'PackageInstall' reconciliation for 'harbor'

 'PackageInstall' resource install status: Reconciling
| 'PackageInstall' resource install status: ReconcileFailed

Please consider using 'tanzu package installed update' to update the installed package with correct settings

Error: resource reconciliation failed: ytt: Error:
- library.eval: Evaluating library 'bundle/config': Evaluating starlark template:
    in <toplevel>
      harbor.yaml:13 | --- #@ template.replace(upstream_lib.with_data_values(downstream_values()).eval())

     - fail: Harbor admin password should be provided
         in validate_harbor_admin_password
           28 |   values.harborAdminPassword or"Harbor admin password should be provided")
         in validate_harbor
           112 |      validate_func()
         in <toplevel>
           120 | validate_harbor()
. Reconcile failed: Error (see .status.usefulErrorMessage for details)
Error: exit status 1  exit status 1

The state of the package installation can be queried using tanzu package installed get <package-name> -n <namespace> -o yaml. The output will show any errors that occurred during the installation.

tanzu package installed get harbor -n tanzu-package-repo-global -o yaml

- conditions: '[{ReconcileFailed True  Error (see .status.usefulErrorMessage for details)}]'
  name: harbor
  package-version: 2.3.3+vmware.1-tkg.1
  status: 'Reconcile failed: Error (see .status.usefulErrorMessage for details)'
  useful-error-message: "ytt: Error: \n- library.eval: Evaluating library 'bundle/config':
    Evaluating starlark template: \n    in <toplevel>\n      harbor.yaml:13 | ---
    #@ template.replace(upstream_lib.with_data_values(downstream_values()).eval())\n\n
    \   reason:\n     - fail: Harbor admin password should be provided\n
    \        in validate_harbor_admin_password\n           28 |   values.harborAdminPassword
    or\"Harbor admin password should be provided\")\n         in validate_harbor\n
    \          112 |      validate_func()\n         in <toplevel>\n           120
    | validate_harbor()\n"

Get the values file for the tanzu package.¤

Similar to helm, tanzu packages has the concept of a values file, variables that can be set to configure the package. The values file schema can be pulled using tanzu package available get <package-name> --values-schema -o yaml.

However, the schema is abstracted and cannot be used directly. To pull the default value file (as in) the package must be pulled and the values file extracted from the package.

image_url=$(kubectl -n tanzu-package-repo-global get packages -o jsonpath='{.spec.template.spec.fetch[0].imgpkgBundle.image}')
imgpkg pull -b $image_url -o /tmp/harbor-package-2.3.3
cp /tmp/harbor-package-2.3.3/config/values.yaml harbor-data-values.yaml
Pulling bundle ''
  Extracting layer 'sha256:07fa4073051c53bd30455fd217e1fd7237ca0643f628a71036aa4d48d0638c61' (1/1)

Locating image lock file images...
The bundle repo ( is hosting every image specified in the bundle's Images Lock file (.imgpkg/images.yml)


Applying the values file¤

After customization to apply the values file to your harbor install use:

tanzu package installed update harbor -n tanzu-package-repo-global --values-file harbor-data-values.yaml

If you are using a values file with a fresh install use:

tanzu package install harbor --package-name  -n tanzu-package-repo-global --version 2.3.3+vmware.1-tkg.1 --values-file harbor-data-values.yaml

Last update: May 1, 2023