Skip to content
This repository was archived by the owner on Oct 10, 2023. It is now read-only.

Commit fb71679

Browse files
author
Anuj Chaudhari
authored
Add README for packages (#3384)
Signed-off-by: Anuj Chaudhari <[email protected]>
1 parent 0785f39 commit fb71679

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

packages/README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Packages
2+
3+
This directory contains two types of packages. Management Packages and Standalone Packages
4+
5+
## Management Packages
6+
7+
This directory contains some carvel packages for management components. Any package that performs the role of managing and operating a workload cluster is a Management package. These management packages are purpose-built to be installed on the management cluster. More details about packages can be found [here](../docs/packages/definitions.md)
8+
9+
These management packages are associated with each other in terms of [Meta Package](../docs/packages/definitions.md#meta-package). A Meta Package contains PackageInstall CRs, Secrets and ServiceAccounts, RBAC rules that are needed to install other packages and when the meta package is installed, it installs the other packages.
10+
11+
Below is the hierarchy of management packages association:
12+
13+
- tkg (TKG Meta Package)
14+
- framework (Framework Meta Package)
15+
- addons-manager
16+
- tkr-service
17+
- featuregates
18+
- tanzu-auth
19+
- cliplugins
20+
- tkg-clusterclass (TKG ClusterClass Meta Package)
21+
- tkg-clusterclass-docker
22+
- tkg-clusterclass-aws
23+
- tkg-clusterclass-azure
24+
- tkg-clusterclass-vsphere
25+
- core-management-plugins
26+
- tkr-source-controller
27+
28+
As part of the Bootstrap and Management Cluster creation, the `management-cluster` plugin installs the `tkg` meta package which installs all child packages. As part of this package installation the `management-cluster` plugin creates a [values.yaml](./tkg/bundle/config/values.yaml) file based on the user input. The configuration is then propagated to child packages based on overlays written within the package.
29+
30+
There are few management packages created under this directory which are not used at the moment and not integrated with the `tkg` meta package. Below is the list of these packages:
31+
32+
- cluster-api
33+
- cluster-api-bootstrap-kubeadm
34+
- cluster-api-control-plane-kubeadm
35+
- cluster-api-provider-aws
36+
- cluster-api-provider-azure
37+
- cluster-api-provider-docker
38+
- cluster-api-provider-vsphere
39+
40+
## Standalone Packages
41+
42+
This type of carvel packages are individual packages that don't depend on other packages. Below is the list of standalone packages:
43+
44+
- standalone-plugins
45+
- capabilities
46+
- tkg-autoscaler
47+
- tkg-storageclass

0 commit comments

Comments
 (0)