VMware Tanzu Kubernetes Grid Integrated Edition Documentation

This repository contains the content for the documentation for Tanzu Kubernetes Grid Integrated Edition (TKGI).

In versions 1.7 and earlier, the product was named Enterprise PKS, not TKGI, and those versions of the document set continue to use the name Enterprise PKS.

Sites

The content in this repository publishes to the documentation sites at https://docs.pivotal.io/tkgi/index.html and https://docs.pivotal.io/pks/index.html.

How To Contribute

Please help us improve the accuracy and completeness of the TKGI documentation by contributing.

One way to to contribute is to file a pull request through GitHub.

Every topic in the documentation has a corresponding file in this repository. Locate the correct file and make a pull request against it. You can also navigate to a topic in the TKGI or Enterprise PKS documentation site and click "View the source for this page in GitHub" at the bottom of the topic to locate the source file of the topic.

Versions and Branching

Branch Name	Content	Location
`1.18`	TKGI 1.18 released content	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.18/tkgi/
`1.17`	TKGI 1.17 released content	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.17/tkgi/
`1.16`	TKGI 1.16 released content	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.16/tkgi/GUID-release-notes.html
`1.15`	TKGI 1.15 released content	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.15/tkgi/GUID-release-notes.html
`1.14`	TKGI 1.14 released content	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.14/tkgi/GUID-release-notes.html
`1.13`	Reached End of General Support	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.13/tkgi/GUID-release-notes.html
`1.12`	Reached End of General Support	https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.12/tkgi/GUID-release-notes.html
`1.11`	Reached End of General Support	https://docs.pivotal.io/tkgi/1-11/index.html
`1.10`	Reached End of General Support	https://docs.pivotal.io/tkgi/1-10/index.html
`1.9`	Reached End of General Support	https://docs.pivotal.io/tkgi/1-9/index.html
`1.8`	Reached End of General Support	https://docs.pivotal.io/tkgi/1-8/index.html
`1.7`	Reached End of General Support	https://docs.pivotal.io/pks/1-7/index.html
`1.6`	Reached End of General Support	https://docs.pivotal.io/pks/1-6/index.html
`1.5`	Reached End of General Support	https://docs.pivotal.io/pks/1-5/index.html
`1.4`	Reached End of General Support	https://docs.pivotal.io/pks/1-4/index.html
`1.3`	Reached End of General Support	https://docs.pivotal.io/pks/1-3/index.html
`1.2`	Not in use	N/A (PDF available)
`1.1`	Not in use	N/A (PDF available)
`1.0-publish`	Not in use	N/A (PDF available)
`0.8`	Not in use	N/A
`pks-patches`	Staging site for not-yet-released TKGI and Enterprise PKS patches.	Publishes to an internal staging site only.

1.17: The 1.17 branch is used to publish the pre-release v1.17 version of the site. Create pull requests on 1.17 to contribute bug fixes or correct technical inaccuracies in the v1.17 documentation.

1.16: The 1.16 branch is used to publish the live v1.16 version of the site. Create pull requests on 1.16 to contribute bug fixes or correct technical inaccuracies in the v1.16 documentation.

1.15: The 1.15 branch is used to publish the live v1.15 version of the site. Create pull requests on 1.15 to contribute bug fixes or correct technical inaccuracies in the v1.15 documentation.

1.14: The 1.14 branch is used to publish the live v1.14 version of the site. Create pull requests on 1.14 to contribute bug fixes or correct technical inaccuracies in the v1.14 documentation.

1.13: This branch is no longer maintained.

1.12: This branch is no longer maintained.

1.11: This branch is no longer maintained.

1.10: This branch is no longer maintained.

1.8: This branch is no longer maintained.

1.7: This branch is no longer maintained.

1.6: This branch is no longer maintained.

1.6.x-patch-releases: This branch is no longer maintained.

1.5: This branch is no longer maintained.

1.5.x-patch-releases: This branch is no longer maintained.

1.4: This branch is no longer maintained.

1.4.x-patch-releases: This branch is no longer maintained.

1.3: This branch is no longer maintained.

1.3.x-patch-releases: This branch is no longer maintained.

The 1.2 branch is no longer maintained. A PDF of the Enterprise PKS v1.2 documentation is available at https://resources.docs.pivotal.io/pdfs/pks-docs-1.2.pdf.

The 1.1 branch is no longer maintained. A PDF of the Enterprise PKS v1.1 documentation is available at https://resources.docs.pivotal.io/pdfs/pks-docs-1.1.pdf.

