Permalink
Fetching contributors…
Cannot retrieve contributors at this time
100 lines (60 sloc) 5.7 KB

Logo

TK8: A multi-cloud, multi-cluster Kubernetes platform installation and integration tool

TK8 is a command line tool written in Go. It fully automatates the installation of Kubernetes on any environment. With TK8, you are able to centrally manage different Kubernetes clusters with different configurations. In addition, TK8 with its simple add-on integration offers the possibility to quickly, cleanly and easily distribute extensions to the different Kubernetes clusters.

These include a Jmeter cluster for load testing, Prometheus for monitoring, Jaeger, Linkerd or Zippkin for tracing, Ambassador API Gateway with Envoy for Ingress and Load Balancing, Istio as mesh support solution, Jenkins-X for CI/CD integration. In addition, the add-on system also supports the management of Helm packages.

Table of contents

The documentation as well as a detailed table of contents can be found here.

Installation

The TK8 CLI requires some dependencies to perform its tasks. At the moment we still need your help here, but we are working on a setup script that will do these tasks for you.

Terraform

Terraform is required to automatically set up the infrastructure in the desired environment. Terraform Installation

Ansible

Ansible is required to run the automated installation routines in the desired and created environment. Ansible Installation

Kubectl

Kubectl is needed by the CLI to roll out the add-ons and by you to access your clusters. Kubectl Installation

Python and pip

In the automated routines Python scripts are used which uses Pip to load its dependencies. Python Installation pip Installation

AWS IAM Authenticator

If you want to install an EKS cluster with TK8, the AWS IAM Authenticator needs to be available on your system and must be executable (chmod +x <path-to-binary>). It is preffered to have the binary in your $PATH location e.g: (/usr/local/bin). This is included in the provisioner package EKS of the TK8 CLI or can be found in the given link.

Usage

We have described the different target platforms separately in detail in the documentation. But we would like to give you just one example using AWS.

You can get the binary in following ways:

  • Download the executable file for your operating system from the release section.
  • Use go get -u github.com/kubernauts/tk8 to let go fetch the repo along with its dependencies and build the executable for you.
  • Build your own version using the go build command.

Create a separate folder and store the executable binary file there, a configuration file is also required. An example config file is available by the name config.yaml.example. Add the necessary parameters for your cluster along with the AWS API credentials. Alternatively you should export the AWS API credentials in the environment variables because parts of the CLI (EKS cluster) needs them there.

export AWS_SECRET_ACCESS_KEY=xxx export AWS_ACCESS_KEY_ID=xxx

Then execute the CLI with the command: tk8 cluster install aws

With this command the TK8 CLI will create all of the required resources in AWS and installs Kubernetes on it.

If you no longer need the cluster, you can use the command: tk8 cluster destroy aws to automatically remove all of the resources.

Contributing

For provisioning the add-ons we have a separate documentation and examples how you can build your extensions and integrate them into the TK8 project. You can also reach us at Slack.

For a platform provider we have a separate documentation which is only about integrating a platform in TK8. Here you will find detailed instructions and examples on how TK8 will execute your integration or you can also reach us in slack.

To join the community and participate in the discussions going around, you can create an issue or get in touch with us in Slack.

Join us on Kubernauts Slack Channel

Credits

Founder and initiator of this project is Arash Kaffamanesh Founder and CEO of Clouds Sky GmbH and Kubernauts GmbH

The project is supported by cloud computing experts from cloudssky GmbH and Kubernauts GmbH. Christopher Adigun, Arush Salil, Manuel Müller, Nikita, Anoop

A big thanks goes to the contributors of Kubespray whose great work we use as a basis for the setup and installation of Kubernetes in the AWS Cloud.

Furthermore we would like to thank the contributors of kubeadm which is currently not only part of the Kubespray project, but also of the TK8.

Also a big thank you to Wesley Charles Blake, on the basis of which we were able to offer our EKS integration.

License

Tk8 Apache License MIT License EKS MIT License EKS