README
¶
Tanzu Plugin Runtime
⚠ NOTE: This repository is still under early development. We plan to make releases available for evaluation in the second quarter of 2023. Please watch this page for further updates.
Overview
The Tanzu CLI is based on a plugin architecture. This architecture enables teams to build, own, and release their own piece of functionality as well as enable external partners to integrate with the system. The Tanzu Plugin Runtime provides functionality and helper methods to develop Tanzu CLI plugins.
Developers can use the Builder admin plugin to bootstrap a new plugin which
can then use tooling and functionality available within the plugin runtime to
implement its own features.
Config API
Tanzu Plugin Runtime provides various config API methods to perform CRUD operations on Contexts, Servers, DiscoverySources, Features, Envs etc.
For more details about the design and APIs go to Config API
Cross Version API Compatibility Testing
Overview
Cross Version API Compatibility testing ensures that Config APIs of different Tanzu Plugin Runtime versions work as expected as long as those Tanzu Plugin Runtime versions are supported.
Cross Version API Compatibility testing simulates the interaction of APIs provided by different versions of plugin runtimes to ensure that they can interoperate with one another.
For more details go to Cross-version API Compatibility
Directories
¶
| Path | Synopsis |
|---|---|
|
Package command provides functions to manipulate tanzu cli commands
|
Package command provides functions to manipulate tanzu cli commands |
|
Package component defines components that can be made use of in plugins.
|
Package component defines components that can be made use of in plugins. |
|
Package config Provide API methods to Read/Write specific stanza of config file
|
Package config Provide API methods to Read/Write specific stanza of config file |
|
collectionutils
Package collectionutils provide helper functions to operate on collections like array, map
|
Package collectionutils provide helper functions to operate on collections like array, map |
|
nodeutils
Package nodeutils provides utility methods to perform operations on yaml node
|
Package nodeutils provides utility methods to perform operations on yaml node |
|
types
Package types specifies the types for clientconfig
|
Package types specifies the types for clientconfig |
|
Package docs contains docs
|
Package docs contains docs |
|
Package plugin provides functions to create new CLI plugins.
|
Package plugin provides functions to create new CLI plugins. |
|
buildinfo
Package buildinfo holds global variables set at build time to provide information about the plugin build.
|
Package buildinfo holds global variables set at build time to provide information about the plugin build. |
|
lint
Package lint provides linters to run against CLI plugins.
|
Package lint provides linters to run against CLI plugins. |
|
test
|
|
|
exec
Package exec implements command execution functionality.
|
Package exec implements command execution functionality. |
|
framework
Package framework provides a tanzu cli test framework
|
Package framework provides a tanzu cli test framework |
|
compatibility/core
Module
|
|
|
compatibility/framework
Module
|
|
|
plugins/helloworld
Module
|