The 1.0-publish and 0.8 branches are no longer maintained. A PDF of the Enterprise PKS v1.0 documentation is available at https://resources.docs.pivotal.io/pdfs/pks-docs-1.0.pdf.

Publishing TKGI documentation

TKGI v1.12 and later documentation is formatted for publishing via a VMware DocWorks Markdown Publishing pipeline. TKGI v1.11 and earlier documentation is formatted for use in a Bookbinder-based pipeline. You cannot reliably preview published document formatting of content formatted with VMware DocWorks pipeline-formatted content.

How To Use Bookbinder To View Your Documentation

Bookbinder is a command-line utility for stitching Markdown documents into a hostable web app. The documentation team uses Bookbinder to publish our documentation sites, but you can also use Bookbinder to view a live version of your documentation on your local machine.

Bookbinder draws the content for the site from this repository, the left navigation menu ("subnav") from docs-book-pks, and various layout configuration and assets from docs-layout-repo.

To use Bookbinder to view your documentation, perform the following steps:

Clone this repository to the ~/workspace directory on your local machine.
Clone docs-book-pks and docs-layout-repo to the ~/workspace directory on your local machine.
Navigate into the docs-book-pks directory.
Run bundle install to install all of the necessary gems, including Bookbinder.
Run bundle exec bookbinder bind local to build a Rack web-app of the book. After the bind has completed, navigate into the final_app directory and run rackup. Then navigate to localhost:9292/tkgi/1-10/index.html in a browser.

