Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.71 KB

migrate.md

File metadata and controls

23 lines (17 loc) · 1.71 KB

Transitioning from tanzu-framework to tanzu-cli/tanzu-plugin-runtime

This section covers information relevant to plugin developers looking to transition their Tanzu CLI plugins developed using the legacy Tanzu CLI codebase in tanzu-framework to make use of tanzu-plugin-runtime project and this repository.

Updating the plugin code and dependencies

Include plugin-tooling.mk in your make file. It will provide make targets that are useful during the plugin build, test, and publishing process

Updating the import references to use tanzu-plugin-runtime

  1. The main change is to update the import references: "github.com/vmware-tanzu/tanzu-framework/cli/runtime" => "github.com/vmware-tanzu/tanzu-plugin-runtime"
  2. Additional required changes are based on the following things:
    • PluginDescriptor has moved from "github.com/vmware-tanzu/tanzu-framework/cli/runtime/apis/cli/v1alpha1" => "github.com/vmware-tanzu/tanzu-plugin-runtime/plugin"
    • buildinfo package has been moved from "github.com/vmware-tanzu/tanzu-framework/cli/runtime/buildinfo" => "github.com/vmware-tanzu/tanzu-plugin-runtime/plugin/buildinfo"
    • Plugins are required to provide the Target information with the PluginDescriptor.

Here is the sample change which includes the updates to the isolated-cluster and feature plugins to use the new tanzu-plugin-runtime and use new tooling to build plugins.