Skip to content

Latest commit

 

History

History
174 lines (113 loc) · 4.46 KB

databases.md

File metadata and controls

174 lines (113 loc) · 4.46 KB
Raw

Configuring a Database

See Application Templates for a list of supported databases.

The database can be configured in the application's values.yaml located in applications/<your-application>/deploy/values.yaml.

Example

harness:
    ...
    database:
      auto: true
      type: mongo
      image_ref: myownpgimage'
      resources:
        requests:
          memory: "512Mi"
          cpu: "100m"
        limits:
          memory: "2Gi"
          cpu: "1000m"

Available Attributes

auto: If true, db will be automatically deployed in the cluster

type: Specifies which DB technology to use, allowed values: mongo, postgres, neo4j

size: Size of the persistent volume that the database container mounts, default is set to 1Gi

resources: Set the database pod resources

image_ref: Optional setting, used for referencing a base/static image from the build. The complete image name with tag will automagically being generated from the values.yaml file. This setting overrides the image setting specific for the database type (e.g. postgres/image). Note: the referenced image must be included as a build dependency in order to be built by the pipelines.

Specific database settings

Specific database settings are defined using the database key:

harness:
    ...
    database:
      [mongo/postgres/neo4j]:
        image:
        ports:

Common settings

image: specifies the default static image (must be a publicly available image with full tag)

ports: specify one or more ports that are exposed by the database

MongoDB

Defaults:

harness
  database:
    mongo:
      image: mongo:5
      ports:
        - name: http
          port: 27017

Postgres

Defaults:

harness
  database:
    postgres:
      image: postgres:13
      initialdb: cloudharness
      ports:
        - name: http
          port: 5432

initialdb is the default database used

Neo4j

Not yet supported!

Programmatic API

The programmatic API allows you to get the connection string used to configure the database driver (e.g. psycopg2)

Example:

from cloudharness import applications db_connection_string = applications.get_current_configuration().get_db_connection_string()

Configuring Backups

Per default, database backups are disabled. However, you can overwrite backups by overwriting the values-template.yaml, as described in Extend CloudHarness.

Example: deployment-configuration/values-template.yaml

backup:
  active: true

See all the default values here. You can find additional configuration fields for backups to overwrite in the generated deployment/helm/values.yaml once you deploy your applications.

Backups are defined for mongo and postgres database in form of a K8s CronJob that creates a dump of the database and stores it in a different persistent volume on the same cluster.

This is done periodically according to a configurable schedule, per default every 5 minutes.

A smart retention strategy is used for backups, by default:

  • all current days backups
  • one per day, last 7 days
  • one per week, last 4 weeks
  • one per month, last 6 months

Implementation of backups and retention is based on https://github.com/prodrigestivill/docker-postgres-backup-local.

How to monitor and restore backups

Backups are stored in a Kubernetes volume named db-backups.

Can mount the volume to your database pod by adding the following to your db deployment:

...
spec:
  template:
    spec:
      containers:
      - ...
        volumeMounts:
        - name: "db-backups"
          mountPath: /backups
          readOnly: true
      ...
      volumes:
      ...
      - name: "db-backups"
        persistentVolumeClaim:
          claimName: "db-backups"

MongoDB

mongodump is used to create a gzipped archive file of the complete database.

Further reading: MongoDB archiving & compression, MongoDB Backup methods, mongodump

Postgres

pg_dumpall is used to create for each database a gzipped script.

Further reading: pg_dumpall docs