Skip to content

SETUP.md

Latest commit

 

History

History
130 lines (91 loc) · 4.6 KB

SETUP.md

File metadata and controls

130 lines (91 loc) · 4.6 KB

Установка и настройка DevOps инструментов

Данный документ содержит инструкции по установке и настройке DevOps инструментов для вашего проекта.

Предварительные требования

Перед началом установки убедитесь, что у вас установлены:

  1. Python 3.7+
  2. Git
  3. jq - для работы с JSON в bash-скриптах
  4. curl - для отправки HTTP-запросов

Шаг 1: Настройка конфигурации

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

  1. Создайте копию файла примера конфигурации:
cp config.example.json config.json
  1. Отредактируйте файл config.json, заполнив все требуемые поля:
{
  "project": {
    "name": "your-project-name",
    "description": "Описание вашего проекта"
  },
  "gitlab": {
    "api_url": "https://gitlab.com/api/v4",
    "project_id": "YOUR_GITLAB_PROJECT_ID",
    "project_path": "your-username/your-repository",
    "branch": "main"
  },
  "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.yourproject.com"
  },
  ...
}
  1. Для нахождения необходимых значений следуйте инструкциям в CONFIG_REFERENCE.md

Шаг 2: Настройка токенов доступа

Для работы с GitLab API необходимо настроить токен доступа:

  1. Создайте файл .gitlab_token в домашней директории:
echo "YOUR_GITLAB_TOKEN" > ~/.gitlab_token
  1. Или установите переменную окружения:
export GITLAB_TOKEN="YOUR_GITLAB_TOKEN"

Шаг 3: Тестирование настройки

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

python ci/run_diagnostics.py

Если все настроено правильно, вы увидите отчет без ошибок.

Использование централизованной конфигурации

В Python-скриптах

Для использования конфигурации в Python-скриптах импортируйте ConfigLoader:

from config_loader import ConfigLoader

# Получение конфигурации GitLab
gitlab_config = ConfigLoader.get_gitlab_config()
project_id = ConfigLoader.get_gitlab_project_id()

# Получение конфигурации Vercel
vercel_config = ConfigLoader.get_vercel_config()
project_url = ConfigLoader.get_project_url()

# Получение путей к файлам проекта
paths = ConfigLoader.get_project_paths()
project_path = paths.get("project_path")

В Bash-скриптах

Для использования конфигурации в Bash-скриптах используйте export_config.sh:

source /path/to/export_config.sh

# Теперь у вас доступны переменные:
echo $GITLAB_PROJECT_ID
echo $GITLAB_PROJECT_PATH
echo $VERCEL_ID
echo $PROJECT_URL

Расширение функциональности

Добавление новых параметров в конфигурацию

  1. Добавьте новый параметр в config.json и config.example.json
  2. Добавьте информацию о параметре в CONFIG_REFERENCE.md
  3. Добавьте метод для получения параметра в config_loader.py
  4. Обновите export_config.sh, если параметр нужен в bash-скриптах

Дополнительная документация

  • CONFIG_REFERENCE.md - подробное описание всех полей конфигурации
  • HOW_TO_UPDATE.md - инструкции по обновлению скриптов
  • README.md в каждой директории - информация о конкретных инструментах

Обновление системы

Для обновления инструментов см. HOW_TO_UPDATE.md.