Tectonic Installer

Tectonic is built on pure-upstream Kubernetes but has an opinion on the best way to install and run a Kubernetes cluster. This project helps you install a Kubernetes cluster the "Tectonic Way". It provides good defaults, enables install automation, and is customizable to meet your infrastructure needs.

Goals of the project:

• Install Kubernetes clusters
• Secure by default (uses TLS, RBAC by default, OIDC AuthN, etcd)
• Automatable install process for scripts and CI/CD
• Deploy on any infrastructure: Amazon AWS, Microsoft Azure, OpenStack, Google Cloud, bare metal
• Run on any OS: Container Linux (the default), RHEL, Ubuntu, and others
• Customizable and modular: Change DNS providers, security settings, authentication providers
• Highly Available by default: Deploy all Kubernetes components HA, use etcd Operator

Note: the project has recently undergone some rearchitecting to support our goal of providing automatic operations, most notably automatic updates, to Kubernetes clusters. The master branch of the project reflects this new design approach and currently provides support only for AWS. In order to deploy Tectonic to other platforms, e.g. Azure, bare metal, OpenStack, etc, please checkout the track-1 branch of this project, which maintains support for the previous architecture and more platforms.

Getting Started

To use a tested release on a supported platform, follow the links below.

To hack or modify the templates or add a new platform, use the scripts in this repo to boot and tear down clusters.

Official releases

See the official Tectonic documentation:

• AWS using a GUI [stable]
• AWS using Terraform CLI [stable]
• Azure using Terraform [stable]
• Bare metal using a GUI [stable]
• Bare metal using Terraform CLI [stable]

Hacking

These instructions can be used for AWS:

1. Build the project

   bazel build tarball

   Note: the project can optionally be built without installing Bazel, provided Docker is installed:

   docker run --rm -v $PWD:$PWD:Z -w $PWD quay.io/coreos/tectonic-builder:bazel-v0.3 bazel --output_base=.cache build tarball

2. Extract the tarball

   tar -zxf bazel-bin/tectonic-dev.tar.gz
   cd tectonic-dev

3. Add binaries to $PATH

   export PATH=$(pwd)/installer:$PATH

4. Edit Tectonic configuration file including the $CLUSTER_NAME

   $EDITOR examples/tectonic.aws.yaml

5. Init Tectonic CLI

   tectonic init --config=examples/tectonic.aws.yaml

6. Install Tectonic cluster

   tectonic install --dir=$CLUSTER_NAME

7. Teardown Tectonic cluster

   tectonic destroy --dir=$CLUSTER_NAME

Managing Dependencies

Go

We follow a hard flattening approach; i.e. direct and inherited dependencies are installed in the base vendor/.

Dependencies are managed with glide but committed directly to the repository. If you don't have glide, install the latest release from https://glide.sh/. We require version 0.12 at a minimum.

The vendor directory is pruned using glide-vc. Follow the installation instructions in the project's README.

To add a new dependency:

• Edit the glide.yaml file to add your dependency.
• Ensure you add a version field for the sha or tag you want to pin to.
• Revendor the dependencies:

rm glide.lock
glide install --strip-vendor
glide-vc --use-lock-file --no-tests --only-code
bazel run //:gazelle

If it worked correctly it should:

• Clone your new dep to the /vendor dir and check out the ref you specified.
• Update glide.lock to include your new package, add any transitive dependencies and update its hash.
• Regenerate BUILD.bazel files.

For the sake of your fellow reviewers, commit vendored code separately from any other changes.

Tests

See tests/README.md.