Для улучшения работы сайта мы используем файлы cookies. Оставаясь на сайте, вы соглашаетесь с политикой обработки персональных данных.

Создание независимой копии (fork) продукта в Конструкторе

В этой инструкции описан процесс создания независимой копии продукта и связанных с ним объектов.

Независимая копия позволяет изменять настройки продукта, графы, репозитории, шаблоны и другие компоненты, не затрагивая оригинальный продукт. Такой подход используется для создания собственных версий продуктов и сохранения внесенных изменений при обновлении платформы.

В процессе работы создаются копии продукта, графов, проектов AWX, шаблонов и других связанных объектов, а для репозитория Git создается отдельный форк (fork), то есть независимая копия.

1. Отключение автоматической очистки артефактов Nexus

По умолчанию при обновлении портала выполняется очистка продуктовых репозиториев Nexus. Из репозиториев удаляются:

  • артефакты, отсутствующие в новой версии релиза;

  • артефакты, загруженные вручную.

Если необходимо сохранить пользовательские артефакты, отключите автоматическую очистку:

  1. Откройте файл:

    inventories/<имя_стенда>/group_vars/k3s/config.yml

  2. Установите параметр:

    nexus_clean: false

Если для независимой копии (fork) продукта были загружены собственные артефакты в Nexus, то параметр nexus_clean обязательно должен иметь значение false.

В противном случае пользовательские артефакты будут удалены при следующем обновлении платформы.

2. Создание копии продукта

  1. Авторизуйтесь в Control Panel:

  2. Перейдите в раздел Конструктор → Продукты.

    constructor fork main

  3. Найдите исходный продукт и в строке с ним нажмите ︙.

  4. Выберите Создать копию.

    constructor fork create product copy

После этого будет создана копия. Копия продукта наследует наименование исходного продукта и код продукта с суффиксом -clone.

constructor fork product copy
Рекомендуется изменить наименование и код продукта, чтобы он отличался от оригинала.
constructor fork product copy rename

3. Создание копии графа

Созданная копия продукта продолжает использовать граф исходного продукта, поэтому для копии необходимо создать собственный граф.

Для создания собственного графа:

  1. Нажмите на созданную копию продукта.

    Откроется режим редактирования.

  2. Перейдите на вкладку Граф.

  3. В строке с названием графа нажмите на b arrow, чтобы перейти в редактор графа.

    constructor fork product copy graph

  4. Копируйте значение из поля Код графа.

    constructor fork graph create 1

  5. Перейдите в раздел Конструктор → Графы.

  6. Введите в поиск скопированный код графа, чтобы найти нужный граф.

  7. Создайте его копию.

    constructor fork graph create 2

    По умолчанию копия графа наследует исходное наименование и код с суффиксом -clone.

    constructor fork graph create 3

  8. Измените наименование и код графа и сохраните изменения.

    constructor fork graph create 4

  9. Скопируйте новый код графа.

  10. Вернитесь в ранее созданную копию продукта и вставьте скопированное значение в поле Код графа на вкладке Граф.

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

    constructor fork graph create 5

4. Создание клона репозитория

Для каждого продукта необходимо определить репозиторий Git, который используется соответствующим Job Template.

Все графы на которые ссылаются подграфы, необходимо копировать как обычный граф. После создания копии подграфа в соответствующем узле необходимо заменить ссылку на новый граф.

Для этого найдите репозиторий, связанный с продуктом:

  1. Вернитесь к ранее созданному графу и откройте его.

  2. Перейдите на вкладку Узлы.

  3. Пролистайте страницу до блока Static data.

    constructor fork repo clone 1

  4. Выполните следующие действия, если в блоке Static data:

    • Присутствует переменная "job_template", запомните ее значение.

    • Переменная "job_template" отсутствует:

      constructor fork repo clone 2

      1. Перейдите в режим редактирования узла подграфа.

      2. В строке подграфа нажмите на b arrow иконку стрелки.

        constructor fork repo clone 3

      3. После перехода в подграф откройте вкладку Узлы.

      4. Прокрутите страницу вниз до блока Static data.

      5. Найдите переменную job_template и запомните ее значение.

        constructor fork repo clone 4