Name		Name	Last commit message	Last commit date
Latest commit History 8,925 Commits
cli		cli
demos		demos
images		images
solutions		solutions
.gitignore		.gitignore
CODE-OF-CONDUCT.md		CODE-OF-CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LEGAL.txt		LEGAL.txt
LICENSE		LICENSE
README.md		README.md
_add-clusters-workloads.html.md.erb		_add-clusters-workloads.html.md.erb
_api.html.md.erb		_api.html.md.erb
_apply-changes.html.md.erb		_apply-changes.html.md.erb
_azs-networks-azure.html.md.erb		_azs-networks-azure.html.md.erb
_azs-networks.html.md.erb		_azs-networks.html.md.erb
_bbr-supported-components.html.md.erb		_bbr-supported-components.html.md.erb
_bbr-unsupported-components.html.md.erb		_bbr-unsupported-components.html.md.erb
_beta-component.html.md.erb		_beta-component.html.md.erb
_bosh-ssh-api.html.md.erb		_bosh-ssh-api.html.md.erb
_bosh-ssh-db.html.md.erb		_bosh-ssh-db.html.md.erb
_cloud-provider.html.md.erb		_cloud-provider.html.md.erb
_cluster-monitoring.html.md.erb		_cluster-monitoring.html.md.erb
_console-usage-data.html.md.erb		_console-usage-data.html.md.erb
_create-auth-token-var.html.md.erb		_create-auth-token-var.html.md.erb
_errands.html.md.erb		_errands.html.md.erb
_expose-external-lb.html.md.erb		_expose-external-lb.html.md.erb
_global-proxy.html.md.erb		_global-proxy.html.md.erb
_harbor.html.md.erb		_harbor.html.md.erb
_host-monitoring.html.md.erb		_host-monitoring.html.md.erb
_ic-network-profile.html.md.erb		_ic-network-profile.html.md.erb
_increase_persistent_disk.html.md.erb		_increase_persistent_disk.html.md.erb
_install-cli.html.md.erb		_install-cli.html.md.erb
_install.html.md.erb		_install.html.md.erb
_k8s-profiles-uses.html.md.erb		_k8s-profiles-uses.html.md.erb
_lb-resource-config.html.md.erb		_lb-resource-config.html.md.erb
_login-api.html.md.erb		_login-api.html.md.erb
_network-profiles-uses.html.md.erb		_network-profiles-uses.html.md.erb
_networking-vsphere.html.md.erb		_networking-vsphere.html.md.erb
_nsx-t-ingress-lb-overview.html.md.erb		_nsx-t-ingress-lb-overview.html.md.erb
_other-super-certificates.html.md.erb		_other-super-certificates.html.md.erb
_plans.html.md.erb		_plans.html.md.erb
_ports-protocols-sphere.html.md.erb		_ports-protocols-sphere.html.md.erb
_ports-protocols.html.md.erb		_ports-protocols.html.md.erb
_preparing-for-bbr.html.md.erb		_preparing-for-bbr.html.md.erb
_prerequisites.html.md.erb		_prerequisites.html.md.erb
_proxy-ops-man.html.md.erb		_proxy-ops-man.html.md.erb
_resource-config-connected.html.md.erb		_resource-config-connected.html.md.erb
_resource-config.html.md.erb		_resource-config.html.md.erb
_saml-sso-login.html.md.erb		_saml-sso-login.html.md.erb
_scale-to-ha-upgrade.html.md.erb		_scale-to-ha-upgrade.html.md.erb
_share-endpoint.html.md.erb		_share-endpoint.html.md.erb
_sink-resources.html.md.erb		_sink-resources.html.md.erb
_ssh-cluster-master-node.html.md.erb		_ssh-cluster-master-node.html.md.erb
_storage-config.html.md.erb		_storage-config.html.md.erb
_tmc.html.md.erb		_tmc.html.md.erb
_uaa-admin-login.html.md.erb		_uaa-admin-login.html.md.erb
_uaa-scopes.html.md.erb		_uaa-scopes.html.md.erb
_uaa.html.md.erb		_uaa.html.md.erb
_usage-data.html.md.erb		_usage-data.html.md.erb
_vrealize-logs.html.md.erb		_vrealize-logs.html.md.erb
_vsphere_versions.html.md.erb		_vsphere_versions.html.md.erb
about-lb.html.md.erb		about-lb.html.md.erb
admission-plugins-disable.html.md.erb		admission-plugins-disable.html.md.erb
admission-plugins.html.md.erb		admission-plugins.html.md.erb
api-auth.html.md.erb		api-auth.html.md.erb
aws-api-load-balancer.html.md.erb		aws-api-load-balancer.html.md.erb
aws-cluster-load-balancer.html.md.erb		aws-cluster-load-balancer.html.md.erb
aws-configure-users.html.md.erb		aws-configure-users.html.md.erb
aws-index.html.md.erb		aws-index.html.md.erb
aws-om-install-config.html.md.erb		aws-om-install-config.html.md.erb
aws-requirements.html.md.erb		aws-requirements.html.md.erb
azure-ad-sso-config.html.md.erb		azure-ad-sso-config.html.md.erb
azure-api-load-balancer.html.md.erb		azure-api-load-balancer.html.md.erb
azure-cluster-load-balancer.html.md.erb		azure-cluster-load-balancer.html.md.erb
azure-configure-users.html.md.erb		azure-configure-users.html.md.erb
azure-index.html.md.erb		azure-index.html.md.erb
azure-managed-identities.html.md.erb		azure-managed-identities.html.md.erb
azure-om-install-config.html.md.erb		azure-om-install-config.html.md.erb
azure-requirements.html.md.erb		azure-requirements.html.md.erb
backup-and-restore-clusters.html.md.erb		backup-and-restore-clusters.html.md.erb
backup-and-restore-infra.html.md.erb		backup-and-restore-infra.html.md.erb
backup-and-restore-intro.html.md.erb		backup-and-restore-intro.html.md.erb
backup-and-restore-nsxt.html.md.erb		backup-and-restore-nsxt.html.md.erb
backup-and-restore-tkgi.html.md.erb		backup-and-restore-tkgi.html.md.erb
backup-and-restore-vcenter.html.md.erb		backup-and-restore-vcenter.html.md.erb
backup-and-restore-work.html.md.erb		backup-and-restore-work.html.md.erb
backup-and-restore.html.md.erb		backup-and-restore.html.md.erb
bbr-backup-clusters.html.md.erb		bbr-backup-clusters.html.md.erb
bbr-backup-tkgi.html.md.erb		bbr-backup-tkgi.html.md.erb
bbr-backup.html.md.erb		bbr-backup.html.md.erb
bbr-install-config.html.md.erb		bbr-install-config.html.md.erb
bbr-install.html.md.erb		bbr-install.html.md.erb
bbr-logging.html.md.erb		bbr-logging.html.md.erb
bbr-restore-clusters.html.md.erb		bbr-restore-clusters.html.md.erb
bbr-restore-tkgi.html.md.erb		bbr-restore-tkgi.html.md.erb
bbr-restore.html.md.erb		bbr-restore.html.md.erb
bosh-vm-extensions.html.md.erb		bosh-vm-extensions.html.md.erb
certificate-concepts.html.md.erb		certificate-concepts.html.md.erb
checklist.html.md.erb		checklist.html.md.erb
cluster-credentials.html.md.erb		cluster-credentials.html.md.erb

License

pivotal-cf/docs-pks

Folders and files

Latest commit

History