Добавление PostgreSQL в Docker Compose¶

На нашей локальной машине, для управления сервисами мы решили использовать Docker. Создайте файл docker-compose.yaml и добавьте PostgreSQL в качестве сервиса:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

version: '3'

services:
    database:
        image: postgres:13-alpine
        environment:
            POSTGRES_USER: main
            POSTGRES_PASSWORD: main
            POSTGRES_DB: main
        ports: [5432]

В результате будет установлен сервер PostgreSQL и настроены переменные окружения для имени базы данных и учётных данных. Конкретные значения сейчас не важны.

Также откроем порт PostgreSQL (5432) у контейнера для доступа к нему с локального хоста, чтобы получить доступ к базе данных с нашего компьютера.

Запуск Docker Compose¶

Запустите Docker Compose в фоновом режиме (-d):

1

$ docker-compose up -d

Подождите немного, пока база данных запустится, а затем проверьте, что всё работает нормально:

1
2
3
4
5

$ docker-compose ps

        Name                      Command              State            Ports
---------------------------------------------------------------------------------------
guestbook_database_1   docker-entrypoint.sh postgres   Up      0.0.0.0:32780->5432/tcp

Если работающих контейнеров нет, или в столбце State не отображается Up, проверьте логи Docker Compose:

1

$ docker-compose logs

Обращение к локальной базе данных¶

Использование консольной программы psql может пригодится в отдельных случаях. Хотя для этого вам нужно помнить учётные данные и имя базы. Вам также нужно знать локальный порт, на котором запущена база данных. Docker выбирает произвольный порт для того, чтобы вы могли одновременно работать над разными проектами, использующими PostgreSQL (локальный порт отображается в выводе команды docker-compose ps).

Если вы запускаете psql с помощью Symfony CLI, вам не нужно ничего помнить.

Symfony CLI автоматически обнаруживает сервисы Docker, запущенные для проекта, и устанавливает переменные окружения, необходимые psql для подключения к базе данных.

Благодаря этим соглашениям, доступ к базе данных с помощью команды symfony run становится намного проще:

1

$ symfony run psql

1

$ docker-compose exec database psql main

Резервное копирование и восстановление базы данных¶

Используйте pg_dump, чтобы выгрузить данные из базы данных:

1

$ symfony run pg_dump --data-only > dump.sql

Для восстановления данных:

1

$ symfony run psql < dump.sql

Добавление PostgreSQL в SymfonyCloud¶

Добавление такого сервиса, как PostgreSQL, в инфраструктуру продакшена на SymfonyCloud, делается через изменения в файле .symfony/services.yaml, который пока ещё пуст:

1
2
3
4

db:
    type: postgresql:13
    disk: 1024
    size: S

Сервис db — это PostgreSQL (в той же версии, что и для Docker), который мы разместим в небольшом контейнере с диском объёмом 1 Гб.

Также необходимо «привязать» БД к контейнеру приложения, который описан в .symfony.cloud.yaml:

1
2

relationships:
    database: "db:postgresql"

Сервис db типа postgresql указан как database в контейнере приложения.

Последним шагом будет добавление PHP-модуля pdo_pgsql:

1
2
3
4

runtime:
    extensions:
        - pdo_pgsql
        # other extensions here

Вот полный результат изменений в файле .symfony.cloud.yaml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

--- a/.symfony.cloud.yaml
+++ b/.symfony.cloud.yaml
@@ -4,6 +4,7 @@ type: php:8.0

 runtime:
     extensions:
+        - pdo_pgsql
         - apcu
         - mbstring
         - sodium
@@ -21,6 +22,9 @@ build:

 disk: 512

+relationships:
+    database: "db:postgresql"
+
 web:
     locations:
         "/":

Зафиксируйте изменения в репозитории, а затем повторно разверните в SymfonyCloud:

1
2
3

$ git add .
$ git commit -m'Configuring the database'
$ symfony deploy

Доступ к базе данных на SymfonyCloud¶

PostgreSQL теперь работает как локально через Docker, так и на продакешене в SymfonyCloud.

Как мы только что увидели, при запуске symfony run psql происходит автоматическое подключение к базе данных, размещённой в контейнере Docker. Это происходит благодаря переменным окружения, установленным командой symfony run.

Если вы хотите подключиться к PostgreSQL, расположенном в контейнерах на продакшене, вы можете открыть SSH-туннель между вашей локальной машиной и инфраструктурой SymfonyCloud:

1

$ symfony tunnel:open --expose-env-vars

По умолчанию сервисы SymfonyCloud не отображаются в переменных окружения на локальной машине. Вы должны сделать это явно, используя флаг --expose-env-vars. Почему? Подключение к базе данных на продакшене является опасной операцией. Вы можете испортить реальные данные. Указывая этот флаг, вы подтверждаете, что действительно хотите это сделать.

Теперь подключитесь к удалённой базе данных PostgreSQL с помощью команды symfony run psql, как раньше:

1

$ symfony run psql

Когда завершите работу, не забудьте закрыть туннель:

1

$ symfony tunnel:close

Просмотр переменных окружения¶

Docker Compose и SymfonyCloud отлично работают с Symfony благодаря переменным окружения.

Просмотрите все переменные окружения, установленные symfony, выполнив symfony var:export:

1
2
3
4
5
6
7
8

$ symfony var:export

PGHOST=127.0.0.1
PGPORT=32781
PGDATABASE=main
PGUSER=main
PGPASSWORD=main
# ...

Переменные окружения, начинающиеся с PG* используются утилитой psql. А остальные?

Когда туннель к SymfonyCloud открыт с установленным флагом --expose-env-vars, команда var:export возвращает переменные из удалённого окружения:

1
2
3

$ symfony tunnel:open --expose-env-vars
$ symfony var:export
$ symfony tunnel:close

Описание вашей инфраструктуры¶

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