4.1. Поиск проекта AWX

  1. Перейдите в сервис AWX.

  2. Откройте раздел Resources → Templates.

  3. Найдите Job Template по названию, полученному на предыдущем шаге.

    constructor fork awx 1
    constructor fork awx 2

  4. Откройте найденный Job Template и запомните название проекта, указанное в поле Project. Оно потребуется при создании форка репозитория.

    constructor fork awx 3

4.2. Создание форка репозитория Gitea

  1. Откройте Gitea по адресу https://git.<FQDN_стенда>, где <FQDN_стенда> — уникальный адрес стенда.

  2. Найдите репозиторий с названием, совпадающим со значением поля Project, полученным на предыдущем шаге, и откройте его.

    constructor fork gitea 1

  3. Нажмите Форкнуть.

  4. При необходимости измените название нового репозитория и нажмите Форкнуть репозиторий.

    constructor fork gitea 2

4.3. Создание копии проекта AWX

  1. Вернитесь в сервис AWX.

  2. Откройте раздел Resources → Projects.

  3. Найдите проект, название которого совпадает со значением поля Project, полученным ранее.

  4. Нажмите Copy Project.

    Будет создана копия проекта. Ее название будет содержать дату и время создания.

    constructor fork awx 4

  5. Откройте созданную копию проекта и нажмите Edit.

    constructor fork awx 5

  6. Измените значение поля Name.

  7. В поле Source Control URL укажите URL форка репозитория, созданного ранее.

  8. При необходимости в поле Source Control Branch/Tag/Commit укажите ветку форка репозитория.

    После создания форка изменяется URL репозитория. Вместо пути https://git.<FQDN_стенда>/cloud/original-repo.git используется путь https://git.<FQDN_стенда>/gitea/fork-repo.git. Укажите новый URL в поле Source Control URL.

    constructor fork awx 6

  9. Нажмите Save и дождитесь завершения синхронизации проекта.

  10. Убедитесь, что в поле Last Job Status отображается статус Successful.

    constructor fork awx 7

4.4. Создание копии Job Template

После создания копии проекта вкладка Job Templates будет пустой. Необходимо создать копию Job Template, имя которого было получено ранее из переменной job_template.

  1. Откройте исходный проект.

  2. Перейдите на вкладку Job Templates.

  3. Найдите Job Template, название которого соответствует значению переменной job_template.

  4. Откройте меню действий и выберите Copy Template.

    constructor fork awx 8

  5. Будет создана копия Job Template. Ее название будет содержать дату и время создания.

  6. Откройте созданную копию и нажмите Edit.

    constructor fork awx 9

  7. Измените значение поля Name.

  8. Запомните значение поля Playbook. Оно потребуется после изменения значения поля Project, поскольку при выборе другого проекта поле Playbook очищается автоматически.

  9. В поле Project выберите созданную ранее копию проекта.

  10. В поле Playbook укажите сохраненное ранее значение.

  11. Остальные параметры оставьте без изменений.

  12. Нажмите Save.

Если исходный проект содержит несколько Job Templates, повторите эту процедуру для каждого шаблона.

5. Создание пользовательских справочников

5.1. Создание справочника images

Создание отдельного справочника images необязательно.

Если требуется использовать собственные образы:

  1. Авторизуйтесь в Control Panel.

  2. Перейдите в раздел Конструктор → Справочники.

  3. Нажмите + и создайте новый справочник.

    constructor fork reference books 1

  4. Укажите имя и описание справочника. В примере используется имя images_custom.

  5. Откройте созданный справочник и добавьте необходимые страницы с образами.

    constructor fork reference books 2

  6. После создания справочника настройте граф продукта.

    1. Перейдите в раздел Конструктор → Графы.

    2. Откройте ранее созданную копию графа продукта.

    3. Перейдите на вкладку Параметры заказа.

    4. Откройте вкладку UI и в блоке кода UI найдите параметр image.

    5. Замените значение свойства directory__name с "images" на имя созданного ранее справочника. В примере используется значение "images_custom".

      constructor fork reference books 3

  7. Сохраните изменения.

5.2. Создание справочника flavors

