service-operator

README

Service Operator

We aim for this to be our generic service operator, with a hope for it to be a provider agnostic one. The reason being, a desire to run the stack locally, without the worry of providing live database connections to a local deployment.

Adding new services

Say you have a desire to add a new service to the mix. We're using Kubebuilder as our generator for all the things.

To get started, install Kubebuilder locally and run:

kubebuilder create api --group database --version v1beta1 --kind MySQL
...
kubebuilder create api --group queue --version v1beta1 --kind RabbitMQ

Where --group defines the general nature of the service and --kind defines the engine we'd like to run.

This will generate some api/, config/ and controller/ files, which you may want to look into. It usually comes with a nice set of comments, which will explain to you, what needs to be done in each section to get to your desired state.

Note, that because it's essentially a generator, for most changes to the codebase, you may want to run make generate.

PostgreSQL via AWS RDS

Given a configuration file of the form:

---
apiVersion: database.govsvc.uk/v1beta1
kind: Postgres
metadata:
  name: postgres-sample
spec:
  aws:
    diskSizeGB: 150
    instanceType: db.m5.large

This service operator will create a Postgres database in AWS RDS, and generate a secret only available to that namespace, containing all required data.

Updating manifests and gsp-cluster chart

Run the following to regenerate the CRDs, roles and any other generated artifacts:

make manifests

Run the following to update the gsp-cluster chart (parent project) with any manifests

make update-chart

Running tests

The simplest way the the tests is as part of the Docker build. This will run the tests with mocked clients:

docker build .

To run the tests against a real AWS account you can set AWS_INTEGRATION=true and pass through any required environment variables. The (./hack/test_integration.sh)[./hack/test_integration.sh] script sets up the environment for running tests against the sandbox account and can be combined with the gds cli to execute the tests:

gds aws gsp-sandbox-admin -- ./hack/test_integration.sh