Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 2.86 KB

quickstart.md

File metadata and controls

111 lines (78 loc) · 2.86 KB
Raw

Quickstart

This guide aims to give you a quick look and feel for using the Database Interface on a local Kubernetes environment.

Prerequisites

Kubernetes

For local tests we recommend to use one of the following solutions:

  • minikube, which creates a single-node K8s cluster inside a VM (requires KVM or VirtualBox),
  • kind and k3d, which allows creating multi-nodes K8s clusters running on Docker (requires Docker)

Postgres

For the quick installation you can use Zalando Postgres Operator

The Postgres Operator can be deployed in the following way:

kubectl apply -k github.com/zalando/postgres-operator/manifests

Check if Postgres Operator is running

kubectl get pod -l name=postgres-operator

If the operator pod is running it listens to new events regarding postgresql resources. Now, it's time to submit your first Postgres cluster manifest.

kubectl create -f https://raw.githubusercontent.com/zalando/postgres-operator/master/manifests/minimal-postgres-manifest.yaml

Now you can retrieve the database password:

kubectl get secret postgres.acid-minimal-cluster.credentials.postgresql.acid.zalan.do -o 'jsonpath={.data.password}' | base64 -d

The database user is postgres

Database Interface CRDs

Before you deploy database-controller and sidecar-controller you have to deploy the Database Interface API CRDs. Clone database-interface-api

Deploy CRDs from manifests:

kubectl create -f config/crd/bases/

Now it's time to deploy database and sidecar controllers.

First deploy database-controller

kubectl create -f config/resources/database-controller

Go to config/resources/sidecar-controller and update secret.yaml file with Postgres parameters:

...
...
stringData:
  DB_HOST: "acid-minimal-cluster"
  DB_PASSWORD: "password"
  DB_PORT: "5432"
  DB_USER: "postgres"

Deploy sidecar-controller together with postgres driver:

kubectl create -f config/resources/sidecar-controller

The next step is to create database and get secret wit the credentials. All necessary files you can find here: config/samples. You have to install DatabaseClass and DatabaseAccessClass:

kubectl create -f config/samples/database_class.yaml
kubectl create -f config/samples/database_access_class.yaml

Now you can deploy database:

kubectl create -f config/samples/database_request.yaml

Check database status:

kubectl get databases

When it's ready you can request for the database credentials:

kubectl create -f config/samples/database_access_request.yaml

You should be able to get the secret:

kubectl get secret database-sample