tanzu imgpkg

Allows to store configuration and image references as OCI artifacts (copy, describe, pull, push, tag, version)

Usage

CLI plugin: imgpkg | Target: global | Release Notes

Syntax:

tanzu imgpkg [FLAGS]
tanzu imgpkg [COMMAND]

Global Flags

--color

Set color output (default true).

--column

Filter to show only given columns.

--debug

Includes debug output.

-h, --help

Help text.

--json

Output as JSON.

--tty

Force TTY-like output.

-y, --yes

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

tanzu imgpkg copy

Copy an imgpkg bundle from one registry to another.

Usage

tanzu imgpkg copy [FLAGS]

Examples

Copy bundle dkalinin/app1-bundle to local tarball at /Volumes/app1-bundle.tar.

tanzu imgpkg copy -b dkalinin/app1-bundle --to-tar /Volumes/app1-bundle.tar

Copy bundle dkalinin/app1-bundle to another registry (or repository).

tanzu imgpkg copy -b dkalinin/app1-bundle --to-repo internal-registry/app1-bundle

Flags

-b, --bundle

Bundle reference for copying (happens thickly, i.e. bundle image + all referenced images).

--concurrency

Concurrency (default 5).

--cosign-signatures

Find and copy cosign signatures for images.

-h, --help

Help text.

-i, --image

Image reference for copying a generic image (example: docker.io/dkalinin/test-content).

--include-non-distributable-layers

Include non-distributable layers when copying an image/bundle.

--lock

Lock file with asset references to copy to destination.

--lock-output

Location to output the generated lockfile. Option only available when using --bundle or --lock flags.

--registry-anon

Set anonymous auth ($IMGPKG_ANON).

--registry-ca-cert-path

Add CA certificates for registry API (format: /tmp/foo) (can be specified multiple times).

--registry-insecure

Allow the use of http when interacting with registries.

--registry-password

Set password for auth ($IMGPKG_PASSWORD).

--registry-response-header-timeout

Maximum time to allow a request to wait for a server’s response headers from the registry (ms|s|m|h) (default 30s).

--registry-retry-count

Set the number of times imgpkg retries to send requests to the registry in case of an error (default 5).

--registry-token

Set token for auth ($IMGPKG_TOKEN).

--registry-username

Set username for auth ($IMGPKG_USERNAME).

--registry-verify-certs

Set whether to verify server’s certificate chain and host name (default true).

--repo-based-tags

Allow imgpkg to use repository-based tags for convenience.

--resume

Resume the copy to tar. When set to true will try to read the tar and only download the missing blobs.

--tar

Path to tar file which contains assets to be copied to a registry.

--to-repo

Location to upload assets.

--to-tar

Location to write a tar file containing assets.

tanzu imgpkg describe

Describe the images and bundles associated with a given bundle.

Usage

tanzu imgpkg describe [FLAGS]

Examples

Describe a bundle.

tanzu imgpkg describe -b carvel.dev/app1-bundle

Flags

-b, --bundle

Bundle reference.

--concurrency

Concurrency (default 5).

--cosign-signatures

Retrieve cosign artifact information (Default: true).

-h, --help

Help text.

-o, --output-type

Type of output possible values: [text, yaml] (default text).

--registry-anon

Set anonymous auth ($IMGPKG_ANON).

--registry-ca-cert-path

Add CA certificates for registry API (format: /tmp/foo) (can be specified multiple times).

--registry-insecure

Allow the use of http when interacting with registries.

--registry-password

Set password for auth ($IMGPKG_PASSWORD).

--registry-response-header-timeout

Maximum time to allow a request to wait for a server’s response headers from the registry (ms|s|m|h) (default 30s).

--registry-retry-count

Set the number of times imgpkg retries to send requests to the registry in case of an error (default 5).

--registry-token

Set token for auth ($IMGPKG_TOKEN).

--registry-username

Set username for auth ($IMGPKG_USERNAME).

--registry-verify-certs

Set whether to verify server’s certificate chain and host name (default true).

tanzu imgpkg help

Help provides help for any command in the application.

tanzu imgpkg pull

Pull files from bundle, image, or bundle lock file.

Usage

tanzu imgpkg pull [FLAGS]

Example

To pull bundle repo/app1-bundle and extract into /tmp/app1-bundle:

tanzu imgpkg pull -b repo/app1-bundle -o /tmp/app1-bundle

To pull image repo/app1-image and extract into /tmp/app1-image:

tanzu imgpkg pull -i repo/app1-image -o /tmp/app1-image

Flags

-b, --bundle

Set bundle (example: docker.io/dkalinin/test-content)

-h, --help

Help text.

-i, --image

Set image (example: docker.io/dkalinin/test-content).

--image-is-bundle-check

Error when image is a bundle (disable pulling bundles via -i) (default true).

--lock

Lock file with asset references to copy to destination.

-o, --output-type

Output directory path.

-r, --recursive

Recursively iterate and fetch content of every bundle.

--registry-anon

Set anonymous auth ($IMGPKG_ANON).

--registry-ca-cert-path

Add CA certificates for registry API (format: /tmp/foo) (can be specified multiple times).

--registry-insecure

Allow the use of http when interacting with registries.

--registry-password

Set password for auth ($IMGPKG_PASSWORD).

--registry-response-header-timeout

Maximum time to allow a request to wait for a server’s response headers from the registry (ms|s|m|h) (default 30s).

--registry-retry-count

Set the number of times imgpkg retries to send requests to the registry in case of an error (default 5).

--registry-token

Set token for auth ($IMGPKG_TOKEN).

--registry-username

Set username for auth ($IMGPKG_USERNAME).

