Что такое переменные среды в Docker Compose

Работа с переменными среды в Docker Compose – это важный навык для любого разработчика, работающего с контейнерами. Он позволяет упростить настройку контейнеров, разделить конфигурацию на отдельные компоненты и обеспечить гибкость развертывания приложений в различных средах. В этой статье рассмотрим, как эффективно работать с переменными среды в Docker Compose, и приведём практические примеры.

1. Что такое переменные среды в Docker Compose?

Переменные среды (environment variables) – это ключевые параметры конфигурации, которые позволяют контейнерам получить доступ к специфической информации о среде, в которой они запущены. Например, переменные могут хранить пути к базам данных, API ключи, порты и другие настройки, нужные для работы приложения.

2. Зачем нужны переменные среды?

Использование переменных среды в Docker Compose даёт несколько преимуществ:

• Повышение гибкости: настройки можно легко менять без изменения кода приложения.
• Безопасность: конфиденциальные данные (например, пароли) можно хранить вне исходного кода.
• Упрощение развертывания: одна конфигурация Docker Compose может быть использована в разных средах (например, для разработки, тестирования и продакшн).

3. Основные способы использования переменных среды в Docker Compose

Docker Compose предоставляет несколько способов управления переменными среды:

1. Файл .env.
2. Передача значений в командной строке.
3. Определение переменных в docker-compose.yml.
4. Использование аргументов командной строки docker-compose.

Рассмотрим каждый из этих способов подробнее.

3.1 Использование файла .env

Файл .env (environment file) – это текстовый файл, который содержит переменные среды в формате ключ=значение. Этот файл автоматически загружается Docker Compose при запуске команды docker-compose up.

Пример .env файла:

POSTGRES_USER=myuser

POSTGRES_PASSWORD=mypassword

POSTGRES_DB=mydatabase

Пример использования переменных из файла .env в docker-compose.yml:

version: '3.8'



services:

  db:

    image: postgres:13

    environment:

      - POSTGRES_USER=${POSTGRES_USER}

      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}

      - POSTGRES_DB=${POSTGRES_DB}

Примечание: если файл .env не найден, Docker Compose не выдаст ошибку, но переменные останутся неопределёнными. Убедитесь, что файл существует и находится в той же директории, что и docker-compose.yml.

3.2 Передача переменных среды в командной строке

Иногда требуется задать переменные среды, не изменяя .env файл или docker-compose.yml. Это можно сделать при помощи командной строки, передав переменные перед командой docker-compose up.

Пример:

POSTGRES_USER=myuser POSTGRES_PASSWORD=mypassword POSTGRES_DB=mydatabase docker-compose up

3.3 Определение переменных среды в docker-compose.yml

Вместо использования .env файла переменные среды можно определить непосредственно в docker-compose.yml. Это удобно, когда настройки для контейнера стабильны и не изменяются между развертываниями.

Пример:

version: '3.8'



services:

  db:

    image: postgres:13

    environment:

      - POSTGRES_USER=myuser

      - POSTGRES_PASSWORD=mypassword

      - POSTGRES_DB=mydatabase

Однако такой способ менее гибкий, поскольку требует изменений в конфигурационном файле каждый раз, когда нужно обновить значения переменных среды.

3.4 Использование переменных окружения в командной строке

Если нужно передать значение переменной среды, отсутствующей в .env файле или docker-compose.yml, это можно сделать с помощью аргумента -e для команды docker-compose run.

Пример:

docker-compose run -e POSTGRES_USER=myuser db

4. Работа с несколькими файлами конфигурации Docker Compose

При работе с Docker Compose можно использовать несколько конфигурационных файлов, добавляя к ним специфические для каждой среды переменные.

Например:

docker-compose -f docker-compose.yml -f docker-compose.prod.yml up

Этот подход позволяет добавлять в docker-compose.prod.yml переменные, специфичные для продакшн-среды.

5. Примеры практического использования переменных среды

5.1 Конфигурирование базы данных

Предположим, у нас есть приложение, использующее базу данных PostgreSQL. Мы можем использовать переменные среды для указания данных для входа.

Файл .env:

POSTGRES_USER=myuser

POSTGRES_PASSWORD=mypassword

POSTGRES_DB=mydatabase

Файл docker-compose.yml:

version: '3.8'



services:

  db:

    image: postgres:13

    environment:

      - POSTGRES_USER=${POSTGRES_USER}

      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}

      - POSTGRES_DB=${POSTGRES_DB}

    ports:

      - "5432:5432"

  web:

    image: myapp

    depends_on:

      - db

    environment:

      - DATABASE_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DB}

Здесь:

• DATABASE_URL — используется приложением для подключения к базе данных, используя переменные среды из db.

5.2 Определение параметров в зависимости от среды

Часто нужно запускать приложение с разными параметрами в зависимости от среды (например, DEV или PROD).

Пример .env.dev:

DEBUG=True

DB_HOST=db_dev

DB_USER=dev_user

Пример .env.prod:

DEBUG=False

DB_HOST=db_prod

DB_USER=prod_user

Запуск для DEV-среды:

docker-compose --env-file .env.dev up

Запуск для PROD-среды:

docker-compose --env-file .env.prod up

6. Работа с секретами

Секреты (например, пароли и ключи) лучше не хранить в .env или docker-compose.yml. Для этого можно использовать Docker secrets. В Docker Compose поддержка секретов ограничена для Swarm Mode, но это позволяет хранить конфиденциальные данные безопасно.

Пример использования:

1. Создайте секрет:echo "mypassword" | docker secret create pg_password -

2. Используйте секрет в docker-compose.yml:version: '3.8'

services:
 db:
   image: postgres:13
   secrets:
     - pg_password
   environment:
     - POSTGRES_PASSWORD_FILE=/run/secrets/pg_password
secrets:
 pg_password:
   external: true


Здесь POSTGRES_PASSWORD_FILE указывает путь, откуда контейнер возьмёт пароль.

7. Плюсы и минусы использования переменных среды в Docker Compose

Плюсы

• Гибкость: позволяет легко переключать окружения.
• Упрощение разработки и тестирования: можно использовать одну и ту же конфигурацию для разных сред.
• Безопасность: чувствительные данные можно изолировать.

Минусы

• Неудобство работы с чувствительными данными: .env файлы могут быть слабо защищены.
• Ограниченная поддержка в Docker Compose: для продвинутых сценариев, например, работы с секретами, лучше использовать Swarm или Kubernetes.

8. Советы и рекомендации

1. Избегайте хранения конфиденциальных данных в .env — используйте Docker Secrets или переменные среды в защищённых системах.
2. Создавайте разные .env файлы для каждой среды (DEV, TEST, PROD) и используйте --env-file для их переключения.
3. Убедитесь, что .env файл не попадает в систему контроля версий (добавьте его в .gitignore).
4. Используйте переменные окружения с именами, уникальными для проекта, чтобы избежать конфликтов.

Заключение

Работа с переменными среды в Docker Compose – это простой, но мощный способ управления конфигурацией контейнерных приложений. Грамотное использование переменных среды позволяет адаптировать приложения для разных сред, обеспечивать безопасность данных и повышать гибкость развертывания.