⚠️ Deprecated - Elastisys Compliant Kubernetes Cluster

As of Feb 22, 2021, this repo is no longer actively maintained. This repo has been superseded by compliantkubernetes-kubespray.

Overview

TODO

Cloud providers

Currently we support three cloud providers: Exoscale, Safespring, an CityCloud.

We also have some support for Azure but this is not production grade.

Requirements

BaseOS (tested with 0.0.6)
terraform (tested with 0.12.29)
kubectl (tested with 1.15.2)
jq (tested with jq-1.6)
sops (tested with 3.6.1)
ansible (tested with 2.9.14)
go (tested with 1.13.8)
netaddr (tested with 0.7.19-1)

Note that you will need a BaseOS VM template available at your cloud provider of choice! See the releases for available VM images that can be uploaded to the cloud provider.

Terraform Cloud

The Terraform state is stored in the Terraform Cloud remote backend. If you haven't done so already, you first need to:

Create an account
Add your authentication token in the .terraformrc file. Read more here.

PGP

Configuration secrets in ck8s are encrypted using SOPS. We currently only support using PGP when encrypting secrets. Because of this, before you can start using ck8s, you need to generate your own PGP key:

gpg --full-generate-key

Note that it's generally preferable that you generate and store your primary key and revocation certificate offline. That way you can make sure you're able to revoke keys in the case of them getting lost, or worse yet, accessed by someone that's not you.

Instead create subkeys for specific devices such as your laptop that you use for encryption and/or signing.

If this is all new to you, here's a link worth reading!

Usage

Quickstart

To build the cli simply run the following:

make build

The binary can then be found in dist/ck8s_linux_amd64. You can now move (or create a link to) this binary to a location in your PATH and rename it to ck8s. If you don't, you'll need to replace all the commands referred to as ck8s to be dist/ck8s_linux_amd64.

In order to setup a new Compliant Kubernetes cluster you will need to do the following:

Set the path of your configuration either as the environment variable CK8S_CONFIG_PATH or use the flag --config-path. You also need to set the path to the code which you can do by setting the environment variable CK8S_CODE_PATH or use the flag --code-path (it defaults to ./ so you don't need to set it if you are running it from the repo root). These options are needed for all commands, so it's often recommended to set them as environment variable.

Set the fingerprint of your PGP-key to either CK8S_PGP_FP or use the --pgp-fp flag.

Then run the following:

NOTE: To not cause any confusion from the old cli, we decided to "hard deprecate" the environment variables CK8S_PGP_UID, CK8S_ENVIRONMENT_NAME and CK8S_CLOUD_PROVIDER so make sure those are not set.

ck8s init <environment name> <cloud provider> [--pgp-fp <PGP key fingerprint>] [--config-path <config path>] [--code-path <path to repo root>]

This will create some files that you need to edit to make it work. The minimum requirements is that you edit ${CK8S_CONFIG_PATH}/tfvars.json to include your IP address in the whitelists and that you add your credentials to the sops encrypted file ${CK8S_CONFIG_PATH}/secrets.yaml. See here for more information

Note that if there already exists a terraform workspace with the same name as your environment name, then you may need to destroy it before you continue to the next step. You can remove the workspace either through the terraform cli or via the backend it is stored in.

Make sure you are logged in to terraform cli (or that you have a valid token in ~/.terraformrc) and run:

ck8s apply --cluster sc
ck8s apply --cluster wc

The cluster should now be up and running. You can verify this with:

ck8s status --cluster sc
ck8s status --cluster wc

Completion

To enable completion you can source the code generated by running ck8s completion <shell>. See ck8s completion --help for more details and examples.

Configuration

Some configurations do not have default values and needs to be set before the cluster can be created. These are the values that needs to be provided by you

`backend.hcl`

Organization: The organization to use in Terraform Cloud

`config.yaml`

Citycloud/Safespring only

os_project_domain_name: Openstack project domain name to use
os_project_id: Openstack project ID to use
os_user_domain_name: Openstack user domain name to use

`tfvars.json`

public_ingress_cidr_whitelist: IP whitelist of ssh port
api_server_whitelist: IP whitelist of api server
nodeport_whitelist: IP whitelist of the nodeports (30000-32767)

`secrets.yaml`

Exoscale only

exoscale_api_key: API key to exoscale
exoscale_secret_key: Secret key to exoscale

Citycloud/Safespring only

os_username: Openstack username
os_password: Openstack password

Development

When developing the cli the most convenient way of running the cli is:

go run ./cmd/ck8s

elastisys/ck8s-cluster