Документация содержит более 100 различных статей, включая наиболее типичные примеры использования werf, подробное описание функций, архитектуры и параметров вызова.
Мы рекомендуем начинать знакомство с раздела Руководства:
- Установка содержит зависимости и возможные варианты установки.
- Первые шаги помогает начать использовать werf с существующим Dockerfile. Вы можете легко запустить werf в вашем проекте прямо сейчас.
- Деплой в Kubernetes — краткий пример развертывания приложения в кластере Kubernetes.
- Интеграция с CI/CD-системами — общий подход к интеграции werf с любой CI/CD-системой.
- Интеграция с GitLab CI расскажет всё об интеграции с GitLab CI: про сборку, публикацию, деплой и очистку Docker registry.
- Интеграция с GitHub Actions расскажет всё об интеграции с GitHub Actions: про сборку, публикацию, деплой и очистку образов.
- В разделе расширенной сборки рассказывается о нашем синтаксисе описания сборки образов. Синтаксис позволяет использовать werf сборщик, который учитывает особенности инкрементальной сборки и предоставляет дополнительные возможности (к примеру, описание сборочных инструкций Ansible-задачами). Рекомендуем начать знакомство с создания первого приложения.
Следующий раздел — Конфигурация.
Для использования werf в вашем проекте, необходимо создать файл конфигурации werf.yaml, который может состоять из:
- Описания метаинформации проекта, которая впоследствии будет использоваться в большинстве команд и влиять на конечный результат (к примеру, на кэши и формат имён Helm-релиза и namespace в Kubernetes). Пример такой метаинформации — имя проекта.
- Описания образов для сборки.
В статье Общие сведения вы найдете информацию о:
- Структуре секций и их конфигурации
- Описанию конфигурации в нескольких файлах
- Этапах обработки конфигурации
- Поддерживаемых функциях Go-шаблонов
В других статьях раздела Конфигурация дается детальная информация о директивах описания Dockerfile-образа, Stapel-образа, Stapel-артефакта и особенностях их использования.
Раздел Справочник посвящен описанию основных процессов werf:
Каждая статья описывает определенный процесс, особенности и доступные опции.
Также в этот раздел включены статьи с описанием базовых примитивов и общих инструментов:
Раздел CLI Commands содержит как базовые, необходимые для управления процессом CI/CD, так и служебные команды, обеспечивающие расширенные функциональные возможности.
Раздел Разработка содержит информацию, предназначенную для более глубокого понимания работы werf.
