ArchMapДокументация

Описать конфигурацию сервиса

Примечание

Параметры конфигурации сервиса (переменные окружения, флаги, настройки) описываются в разделе Конфигурация на странице сервиса. Правки в разделе сохраняются, когда вы уходите из поля.

Примечание

ArchMap хранит только значение параметра по умолчанию из кода. Значений для конкретных сред (тестовой, боевой) в нём нет. Не записывайте в документацию пароли, токены и другие секреты.

Описать параметр вручную#

Чтобы описать параметр, выполните следующие действия:

  1. На странице сервиса в разделе Конфигурация нажмите + Параметр и выберите Вручную. Появится новый параметр.
  2. Введите имя параметра так же, как оно записано в коде (например, MAX_ITEMS_PER_ORDER).
  3. Укажите тип значения (например, int, bool, duration).
  4. Если без параметра сервис не запустится, установите флажок обяз..
  5. Укажите значение по умолчанию из кода.
  6. Опишите, что переключает параметр.

Примечание

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

Примечание

Строку зависит: у параметра ArchMap строит сам по пометкам зависит от: в шагах схем логики этого же сервиса (см. Сослаться на таблицы, каналы и параметры).

Описать конфигурацию с помощью ИИ-агента#

Бета-версия

Документирование с помощью ИИ-агента пока работает в режиме бета-версии. Перед применением проверьте, что предлагает агент, а после применения при необходимости поправьте результат вручную.

Примечание

Агент ищет все места, где код сервиса читает конфигурацию: переменные окружения, классы настроек, флаги командной строки. Перечень он дополняет объявлениями из .env.example, docker-compose, Helm-чартов и манифестов Kubernetes. Назначение параметра агент описывает по тому, что параметр меняет в коде.

Примечание

Значения параметров агент не переносит. Из файлов с секретами (например, .env или Secret в Kubernetes) он берёт только имена параметров, а значение по умолчанию записывает, только если оно задано в коде.

Чтобы описать конфигурацию сервиса с помощью агента, выполните следующие действия:

  1. На странице сервиса в разделе Конфигурация нажмите + Параметр и выберите Через ИИ-агента. Откроется окно Описать конфигурацию с помощью ИИ-агента.

  2. Нажмите кнопку Скопировать промпт.

  3. Запустите агента в папке репозитория сервиса, вставьте промпт и отправьте. Агент сложит файлы в папку archmap-docs/ репозитория.

  4. Добавьте файлы из папки archmap-docs/ в окно одним из способов:

    • перетащите файлы в поле справа;
    • нажмите Загрузить файлы… и выберите файлы;
    • нажмите + вставить из буфера и вставьте текст файла.

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

  5. Нажмите кнопку Применить. Окно закроется, а параметры появятся в разделе Конфигурация.

Примечание

Если в репозитории живут несколько сервисов, агент сделает отдельный файл для каждого и первой строкой файла укажет адрес сервиса (например, # archmap-node: Маркетплейс «Ярмарка» / Сервис заказов). Параметры из файла без такой строки попадут к сервису, со страницы которого открыто окно.

Примечание

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

Примечание

Какие шаги схем логики зависят от параметра, в этом окне не описывается. Это задают пометки зависит от: в схемах логики, поэтому конфигурацию удобнее описать до схем логики (см. Документировать систему с помощью ИИ-агента).

Примечание

Если проверка нашла замечания, нажмите Скопировать замечания для агента и отправьте текст агенту в ту же сессию. ArchMap предложит убрать текущие файлы из окна. Нажмите Убрать из панели, а когда агент исправит файлы, загрузите их в окно заново.

Примечание

Описать конфигурацию может и агент, подключённый по MCP. Попросите его об этом своими словами (например, «Опиши конфигурацию сервиса заказов в проекте «Ярмарка» по этому репозиторию»). Агент покажет план и после вашего подтверждения запишет параметры в проект (см. Подключить своего агента через MCP-сервер).