Справочный файл

Как и традиционные пакеты, контейнеры нуждаются в информации, подобной «man-странице», о том, как их использовать, настраивать и интегрировать в более крупный стек. Поэтому справочный файл (Help File) требуется в составе пакета контейнера, если только вы не предоставили вместо него команду "help". Этот справочный файл, если он присутствует, будет предоставлен в рамках проверки контейнера. Это должен быть файл в формате MarkDown, размещённый в корне репозитория DistGit перед запуском сборки контейнера, и он должен иметь следующее имя:

  • help.md

OSBS автоматически преобразует этот файл в man-страницу и скопирует его в /help.1 в собранном образе.

Справочный файл должен содержать всё перечисленное ниже в зависимости от требований к образу:

  • Краткое описание того, какой сервис/программное обеспечение содержит образ.

  • Какую цель он выполняет в более крупной инфраструктуре, если таковая имеется.

  • Если существует возможность настройки содержащегося сервиса, файл '''должен''' содержать инструкции о том, как это сделать.

  • Если контейнер имеет какие-либо зависимости от других сервисов (например, базы данных), файл '''должен''' подробно описывать их.

  • Если контейнер использует какие-либо тома, файл '''должен''' подробно описывать назначение каждого из них; дополнительные сведения см. в рекомендациях по томам (VOLUMES).

  • Объяснение для каждого PORT, который прослушивает образ, включая его протокол и назначение.

  • Ссылки на любые внешние страницы документации или проектов программного обеспечения, если такие страницы существуют.

  • Если контейнер имеет какие-либо особые требования (например, большой объём ОЗУ или доступ к звуковому серверу), они '''должны''' быть перечислены.

  • Если приложение имеет основные варианты сборки, информация о них (например, mod_php против fastcgi) '''требуется'''.

Пример справочного файла:

  PostgreSQL 9.6 image, for supplying PostgreSQL within a Kubernetes stack.
  Includes all of "contrib", but does not include PostGIS or any automated replication management.
  
  Volumes:
  pg-config: usually mapped to /etc/postgresql/, contains the configuration files for PostgreSQL, 
    including postgresql.conf and pg_hba.conf. Read-only within the container.  
    Should map to local storage.
  pg-data: usually mapped to /var/lib/pgsql/data, contains database data.  Should be stored in 
    a persistent volume or network storage of some kind.  Requires high-throughput, read-write storage.
  
  Ports:
  5432: the PostgreSQL data port using the pgsql protocol.
  
  Documentation:
  See https://www.postgresql.org/docs/9.6/static/index.html
  
  Requirements:
  This is a transactional database, and requires 256MB of RAM and at 
  least one dedicated core.  If heavily used, can require much greater system resources.
  
  Configuration:
  Sample postgresql.conf and pg_hba.conf files are supplied in the image.  For further documentation, 
    please see the PostgreSQL docs.  Note that these files must be readable by the "postgres" user 
    inside the container.
  The database system is initialized with the admin user/password of postgres/postgres.  If you wish
    to override this, supply the ENV vars ADMIN_USER and ADMIN_PASS inside the container at initialization time.

Want to help? Learn how to contribute to Fedora Docs ›