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!
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/cluster
command
Manage cluster lifecycle operations.
|
Manage cluster lifecycle operations. |
|
cli/plugin/cluster/test
command
|
|
|
cli/plugin/managementcluster
command
Kubernetes management cluster operations.
|
Kubernetes management cluster operations. |
|
cli/plugin/telemetry
command
|
|
|
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/test
command
|
|
|
cli/plugin/telemetry/update
Package update contains logic for the update subcommand
|
Package update contains logic for the update subcommand |
|
cli/plugin/tkr
command
|
|
|
cli/plugin/tkr/test
command
|
|
|
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
command
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/tkg
Package tkgauth provides TKG authentication functions.
|
Package tkgauth provides TKG authentication functions. |
|
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/providers/client
Package client provides access to the providers template data
|
Package client provides access to the providers template data |
|
v1/providers/client/manifest
Package manifest ...
|
Package manifest ... |
|
v1/test/cmp/strings
Package strings provides string related utilities for testing purposes.
|
Package strings provides string related utilities for testing purposes. |
|
v1/tkr
command
|
|
|
v1/tkr/controllers/label
Package label defines a labeling controller for TanzuKubernetesRelease resources.
|
Package label defines a labeling controller for TanzuKubernetesRelease resources. |
|
v1/tkr/controllers/source
Package source defines source controller for reconciling TanzuKubernetesRelease resources.
|
Package source defines source controller for reconciling TanzuKubernetesRelease resources. |
|
v1/tkr/fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
v1/tkr/pkg/constants
Package constants provides some constants for TKR.
|
Package constants provides some constants for TKR. |
|
v1/tkr/pkg/context
Package context provides controller manager context for TKR resources.
|
Package context provides controller manager context for TKR resources. |
|
v1/tkr/pkg/registry
Package registry defines a Registry interface and client for working for imkpkg images.
|
Package registry defines a Registry interface and client for working for imkpkg images. |
|
v1/tkr/pkg/utils
Package utils provides some utility functionalities for TKR.
|
Package utils provides some utility functionalities for TKR. |
|
v1/util/patchset
Package patchset provides the patchSet utility type.
|
Package patchset provides the patchSet utility type. |
|
v2/object-propagation
command
|
|
|
v2/object-propagation/config
Package config provides structs for parsing object-propagation controller configuration.
|
Package config provides structs for parsing object-propagation controller configuration. |
|
v2/object-propagation/propagation
Package propagation provides object-propagation controller reconciler.
|
Package propagation provides object-propagation controller reconciler. |
|
v2/tkr/controller/tkr-source
command
|
|
|
v2/tkr/controller/tkr-source/compatibility
Package compatibility provides the TKR Compatibility reconciler.
|
Package compatibility provides the TKR Compatibility reconciler. |
|
v2/tkr/controller/tkr-source/fetcher
Package fetcher provides implementation of the Fetcher component of the TKR Source Controller responsible for fetching TKR BOM, TKR compatibility and TKR package repository OCI images.
|
Package fetcher provides implementation of the Fetcher component of the TKR Source Controller responsible for fetching TKR BOM, TKR compatibility and TKR package repository OCI images. |
|
v2/tkr/controller/tkr-source/pkgcr
Package pkgcr provides the TKR Package reconciler: it installs yet uninstalled TKR packages.
|
Package pkgcr provides the TKR Package reconciler: it installs yet uninstalled TKR packages. |
|
v2/tkr/controller/tkr-source/registry
Package registry provides the Registry interface and implementation.
|
Package registry provides the Registry interface and implementation. |
|
v2/tkr/controller/tkr-status
command
|
|
|
v2/tkr/controller/tkr-status/clusterstatus
Package clusterstatus provides the reconciler for the Cluster UpdatesAvailable status controller.
|
Package clusterstatus provides the reconciler for the Cluster UpdatesAvailable status controller. |
|
v2/tkr/controller/tkr-status/tkr
Package tkr provides the reconciler for the TKR labeling controller / TKR resolver cache refresher.
|
Package tkr provides the reconciler for the TKR labeling controller / TKR resolver cache refresher. |
|
v2/tkr/resolver
Package resolver provides the implementation of the TKR resolver.
|
Package resolver provides the implementation of the TKR resolver. |
|
v2/tkr/resolver/data
Package data provides data types for the TKR Resolver.
|
Package data provides data types for the TKR Resolver. |
|
v2/tkr/resolver/internal
Package internal contains the implementation of the TKR Resolver.
|
Package internal contains the implementation of the TKR Resolver. |
|
v2/tkr/util/fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
v2/tkr/util/osimage
Package osimage provides helper functions to work with OSImage data.
|
Package osimage provides helper functions to work with OSImage data. |
|
v2/tkr/util/resolution
Package resolution provides helper functions for TKR resolution, e.g.
|
Package resolution provides helper functions for TKR resolution, e.g. |
|
v2/tkr/util/topology
Package topology provides helper functions to work with Cluster and ClusterClass topology features, such as variables.
|
Package topology provides helper functions to work with Cluster and ClusterClass topology features, such as variables. |
|
v2/tkr/webhook/cluster/tkr-resolver/cache
Package cache provides cache.Reconciler that updates the cache based on the watched objects' state.
|
Package cache provides cache.Reconciler that updates the cache based on the watched objects' state. |
|
v2/tkr/webhook/cluster/tkr-resolver/cluster
Package cluster provides the TKR Resolver mutating webhook on CAPI Cluster.
|
Package cluster provides the TKR Resolver mutating webhook on CAPI Cluster. |
|
v2/tkr/webhook/cluster/vsphere-template-resolver/template
Package template provides the vSphere template Resolver mutating webhook on CAPI Cluster.
|
Package template provides the vSphere template Resolver mutating webhook on CAPI Cluster. |
|
v2/tkr/webhook/cluster/vsphere-template-resolver/templateresolver
Package templateresolver provides vsphere template resolution.
|
Package templateresolver provides vsphere template resolution. |
|
v2/tkr/webhook/infra-machine
command
|
|
|
v2/tkr/webhook/infra-machine/fieldsetter
Package fieldsetter defines methods to set the fields of <Infra>Machine resource
|
Package fieldsetter defines methods to set the fields of <Infra>Machine resource |
|
v2/tkr/webhook/tkr-conversion
command
|
|
|
v1/providers/tests
module
|
|
|
readiness
|
|
|
controller
module
|
|
|
e2e
module
|
|
|
test
|
|
|
cli/mock/plugin-alt/corge
command
|
|
|
cli/mock/plugin-alt/corge/test
command
|
|
|
cli/mock/plugin-alt/qux
command
|
|
|
cli/mock/plugin-alt/qux/test
command
|
|
|
cli/mock/plugin-new/bar
command
|
|
|
cli/mock/plugin-new/bar/test
command
|
|
|
cli/mock/plugin-new/baz
command
|
|
|
cli/mock/plugin-new/baz/test
command
|
|
|
cli/mock/plugin-new/foo
command
|
|
|
cli/mock/plugin-new/foo/test
command
|
|
|
cli/mock/plugin-old/bar
command
|
|
|
cli/mock/plugin-old/bar/test
command
|
|
|
cli/mock/plugin-old/baz
command
|
|
|
cli/mock/plugin-old/baz/test
command
|
|
|
cli/mock/plugin-old/foo
command
|
|
|
cli/mock/plugin-old/foo/test
command
|
|
|
pkg
module
|
|
|
tkg
module
|
|
|
hack/tools
module
|
|
|
tkr
module
|
|
|
util
module
|
Click to show internal directories.
Click to hide internal directories.