Skip to content

CONFIG_REFERENCE.md

Latest commit

 

History

History
143 lines (111 loc) · 5.68 KB

CONFIG_REFERENCE.md

File metadata and controls

143 lines (111 loc) · 5.68 KB

Справочник по конфигурационному файлу

Этот документ содержит подробное описание полей в файле config.json.

Структура конфигурационного файла

Раздел "project"

"project": {
  "name": "example-project",
  "description": "Шаблон DevOps инструментов для проектов"
}
Поле Описание Обязательное Пример
name Имя вашего проекта, используется для идентификации Да "my-awesome-project"
description Описание проекта Нет "Мой проект с DevOps инструментами"

Раздел "gitlab"

"gitlab": {
  "api_url": "https://gitlab.com/api/v4",
  "project_id": "YOUR_GITLAB_PROJECT_ID",
  "project_path": "YOUR_PROJECT_PATH",
  "branch": "main"
}
Поле Описание Обязательное Пример
api_url URL GitLab API, обычно не требует изменений Нет "https://gitlab.com/api/v4"
project_id ЗАПОЛНИТЬ: ID проекта из GitLab Да "12345678"
project_path ЗАПОЛНИТЬ: Путь к проекту в GitLab Да "username/repository"
branch Ветка по умолчанию Нет "main" или "master"

Раздел "vercel"

"vercel": {
  "api_url": "https://api.vercel.com",
  "team_id": "YOUR_VERCEL_TEAM_ID",
  "project_id": "YOUR_VERCEL_PROJECT_ID",
  "token": "YOUR_VERCEL_TOKEN",
  "project_url": "https://www.example.com"
}
Поле Описание Обязательное Пример
api_url URL Vercel API, обычно не требует изменений Нет "https://api.vercel.com"
team_id ЗАПОЛНИТЬ: ID команды в Vercel Да "team_abcdefghijk12345"
project_id ЗАПОЛНИТЬ: ID проекта в Vercel Да "prj_abcdefghijk12345"
token ЗАПОЛНИТЬ: токен API Vercel для доступа Да "your_vercel_token_here"
project_url ЗАПОЛНИТЬ: URL вашего сайта Да "https://www.myproject.com"

Раздел "endpoints"

"endpoints": [
  "/",
  "/admin/",
  "/api/v1/docs",
  "/api/v1/s2s/docs",
  "/im/api/identify"
]

Список URL-путей для проверки доступности. Это массив строк, содержащий относительные пути, которые будут проверяться инструментами. При необходимости можно добавить или удалить эндпоинты в соответствии с вашим проектом.

Раздел "paths"

"paths": {
  "project_path": "<PROJECT_PATH>",
  "im_js_path": "<PROJECT_PATH>/im.js",
  "backend_path": "backend-python",
  "admin_ui_path": "admin-ui/dist"
}
Поле Описание Обязательное Пример
project_path ЗАПОЛНИТЬ: Путь к корневой папке проекта Да "path/to/project/files"
im_js_path ЗАПОЛНИТЬ: Путь к файлу im.js Да "path/to/project/files/im.js"
backend_path Путь к бэкенду Нет "backend-python"
admin_ui_path Путь к административному интерфейсу Нет "admin-ui/dist"

Раздел "required_dirs"

"required_dirs": [
  "<PROJECT_PATH>",
  "backend-python",
  "admin-ui/dist"
]

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

Раздел "required_files"

"required_files": [
  "vercel.json",
  "backend-python/vercel.py",
  "backend-python/requirements.txt"
]

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

Раздел "dependencies"

"dependencies": {
  "python": [
    "fastapi",
    "uvicorn",
    "pydantic",
    "python-multipart",
    "starlette",
    "requests",
    "python-gitlab"
  ]
}

Список зависимостей для различных языков программирования. В данном случае, это зависимости Python, необходимые для работы инструментов DevOps.

Как указать значения

  1. GitLab Project ID: Найдите его на странице вашего проекта в GitLab. Обычно это число, которое отображается рядом с названием проекта.

  2. GitLab Project Path: Это путь вида "username/repository" или "group/subgroup/repository".

  3. Vercel Team ID: Найдите его в настройках команды в Vercel или в URL при просмотре командных проектов.

  4. Vercel Project ID: Найдите его в настройках проекта в Vercel.

  5. Vercel Token: Создайте токен в настройках аккаунта Vercel, в разделе "Tokens".