--registry-verify-certs

Set whether to verify server’s certificate chain and host name (default true).

tanzu imgpkg push

Push files as image.

Usage

tanzu imgpkg push [FLAGS]

Examples

Push bundle repo/app1-config with contents of config/ directory:

tanzu imgpkg push -b repo/app1-config -f config/

Push image repo/app1-config with contents from multiple locations

tanzu imgpkg push -i repo/app1-config -f config/ -f additional-config.yml

Flags

-b, --bundle

Set bundle (example: docker.io/dkalinin/test-content).

-f, --file

Set file (format: /tmp/foo) (can be specified multiple times).

--file-exclusion

Exclude file whose path, relative to the bundle root, matches (format: bar.yaml, nested-dir/baz.txt) (can be specified multiple times) (default [.git]).

-h, --help

Help text.

-i, --image

Set image (example: docker.io/dkalinin/test-content).

-l, --labels

Set labels on image (default []).

--lock-output

Location to output the generated lockfile. Option only available when using --bundle flag.

--preserve-permissions

Preserve the group and all permissions of all the files and folders.

--registry-anon

Set anonymous auth ($IMGPKG_ANON).

--registry-ca-cert-path

Add CA certificates for registry API (format: /tmp/foo) (can be specified multiple times).

--registry-insecure

Allow the use of http when interacting with registries.

--registry-password

Set password for auth ($IMGPKG_PASSWORD).

--registry-response-header-timeout

Maximum time to allow a request to wait for a server’s response headers from the registry (ms|s|m|h) (default 30s).

--registry-retry-count

Set the number of times imgpkg retries to send requests to the registry in case of an error (default 5).

--registry-token

Set token for auth ($IMGPKG_TOKEN).

--registry-username

Set username for auth ($IMGPKG_USERNAME).

--registry-verify-certs

Set whether to verify server’s certificate chain and host name (default true).

tanzu imgpkg completion

Configures auto-completion for tanzu imgpkg CLI commands.

Usage

tanzu imgpkg completion [bash|zsh|fish|powershell]

Examples

To enable auto-completion for Bash:

Note: Install the bash-completion OS package before following the steps below.

• Load for the current session:

  source <(tanzu imgpkg completion bash)
  

  • For Linux:

    tanzu imgpkg completion bash > /etc/bash_completion.d/imgpkg
    

  • For MacOS:

    tanzu imgpkg completion bash > /usr/local/etc/bash_completion.d/imgpkg
    

To enable auto-completion for Zsh:

• If shell completion is not already enabled in your environment, enable it. Execute the following once: echo "autoload -U compinit; compinit" >> ~/.zshrc

  To load completions for each session, execute once:
  
  ```
  tanzu imgpkg completion zsh > "${fpath[1]}/_imgpkg"
  ```
  
  You will need to start a new shell for this setup to take effect.
  

To enable auto-completion for Fish:

• tanzu imgpkg completion fish | source
  

  To load completions for each session, execute once:

  tanzu imgpkg completion fish > ~/.config/fish/completions/imgpkg.fish
  

To enable auto-completion for PowerShell:

• tanzu imgpkg completion powershell | Out-String | Invoke-Expression
  

  To load completions for every new session, run:

  tanzu imgpkg completion powershell > imgpkg.ps1
  

  and source this file from your PowerShell profile.

Flags

-h, --help

Help text.

tanzu imgpkg tags

Tag (list, resolve)

Available commands:

• list
• resolve

Flags

-h, --help

Help text.

tanzu imgpkg tag list

List tags for image.

Usage

tanzu imgpkg tag list [FLAGS]

Flags

--digests

Include digests.

-h, --help

Help text.

-i, --image

Set image (example: docker.io/dkalinin/test-content).

--imgpkg-internal-tags

Include internal .imgpkg tags.

--registry-anon

Set anonymous auth ($IMGPKG_ANON).

--registry-ca-cert-path

Add CA certificates for registry API (format: /tmp/foo) (can be specified multiple times).

--registry-insecure

Allow the use of http when interacting with registries.

--registry-password

Set password for auth ($IMGPKG_PASSWORD).

--registry-response-header-timeout

Maximum time to allow a request to wait for a server’s response headers from the registry (ms|s|m|h) (default 30s).

--registry-retry-count

Set the number of times imgpkg retries to send requests to the registry in case of an error (default 5).

--registry-token

Set token for auth ($IMGPKG_TOKEN).

--registry-username

Set username for auth ($IMGPKG_USERNAME).

--registry-verify-certs

Set whether to verify server’s certificate chain and host name (default true).

tanzu imgpkg tag resolve

Resolve tag to digest for image.

Usage

tanzu imgpkg tag resolve [FLAGS]

Flags

-h, --help

Help text.

-i, --image

Set image (example: docker.io/dkalinin/test-content).

--registry-anon

Set anonymous auth ($IMGPKG_ANON).

--registry-ca-cert-path

Add CA certificates for registry API (format: /tmp/foo) (can be specified multiple times).

--registry-insecure

Allow the use of http when interacting with registries.

--registry-password

Set password for auth ($IMGPKG_PASSWORD).

--registry-response-header-timeout

Maximum time to allow a request to wait for a server’s response headers from the registry (ms|s|m|h) (default 30s).

--registry-retry-count

Set the number of times imgpkg retries to send requests to the registry in case of an error (default 5).

--registry-token

Set token for auth ($IMGPKG_TOKEN).

--registry-username

Set username for auth ($IMGPKG_USERNAME).

--registry-verify-certs

Set whether to verify server’s certificate chain and host name (default true).

tanzu imgpkg version

Print client version

Flags

-h, --help

Help text.