Configuration

Hydroplane is configured by passing a configuration YAML file to it with the -c/--conf flag. By default, Hydroplane will read its configuration from basic-config.yml.

To provide your own configuration file to Hydroplane, write your configuration YAML to a file (e.g. conf.yml) and run Hydroplane like so:

bin/hydroplane -c conf.yml

There are two things that need to be configured in settings: Hydroplane’s runtime and its secret store. Optionally, you can also configure the process culler.

Example Configurations

Here’s a basic example of a configuration file that uses the none secret store and the docker runtime:

---
secret_store:
  secret_store_type: none

runtime:
  runtime_type: docker

and another example that uses the local secret store and the eks runtime:

---
secret_store:
  secret_store_type: local
  store_location: ~/.hydro_secrets

runtime:
  runtime_type: eks
  cluster_name: test-cluster
  region: us-west-2
  credentials:
    access_key:
      access_key_id:
        secret_name: aws-credentials
        key: AccessKeyId
      secret_access_key:
        secret_name: aws-credentials
        key: SecretAccessKey

Here’s an example that’s using the same runtime and secret store as the Docker example above, but also configures process culling (see the process culler documentation for more information on how to configure process culling):

---
secret_store:
  secret_store_type: none

runtime:
  runtime_type: docker

process_culling:
  # Cull all processes older than two hours
  max_age_minutes: 120

  # Cull processes every 5 minutes
  culling_interval_minutes: 5

Each runtime has its own specific configuration that’s documented in the Runtimes section of this documentation.