Kubo is a BOSH release for Kubernetes. It provides a solution for deploying and managing Kubernetes with BOSH
This repository contains the documentation and manifests for deploying kubo-release with BOSH.
Slack: #kubo on https://slack.cloudfoundry.org Pivotal Tracker: https://www.pivotaltracker.com/n/projects/2093412
Build Kubo Release status
| Job | GCP with CF routing pipeline Status | GCP with load balancer status | vSphere status |
|---|---|---|---|
| Install BOSH | |||
| Deploy K8s | |||
| Run smoke tests |
See the complete pipeline for more details. The CI pipeline definitions are stored in the kubo-ci repository.
A specialized BOSH director manages the virtual machines for the Kubo instance. This involves VM creation, health checking, and resurrection of missing or unhealthy VMs. The BOSH director includes CredHub and PowerDNS to handle certificate generation within the kubo clusters. Additionally, Credhub is used to store the auto-generated passwords.
The nodes that run the Kubernetes API (master nodes) are exposed through an IaaS specific load balancer. The load balancer will have an external static IP address that is used as a public and internal endpoint for traffic to the Kubernetes API.
Kubernetes services can be exposed using a second IaaS specific load balancer which forwards traffic to the Kubernetes worker nodes.
The nodes that run the Kubernetes API (master nodes) register themselves with the Cloud Foundry TCP router. The TCP Router acts as both public and internal endpoint for the Kubernetes API to route traffic to the master nodes of a Kubo instance. All traffic to the API goes through the Cloud Foundry TCP router and then to a healthy node.
The Cloud Foundry subnet must be able to route traffic directly to the Kubo subnet. It is recommended to keep them in separate subnets when possible to avoid the BOSH directors from trying to provision the same addresses. This diagram specifies CIDR ranges for demonstration purposes as well as a public router in front of the Cloud Foundry gorouter and tcp-router which is typical.
- Kubo - Kubernetes on BOSH
- Bastion - A server within the kubo network that provides secure access to kubo.
- Kubo environment Configuration - Folder that contains all configuration files needed to deploy BOSH and Kubo, as well as all
configuration files that are generated during deployment. Also called
<KUBO_ENV> - Creds - Credentials that are generated during BOSH deployment process and stored in
<KUBO_ENV>/creds.yml - Service - stands for K8s service, which represents a logical collection of Kubernetes pods and a way to access them without needing information about the specific pods
Please follow the install guide for installation instructions.
Please refer to the troubleshooting guide to look for solutions to the most common issues.
Review the following documentation to get a better understanding of Cloud Foundry and Kubernetes architectures.
For instructions on contributing to this project, please see CONTRIBUTING.md.