Skip to content

Commit

Permalink
Add more details on 'tanzu plugin download-bundle' (#656)
Browse files Browse the repository at this point in the history
Signed-off-by: Marc Khouzam <marc.khouzam@broadcom.com>
  • Loading branch information
marckhouzam authored Jan 22, 2024
1 parent fe58063 commit e731feb
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions docs/quickstart/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,16 +411,21 @@ resulting images without authentication.
#### Downloading plugin bundle
You can download all plugins within the default central repository by running
the following command:
To download plugins you will use the `tanzu plugin download-bundle` command and
specify the different plugin groups relevant to your environment.
```sh
tanzu plugin download-bundle --to-tar /tmp/plugin_bundle_complete.tar.gz
```
This command will download the plugin bundle containing the plugin versions specified
in the plugin group definition. The bundle will also include the plugin group
definition itself, so that it can be used for plugin installation by users.
However, if you only want to migrate plugins within a specific plugin group version
(e.g. `vmware-tkg/default:v2.1.0`) you can run the following command to download
the plugin bundle containing only the plugins from specified group version:
Note that the latest version of the `vmware-tanzucli/essentials` plugin group
and the plugin versions it contains will automatically be included in any plugin
bundle.
For example, the following command downloads the plugin bundle containing the
plugins from `vmware-tkg/default:v2.1.0` as well as the `vmware-tkg/default:v2.1.0`
plugin group definition itself along with the `vmware-tanzucli/essentials` plugin group
plugins and group definition:
```sh
tanzu plugin download-bundle --group vmware-tkg/default:v2.1.0 --to-tar /tmp/plugin_bundle_tkg_v2_1_0.tar.gz
Expand Down Expand Up @@ -451,6 +456,14 @@ tanzu plugin download-bundle
--to-tar /tmp/plugin_bundle_tkg_v2_1_0.tar.gz
```
It is possible to download all plugins within the default central repository by running
the command below. Note that this is not recommended as all versions of all plugins
will be downloaded, which represents a very large amount of data.
```sh
tanzu plugin download-bundle --to-tar /tmp/plugin_bundle_complete.tar.gz
```
#### Uploading plugin bundle to the private registry
Once you download the plugin bundle as a `tar.gz` file and copy the file to the
Expand Down

0 comments on commit e731feb

Please sign in to comment.