diff --git a/docs/pages_en/usage/build_draft/building.md b/docs/pages_en/usage/build_draft/building.md new file mode 100644 index 0000000000..318b4fc1df --- /dev/null +++ b/docs/pages_en/usage/build_draft/building.md @@ -0,0 +1,6 @@ +--- +title: Build process +permalink: usage/build_draft/building.html +--- + + diff --git a/docs/pages_en/usage/build_draft/images.md b/docs/pages_en/usage/build_draft/images.md new file mode 100644 index 0000000000..45c3b9f083 --- /dev/null +++ b/docs/pages_en/usage/build_draft/images.md @@ -0,0 +1,6 @@ +--- +title: Images configuration +permalink: usage/build_draft/images.html +--- + + diff --git a/docs/pages_en/usage/build_draft/overview.md b/docs/pages_en/usage/build_draft/overview.md new file mode 100644 index 0000000000..c4df5cc4e9 --- /dev/null +++ b/docs/pages_en/usage/build_draft/overview.md @@ -0,0 +1,6 @@ +--- +title: Overview +permalink: usage/build_draft/overview.html +--- + + diff --git a/docs/pages_en/usage/build_draft/stapel.md b/docs/pages_en/usage/build_draft/stapel.md new file mode 100644 index 0000000000..bb48eceb7b --- /dev/null +++ b/docs/pages_en/usage/build_draft/stapel.md @@ -0,0 +1,6 @@ +--- +title: Stapel +permalink: usage/build_draft/stapel.html +--- + + diff --git a/docs/pages_en/usage/build_draft/storage.md b/docs/pages_en/usage/build_draft/storage.md new file mode 100644 index 0000000000..e8e88eb1ff --- /dev/null +++ b/docs/pages_en/usage/build_draft/storage.md @@ -0,0 +1,6 @@ +--- +title: Storage layout +permalink: usage/build_draft/storage.html +--- + + diff --git a/docs/pages_ru/usage/build/build_process.md b/docs/pages_ru/usage/build/build_process.md index 93234a2914..7df96fb65d 100644 --- a/docs/pages_ru/usage/build/build_process.md +++ b/docs/pages_ru/usage/build/build_process.md @@ -3,6 +3,8 @@ title: Процесс сборки permalink: usage/build/build_process.html --- + + Сборочный процесс werf для образов, описанных в [werf.yaml]({{ "reference/werf_yaml.html" | true_relative_url }}), подразумевает [последовательную сборку стадий]({{ "usage/build/stages_and_storage.html" | true_relative_url }}#конвеер-стадий) для описанных образов. Несмотря на то, что [_конвейеры стадий_]({{ "usage/build/stages_and_storage.html#конвеер-стадий" | true_relative_url }}) для Dockerfile-образа, Stapel-образа и Stapel-артефакта отличаются, каждая стадия подчиняется общим правилам [выборки из хранилища](#выборка-стадий), [сохранения](#сохранение-стадий-в-хранилище), а также [работы кеша и блокировок]({{ "usage/build/synchronization.html" | true_relative_url }}) в параллельных запусках. diff --git a/docs/pages_ru/usage/build/buildah_mode.md b/docs/pages_ru/usage/build/buildah_mode.md index 568d340a3b..b37df588cb 100644 --- a/docs/pages_ru/usage/build/buildah_mode.md +++ b/docs/pages_ru/usage/build/buildah_mode.md @@ -3,6 +3,8 @@ title: Режим сборки с использованием Buildah permalink: usage/build/buildah_mode.html --- + + > ПРИМЕЧАНИЕ: werf поддерживает сборку образов с _использованием Docker-сервера_ или _с использованием Buildah_. Поддерживается сборка как Dockerfile-образов, так и stapel-образов через Buildah. Для сборки без Docker-сервера werf использует встроенный Buildah в rootless-режиме. diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/artifacts.md b/docs/pages_ru/usage/build/building_images_with_stapel/artifacts.md index 167490b99f..ef5511be97 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/artifacts.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/artifacts.md @@ -5,6 +5,8 @@ author: Alexey Igrychev directive_summary: artifact --- + + ## Что такое артефакты? ***Артефакт*** — это специальный образ, используемый в других артефактах или отдельных образах, описанных в конфигурации. Артефакт предназначен преимущественно для отделения ресурсов инструментов сборки от процесса сборки образа приложения. Примерами таких ресурсов могут быть — программное обеспечение или данные, которые необходимы для сборки, но не нужны для запуска приложения, и т.п. diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/assembly_instructions.md b/docs/pages_ru/usage/build/building_images_with_stapel/assembly_instructions.md index 912d7e07b2..db50a76d07 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/assembly_instructions.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/assembly_instructions.md @@ -4,6 +4,8 @@ permalink: usage/build/building_images_with_stapel/assembly_instructions.html directive_summary: shell_and_ansible --- + + ## Пользовательские стадии ***Пользовательские стадии*** — это [_стадии_]({{ "usage/build/stages_and_storage.html" | true_relative_url }}) со сборочными инструкциями из [конфигурации]({{ "reference/werf_yaml.html#секция-image" | true_relative_url }}). Другими словами — это стадии, конфигурируемые пользователем (существуют также служебные стадии, которые пользователь конфигурировать не может). В настоящее время существует два вида сборочных инструкций: _shell_ и _ansible_. diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/base_image.md b/docs/pages_ru/usage/build/building_images_with_stapel/base_image.md index c08274b4f4..c3f35c79a2 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/base_image.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/base_image.md @@ -5,6 +5,8 @@ author: Alexey Igrychev directive_summary: base_image --- + + Пример минимального `werf.yaml`: ```yaml project: my-project diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/docker_directive.md b/docs/pages_ru/usage/build/building_images_with_stapel/docker_directive.md index 3533847a0b..8ed81217e0 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/docker_directive.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/docker_directive.md @@ -5,6 +5,8 @@ author: Alexey Igrychev directive_summary: docker --- + + Инструкции в [Dockerfile](https://docs.docker.com/engine/reference/builder/) можно условно разделить на две группы: сборочные инструкции и инструкции, которые влияют на manifest Docker-образа. Так как werf сборщик использует свой синтаксис для описания сборки, поддерживаются только следующие Dockerfile-инструкции второй группы: diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/git_directive.md b/docs/pages_ru/usage/build/building_images_with_stapel/git_directive.md index 1bfe01aebc..2274a79dc3 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/git_directive.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/git_directive.md @@ -4,6 +4,8 @@ permalink: usage/build/building_images_with_stapel/git_directive.html directive_summary: git --- + + ## Что такое git mapping? ***Git mapping*** определяет, какой файл или папка из Git-репозитория должны быть добавлены в конкретное место образа. diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/import_directive.md b/docs/pages_ru/usage/build/building_images_with_stapel/import_directive.md index 01198cc303..11e6efa5ed 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/import_directive.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/import_directive.md @@ -5,6 +5,8 @@ author: Alexey Igrychev directive_summary: import --- + + Из-за используемых инструментов сборки, либо просто из-за исходных файлов, размер конечного образа может увеличиваться в несколько раз. Зачастую эти файлы не нужны в конечном образе. Для решения таких проблем, сообщество Docker предлагает выполнять установки инструментов, сборку и удаление ненужных файлов за один шаг. Условный пример: diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/integration_with_ssh_agent.md b/docs/pages_ru/usage/build/building_images_with_stapel/integration_with_ssh_agent.md index cb958d0acf..2be09fb74e 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/integration_with_ssh_agent.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/integration_with_ssh_agent.md @@ -3,6 +3,8 @@ title: Интеграция с SSH-агентом permalink: usage/build/building_images_with_stapel/integration_with_ssh_agent.html --- + + werf необходим ssh-ключ пользователя в следующих случаях: 1. Клонирование удаленного git-репозитория, указанного в файле конфигурации `werf.yaml`. diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/mount_directive.md b/docs/pages_ru/usage/build/building_images_with_stapel/mount_directive.md index 1d28bd81a7..0b11cbf3d5 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/mount_directive.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/mount_directive.md @@ -5,6 +5,8 @@ author: Artem Kladov , Alexey Igrychev + Довольно часто бывают случаи, когда при сборке у вас появляются файлы которые нет необходимости оставлять в образе, и их нужно исключить. Например: - Большинство пакетных менеджеров создают в системе кэш пакетов и служебных файлов. - [APT](https://wiki.debian.org/Apt) хранит список пакетов в директории `/var/lib/apt/lists/`. diff --git a/docs/pages_ru/usage/build/building_images_with_stapel/stage_introspection.md b/docs/pages_ru/usage/build/building_images_with_stapel/stage_introspection.md index aa5bc77510..1aef8d18df 100644 --- a/docs/pages_ru/usage/build/building_images_with_stapel/stage_introspection.md +++ b/docs/pages_ru/usage/build/building_images_with_stapel/stage_introspection.md @@ -15,6 +15,7 @@ summary: | --- + Написание конфигурации на начальном этапе может вызывать трудности из-за того, что при выполнении инструкций сборки какой-либо стадии не до конца понятно состояние системы в _сборочном контейнере_. diff --git a/docs/pages_ru/usage/build/run_in_container/how_it_works.md b/docs/pages_ru/usage/build/run_in_container/how_it_works.md index bf94125d22..9e34fb2bcf 100644 --- a/docs/pages_ru/usage/build/run_in_container/how_it_works.md +++ b/docs/pages_ru/usage/build/run_in_container/how_it_works.md @@ -3,6 +3,8 @@ title: Принципы работы permalink: usage/build/run_in_containers/how_it_works.html --- + + > ПРИМЕЧАНИЕ: werf поддерживает сборку образов с _использованием Docker-сервера_ или _с использованием Buildah_. Поддерживается сборка как Dockerfile-образов, так и stapel-образов через Buildah. Общая информация о том, как включить Buildah в werf, доступна на странице [режима сборки с использованием Buildah]({{ "/usage/build/buildah_mode.html" | true_relative_url }}). diff --git a/docs/pages_ru/usage/build/run_in_container/use_docker_container.md b/docs/pages_ru/usage/build/run_in_container/use_docker_container.md index cbc6140eb7..8149c556f2 100644 --- a/docs/pages_ru/usage/build/run_in_container/use_docker_container.md +++ b/docs/pages_ru/usage/build/run_in_container/use_docker_container.md @@ -3,6 +3,8 @@ title: С помощью контейнеров Docker permalink: usage/build/run_in_containers/use_docker_container.html --- + + > ПРИМЕЧАНИЕ: werf поддерживает сборку образов с _использованием Docker-сервера_ или _с использованием Buildah_. Поддерживается сборка как Dockerfile-образов, так и stapel-образов через Buildah. ## Сборка образов с помощью Buildah (рекомендуемый метод) diff --git a/docs/pages_ru/usage/build/run_in_container/use_kubernetes.md b/docs/pages_ru/usage/build/run_in_container/use_kubernetes.md index b1f41e406a..cea3f85a2c 100644 --- a/docs/pages_ru/usage/build/run_in_container/use_kubernetes.md +++ b/docs/pages_ru/usage/build/run_in_container/use_kubernetes.md @@ -3,6 +3,8 @@ title: С помощью Kubernetes permalink: usage/build/run_in_containers/use_kubernetes.html --- + + > ПРИМЕЧАНИЕ: werf поддерживает сборку образов с _использованием Docker-сервера_ или _с использованием Buildah_. Поддерживается сборка как Dockerfile-образов, так и stapel-образов через Buildah. ## 1. Подготовьте кластер Kubernetes diff --git a/docs/pages_ru/usage/build/stages_and_storage.md b/docs/pages_ru/usage/build/stages_and_storage.md index 973bd71e01..7eb9e0c3d9 100644 --- a/docs/pages_ru/usage/build/stages_and_storage.md +++ b/docs/pages_ru/usage/build/stages_and_storage.md @@ -3,6 +3,8 @@ title: Стадии и хранилище permalink: usage/build/stages_and_storage.html --- + + Мы разделили сборочный процесс образов, описанных в файле конфигурации [werf.yaml]({{ "reference/werf_yaml.html" | true_relative_url }}) на этапы, [с четкими функциями и назначением](#зависимости-стадии). Каждый такой этап соответствует промежуточному образу, подобно слоям в Docker. В werf такой этап называется [стадией](#конвеер-стадий), а **конечный образ** соответствует последней собранной стадии для определённого состояния git и конфигурации werf.yaml. Стадии — это этапы сборочного процесса. ***Стадия*** определяется группой инструкций, указанных в конфигурации. Причем группировка этих инструкций не случайна, имеет определенную логику и учитывает условия и правила сборки. С каждой _стадией_ связан конкретный Docker-образ. Все стадии хранятся в [хранилище](#хранилище). diff --git a/docs/pages_ru/usage/build/storage_layouts.md b/docs/pages_ru/usage/build/storage_layouts.md index cab81c38b2..9be2aef07d 100644 --- a/docs/pages_ru/usage/build/storage_layouts.md +++ b/docs/pages_ru/usage/build/storage_layouts.md @@ -3,6 +3,8 @@ title: Организация хранилища стадий permalink: usage/build/storage_layouts.html --- + + В данной статье описано, как устроено хранилище собираемых образов в werf, какие бывают типы хранилища, какие функции выполняют эти хранилища, а также различные варианты организации хранилища в проекте. ## Хранилище стадий diff --git a/docs/pages_ru/usage/build/synchronization.md b/docs/pages_ru/usage/build/synchronization.md index 5f3b14c3b5..b688ccf425 100644 --- a/docs/pages_ru/usage/build/synchronization.md +++ b/docs/pages_ru/usage/build/synchronization.md @@ -3,6 +3,8 @@ title: Синхронизация в werf permalink: usage/build/synchronization.html --- + + Синхронизация — это группа сервисных компонентов werf, предназначенных для координации нескольких процессов werf при выборке и сохранении стадий в хранилище, а также при публикации образов в репозиторий образов. Существует 2 таких компонента для синхронизации: 1. _Кеш хранилища_ — это внутренний служебный кеш werf, который существенно повышает производительность фазы расчёта стадий в случае, если эти стадии уже есть в хранилище. Кеш хранилища содержит соответствие существующих в хранилище с дайджестом (или другими словами: содержит предварительно рассчитанный шаг алгоритма выборки стадий по дайджесту). Данный кеш является когерентным и werf автоматически сбрасывает его, если будет замечена несостыковка между хранилищем стадий и кешом хранилища. diff --git a/docs/pages_ru/usage/build_draft/building.md b/docs/pages_ru/usage/build_draft/building.md new file mode 100644 index 0000000000..3c7eb1b8b2 --- /dev/null +++ b/docs/pages_ru/usage/build_draft/building.md @@ -0,0 +1,6 @@ +--- +title: Сборочный процесс +permalink: usage/build_draft/building.html +--- + + diff --git a/docs/pages_ru/usage/build_draft/images.md b/docs/pages_ru/usage/build_draft/images.md new file mode 100644 index 0000000000..53b0e6438c --- /dev/null +++ b/docs/pages_ru/usage/build_draft/images.md @@ -0,0 +1,6 @@ +--- +title: Конфигурация образов +permalink: usage/build_draft/images.html +--- + + diff --git a/docs/pages_ru/usage/build_draft/overview.md b/docs/pages_ru/usage/build_draft/overview.md new file mode 100644 index 0000000000..20ffc2b759 --- /dev/null +++ b/docs/pages_ru/usage/build_draft/overview.md @@ -0,0 +1,6 @@ +--- +title: Обзор +permalink: usage/build_draft/overview.html +--- + + diff --git a/docs/pages_ru/usage/build_draft/stapel.md b/docs/pages_ru/usage/build_draft/stapel.md new file mode 100644 index 0000000000..bb48eceb7b --- /dev/null +++ b/docs/pages_ru/usage/build_draft/stapel.md @@ -0,0 +1,6 @@ +--- +title: Stapel +permalink: usage/build_draft/stapel.html +--- + + diff --git a/docs/pages_ru/usage/build_draft/storage.md b/docs/pages_ru/usage/build_draft/storage.md new file mode 100644 index 0000000000..2d9b2e874b --- /dev/null +++ b/docs/pages_ru/usage/build_draft/storage.md @@ -0,0 +1,6 @@ +--- +title: Организация хранилища стадий +permalink: usage/build_draft/storage.html +--- + +