- {%- if page.summary %} -
{{page.summary}}
+ {%- if page.directive_summary %} + {%- include directive_summary.html directive=page.directive_summary %} {%- endif %} {%- unless page.toc == false %} - {%- include toc.html %} + {%- include common/toc.html %} {%- endunless %} {%- unless jekyll.environment == "production" %} diff --git a/bin/configurator/config.go b/bin/configurator/config.go index ec1605292..47a06bbd9 100644 --- a/bin/configurator/config.go +++ b/bin/configurator/config.go @@ -3,12 +3,20 @@ package main import ( "fmt" "io/ioutil" + "log" + "os" "regexp" "strings" "gopkg.in/yaml.v2" ) +const ( + pathToConfiguratorYaml = "static/_data/_common/configurator.yaml" + startPhraseRu = "Установка и запуск на " + startPhraseEn = "Install and run on " +) + type config struct { Options []configOption `yaml:"options"` Combinations []configCombination `yaml:"combinations"` @@ -34,6 +42,43 @@ type configCombinationOption struct { type configCombinationSlug string +type configNames struct { + Groups []struct { + Name string `yaml:"name"` + Title struct { + En string `yaml:"en"` + Ru string `yaml:"ru"` + } `yaml:"title"` + Tooltip struct { + En string `yaml:"en"` + Ru string `yaml:"ru"` + } `yaml:"tooltip,omitempty"` + Buttons []struct { + Name string `yaml:"name"` + Title struct { + En string `yaml:"en"` + Ru string `yaml:"ru"` + PageName struct { + En string `yaml:"en"` + Ru string `yaml:"ru"` + } `yaml:"page-name"` + } `yaml:"title"` + } `yaml:"buttons"` + } `yaml:"groups"` + Tabs []struct { + Name string `yaml:"name"` + Title struct { + En string `yaml:"en"` + Ru string `yaml:"ru"` + } `yaml:"title"` + } `yaml:"tabs"` +} + +type titlesStruct struct { + Ru string + En string +} + func (options configCombinationOptions) ToSlug() configCombinationSlug { var opts []string for _, option := range options { @@ -43,6 +88,101 @@ func (options configCombinationOptions) ToSlug() configCombinationSlug { return configCombinationSlug(strings.Join(opts, "_")) } +func (options configCombinationOptions) ToUrlPath() configCombinationSlug { + var opts []string + var usage string + for _, option := range options { + if option.Value == "localDev" { + usage = "local/" + } else if option.Value == "ci" { + usage = "cicd/" + } else { + opts = append(opts, strings.ToLower(option.Value)) + } + } + + return configCombinationSlug(usage + strings.Join(opts, "-")) +} + +func (options configCombinationOptions) GetTitle(lang string) string { + var opts []configCombinationOption + for _, option := range options { + if option.Name != "usage" && + option.Name != "repoType" && + option.Name != "sharedCICD" && + option.Name != "projectType" { + opts = append(opts, option) + } + } + + file, err := os.Open(pathToConfiguratorYaml) + if err != nil { + log.Fatalf("Failed to open configurator.yaml file: %v", err) + } + defer file.Close() + confData, err := ioutil.ReadAll(file) + if err != nil { + log.Fatalf("Failed to open configurator.yaml file: %v", err) + } + var configNames configNames + err = yaml.Unmarshal(confData, &configNames) + if err != nil { + log.Fatalf("Failed to unmarshal YAML data: %v", err) + } + + var titles titlesStruct + titles.Ru = startPhraseRu + titles.En = startPhraseEn + count := 0 + for _, opt := range opts { + count++ + for _, group := range configNames.Groups { + if group.Name == opt.Name { + for _, btn := range group.Buttons { + if opt.Value == btn.Name { + switch lang { + case "ru": + if len(btn.Title.PageName.Ru) != 0 { + titles.Ru += btn.Title.PageName.Ru + } else { + titles.Ru += btn.Title.Ru + } + if count < len(opts) { + if count < len(opts)-1 { + titles.Ru += ", " + } else { + titles.Ru += " и " + } + } + case "en": + if len(btn.Title.PageName.Ru) != 0 { + titles.En += btn.Title.PageName.En + } else { + titles.En += btn.Title.En + } + if count < len(opts) { + if count < len(opts)-1 { + titles.En += ", " + } else { + titles.En += " and " + } + } + } + } + } + } + } + } + + if lang == "ru" { + return titles.Ru + } else if lang == "en" { + return titles.En + } + + return "" +} + type configCombinationTab struct { Name string `yaml:"name"` IncludePath string `yaml:"includePath"` diff --git a/bin/configurator/go.mod b/bin/configurator/go.mod index 7bf58db2c..7558fde49 100644 --- a/bin/configurator/go.mod +++ b/bin/configurator/go.mod @@ -1,5 +1,5 @@ module install_conf_generator -go 1.18 +go 1.21 require gopkg.in/yaml.v2 v2.4.0 diff --git a/bin/configurator/main.go b/bin/configurator/main.go index 870754316..1b21ace64 100644 --- a/bin/configurator/main.go +++ b/bin/configurator/main.go @@ -8,23 +8,29 @@ import ( const ( configFile = "config.yml" - generatedDirectory = "generated" - generatedIncludePathFormatTabs = "generated/_includes/%s/configurator/tabs/%s.md" - generatedPagePathFormatConfigurator = "generated/pages_%s/configurator.md" - generatedPagePathFormatTabs = "generated/pages_%s/configurator/tabs/%s.md" - generatedPathCombinationTreeConfig = "generated/configurator-options-list.json" - generatedPathCombinationTabsConfig = "generated/configurator-data.json" - - pagePermalinkConfigurator = "/includes/configurator.html" - includePathFormatTabs = "/configurator/tabs/%s.md" - pagePermalinkFormatTabs = "/configurator/tabs/%s.html" - - templatePathPagesConfigurator = "templates/pages/configurator.html" - templatePathPagesTabs = "templates/pages/tabs.html" - templatePathIncludesTabs = "templates/includes/tabs.html" - - pageTitleEnConfigurator = "Configurator" - pageTitleRuConfigurator = "Конфигуратор" + generatedDirectory = "generated" + generatedIncludePathFormatTabs = "generated/_includes/%s/configurator/tabs/%s.md" + generatedIncludePathFormatTabsForPages = "generated/_includes/%s/configurator/tabs_for_pages/%s.md" + generatedPagePathFormatConfigurator = "generated/pages_%s/configurator.md" + generatedPagePathFormatTabs = "generated/pages_%s/configurator/tabs/%s.md" + generatedPagePathFormat = "generated/pages_%s/configurator/pages/%s.md" + generatedPathCombinationTreeConfig = "generated/configurator-options-list.json" + generatedPathCombinationTabsConfig = "generated/configurator-data.json" + + pagePermalinkConfigurator = "/getting_started/index.html" + includePathFormatTabs = "/configurator/tabs/%s.md" + includePathFormatTabsForPages = "/configurator/tabs_for_pages/%s.md" + pagePermalinkFormatTabs = "/configurator/tabs/%s.html" + pagePermalinkFormatPages = "/getting_started/%s.html" + + templatePathPagesConfigurator = "templates/pages/configurator.html" + templatePathAllPagesConfigurator = "templates/pages/page.html" + templatePathPagesTabs = "templates/pages/tabs.html" + templatePathIncludesTabs = "templates/includes/tabs.html" + templatePathIncludesTabsForPages = "templates/includes/tabs-for-pages.html" + + pageTitleEnConfigurator = "Getting Started" + pageTitleRuConfigurator = "Быстрый старт" ) var ( @@ -115,6 +121,20 @@ func generateTabsIncludesAndPages(conf config) error { } } + // generate tabs includes for searched pages + { + var pageData tabsIncludeData + pageData.Options = combinationOptions + for _, cCombTab := range combination.Tabs { + pageData.Tabs = append(pageData.Tabs, cCombTab) + } + + tabsIncludePath := getTabsForPagesGeneratedIncludePath(lang, combinationOptions.ToSlug()) + if err := createFileByTemplate(templatePathIncludesTabsForPages, tabsIncludePath, pageData); err != nil { + return fmt.Errorf("unable to create file %q: %s", tabsIncludePath, err) + } + } + // generate tabs pages { tabsPagePath := getTabsGeneratedPagePath(lang, combinationOptions.ToSlug()) @@ -127,6 +147,29 @@ func generateTabsIncludesAndPages(conf config) error { return fmt.Errorf("unable to create file %q: %s", tabsPagePath, err) } } + + // generate pages + { + for _, pageOptions := range configuratorPageOptions { + var pageData configurationPageData + pageData.Title = pageOptions.Title + pageData.Groups = conf.getOptionGroupList() + pageData.DefaultCombinationOptions = conf.getAllCombinationOptionsList()[0] + pageData.DefaultIncludePath = getTabsIncludePath(pageData.DefaultCombinationOptions.ToSlug()) + + pageData.IncludePath = getTabsForPagesIncludePath(combinationOptions.ToSlug()) + pageData.Permalink = getPagesPagePermalink(combinationOptions.ToUrlPath()) + + pageData.Title = combinationOptions.GetTitle(lang) + + pageData.PageTab = true + + pageFilePath := getPagesGeneratedPagePath(lang, combinationOptions.ToSlug()) + if err := createFileByTemplate(templatePathAllPagesConfigurator, pageFilePath, pageData); err != nil { + return fmt.Errorf("unable to generate file %q: %s", pageFilePath, err) + } + } + } } } } @@ -138,24 +181,43 @@ func getTabsGeneratedPagePath(lang string, slug configCombinationSlug) string { return fmt.Sprintf(generatedPagePathFormatTabs, lang, slug) } +func getPagesGeneratedPagePath(lang string, slug configCombinationSlug) string { + return fmt.Sprintf(generatedPagePathFormat, lang, slug) +} + func getTabsGeneratedIncludePath(lang string, slug configCombinationSlug) string { return fmt.Sprintf(generatedIncludePathFormatTabs, lang, slug) } +func getTabsForPagesGeneratedIncludePath(lang string, slug configCombinationSlug) string { + return fmt.Sprintf(generatedIncludePathFormatTabsForPages, lang, slug) +} + func getTabsIncludePath(slug configCombinationSlug) string { return fmt.Sprintf(includePathFormatTabs, slug) } +func getTabsForPagesIncludePath(slug configCombinationSlug) string { + return fmt.Sprintf(includePathFormatTabsForPages, slug) +} + func getTabsPagePermalink(slug configCombinationSlug) string { return fmt.Sprintf(pagePermalinkFormatTabs, slug) } +func getPagesPagePermalink(slug configCombinationSlug) string { + return fmt.Sprintf(pagePermalinkFormatPages, slug) +} + type configurationPageData struct { Title string + TitleParts []configCombinationOption Permalink string + IncludePath string Groups []optionGroup DefaultCombinationOptions configCombinationOptions DefaultIncludePath string + PageTab bool } func generateConfiguratorPage(conf config) error { @@ -166,6 +228,7 @@ func generateConfiguratorPage(conf config) error { pageData.Groups = conf.getOptionGroupList() pageData.DefaultCombinationOptions = conf.getAllCombinationOptionsList()[0] pageData.DefaultIncludePath = getTabsIncludePath(pageData.DefaultCombinationOptions.ToSlug()) + pageData.PageTab = false pageFilePath := getConfiguratorGeneratedPagePath(pageOptions.Language) if err := createFileByTemplate(templatePathPagesConfigurator, pageFilePath, pageData); err != nil { diff --git a/bin/configurator/static/_data/_common/configurator.yaml b/bin/configurator/static/_data/_common/configurator.yaml index 192c10e44..5b8f66a5a 100644 --- a/bin/configurator/static/_data/_common/configurator.yaml +++ b/bin/configurator/static/_data/_common/configurator.yaml @@ -98,6 +98,9 @@ groups: title: en: "Other CI/CD" ru: "Другая CI/CD" + page-name: + en: "other CI/CD" + ru: "другой CI/CD" - name: "argoCdWithGitlabCiCd" title: en: "Argo CD with GitLab CI/CD" diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_main_section.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_main_section.md.liquid index 0dab88780..c877d5ceb 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_main_section.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_main_section.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - GitLab; @@ -15,7 +15,7 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). -## Installing the GitLab Runner +### Installing the GitLab Runner Follow the [official instructions](https://docs.gitlab.com/runner/install/linux-repository.html) to install the GitLab Runner on your dedicated host. @@ -24,7 +24,7 @@ Follow the [official instructions](https://docs.gitlab.com/runner/install/linux- {% endif %} -## Installing werf +### Installing werf To install werf on the GitLab Runner host, run the following command: @@ -32,15 +32,15 @@ To install werf on the GitLab Runner host, run the following command: curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Registering the GitLab Runner +### Registering the GitLab Runner Follow the [official instructions](https://docs.gitlab.com/runner/register/index.html) to register the GitLab Runner in GitLab: set Shell as the executor. Once the registration is complete, you may want to perform [additional GitLab Runner configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html). -## Configuring the container registry +### Configuring the container registry [Enable garbage collection](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step is only needed to build images for platforms other than the host platform on which werf is being run. @@ -50,7 +50,7 @@ Register emulators on your system using qemu-user-static: docker run --restart=always --name=qemu-user-static -d --privileged --entrypoint=/bin/sh multiarch/qemu-user-static -c "/register --reset -p yes && tail -f /dev/null" ``` -## Installing Argo CD Image Updater +### Installing Argo CD Image Updater Install Argo CD Image Updater with the ["continuous deployment of OCI Helm chart type application" patch](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_project_section.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_project_section.md.liquid index 9787252e8..5fbdb4d84 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_project_section.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/argocd_host_project_section.md.liquid @@ -1,4 +1,4 @@ -## Configuring Argo CD Application +### Configuring Argo CD Application 1. Apply the following Application CRD to the target cluster to deploy a bundle from the container registry: @@ -49,7 +49,7 @@ data: EOF ``` -## Configuring the GitLab project +### Configuring the GitLab project - [Create and save the access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#create-a-project-access-token) for cleaning up the no longer needed images in the container registry; use the following parameters: @@ -73,7 +73,7 @@ EOF - [Add a scheduled nightly task](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) to clean up the no longer needed images in the container registry and set the `main`/`master` branch as the **Target branch**. -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is what the repository that uses werf for building and deploying might look like: diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/buildah_install.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/buildah_install.md.liquid index a2d1164be..c69901989 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/buildah_install.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/buildah_install.md.liquid @@ -1,4 +1,4 @@ -## Installing Buildah +### Installing Buildah Follow these steps on the GitLab Runner host to install Buildah: diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/configuring_the_container_registry.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/configuring_the_container_registry.md.liquid index 244592caf..5a62ab4f9 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/configuring_the_container_registry.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/configuring_the_container_registry.md.liquid @@ -1,3 +1,3 @@ -## Configuring the container registry +### Configuring the container registry [Enable garbage collection](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) for your container registry. diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid index 757a65dcc..af3b7c44c 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - GitLab; @@ -6,15 +6,15 @@ - [Docker Engine](https://docs.docker.com/engine/install/). -## Installing GitLab Runner +### Installing GitLab Runner Install GitLab Runner on its dedicated host by following the [official instructions](https://docs.gitlab.com/runner/install/linux-repository.html). -## Registering GitLab Runner +### Registering GitLab Runner Follow [official instructions](https://docs.gitlab.com/runner/register/index.html) to register GitLab Runner in GitLab; specify Docker as the executor and any image as the image (e.g. `alpine`). -## Configuring GitLab Runner +### Configuring GitLab Runner On the GitLab Runner host, open its `config.toml` configuration file and add the following options to the GitLab Runner you registered earlier: @@ -39,7 +39,7 @@ If needed, perform [additional configuration](https://docs.gitlab.com/runner/con {% include configurator/partials/ci/configuring_the_container_registry.md.liquid %} -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) {% include configurator/partials/ci/cross_platform_note.md.liquid %} diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_host_main_section.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_host_main_section.md.liquid index 51b570b57..6fe580405 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_host_main_section.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_host_main_section.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - GitLab; @@ -17,7 +17,7 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). {% endif %} -## Installing the GitLab Runner +### Installing the GitLab Runner Follow [official instructions](https://docs.gitlab.com/runner/install/linux-repository.html) to install the GitLab Runner on your dedicated host. @@ -25,7 +25,7 @@ Follow [official instructions](https://docs.gitlab.com/runner/install/linux-repo {% include configurator/partials/ci/buildah_install.md.liquid %} {% endif %} -## Installing werf +### Installing werf To install werf on the GitLab Runner host, run the following command: @@ -33,15 +33,15 @@ To install werf on the GitLab Runner host, run the following command: curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Registering the GitLab Runner +### Registering the GitLab Runner Follow [official instructions](https://docs.gitlab.com/runner/register/index.html) to register GitLab Runner in GitLab: set Shell as the executor. Once the registration is complete, you may want to perform [additional GitLab Runner configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html). -## Configuring the container registry +### Configuring the container registry [Enable garbage collection](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. @@ -51,7 +51,7 @@ Register emulators on your system using qemu-user-static: docker run --restart=always --name=qemu-user-static -d --privileged --entrypoint=/bin/sh multiarch/qemu-user-static -c "/register --reset -p yes && tail -f /dev/null" ``` {% if include.argocd == true %} -## Installing Argo CD Image Updater +### Installing Argo CD Image Updater Install Argo CD Image Updater with the ["continuous deployment of OCI Helm chart type application" patch](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid index ee93ebf5d..7a274d7ce 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid @@ -1,14 +1,14 @@ -## Requirements +### Requirements - GitLab; - Kubernetes to run the GitLab Runner. -## Installing and registering the GitLab Runner +### Installing and registering the GitLab Runner Follow [official instructions](https://docs.gitlab.com/runner/register/index.html) to install the GitLab Runner in Kubernetes and registering it. -## Configuring the GitLab Runner +### Configuring the GitLab Runner Modify the configuration of the registered GitLab Runner by adding the following parameters to its `config.toml`: @@ -65,7 +65,7 @@ Add one more parameter if you are going to deploy applications using werf to the You may want to perform [additional configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) of the GitLab Runner as well. -## Configuring Kubernetes +### Configuring Kubernetes If you enabled caching of `.werf` and `/builds` in the GitLab Runner configuration, create appropriate PersistentVolumeClaims in the cluster, for example: @@ -176,7 +176,7 @@ EOF {% include configurator/partials/ci/configuring_the_container_registry.md.liquid %} -## Preparing Kubernetes for multi-platform building (optional) +### Preparing Kubernetes for multi-platform building (optional) {% include configurator/partials/ci/cross_platform_note.md.liquid %} diff --git a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_project_main_section.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_project_main_section.md.liquid index 30183ed0b..b3ee40c5f 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_project_main_section.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/ci/gitlab_project_main_section.md.liquid @@ -1,4 +1,4 @@ -## Configuring the GitLab project +### Configuring the GitLab project {% if include.type == "best-monorepo-linux-buildah" or include.type == "best-monorepo-linux-docker" or include.type == "best-monorepo-kubernetes" or include.type == "best-monorepo-docker" or include.type == "best-application-docker" or include.type == "best-application-buildah" or include.type == "best-application-host-docker" or include.type == "best-application-kubernetes-buildah" %} - Enable [Require a successful pipeline for merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html#require-a-successful-pipeline-for-merge). @@ -31,7 +31,7 @@ * [Add a scheduled nightly task](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) to clean up the no longer needed images in the container registry by setting the `main`/`master` branch as the **Target branch**. -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is how the repository that uses werf for build and deploy might look: diff --git a/bin/configurator/static/_includes/en/configurator/partials/dev/buildah_install.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/dev/buildah_install.md.liquid index 9f2aa0d7b..82cc7d45e 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/dev/buildah_install.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/dev/buildah_install.md.liquid @@ -1,4 +1,4 @@ -## Installing Buildah +### Installing Buildah Perform the following steps to install Buildah: diff --git a/bin/configurator/static/_includes/en/configurator/partials/dev/cross_build.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/dev/cross_build.md.liquid index acd313cb4..41fc2406b 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/dev/cross_build.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/dev/cross_build.md.liquid @@ -1,4 +1,4 @@ -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. diff --git a/bin/configurator/static/_includes/en/configurator/partials/dev/install_main_block.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/dev/install_main_block.md.liquid index c6c167b68..a1e035861 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/dev/install_main_block.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/dev/install_main_block.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - {{include.shell}}; @@ -16,7 +16,7 @@ {% include configurator/partials/dev/buildah_install.md.liquid %} {% endif %} -## Installing werf +### Installing werf {% if include.os == "win" %} * [Install trdl](https://github.com/werf/trdl/releases/) to `:\Users\\bin\trdl`. diff --git a/bin/configurator/static/_includes/en/configurator/partials/dev/run_main_block.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/dev/run_main_block.md.liquid index ff2946d60..5cc886f74 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/dev/run_main_block.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/dev/run_main_block.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements * Kubernetes cluster. @@ -9,7 +9,7 @@ * PowerShell. {% endif %} -## Build and deploy with werf +### Build and deploy with werf Contents of the demo project: @@ -40,11 +40,11 @@ export WERF_BUILDAH_MODE=auto Specify werf secret key to decrypt secrets in `.helm/secret-values.yaml`: ```{{include.shell}} -{% if include.powershell == true %} +{%- if include.powershell == true %} $ENV:WERF_SECRET_KEY="733658e8ce39dff4ceef0a3e5d8c15f6" -{% else %} +{%- else %} export WERF_SECRET_KEY=733658e8ce39dff4ceef0a3e5d8c15f6 -{% endif %} +{%- endif %} ``` Build and deploy with werf: diff --git a/bin/configurator/static/_includes/en/configurator/partials/dev/windows_prepare.md.liquid b/bin/configurator/static/_includes/en/configurator/partials/dev/windows_prepare.md.liquid index 2ed05707f..fea85a9d8 100644 --- a/bin/configurator/static/_includes/en/configurator/partials/dev/windows_prepare.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/partials/dev/windows_prepare.md.liquid @@ -1,4 +1,4 @@ -## Preparing the system +### Preparing the system Grant the user permission to create symbolic links by following [these instructions](https://superuser.com/a/105381), or by running the following commands in PowerShell as an administrator: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid index 2ea22b04a..d6be32b7a 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - GitLab; @@ -8,15 +8,15 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). -## Installing GitLab Runner +### Installing GitLab Runner Install GitLab Runner on its dedicated host by following the [official instructions](https://docs.gitlab.com/runner/install/linux-repository.html). -## Registering GitLab Runner +### Registering GitLab Runner Follow the [official instructions](https://docs.gitlab.com/runner/register/index.html) to register GitLab Runner in GitLab; specify Docker as the executor and any image as the image (e.g. `alpine`). -## Configuring GitLab Runner +### Configuring GitLab Runner On the GitLab Runner host, open its `config.toml` configuration file and add the following options to the GitLab Runner you registered earlier: @@ -39,11 +39,11 @@ If the GitLab Runner host runs Linux kernel version 5.12 or lower, install `fuse If needed, perform [additional configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) of the GitLab Runner. -## Configuring the container registry +### Configuring the container registry [Enable garbage collection](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step is only needed to build images for platforms other than the host platform on which werf is being run. @@ -53,7 +53,7 @@ Register emulators on your system using qemu-user-static: docker run --restart=always --name=qemu-user-static -d --privileged --entrypoint=/bin/sh multiarch/qemu-user-static -c "/register --reset -p yes && tail -f /dev/null" ``` -## Installing Argo CD Image Updater +### Installing Argo CD Image Updater Install Argo CD Image Updater with the ["continuous deployment of OCI Helm chart type application" patch](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid index bfcb4fd1c..29629fc7d 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Configuring Argo CD Application +### Configuring Argo CD Application 1. Apply the following Application CRD to the target cluster to deploy a bundle from the container registry: @@ -49,7 +49,7 @@ data: EOF ``` -## Configuring a GitLab project +### Configuring a GitLab project - [Create and save the access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#create-a-project-access-token) for cleaning up the no longer needed images from the container registry; use the following parameters: @@ -73,7 +73,7 @@ EOF - [Add a scheduled nightly job](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) to clean up the no longer needed images in the container registry and set the `main`/`master` branch as the **Target branch**. -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is what the repository that uses werf for building and deploying might look like: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid index 840624e18..990af7fe1 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - GitLab; @@ -6,11 +6,11 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). -## Installing and registering the GitLab Runner +### Installing and registering the GitLab Runner Follow the [official instructions](https://docs.gitlab.com/runner/register/index.html) on how to install the GitLab Runner in Kubernetes and register it. -## Configuring the GitLab Runner +### Configuring the GitLab Runner Modify the configuration of the registered GitLab Runner by adding the following parameters to its `config.toml`: @@ -67,7 +67,7 @@ Add one more parameter if you are going to deploy applications using werf to the You may want to perform [additional configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) of the GitLab Runner as well. -## Configuring Kubernetes +### Configuring Kubernetes If you enabled caching of `.werf` and `/builds` in the GitLab Runner configuration, create appropriate PersistentVolumeClaims in the cluster, for example: @@ -176,11 +176,11 @@ spec: EOF ``` -## Configuring the container registry +### Configuring the container registry [Enable garbage collection](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) for your container registry. -## Preparing Kubernetes for multi-platform building (optional) +### Preparing Kubernetes for multi-platform building (optional) > This step is only needed to build images for platforms other than the host platform on which werf is being run. @@ -220,7 +220,7 @@ spec: memory: 50Mi ``` -## Installing Argo CD Image Updater +### Installing Argo CD Image Updater Install Argo CD Image Updater with the ["continuous deployment of OCI Helm chart type application" patch](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid index 9018f971b..1926839a6 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Configuring Argo CD Application +### Configuring Argo CD Application 1. Apply the following Application CRD to the target cluster to deploy a bundle from the container registry: @@ -49,7 +49,7 @@ data: EOF ``` -## Configuring the GitLab project +### Configuring the GitLab project - [Create and save the access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#create-a-project-access-token) for cleaning up the no longer needed images in the container registry; use the following parameters: @@ -73,7 +73,7 @@ EOF - [Add a scheduled nightly job](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) to clean up the no longer needed images in the container registry and set the `main`/`master` branch as the **Target branch**. -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is what the repository that uses werf for building and deploying might look like: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid index 05e62a6f7..7bda51209 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid @@ -1,14 +1,14 @@ -## Requirements +### Requirements * GitHub Actions; * GitHub-hosted Linux Runner. -## Setting up a GitHub project +### Setting up a GitHub project Save the kubeconfig file to access the Kubernetes cluster as a `KUBECONFIG_BASE64` [encrypted secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets), pre-encoding it in Base64. -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is how the repository that uses werf for build and deploy might look: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/gitlab-ci-cd/best-practice/with-per-repo-ci-cd/monorepo/docker-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/gitlab-ci-cd/best-practice/with-per-repo-ci-cd/monorepo/docker-runner/linux/buildah/infra.md.liquid index b44b58291..ef3c2ca71 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/gitlab-ci-cd/best-practice/with-per-repo-ci-cd/monorepo/docker-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/gitlab-ci-cd/best-practice/with-per-repo-ci-cd/monorepo/docker-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - GitLab; @@ -6,15 +6,15 @@ * [Docker Engine](https://docs.docker.com/engine/install/). -## Installing the GitLab Runner +### Installing the GitLab Runner Follow [official instructions](https://docs.gitlab.com/runner/install/linux-repository.html) to install the GitLab Runner on its dedicated host. -## Registering the GitLab Runner +### Registering the GitLab Runner Follow [official instructions](https://docs.gitlab.com/runner/register/index.html) to register the GitLab Runner in GitLab; set Docker as the executor and any image as the image (e.g., `alpine`). -## Configuring the GitLab Runner +### Configuring the GitLab Runner On the GitLab Runner host, open its `config.toml` configuration file and add the following options to the GitLab Runner you registered earlier: @@ -37,11 +37,11 @@ If the GitLab Runner host runs Linux kernel version 5.12 or lower, install `fuse You may also want to perform [additional configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) of the GitLab Runner. -## Configuring the container registry +### Configuring the container registry [Enable garbage collection]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#automating-the-container-registry-cleanup" | relative_url }}) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid index a58b8e3d7..e40a9f25a 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - CI system; @@ -8,7 +8,7 @@ * [Docker Engine](https://docs.docker.com/engine/install/). -## Configuring the Runner +### Configuring the Runner Create the `werf` volume on the host where CI jobs are run: @@ -26,11 +26,11 @@ Configure your CI system's Runner so that the containers you create have the fol If the host to run CI jobs has Linux kernel version 5.12 or lower, install `fuse` on the host and configure Runner so that the containers you create have the optional parameter `--device /dev/fuse`. -## Configuring the container registry +### Configuring the container registry [Enable garbage collection]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#container-registrys-garbage-collector" | relative_url }}) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid index 4d4803864..6e7ed97ab 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is how the repository that uses werf for build and deploy might look: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid index 7aa7de699..7f3648afb 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements - CI system; @@ -12,7 +12,7 @@ * GPG. -## Installing Buildah +### Installing Buildah To install Buildah, do the following on the host for running CI jobs: @@ -52,7 +52,7 @@ To install Buildah, do the following on the host for running CI jobs: * The `sysctl -n user.max_user_namespaces` command should return `15000` or more, otherwise run `echo 'user.max_user_namespaces = 15000' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p`. -## Installing werf +### Installing werf On the host for running CI jobs, run the following command to install werf: @@ -60,11 +60,11 @@ On the host for running CI jobs, run the following command to install werf: curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Configuring the container registry +### Configuring the container registry [Enable garbage collection]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#container-registrys-garbage-collector" | relative_url }}) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid index f816dba5c..ba8cae1f7 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is how the repository that uses werf for build and deploy might look: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid index 28af8e93d..f19e4b717 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid @@ -1,4 +1,4 @@ -## Requirements +### Requirements * CI system; @@ -14,7 +14,7 @@ - [Docker Engine](https://docs.docker.com/engine/install/). -## Installing werf +### Installing werf To install werf, run the following command on the host for running CI jobs: @@ -22,11 +22,11 @@ To install werf, run the following command on the host for running CI jobs: curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Configuring the container registry +### Configuring the container registry [Enable garbage collection]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#container-registrys-garbage-collector" | relative_url }}) for your container registry. -## Preparing the system for cross-platform building (optional) +### Preparing the system for cross-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid index 47116e244..9fd3e11aa 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid @@ -1,4 +1,4 @@ -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is how the repository that uses werf for build and deploy might look: diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid index c12691a06..3d8e67772 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid @@ -1,10 +1,10 @@ -## Requirements +### Requirements - CI system; - Kubernetes for running CI jobs with your CI system's Kubernetes Runner. -## Configuring the Runner +### Configuring the Runner Configure your CI system's Runner so that the containers you create have the following configuration: @@ -57,7 +57,7 @@ spec: serviceAccountName: ci-kubernetes-runner ``` -## Configuring Kubernetes +### Configuring Kubernetes If you enabled caching of `.werf` in the Kubernetes Runner configuration, create the appropriate PersistentVolumeClaim in the cluster as follows: @@ -153,11 +153,11 @@ spec: EOF ``` -## Configuring the container registry +### Configuring the container registry [Enable garbage collection]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#container-registrys-garbage-collector" | relative_url }}) for your container registry. -## Preparing Kubernetes for multi-platform building (optional) +### Preparing Kubernetes for multi-platform building (optional) > This step only needed to build images for platforms other than host platform running werf. diff --git a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid index 67046c169..23cc92fa2 100644 --- a/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/en/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Configuring CI/CD of the project +### Configuring CI/CD of the project This is how the repository that uses werf for build and deploy might look: diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/argocd_host_project_section.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/argocd_host_project_section.md.liquid index 7c2f85551..255417604 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/argocd_host_project_section.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/argocd_host_project_section.md.liquid @@ -1,4 +1,4 @@ -## Настройка приложения Argo CD +### Настройка приложения Argo CD 1. В целевом кластере примените следующий Application CRD, чтобы развернуть бандл из container registry: @@ -49,7 +49,7 @@ data: EOF ``` -## Настройка GitLab-проекта +### Настройка GitLab-проекта - [Создайте и сохраните токен доступа](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#create-a-project-access-token) для очистки ненужных образов из container registry. Используйте следующие параметры: @@ -73,7 +73,7 @@ EOF - [Добавьте ночную задачу по расписанию](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) для очистки ненужных образов в container registry, установив ветку `main`/`master` в качестве целевой (**Target branch**). -## Настройка CI/CD проекта +### Настройка CI/CD проекта Вот как может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/buildah_install.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/buildah_install.md.liquid index c4a801828..4805ee89e 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/buildah_install.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/buildah_install.md.liquid @@ -1,4 +1,4 @@ -## Установка Buildah +### Установка Buildah Для установки Buildah выполните следующие инструкции на хосте для GitLab Runner: diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/configuring_the_container_registry.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/configuring_the_container_registry.md.liquid index 4357bd6eb..2af4fdaa3 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/configuring_the_container_registry.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/configuring_the_container_registry.md.liquid @@ -1,3 +1,3 @@ -## Конфигурация container registry +### Конфигурация container registry [Включите сборщик мусора](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) вашего container registry. diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_docker_main_section.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_docker_main_section.md.liquid index 9190da407..13bffb941 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_docker_main_section.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_docker_main_section.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - GitLab; @@ -6,15 +6,15 @@ - [Docker Engine](https://docs.docker.com/engine/install/). -## Установка GitLab Runner +### Установка GitLab Runner Установите GitLab Runner на выделенный для него хост, следуя [официальным инструкциям](https://docs.gitlab.com/runner/install/linux-repository.html). -## Регистрация GitLab Runner +### Регистрация GitLab Runner Для регистрации GitLab Runner в GitLab следуйте [официальным инструкциям](https://docs.gitlab.com/runner/register/index.html), указав Docker в качестве executor'а и любой образ в качестве image (например, `alpine`). -## Настройка GitLab Runner +### Настройка GitLab Runner На хосте GitLab Runner'а откройте его конфигурационный файл `config.toml` и добавьте зарегистрированному ранее GitLab Runner'у следующие опции: @@ -39,7 +39,7 @@ {% include configurator/partials/ci/configuring_the_container_registry.md.liquid %} -## Подготовка системы к кроссплатформенной сборке (опционально) +### Подготовка системы к кроссплатформенной сборке (опционально) {% include configurator/partials/ci/cross_platform_note.md.liquid %} diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_host_main_section.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_host_main_section.md.liquid index e325773a6..698f8e53a 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_host_main_section.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_host_main_section.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - GitLab; @@ -17,7 +17,7 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). {% endif %} -## Установка GitLab Runner +### Установка GitLab Runner Установите GitLab Runner на выделенный для него хост, следуя [официальным инструкциям](https://docs.gitlab.com/runner/install/linux-repository.html). @@ -25,7 +25,7 @@ {% include configurator/partials/ci/buildah_install.md.liquid %} {% endif %} -## Установка werf +### Установка werf Для установки werf на хосте для GitLab Runner выполните: @@ -33,15 +33,15 @@ curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Регистрация GitLab Runner +### Регистрация GitLab Runner Для регистрации GitLab Runner в GitLab следуйте [официальным инструкциям](https://docs.gitlab.com/runner/register/index.html), указав Shell в качестве executor'а. При желании после регистрации произведите [дополнительную конфигурацию](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) GitLab Runner'а. -## Конфигурация container registry +### Конфигурация container registry [Включите сборщик мусора](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) вашего container registry. -## Подготовка системы к кроссплатформенной сборке (опционально) +### Подготовка системы к кроссплатформенной сборке (опционально) > Данный шаг требуется только для сборки образов для платформ, отличных от платформы системы, где запущен werf. @@ -51,7 +51,7 @@ curl -sSL https://werf.io/install.sh | bash -s -- --ci docker run --restart=always --name=qemu-user-static -d --privileged --entrypoint=/bin/sh multiarch/qemu-user-static -c "/register --reset -p yes && tail -f /dev/null" ``` {% if include.argocd == true %} -## Установка Argo CD Image Updater +### Установка Argo CD Image Updater Установите Argo CD Image Updater с патчем ["continuous deployment of OCI Helm chart type application"](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid index e608dd293..e29b3ac9a 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_kubernetes_main_section.md.liquid @@ -1,14 +1,14 @@ -## Требования +### Требования - GitLab; - Kubernetes для запуска GitLab Runner. -## Установка и регистрация GitLab Runner +### Установка и регистрация GitLab Runner Для установки GitLab Runner в Kubernetes и его регистрации в GitLab следуйте [официальным инструкциям](https://docs.gitlab.com/runner/register/index.html). -## Настройка GitLab Runner +### Настройка GitLab Runner Измените конфигурацию зарегистрированного GitLab Runner'а, добавив в его `config.toml` следующие параметры: @@ -65,7 +65,7 @@ При желании произведите [дополнительную конфигурацию](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) GitLab Runner'а. -## Настройка Kubernetes +### Настройка Kubernetes Если в конфигурации GitLab Runner вы включили кеширование `.werf` и `/builds`, то создайте в кластере соответствующие PersistentVolumeClaims, например: @@ -176,7 +176,7 @@ EOF {% include configurator/partials/ci/configuring_the_container_registry.md.liquid %} -## Подготовка кластера Kubernetes к мультиплатформенной сборке (опционально) +### Подготовка кластера Kubernetes к мультиплатформенной сборке (опционально) {% include configurator/partials/ci/cross_platform_note.md.liquid %} diff --git a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_project_main_section.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_project_main_section.md.liquid index e95d9196b..d73acfdc0 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_project_main_section.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/ci/gitlab_project_main_section.md.liquid @@ -1,4 +1,4 @@ -## Настройка проекта GitLab +### Настройка проекта GitLab {% if include.type == "best-monorepo-linux-buildah" or include.type == "best-monorepo-linux-docker" or include.type == "best-monorepo-kubernetes" or include.type == "best-monorepo-docker" or include.type == "best-application-docker" or include.type == "best-application-buildah" or include.type == "best-application-host-docker" or include.type == "best-application-kubernetes-buildah" %} - Включите [требование удачно выполненного pipeline для merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html#require-a-successful-pipeline-for-merge). @@ -32,7 +32,7 @@ - [Добавьте плановое задание](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) на каждую ночь для очистки ненужных образов в container registry, указав ветку `main`/`master` в качестве **Target branch**. -## Конфигурация CI/CD проекта +### Конфигурация CI/CD проекта Так может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/partials/dev/buildah_install.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/dev/buildah_install.md.liquid index 4551da8bc..6ac3d43c9 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/dev/buildah_install.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/dev/buildah_install.md.liquid @@ -1,4 +1,4 @@ -## Установка Buildah +### Установка Buildah Для установки Buildah выполните следующие инструкции: diff --git a/bin/configurator/static/_includes/ru/configurator/partials/dev/cross_build.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/dev/cross_build.md.liquid index c6712fed3..1d345a407 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/dev/cross_build.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/dev/cross_build.md.liquid @@ -1,4 +1,4 @@ -## Подготовка системы к кроссплатформенной сборке (опционально) +### Подготовка системы к кроссплатформенной сборке (опционально) > Данный шаг требуется только для сборки образов для платформ, отличных от платформы системы, где запущен werf. diff --git a/bin/configurator/static/_includes/ru/configurator/partials/dev/install_main_block.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/dev/install_main_block.md.liquid index 8114fa86b..f8ee56f0f 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/dev/install_main_block.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/dev/install_main_block.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - {{include.shell}}; @@ -16,7 +16,7 @@ {% include configurator/partials/dev/buildah_install.md.liquid %} {% endif %} -## Установка werf +### Установка werf {% if include.os == "win" %} * [Установите trdl](https://github.com/werf/trdl/releases/) в `<диск>:\Users\<имя пользователя>\bin\trdl`. diff --git a/bin/configurator/static/_includes/ru/configurator/partials/dev/run_main_block.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/dev/run_main_block.md.liquid index c7ad4cb17..811dc11cf 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/dev/run_main_block.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/dev/run_main_block.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования * Кластер Kubernetes. @@ -9,7 +9,7 @@ * PowerShell. {% endif %} -## Сборка и развертывание с werf +### Сборка и развертывание с werf Содержимое демо-проекта: @@ -41,11 +41,11 @@ export WERF_BUILDAH_MODE=auto Укажите секретный ключ werf для расшифровки секретов в `.helm/secret-values.yaml`: ```{{include.shell}} -{% if include.powershell == true %} +{%- if include.powershell == true %} $ENV:WERF_SECRET_KEY="733658e8ce39dff4ceef0a3e5d8c15f6" -{% else %} +{%- else %} export WERF_SECRET_KEY=733658e8ce39dff4ceef0a3e5d8c15f6 -{% endif %} +{%- endif %} ``` Запустите сборку и развертывание с werf: diff --git a/bin/configurator/static/_includes/ru/configurator/partials/dev/windows_prepare.md.liquid b/bin/configurator/static/_includes/ru/configurator/partials/dev/windows_prepare.md.liquid index c981893ce..ee2863f3c 100644 --- a/bin/configurator/static/_includes/ru/configurator/partials/dev/windows_prepare.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/partials/dev/windows_prepare.md.liquid @@ -1,4 +1,4 @@ -## Подготовка системы +### Подготовка системы Выдайте пользователю права на создание символьных ссылок следуя [этим инструкциям](https://superuser.com/a/105381), либо выполнив в PowerShell от администратора следующее: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid index d2b318aa9..82e7d9296 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - GitLab; @@ -8,15 +8,15 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). -## Установка GitLab Runner +### Установка GitLab Runner Установите GitLab Runner на выделенный для него хост, следуя [официальным инструкциям](https://docs.gitlab.com/runner/install/linux-repository.html). -## Регистрация GitLab Runner +### Регистрация GitLab Runner Следуйте [официальным инструкциям](https://docs.gitlab.com/runner/register/index.html) по регистрации GitLab Runner'а в GitLab'е; укажите `docker` в качестве исполнителя и любой образ в качестве default image (например, `alpine`). -## Настройка GitLab Runner +### Настройка GitLab Runner На хосте с GitLab Runner'ом откройте его конфигурационный файл `config.toml` и добавьте следующие параметры к GitLab Runner'у, который вы зарегистрировали выше: @@ -39,11 +39,11 @@ При необходимости проведите [дополнительную настройку](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) GitLab Runner'а. -## Настройка container registry +### Настройка container registry [Включите сборку мусора](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) в своем container registry. -## Подготовка системы для кроссплатформенной борки (опционально) +### Подготовка системы для кроссплатформенной борки (опционально) > Этот шаг необходим только если проводится сборка образов для платформ, отличных от хост-платформы, на которой запущен werf. @@ -53,7 +53,7 @@ docker run --restart=always --name=qemu-user-static -d --privileged --entrypoint=/bin/sh multiarch/qemu-user-static -c "/register --reset -p yes && tail -f /dev/null" ``` -## Установка Argo CD Image Updater +### Установка Argo CD Image Updater Установите Argo CD Image Updater с патчем ["continuous deployment of OCI Helm chart type application"](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid index 0db974fe5..849a306a3 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/docker-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Настройка приложения Argo CD +### Настройка приложения Argo CD 1. В целевом кластере примените следующий Application CRD, чтобы развернуть бандл из container registry: @@ -49,7 +49,7 @@ data: EOF ``` -## Настройка GitLab-проекта +### Настройка GitLab-проекта - [Создайте и сохраните токен](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#create-a-project-access-token) для очистки ненужных образов из container registry. Используйте следующие параметры: @@ -73,7 +73,7 @@ EOF - [Добавьте ночную задачу по расписанию](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) для очистки ненужных образов в container registry, установив ветку `main`/`master` в качестве целевой (**Target branch**). -## Настройка CI/CD проекта +### Настройка CI/CD проекта Вот как может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid index 36f382b26..d65e91df4 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - GitLab; @@ -6,11 +6,11 @@ - [Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd). -## Установка и регистрация GitLab Runner +### Установка и регистрация GitLab Runner Установите GitLab Runner в Kubernetes и зарегистрируйте его, следуя [официальным инструкциям](https://docs.gitlab.com/runner/register/index.html). -## Настройка GitLab Runner +### Настройка GitLab Runner Измените конфигурацию зарегистрированного GitLab Runner'а, добавив в его `config.toml` следующие параметры: @@ -67,7 +67,7 @@ При необходимости проведите [дополнительную настройку](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) GitLab Runner'а. -## Настройка Kubernetes +### Настройка Kubernetes Если вы включили кеширование `.werf` и `/builds` в конфигурации GitLab Runner'а, создайте соответствующие PersistentVolumeClaims в кластере, например: @@ -176,11 +176,11 @@ spec: EOF ``` -## Настройка container registry +### Настройка container registry [Включите сборку мусора](https://docs.gitlab.com/ee/administration/packages/container_registry.html#container-registry-garbage-collection) в своем container registry. -## Подготовка Kubernetes для многоплатформенной сборки (опционально) +### Подготовка Kubernetes для многоплатформенной сборки (опционально) > Этот шаг необходим только если собираются образы для платформ, отличных от хост-платформы, на которой запущен werf. @@ -220,7 +220,7 @@ spec: memory: 50Mi ``` -## Установка Argo CD Image Updater +### Установка Argo CD Image Updater Установите Argo CD Image Updater с патчем ["continuous deployment of OCI Helm chart type application"](https://github.com/argoproj-labs/argocd-image-updater/pull/405): diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid index 875ad553f..c4ab7c614 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/argocd-with-gitlab-ci-cd/simple/kubernetes-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Настройка приложения Argo CD +### Настройка приложения Argo CD 1. В целевом кластере примените следующий Application CRD, чтобы развернуть бандл из container registry: @@ -49,7 +49,7 @@ data: EOF ``` -## Настройка GitLab-проекта +### Настройка GitLab-проекта - [Создайте и сохраните токен](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#create-a-project-access-token) для очистки ненужных образов из container registry. Используйте следующие параметры: @@ -73,7 +73,7 @@ EOF - [Добавьте ночную задачу по расписанию](https://docs.gitlab.com/ee/ci/pipelines/schedules.html#add-a-pipeline-schedule) для очистки ненужных образов в container registry, установив ветку `main`/`master` в качестве целевой (**Target branch**). -## Настройка CI/CD проекта +### Настройка CI/CD проекта Вот как может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid index 7249adffc..40c8f7bb9 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/github-actions/simple/host-runner/linux/docker/project.md.liquid @@ -1,14 +1,14 @@ -## Требования +### Требования * GitHub Actions; * GitHub-hosted Linux Runner. -## Настройка проекта GitHub +### Настройка проекта GitHub Сохраните kubeconfig-файл для доступа к Kubernetes-кластеру [в зашифрованный секрет](https://docs.github.com/en/actions/security-guides/encrypted-secrets) `KUBECONFIG_BASE64`, предварительно закодировав его в Base64. -## Конфигурация CI/CD проекта +### Конфигурация CI/CD проекта Так может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid index aea4cf26c..4a5718db1 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - CI-система; @@ -8,7 +8,7 @@ * [Docker Engine](https://docs.docker.com/engine/install/). -## Настройка Runner'а +### Настройка Runner'а На хосте для запуска CI задач создайте volume `werf`: @@ -26,11 +26,11 @@ docker volume create werf Если хост для запуска CI-задач имеет версию ядра Linux 5.12 или ниже, то установите на хост `fuse` и настройте Runner так, чтобы создаваемые контейнеры имели дополнительный параметр `--device /dev/fuse`. -## Конфигурация container registry +### Конфигурация container registry [Включите сборщик мусора]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#%D1%81%D0%B1%D0%BE%D1%80%D1%89%D0%B8%D0%BA-%D0%BC%D1%83%D1%81%D0%BE%D1%80%D0%B0-container-registry" | relative_url }}) вашего container registry. -## Подготовка системы к кроссплатформенной сборке (опционально) +### Подготовка системы к кроссплатформенной сборке (опционально) > Данный шаг требуется только для сборки образов для платформ, отличных от платформы системы, где запущен werf. diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid index 0b7bd7fb3..74f4b5999 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/docker-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Конфигурация CI/CD проекта +### Конфигурация CI/CD проекта Так может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid index e3c32c676..3774be8e1 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/infra.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования - CI-система; @@ -12,7 +12,7 @@ * GPG. -## Установка Buildah +### Установка Buildah Для установки Buildah выполните следующие инструкции на хосте для запуска CI-задач: @@ -52,7 +52,7 @@ * Команда `sysctl -n user.max_user_namespaces` должна вернуть `15000` или больше, а иначе выполните `echo 'user.max_user_namespaces = 15000' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p`. -## Установка werf +### Установка werf Для установки werf, на хосте для запуска CI-задач выполните: @@ -60,11 +60,11 @@ curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Конфигурация container registry +### Конфигурация container registry [Включите сборщик мусора]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#%D1%81%D0%B1%D0%BE%D1%80%D1%89%D0%B8%D0%BA-%D0%BC%D1%83%D1%81%D0%BE%D1%80%D0%B0-container-registry" | relative_url }}) вашего container registry. -## Подготовка системы к кроссплатформенной сборке (опционально) +### Подготовка системы к кроссплатформенной сборке (опционально) > Данный шаг требуется только для сборки образов для платформ, отличных от платформы системы, где запущен werf. diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid index 5001e88ce..0b75f013a 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Конфигурация CI/CD проекта +### Конфигурация CI/CD проекта Так может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid index c4038aea9..70d4765ca 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/infra.md.liquid @@ -1,4 +1,4 @@ -## Требования +### Требования * CI-система; @@ -14,7 +14,7 @@ - [Docker Engine](https://docs.docker.com/engine/install/). -## Установка werf +### Установка werf Для установки werf, на хосте для запуска CI-задач выполните: @@ -22,11 +22,11 @@ curl -sSL https://werf.io/install.sh | bash -s -- --ci ``` -## Конфигурация container registry +### Конфигурация container registry [Включите сборщик мусора]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#%D1%81%D0%B1%D0%BE%D1%80%D1%89%D0%B8%D0%BA-%D0%BC%D1%83%D1%81%D0%BE%D1%80%D0%B0-container-registry" | relative_url }}) вашего container registry. -## Подготовка системы к кроссплатформенной сборке (опционально) +### Подготовка системы к кроссплатформенной сборке (опционально) > Данный шаг требуется только для сборки образов для платформ, отличных от платформы системы, где запущен werf. diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid index 82d2cfa8f..f2a6933a2 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/host-runner/linux/docker/project.md.liquid @@ -1,4 +1,4 @@ -## Конфигурация CI/CD проекта +### Конфигурация CI/CD проекта Так может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid index 9e24180cc..d21c8bfc0 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/infra.md.liquid @@ -1,10 +1,10 @@ -## Требования +### Требования - CI-система; - Kubernetes для запуска CI-задач с установленным Kubernetes Runner вашей CI-системы. -## Настройка Runner'а +### Настройка Runner'а Настройте Kubernetes Runner вашей CI-системы так, чтобы создаваемые им Pod'ы имели следующую конфигурацию: @@ -57,7 +57,7 @@ spec: serviceAccountName: ci-kubernetes-runner ``` -## Настройка Kubernetes +### Настройка Kubernetes Если в конфигурации Kubernetes Runner'а вы включили кеширование `.werf`, то создайте в кластере соответствующий PersistentVolumeClaim, например: @@ -153,11 +153,11 @@ spec: EOF ``` -## Конфигурация container registry +### Конфигурация container registry [Включите сборщик мусора]({{ "/documentation/v1.2/usage/cleanup/cr_cleanup.html#%D1%81%D0%B1%D0%BE%D1%80%D1%89%D0%B8%D0%BA-%D0%BC%D1%83%D1%81%D0%BE%D1%80%D0%B0-container-registry" | relative_url }}) вашего container registry. -## Подготовка кластера Kubernetes к мультиплатформенной сборке (опционально) +### Подготовка кластера Kubernetes к мультиплатформенной сборке (опционально) > Данный шаг требуется только для сборки образов для платформ, отличных от платформы системы, где запущен werf. diff --git a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid index 295cb42ce..c3ec84509 100644 --- a/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid +++ b/bin/configurator/static/_includes/ru/configurator/tab/ci/other-ci-cd-system/simple/kubernetes-runner/linux/buildah/project.md.liquid @@ -1,4 +1,4 @@ -## Конфигурация CI/CD проекта +### Конфигурация CI/CD проекта Так может выглядеть репозиторий, использующий werf для сборки и развертывания: diff --git a/bin/configurator/templates/includes/tabs-for-pages.html b/bin/configurator/templates/includes/tabs-for-pages.html new file mode 100644 index 000000000..10137aa77 --- /dev/null +++ b/bin/configurator/templates/includes/tabs-for-pages.html @@ -0,0 +1,12 @@ +
+ {{- range $i, $tab := .Tabs }} + {% assign tab_info = site.data.common.configurator.tabs | find: "name", "{{ $tab.Name }}" %} + {% assign tab_title = tab_info.title[page.lang] | default: "{{ $tab.Name }}" %} + +

{{`{{tab_title}}`}}

+ +
+{% include {{ $tab.IncludePath }} {{ range $option := $.Options }}{{ $option.Name }}='{{ $option.Value }}' {{ end }} {{ range $k, $v := $tab.Params }}{{ $k }}='{{ $v }}' {{ end -}} %} +
+ {{ end }} +
diff --git a/bin/configurator/templates/pages/configurator.html b/bin/configurator/templates/pages/configurator.html index c99fa30f9..cf5e10f66 100644 --- a/bin/configurator/templates/pages/configurator.html +++ b/bin/configurator/templates/pages/configurator.html @@ -1,12 +1,10 @@ --- title: {{ .Title }} permalink: {{ .Permalink }} -layout: none -search: exclude -sitemap_include: false -sidebar: none +layout: plain +breadcrumbs: none --- - +

Быстрый старт

{{- range $group := .Groups }} @@ -37,6 +35,6 @@
-{% include {{ .DefaultIncludePath }} %} +{{ if .PageTab }} {% include {{ .IncludePath }} %} {{ else }} {% include {{ .DefaultIncludePath }} %} {{ end }}
diff --git a/bin/configurator/templates/pages/page.html b/bin/configurator/templates/pages/page.html new file mode 100644 index 000000000..d95d90143 --- /dev/null +++ b/bin/configurator/templates/pages/page.html @@ -0,0 +1,12 @@ +--- +title: {{ .Title }} +permalink: {{ .Permalink }} +layout: page-nosidebar +breadcrumbs: none +--- + +
+
+{{ if .PageTab }}{% include {{ .IncludePath }} %}{{ else }}{% include {{ .DefaultIncludePath }} %}{{ end }} +
+
\ No newline at end of file diff --git a/sitemap-site.xml b/sitemap-site.xml index 0e4bd4f7b..28d6dff03 100644 --- a/sitemap-site.xml +++ b/sitemap-site.xml @@ -22,16 +22,4 @@ search: exclude 0.5 {%- endfor %} - - {%- assign configurator_links = site.data.common.install_sitemap.links %} - {%- for link in configurator_links %} - - {{ site.url }}/documentation/v1.2/index.html?{{ link }} - - - {{site.time | date: '%Y-%m-%d' }} - daily - 0.5 - - {%- endfor %} diff --git a/werf.yaml b/werf.yaml index 796c36266..6e8f438ac 100644 --- a/werf.yaml +++ b/werf.yaml @@ -69,7 +69,7 @@ ansible: chdir: /artifacts --- image: configuration_artifacts -from: golang:1.16 +from: golang:1.21 fromCacheVersion: {{ $.CacheVersion }} git: - add: /bin/configurator