README
¶
Tanzu Framework
Overview
Tanzu Framework provides a set of building blocks to build atop of the Tanzu platform, which includes the following:
- API Machinery: For defining and implementing APIs and their controllers
- CLI Machinery: For extending the command line experience
- Packages: For consistent delivery of core and optional components
Framework leverages Carvel packaging and plugins to provide users with a much stronger, more integrated experience than the loose coupling and stand-alone commands of the previous generation of tools.
Documentation
The documentation provides a getting started guide and information about building from source, the Tanzu Framework architecture, extending the Tanzu platform, and more.
Getting Started
The best way to get started with Tanzu Framework is by using the CLI. Please see our getting started with the CLI guide for more details.
Contributing
Thanks for taking the time to join our community and start contributing! We welcome pull requests. Feel free to dig through the issues and jump in.
Before you begin
- Check out the contribution guidelines to learn more about how to contribute
- Reference our troubleshooting tips if you find yourself in need of more debug options.
- Check out this support process document here to learn more about the process.
Roadmap
Check out Framework's project Roadmap and consider contributing!
Cherry-pick process
Check quick instructions here
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
addons
module
|
|
|
hack/tools
Module
|
|
|
pinniped/config-controller
Module
|
|
|
pinniped/post-deploy
Module
|
|
|
apis
|
|
|
providers/v1alpha1
Package v1alpha1 ...
|
Package v1alpha1 ... |
|
addonconfigs
Module
|
|
|
cli
Module
|
|
|
cni
Module
|
|
|
config
Module
|
|
|
core
Module
|
|
|
cpi
Module
|
|
|
run
Module
|
|
|
capabilities
|
|
|
client
Module
|
|
|
controller
Module
|
|
|
cli
|
|
|
core
Module
|
|
|
integrations
Module
|
|
|
runtime
Module
|
|
|
cmd
|
|
|
cli/plugin/telemetry/cmd
Package cmd contains the cobra command code for each subcommand of the telemetry plugin
|
Package cmd contains the cobra command code for each subcommand of the telemetry plugin |
|
cli/plugin/telemetry/cmd/fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
cli/plugin/telemetry/kubernetes
Package kubernetes contains utilities for interacting with kubernetes clusters and unit testing code that deals with clusters
|
Package kubernetes contains utilities for interacting with kubernetes clusters and unit testing code that deals with clusters |
|
cli/plugin/telemetry/status
Package status contains logic for the status subcommand
|
Package status contains logic for the status subcommand |
|
cli/plugin/telemetry/update
Package update contains logic for the update subcommand
|
Package update contains logic for the update subcommand |
|
cli/plugin/tkr/utils
Package utils provides common utility functions
|
Package utils provides common utility functions |
|
cli/plugin/tkr/v1alpha1
Package v1alpha1 provides the command definitions for TKR API v1alpha1
|
Package v1alpha1 provides the command definitions for TKR API v1alpha1 |
|
cli/plugin/tkr/v1alpha3
Package v1alpha3 provides the command definitions for TKR API v1alpha3
|
Package v1alpha3 provides the command definitions for TKR API v1alpha3 |
|
cli/tkg
This file allows building tkg-cli Note: This is added as some tests still relies on tkg cli.
|
This file allows building tkg-cli Note: This is added as some tests still relies on tkg cli. |
|
cli/plugin/feature
Module
|
|
|
cli/plugin/isolated-cluster
Module
|
|
|
cli/plugin/package
Module
|
|
|
cli/plugin/secret
Module
|
|
|
plugin/codegen
Module
|
|
|
plugin/feature
Module
|
|
|
featuregates
|
|
|
client
Module
|
|
|
controller
Module
|
|
|
hack
|
|
|
packages/package-tools
Module
|
|
|
tools
Module
|
|
|
object-propagation
module
|
|
|
packageclients
module
|
|
|
pinniped-components
|
|
|
pkg/buildinfo
Package buildinfo holds global vars set at build time to provide information about the build.
|
Package buildinfo holds global vars set at build time to provide information about the build. |
|
common
Module
|
|
|
hack/tools
Module
|
|
|
post-deploy
Module
|
|
|
pkg
|
|
|
v1/auth/csp
Package csp provides VMware Cloud Services Platform token utilities.
|
Package csp provides VMware Cloud Services Platform token utilities. |
|
v1/auth/wcp
Package wcp provides helpers to interact with a vSphere Supervisor.
|
Package wcp provides helpers to interact with a vSphere Supervisor. |
|
v1/buildinfo
Package buildinfo holds global vars set at build time to provide information about the build.
|
Package buildinfo holds global vars set at build time to provide information about the build. |
|
v1/test/cmp/strings
Package strings provides string related utilities for testing purposes.
|
Package strings provides string related utilities for testing purposes. |
|
v1/providers/tests
Module
|
|
|
v1/tkr
Module
|
|
|
providers
|
|
|
client
Package client provides access to the providers template data
|
Package client provides access to the providers template data |
|
client/manifest
Package manifest ...
|
Package manifest ... |
|
readiness
|
|
|
controller
Module
|
|
|
e2e
Module
|
|
|
test
|
|
|
pkg
Module
|
|
|
tkg
module
|
|
|
hack/tools
Module
|
|
|
tkr
module
|
|
|
util
module
|
Click to show internal directories.
Click to hide internal directories.