Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ updateAddIfMissing:

### Спецификация запроса

Незаданные поля `templateId`, `templatePackSource`, `targetRepositoryUrl` и `targetBranch` заполняются из параметров сущности микросервиса по ролям [правил маппинга](../../home/mapping/#микросервисы).
Незаданные `templateId` и `templatePackSource` заполняются из управляемых параметров сущности микросервиса. Поля `targetRepositoryUrl` и `targetBranch` заполняются по ролям [правил маппинга](../../home/mapping/#микросервисы).

| Название | Обязательность | Описание | Значение по умолчанию |
| ------------------------ | -------------- | ---------------------------------------------------------------------------------------- | --------------------- |
| targetRepositoryUrl | Да | HTTPS-адрес репозитория микросервиса | Роль `microservice_repository` |
| targetBranch | Нет | Ветка, от которой создаётся ветка обновления | Роль `microservice_default_branch`, затем «Ветка по умолчанию» реестра шаблонов, затем `main` |
| sourceBranch | Нет | Ветка, в которую записываются изменения | `<префикс ветки обновления><версия>`, например `ddp/template-upgrade-1.3.0` |
| templateId | Да | Идентификатор шаблона | Роль `microservice_binding_template_id` |
| templatePackSource | Да | Название подключения в реестре шаблонов | Роль `microservice_binding_template_source` |
| templateId | Да | Идентификатор шаблона | Параметр `ddp_template_id` |
| templatePackSource | Да | Название подключения в реестре шаблонов | Параметр `ddp_template_source` |
| templateVersion | Нет | Целевая версия шаблона в формате semver | Последняя версия шаблона |
| upgradeStrategy | Нет | Стратегия обновления: `selective`, `additive`, `selective_additive`, `full` или `merge` | Параметр микросервиса, затем стратегия пакета, затем `selective` |
| updateOverwrite | Нет | Glob-шаблоны перезаписываемых путей | Параметр микросервиса, затем список пакета |
Expand Down
2 changes: 1 addition & 1 deletion content/documentation/admin/datasets.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ weight: 74

После применения заполните в профиле пользователя учётные данные «GitLab токен» и «GitLab username».

Группы, репозитории и виджеты GitLab для главной создают наборы данных «GitLab: группы», «GitLab: активность репозиториев» и «GitLab: виджеты». Они описаны в разделе [«Первоначальная настройка»](../home/setup/#наборы-данных-мастера).
Группы и виджеты GitLab для главной создают наборы данных «GitLab: группы» и «GitLab: виджеты». Они описаны в разделе [«Первоначальная настройка»](../home/setup/#наборы-данных-мастера).

### Kubernetes

Expand Down
2 changes: 1 addition & 1 deletion content/documentation/admin/datasources/types.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ DDP (портал) выполняет GET-запрос по URL: `/api/v2/produc

Источник данных типа `GitlabRepositoryActivity` возвращает активность проектов GitLab: число открытых merge request, последний коммит и последний пайплайн ветки по умолчанию.

Источник заполняет показатели карточки микросервиса на главной и используется набором данных «GitLab: активность репозиториев».
Источник можно настроить для записи активности репозиториев в собственные параметры каталога. Для вывода пайплайнов и запросов на слияние в карточке микросервиса на главной используются [слоты виджетов](../home/mapping/#слоты-виджетов).

### Авторизация

Expand Down
22 changes: 11 additions & 11 deletions content/documentation/admin/examples/home-custom-catalog.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,27 +57,27 @@ description: Настройка правил маппинга главной DDP

## Заполнение областей

Области заполняются по очереди: связи и параметры роли выбираются из ресурса её родительской роли, поэтому сначала сопоставьте ресурсы.
Добавьте существующие ресурсы в соответствующие области. В таблицах их свойств и связей назначьте значения в поле «Роль на главной».

Заполните область «Системы»:

1. В блоке «Ресурс каталога» выберите «Продукты».
1. В блоке «Свойства» выберите `domain` для «Домен системы» и `status` для «Жизненный цикл системы».
1. Нажмите «Добавить ресурс каталога» и выберите «Продукты».
1. В таблице «Свойства ресурса» назначьте параметру `domain` роль «Домен системы», а параметру `status` — «Жизненный цикл системы».

Заполните область «Микросервисы»:

1. В блоке «Ресурсы каталога» нажмите «Добавить ресурс» и выберите «Сервисы».
1. В карточке ресурса выберите параметры `lang` для «Язык микросервиса» и `repo_url` для «Репозиторий микросервиса».
1. Выберите связь «Продукт — сервис» для «Содержит микросервис» и связь «Сервис — workload» для «Имеет развёртывание».
1. Нажмите «Добавить ресурс каталога» и выберите «Сервисы».
1. Параметру `lang` назначьте роль «Язык микросервиса», а параметру `repo_url` — «Репозиторий микросервиса».
1. В таблице «Связи ресурса» назначьте связи «Продукт — сервис» роль «Содержит микросервис», а связи «Сервис — workload» — «Имеет развёртывание».

Заполните области «Окружения» и «Развёртывания»:

1. В области «Окружения» выберите ресурс «Стенды» и параметры `stand_type` для «Тип окружения» и `base_domain` для «Домен окружения».
1. В области «Развёртывания» выберите ресурс «Workloads», связь «Workload — стенд» для «Развёртывание в окружении» и параметры `replicas` и `image`.
1. В области «Окружения» добавьте ресурс «Стенды». Параметру `stand_type` назначьте роль «Тип окружения», параметру `base_domain` — «Домен окружения».
1. В области «Развёртывания» добавьте ресурс «Workloads». Связи «Workload — стенд» назначьте роль «Развёртывание в окружении», параметру `replicas` — «Реплики развёртывания», параметру `image` — «Тег образа развёртывания».
1. В поле «Пример значений» выберите сущность и проверьте, что строки параметров содержат ожидаемые значения.
1. Нажмите «Сохранить».

Нажмите «Сохранить».

Если после сохранения изменить ресурс роли, форма очистит зависимые связи и параметры. Проверьте их перед повторным сохранением.
Сопоставления отдельного ресурса можно изменить из каталога: откройте меню ресурса → «Маппинг главной», выберите «Роль ресурса на главной» и назначьте роли его свойствам и связям. Порядок описан [в настройке со страницы ресурса](../home/mapping/#настройка-со-страницы-ресурса).

## Проверка результата

Expand Down
10 changes: 5 additions & 5 deletions content/documentation/admin/examples/home-quick-start.ru.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Быстрая настройка главной
weight: 30
description: Пошаговая настройка главной DDP на новой установке — мастер первоначальной настройки, включение главной, учётные данные, реестр шаблонов, привязка процессов к шаблонам и проверка результата.
description: Пошаговая настройка главной DDP на новой установке — мастер первоначальной настройки, учётные данные, реестр шаблонов, привязка процессов к шаблонам и проверка результата.
---

Инструкция описывает настройку главной на новой установке Deckhouse Development Portal (DDP, портал) с каноничной моделью каталога. В результате на главной отображаются окружения и развёртывания кластера, а разработчики создают микросервисы из шаблонов и разворачивают их на окружения.
Expand Down Expand Up @@ -36,15 +36,15 @@ description: Пошаговая настройка главной DDP на но

Если применение набора завершилось ошибкой, исправьте причину и нажмите «Повторить с текущего».

## Включение главной
## Проверка набора маппинга

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

1. Перейдите в раздел «Администрирование» → «Справочники» → «Правила маппинга».
1. Убедитесь, что в таблице есть набор «Главная (по умолчанию)» с включённым переключателем «По умолчанию для главной».
1. Включите переключатель «Показывать главную».
1. Откройте вкладку «Главная» и перейдите из раздела «Рабочие пространства» в нужный раздел каталога.

В верхней панели портала появится вкладка «Главная».
Вкладка «Главная» доступна сразу после установки портала.

## Учётные данные

Expand Down
6 changes: 3 additions & 3 deletions content/documentation/admin/examples/home-widget-slot.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Вывод виджета GitLab на вкладках «Пайпл

- разрешения на создание виджетов и разрешение `update:home-mapping-sets`;
- внешний сервис GitLab;
- у сущностей микросервисов — параметр с числовым ID проекта GitLab, сопоставленный роли `microservice_gitlab_project_id`. В каноничной модели каталога это параметр `gitlab_repository_id`, который заполняет процесс создания микросервиса из шаблона или источник данных «GitLab: активность репозиториев».
- у сущностей микросервисов — параметр с числовым ID проекта GitLab, сопоставленный роли `microservice_repository_id`. В каноничной модели каталога это параметр `vcs_repository_id`, который заполняет процесс создания микросервиса из шаблона. Для собственного каталога настройте заполнение параметра вашим процессом или источником данных.

Набор данных «GitLab: виджеты» создаёт готовые виджеты для обеих вкладок. Инструкция показывает, как настроить виджет самостоятельно, например для другой системы контроля версий или с другими параметрами.

Expand All @@ -33,7 +33,7 @@ description: Вывод виджета GitLab на вкладках «Пайпл
| `.context.microservice.uuid` | UUID сущности микросервиса |
| `.context.microservice.slug` | Идентификатор микросервиса |
| `.context.microservice.name` | Название микросервиса |
| `.context.repository.id` | Значение роли `microservice_gitlab_project_id` |
| `.context.repository.id` | Значение роли `microservice_repository_id` |
| `.context.repository.url` | Значение роли `microservice_repository` |

Контекст передаётся только на вкладках карточки микросервиса. Для дашбордов создайте отдельный виджет с конкретным ID проекта.
Expand All @@ -58,4 +58,4 @@ description: Вывод виджета GitLab на вкладках «Пайпл

На вкладке отображаются пайплайны репозитория выбранного микросервиса. При выборе другого микросервиса виджет показывает пайплайны его репозитория.

Если на вкладке отображается «Раздел пока недоступен», слот виджета не заполнен. Если виджет не показывает данные, проверьте, что у микросервиса заполнен параметр, сопоставленный роли `microservice_gitlab_project_id`.
Если на вкладке отображается «Раздел пока недоступен», слот виджета не заполнен. Если виджет не показывает данные, проверьте, что у микросервиса заполнен параметр, сопоставленный роли `microservice_repository_id`.
Loading
Loading