Skip to content

Latest commit

 

History

History
60 lines (49 loc) · 6.72 KB

EnvironmentVariables.md

File metadata and controls

60 lines (49 loc) · 6.72 KB
Raw

Configuration Via Environment Variables

Many features in an Engine Yard Cloud stable-v6 environment can now be enabled and configured via environment variables.

This makes working with the Engine Yard Cloud platform much easier and removes the need for custom Chef recipes in many cases.

A list of supported settings is documented in the next section. If you are missing a setting, please request it by opening a GitHub issue.

Supported Settings

Environment Variable Default Value Description
EY_RUBY_VERSION N/A Sets the exact version of Ruby. (e.g. "2.7.0-preview1") important: besides an 'Apply', app workers need to be restarted via /engineyard/bin/app_<app_name> restart for the new version to be used
EY_RUBY_JEMALLOC false Activates Ruby with jemalloc as allocator. Check this article for more information.
EY_ENABLE_UNATTENDED_UPGRADES false Enables periodic security upgrades via Ubuntu's unattended-upgrades.
EY_REDIS_ENABLED false Sets up Redis. More details here
EY_REDIS_VERSION N/A Sets a custom version for Redis. More details here
EY_MEMCACHED_ENABLED false Sets up Memcached. More details here
EY_SIDEKIQ_* N/A Sets up Sidekiq. More details here
EY_PHP_EXTRA_EXTENSIONS N/A Lists (as comma-separated values) additional PHP extensions that should be installed.
EY_NODEJS_VERSION N/A Sets the exact version of NodeJS (e.g. "12.18.3")
Worker settings N/A See below
[LetsEncrypt settings] N/A LetsEncrypt Documentation

Worker Settings

Environment Variable Default Value Description
EY_POOL_SIZE N/A The worker pool size. Calculated automatically based on instance type if not set.
EY_MIN_POOL_SIZE 3 The minimum worker pool size.
EY_MAX_POOL_SIZE 100 The maximum worker pool size.
EY_RESERVED_MEMORY 1500 MB Memory (in MB) that's reserved for non-worker processes (system).
EY_RESERVED_MEMORY_SOLO 2000 MB Memory (in MB) that's reserved for non-worker processes on solo instances.
EY_WORKERS_PER_ECU 2 Number of workers per ECU.
EY_DB_WORKERS_PER_ECU 0.5 Number of DB workers per ECU.
EY_DB_VCPU_MAX 0 Number of vCPUs to reserve for the DB on a solo instance.
EY_WORKER_MEMORY_SIZE 250 MB Sets the max memory size in MB for application servers.
EY_SWAP_USAGE_PERCENT 25% Percentage of available swap to account for in worker pool size calculation.
EY_WORKER_TERMINATION_CONDITIONS N/A Additional termination conditions for the monit unit monitoring unicorn workers.
EY_PASSENGER_GRACE_TIME 60 seconds How long to wait in seconds until the passanger monitor kills workers.

Contribution Guidelines

The usual contribution guidelines apply.

Additionally, please adhere to the following specific rules:

  1. Use the fetch_env_var helper in cookbooks/ey-lib/libraries/env_vars.rb
  2. Add "enabled" flags logic to cookbooks/ey-base/recipes/custom.rb
  3. Binary flags need to match against /^TRUE$/i
  4. Make sure the default core cookbooks attributes are sensible defaults
  5. Introduce additional variables to configure important settings as you see fit
  6. Keep the naming of the variables consistent
    1. Variables must be prefixed with EY_
    2. Variable names should be declarative in nature (EY_SOMETHING_ENABLED rather than EY_ENABLE_SOMETHING)
  7. Document every new variable introduced in the section above. If the variable needs further documentation, put it in a separate file and link to it from the description column