aws-operator

README

aws-operator

The aws-operator manages Kubernetes clusters running on AWS.

Branches

• thiccc
  • Up to and including version v5.4.0.
  • Contains all versions of legacy controllers (reconciling AWSConfig CRs) up to and including v5.4.0.
• legacy
  • In version range >= v5.5.0 and < v6.0.0.
  • Used for development of features for legacy (i.e. non-node pools) clusters.
  • Contains only the latest version of legacy controllers (reconciling AWSConfig CRs).
• legacy-1-15
  • In version range >= v5.5.0 and < v5.6.0.
  • Includes Kubernetes 1.15 only.
  • Contains only the latest version of legacy controllers (reconciling AWSConfig CRs).
• master
  • From version v6.0.0.
  • Contains only the latest version of controllers (reconciling cluster API objects).

Getting Project

Download the latest release: https://github.com/giantswarm/aws-operator/releases/latest

Clone the git repository: https://github.com/giantswarm/aws-operator.git

Download the latest docker image from here: https://quay.io/repository/giantswarm/aws-operator

How to build

Build the standard way.

go build github.com/giantswarm/aws-operator

Architecture

The operator uses our operatorkit framework. It manages an awsconfig CRD using a generated client stored in our apiextensions repo. Releases are versioned using version bundles.

The operator provisions guest Kubernetes clusters running on AWS. It runs in a host Kubernetes cluster also running on AWS.

CloudFormation

The guest Kubernetes clusters are provisioned using AWS CloudFormation. The resources are split between 3 CloudFormation stacks.

• guest-main manages the guest cluster resources.
• host-setup manages an IAM role used for VPC peering.
• host-main manages network routes for the VPC peering connection.

The host cluster may run in a separate AWS account. If so resources are created in both the host and guest AWS accounts.

Other AWS Resources

As well as the CloudFormation stacks we also provision a KMS key and S3 bucket per cluster. This is to upload cloudconfigs for the cluster nodes. The cloudconfigs contain TLS certificates which are encrypted using the KMS key.

Kubernetes Resources

The operator also creates a Kubernetes namespace per guest cluster with a service and endpoints. These are used by the host cluster to access the guest cluster.

Certificates

Authentication for the cluster components and end-users uses TLS certificates. These are provisioned using Hashicorp Vault and are managed by our cert-operator.

Secret

Here the AWS IAM credentials have to be inserted.

service:
  aws:
    accesskey:
      id: 'TODO'
      secret: 'TODO'

Here the base64 representation of the data structure above has to be inserted.

apiVersion: v1
kind: Secret
metadata:
  name: aws-operator-secret
  namespace: giantswarm
type: Opaque
data:
  secret.yml: 'TODO'

To create the secret manually do this.

kubectl create -f ./path/to/secret.yml

We also need a key to hold the SSH public key

apiVersion: v1
kind: Secret
metadata:
  name: aws-operator-ssh-key-secret
  namespace: giantswarm
type: Opaque
data:
  id_rsa.pub: 'TODO'

Contact

• Mailing list: giantswarm
• IRC: #giantswarm on freenode.org
• Bugs: issues

Contributing & Reporting Bugs

See CONTRIBUTING for details on submitting patches, the contribution workflow as well as reporting bugs.

License

aws-operator is under the Apache 2.0 license. See the LICENSE file for details.

Credit

• https://golang.org
• https://github.com/giantswarm/microkit