Manifest settings for databases

Overview

This reference doc details all the Manifest settings for data, caching and storage components. If you’re unfamiliar with Manifest files and how they work, please follow our getting started guide and detailed how-to guide.

If you’re looking for the Manifest settings for webservers & frameworks or load balancers, please see our respective reference documents for those components.

Key to table headings

• Option - the name of the setting as used in the YAML of your Manifest file
• Applied on - the type of deployment required to update this setting. In many cases settings only apply when an application is first built, or when new servers are created or it is cloned. Hover over the names of each condition to see more info.
• Clouds - the cloud providers on which a setting can be used.

ElasticSearch

Elasticsearch is a search engine based on the Lucene library. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.

The following settings are available via the Manifest file:

Example YAML for ElasticSearch

elasticsearch:
  groups:
    my_main:
      configuration:
        iam_instance_profile_name: elastic-perms
        version: 0.90.7
        root_disk_size: 1000
        root_disk_type: ssd
    my_spare:
      configuration:
        root_disk_size: 100

GlusterFS

GlusterFS is a scalable network filesystem suitable for data-intensive tasks such as cloud storage and media streaming.

Restrictions with GlusterFS

• Renaming a volume will actually delete that volume and create a new one.
• After you change the volume list, you need to redeploy your application for new configuration be applied to your application.
• You cannot change replica_count after GlusterFS added to your application.
• You cannot use glusterfs group or any of its servers in mount_targets.

The following settings are available via the Manifest file:

Example YAML for GlusterFS

glusterfs:
  configuration:
    version: 3.7
    replica_count: 2
    mount_targets: ['app','redis']
    volumes:
      -  volume:
         name: images-data
         mount: "/mnt/images"
         access_control:
           read: ['web', 'api']
           write: ['web']
      -  volume:
         name: videos
         mount: /mnt-data/videos
         access_control:
           read: ['web']
           write: ['web']

Memcached

Memcached is a general-purpose distributed memory-caching system. It is often used to speed up dynamic database-driven websites by caching data and objects in RAM to reduce the number of times an external data source must be read.

The following settings are available via the Manifest file :

Example YAML for Memcached

memcached:
  configuration:
    memory: 1024
    port: 11211
    listen_ip: 127.0.0.1

MongoDB

MongoDB is a cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas.

The following settings are available via the Manifest file :

Example YAML for MongoDB

mongodb:
  groups:
    my_mongo:
      configuration:
        version: 2.4.8
        root_disk_size: 100
        root_disk_type: ssd
    spare_mongo:
      configuration:
        version: 2.4.8

MySQL

MySQL is an open-source relational database management system.

The following settings are available via the Manifest file :

Example YAML for MySQL

mysql:
  groups:
    live-db:
      configuration:
        version: 5.7
        root_disk_size: 100
        root_disk_type: ssd
        engine: percona
        iam_instance_profile_name: mysql-perms
    upgrade:
      configuration:
        version: 8.0
        root_disk_size: 100
        root_disk_type: ssd
        engine: percona
        iam_instance_profile_name: mysql-perms

PostgreSQL

PostgreSQL is a powerful, open source object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

The following settings are available via the Manifest file :

Example YAML for PostgreSQL

postgresql:
  groups:
    live-data:
      configuration:
        iam_instance_profile_name: psql-perms
        version: 9.3.4
        postgis: true
        root_disk_size: 100
        root_disk_type: ssd
    spare-data:
      configuration:
        version: 9.3.4

Example YAML for PostGIS

postgresql:
  configuration:
    postgis:
      version: 2.1.1

Redis

Redis is an in-memory data structure store, used as a distributed, in-memory key–value database, cache and message broker, with optional durability.

The following settings are available via the Manifest file :

Example YAML for Redis

redis:
  configuration:
    version: 5.0.5
    root_disk_size: 100
    root_disk_type: ssd
    iam_instance_profile_name: redis-perms

More on Manifest files

• Getting started guide
• Detailed how-to guide
• Understanding manifest files

Need help with deployments?

Contact Support

More Questions?

Join the Slack Channel