localdev.md

Local development

This document describes how to develop Trousseau on your local machine.

Requirements:

• install and set up Docker
• install taskfile https://taskfile.dev/#/installation

Run Trousseau components

task go:run:proxy
task go:run:debug
task go:run:trousseau

Start cluster with encryption support

For local testing we suggest to use Kind to create a cluster. Everything is configured for you so please run the command below:

task cluster:create

You are ready for create secrets!

Verify secret encryption

To verify encryption please create a secret and check value in ETCD.

kubectl create secret -n default generic trousseau-test --from-literal=FOO=bar
kubectl get secret -o yaml
docker exec kms-vault-control-plane bash -c 'apt update && apt install -y etcd-client' # only once
docker exec -it -e ETCDCTL_API=3 -e SSL_OPTS='--cacert=/etc/kubernetes/pki/etcd/ca.crt --cert=/etc/kubernetes/pki/apiserver-etcd-client.crt --key=/etc/kubernetes/pki/apiserver-etcd-client.key --endpoints=localhost:2379' kms-vault-control-plane \
bash -c 'etcdctl $SSL_OPTS get --keys-only=false --prefix /registry/secrets/default'

You have to see encrypted data in ETCD dump.

Cleanup cluster

After you have finished fun on Trousseau you should terminate the cluster with the following command:

task cluster:delete

Run end to end tests

Test are found in tests/e2e/kuttl directory. To run full test please execute the command below:

task go:e2e-tests:debug