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
|
|
|
cli/v1alpha1
Package v1alpha1 contains API Schema definitions for the cli v1alpha1 API group +kubebuilder:object:generate=true +groupName=cli.tanzu.vmware.com
|
Package v1alpha1 contains API Schema definitions for the cli v1alpha1 API group +kubebuilder:object:generate=true +groupName=cli.tanzu.vmware.com |
|
config/v1alpha1
Package v1alpha1 contains API Schema definitions for the client v1alpha1 API group +kubebuilder:object:generate=true +groupName=config.tanzu.vmware.com
|
Package v1alpha1 contains API Schema definitions for the client v1alpha1 API group +kubebuilder:object:generate=true +groupName=config.tanzu.vmware.com |
|
providers/v1alpha1
Package v1alpha1 ...
|
Package v1alpha1 ... |
|
run/v1alpha1
Package v1alpha1 contains API Schema definitions for the run v1alpha1 API group +kubebuilder:object:generate=true +groupName=run.tanzu.vmware.com
|
Package v1alpha1 contains API Schema definitions for the run v1alpha1 API group +kubebuilder:object:generate=true +groupName=run.tanzu.vmware.com |
|
run/v1alpha1/upgrade
Package upgrade contains upgrade related api structs
|
Package upgrade contains upgrade related api structs |
|
run/v1alpha2
Package v1alpha2 contains API Schema definitions for the run.tanzu v1alpha2 API group +kubebuilder:object:generate=true +groupName=run.tanzu.vmware.com
|
Package v1alpha2 contains API Schema definitions for the run.tanzu v1alpha2 API group +kubebuilder:object:generate=true +groupName=run.tanzu.vmware.com |
|
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
Manage cluster lifecycle operations.
|
Manage cluster lifecycle operations. |
|
cli/plugin/login
Login to the platform.
|
Login to the platform. |
|
cli/plugin/managementcluster
Kubernetes management cluster operations.
|
Kubernetes management cluster operations. |
|
cli/plugin/pinniped-auth
Wrapper plugin provided for pinniped login.
|
Wrapper plugin provided for pinniped login. |
|
cli/plugin/tkr
Kubernetes release operations.
|
Kubernetes release operations. |
|
cli/tanzu
The Tanzu CLI.
|
The Tanzu CLI. |
|
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
|
|
|
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
|
|
|
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/builder/command
Package command provides commands for scaffolding new CLI plugins.
|
Package command provides commands for scaffolding new CLI plugins. |
|
v1/builder/command/publish
Package publish implements plugin and plugin api publishing related function
|
Package publish implements plugin and plugin api publishing related function |
|
v1/builder/template
Package template provides template for creating new plugins.
|
Package template provides template for creating new plugins. |
|
v1/builder/template/plugintemplates
Package plugintemplates provides templates for bootstrapping plugins.
|
Package plugintemplates provides templates for bootstrapping plugins. |
|
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/cli
Package cli provides libraries for building CLI commands and plugins.
|
Package cli provides libraries for building CLI commands and plugins. |
|
v1/cli/artifact
Package artifact implements interface to fetch the binary artifacts from different sources
|
Package artifact implements interface to fetch the binary artifacts from different sources |
|
v1/cli/carvelhelpers
Package carvelhelpers implements wrapper functions to use carvel tooling
|
Package carvelhelpers implements wrapper functions to use carvel tooling |
|
v1/cli/catalog
Package catalog implements catalog management functions
|
Package catalog implements catalog management functions |
|
v1/cli/clientconfighelpers
Package clientconfighelpers implements helper function related to client configurations
|
Package clientconfighelpers implements helper function related to client configurations |
|
v1/cli/command/core
Package core creates and initializes the tanzu CLI.
|
Package core creates and initializes the tanzu CLI. |
|
v1/cli/command/core/templates
Package plugintemplates provides templates for CLI doc generation
|
Package plugintemplates provides templates for CLI doc generation |
|
v1/cli/command/plugin
Package plugin provides functions to create new CLI plugins.
|
Package plugin provides functions to create new CLI plugins. |
|
v1/cli/command/plugin/lint
Package lint provides linters to run against CLI plugins.
|
Package lint provides linters to run against CLI plugins. |
|
v1/cli/common
Package common defines generic constants and structs Package common defines generic constants and structs
|
Package common defines generic constants and structs Package common defines generic constants and structs |
|
v1/cli/component
Package component defines components that can be made use of in plugins.
|
Package component defines components that can be made use of in plugins. |
|
v1/cli/discovery
Package discovery is implements discovery interface for plugin discovery Discovery is the interface to fetch the list of available plugins, their supported versions and how to download them either stand-alone or scoped to a server.
|
Package discovery is implements discovery interface for plugin discovery Discovery is the interface to fetch the list of available plugins, their supported versions and how to download them either stand-alone or scoped to a server. |
|
v1/cli/distribution
Package distribution implements plugin distribution interface Distribution is the interface to download a plugin version binary for a given OS and architecture combination.
|
Package distribution implements plugin distribution interface Distribution is the interface to download a plugin version binary for a given OS and architecture combination. |
|
v1/cli/plugin
Package plugin ...
|
Package plugin ... |
|
v1/cli/pluginmanager
Package pluginmanager is resposible for plugin discovery and installation
|
Package pluginmanager is resposible for plugin discovery and installation |
|
v1/codegen
Package codegen provides code generators
|
Package codegen provides code generators |
|
v1/codegen/generators/feature
Package feature provides feature generator
|
Package feature provides feature generator |
|
v1/codegen/generators/feature/fakeData
Package fakedata provides data needed for testing
|
Package fakedata provides data needed for testing |
|
v1/config
Package config provides functions for reading and writing client configuration.
|
Package config provides functions for reading and writing client configuration. |
|
v1/encoding/proto
Package proto provides conversion functions to protobuf format.
|
Package proto provides conversion functions to protobuf format. |
|
v1/grpc
Package grpc provides gRPC client utilities.
|
Package grpc provides gRPC client utilities. |
|
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/sdk/capabilities/controllers
Package controllers has controllers for Capability API.
|
Package controllers has controllers for Capability API. |
|
v1/sdk/capabilities/discovery
Package discovery provides efficient means to query Kubernetes clusters for the state of its api surface and existing objects
|
Package discovery provides efficient means to query Kubernetes clusters for the state of its api surface and existing objects |
|
v1/sdk/capabilities/discovery/tkg
Package tkg exports constants and functions to help evaluate the state of a TKG cluster.
|
Package tkg exports constants and functions to help evaluate the state of a TKG cluster. |
|
v1/sdk/features
Package features contains feature gate related controllers and utilities.
|
Package features contains feature gate related controllers and utilities. |
|
v1/sdk/features/controllers
Package controllers has the controller for feature gates.
|
Package controllers has the controller for feature gates. |
|
v1/sdk/features/featuregate
Package featuregate provides utilities for features and feature gates.
|
Package featuregate provides utilities for features and feature gates. |
|
v1/sdk/features/util
Package util provides utilities for feature and feature gate functionality.
|
Package util provides utilities for feature and feature gate functionality. |
|
v1/test/cmp/strings
Package strings provides string related utilities for testing purposes.
|
Package strings provides string related utilities for testing purposes. |
|
v1/tkg/api/tmc/v1alpha1
Package v1alpha1 ...
|
Package v1alpha1 ... |
|
v1/tkg/avi
Package avi defines client to connect to the avi server
|
Package avi defines client to connect to the avi server |
|
v1/tkg/avi/mocks
Package avi is a generated GoMock package.
|
Package avi is a generated GoMock package. |
|
v1/tkg/aws
Package aws defines functions to connect to the AWS cloud provider
|
Package aws defines functions to connect to the AWS cloud provider |
|
v1/tkg/aws/ini
Package ini is an LL(1) parser for configuration files.
|
Package ini is an LL(1) parser for configuration files. |
|
v1/tkg/azure
Package azure defines client to connect to Azure cloud
|
Package azure defines client to connect to Azure cloud |
|
v1/tkg/azure/mocks
Package azure is a generated GoMock package.
|
Package azure is a generated GoMock package. |
|
v1/tkg/buildinfo
Package buildinfo ...
|
Package buildinfo ... |
|
v1/tkg/client
Package client implements core functionality of the tkg client
|
Package client implements core functionality of the tkg client |
|
v1/tkg/clientcreator
Package clientcreator defines functions to create clients.
|
Package clientcreator defines functions to create clients. |
|
v1/tkg/clusterclient
Package clusterclient implements generic functions for talking to cluster
|
Package clusterclient implements generic functions for talking to cluster |
|
v1/tkg/cmd
Package cmd defines commands for tkg-cli
|
Package cmd defines commands for tkg-cli |
|
v1/tkg/constants
Package constants provides TKG constants
|
Package constants provides TKG constants |
|
v1/tkg/docker
Package docker ...
|
Package docker ... |
|
v1/tkg/fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
v1/tkg/fakes/helper
Package helper implements helper functions used for unit tests
|
Package helper implements helper functions used for unit tests |
|
v1/tkg/fakes/providers
Package providers ...
|
Package providers ... |
|
v1/tkg/features
Package features provides TKG related feature enablement functionalities
|
Package features provides TKG related feature enablement functionalities |
|
v1/tkg/kappclient
Package kappclient provides CRUD functionality for kapp-controller related resources
|
Package kappclient provides CRUD functionality for kapp-controller related resources |
|
v1/tkg/kind
Package kind provides kind cluster functionalities
|
Package kind provides kind cluster functionalities |
|
v1/tkg/ldap
Package ldap provides ldap configuration verification
|
Package ldap provides ldap configuration verification |
|
v1/tkg/log
Package log provides logging functionalities
|
Package log provides logging functionalities |
|
v1/tkg/providerinterface
Package providerinterface ...
|
Package providerinterface ... |
|
v1/tkg/providersupgradeclient
Package providersupgradeclient provides wrapper for clusterctl upgrade functionalities
|
Package providersupgradeclient provides wrapper for clusterctl upgrade functionalities |
|
v1/tkg/region
Package region provides region context functionalities
|
Package region provides region context functionalities |
|
v1/tkg/test/framework
Package framework implements the test framework.
|
Package framework implements the test framework. |
|
v1/tkg/test/framework/exec
Package exec implements command execution functionality.
|
Package exec implements command execution functionality. |
|
v1/tkg/test/tkgctl/shared
nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint
|
nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint nolint:typecheck,goconst,gocritic,golint,stylecheck,nolintlint |
|
v1/tkg/tkgconfigbom
Package tkgconfigbom provides utilities to read and manipulate BOM files
|
Package tkgconfigbom provides utilities to read and manipulate BOM files |
|
v1/tkg/tkgconfighelper
Package tkgconfighelper provides various helpers and utilities
|
Package tkgconfighelper provides various helpers and utilities |
|
v1/tkg/tkgconfigpaths
Package tkgconfigpaths provides utilities to get info related to TKG configuration paths.
|
Package tkgconfigpaths provides utilities to get info related to TKG configuration paths. |
|
v1/tkg/tkgconfigproviders
Package tkgconfigproviders helps setup and modify configs for TKG supported providers
|
Package tkgconfigproviders helps setup and modify configs for TKG supported providers |
|
v1/tkg/tkgconfigreaderwriter
Package tkgconfigreaderwriter provides utilities to read/write configs
|
Package tkgconfigreaderwriter provides utilities to read/write configs |
|
v1/tkg/tkgconfigupdater
Package tkgconfigupdater provides utilities to update tkg configs
|
Package tkgconfigupdater provides utilities to update tkg configs |
|
v1/tkg/tkgctl
Package tkgctl placeholder package comment
|
Package tkgctl placeholder package comment |
|
v1/tkg/tkgpackageclient
Package tkgpackageclient provides functionality for package plugin
|
Package tkgpackageclient provides functionality for package plugin |
|
v1/tkg/tkgpackagedatamodel
nolint nolint
|
nolint nolint |
|
v1/tkg/types
Package types package to store configs
|
Package types package to store configs |
|
v1/tkg/utils
Package utils adding package comment to satisfy linters
|
Package utils adding package comment to satisfy linters |
|
v1/tkg/vc
Package vc ...
|
Package vc ... |
|
v1/tkg/web/server
Package server providers backend api for UI
|
Package server providers backend api for UI |
|
v1/tkg/web/server/handlers
Package handlers implements api handlers
|
Package handlers implements api handlers |
|
v1/tkg/web/server/restapi
Package restapi Tanzu Kubernetes Grid Setup API Tanzu Kubernetes Grid Setup API.
|
Package restapi Tanzu Kubernetes Grid Setup API Tanzu Kubernetes Grid Setup API. |
|
v1/tkg/web/server/ws
Package ws implements websocket used with UI communications
|
Package ws implements websocket used with UI communications |
|
v1/tkg/yamlprocessor
Package yamlprocessor ...
|
Package yamlprocessor ... |
|
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/types
Package types defines some common types used in TKR.
|
Package types defines some common types used in TKR. |
|
v1/tkr/pkg/utils
Package utils provides some utility functionalities for TKR.
|
Package utils provides some utility functionalities for TKR. |
|
v1/providers/tests
Module
|
|
|
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.