По умолчанию продукты используют общий справочник flavors, содержащий доступные конфигурации виртуальных машин.

Если для копии продукта необходимо использовать собственный набор конфигураций, создайте отдельный справочник flavors и настройте фильтр для его использования.

  1. Перейдите в раздел Control Panel: Конструктор → Справочники.

  2. Нажмите + и создайте новый справочник.

  3. Укажите имя и описание справочника. В примере используется имя flavors_custom.

  4. Откройте созданный справочник и добавьте необходимые страницы с конфигурациями.

    constructor fork reference books 4

  5. После создания справочника настройте фильтр для доступа к его содержимому:

    1. Перейдите на вкладку Фильтры.

    2. Нажмите + и создайте новый фильтр.

    3. В поле Ключ укажите имя фильтра. В примере используется значение redos_custom.

    4. В поле Значение:

      1. Укажите имя созданного ранее справочника в параметре directory__name;

      2. Задайте значение параметра tags, которое будет использоваться для отбора записей справочника.

    5. Сохраните фильтр.

      constructor fork reference books 5

После создания фильтра настройте граф продукта:

  1. Откройте копию графа продукта.

  2. Перейдите на вкладку Параметры заказа.

  3. Откройте вкладку UI и найдите параметр flavor.

  4. Измените значение свойства filter, указав ключ созданного ранее фильтра. В примере используется значение redos_custom.

  5. Сохраните изменения.

    constructor fork reference books 6
    constructor fork reference books 7

5.3. Настройка справочника enums

Страница EventProvider справочника enums содержит список провайдеров событий, доступных в продуктах платформы.

Если для копии продукта требуется использовать собственный провайдер, добавьте его в поле PageData страницы EventProvider. Создавать копию справочника enums или отдельную страницу EventProvider не требуется.

При обновлении платформы Cloudlink пользовательские значения в поле PageData объединяются со значениями, поставляемыми в составе платформы.

  1. Перейдите в раздел Конструктор → Справочники.

  2. Откройте справочник enums.

  3. Перейдите на вкладку Страницы и найдите страницу EventProvider.

    constructor fork reference books 8

  4. В строке c EventProvider нажмите ︙ и выберите Редактировать.

  5. В поле PageData добавьте новую пару ключ-значение в формате JSON, например:

    "CUSTOM_PROVIDER": "custom_provider"

    При добавлении нового значения:

    • используйте уникальный ключ;

    • укажите значение, которое будет использоваться в качестве кода провайдера в настройках продукта;

    • соблюдайте корректный синтаксис JSON.

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

    constructor fork reference books 9

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

Если пользовательский EventProvider используется в копии продукта, создайте также копии шаблона отображения и действия удаления. В противном случае изменения, внесенные в оригинальные шаблон и действие, могут быть перезаписаны при обновлении платформы.

6. Создание копии шаблона отображения

В качестве примера используется пользовательское значение EventProvider, созданное для продукта Nginx.

  1. Перейдите в раздел Конструктор → Шаблоны отображения.

  2. С помощью фильтра Провайдер найдите шаблон отображения, соответствующий пользовательскому значению EventProvider.

  3. Нажмите Применить, чтобы отфильтровать шаблоны.

    constructor fork event provider 1

  4. Создайте копию шаблона:

    1. Нажмите в строке оригинального шаблона на ︙.

    2. Выберите Создать копию.

      constructor fork event provider 2

  5. В созданной копии измените значения полей Наименование и Код.

  6. В поле Провайдер выберите ранее заданное пользовательское значение.

  7. Измените состояние шаблона на Включено.

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

    constructor fork event provider 3

7. Создание копии действия удаления

  1. Перейдите в раздел Конструктор → Действия.

  2. С помощью фильтра найдите действие удаления, соответствующее исходному значению EventProvider.

  3. Создайте копию действия:

    1. Нажмите в строке оригинального действия на ︙.

    2. Выберите Создать копию.

      constructor fork event provider 4

  4. Откройте созданную копию.

  5. Измените значения полей Наименование и Код.

  6. Перейдите на вкладку Параметры и добавьте пользовательское значение EventProvider.

    constructor fork event provider 5

  7. Нажмите Зарегистрировать.

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