Initial SFERA platform baseline
This commit is contained in:
@@ -0,0 +1,194 @@
|
||||
# SFERA Project Settings Contract
|
||||
|
||||
## 1. Назначение
|
||||
|
||||
Настройки проекта - один из главных экранов SFERA.
|
||||
|
||||
Открывается из Top Project Bar через кнопку рядом с Project selector.
|
||||
|
||||
## 2. Разделы Настроек
|
||||
|
||||
```text
|
||||
Основные сведения
|
||||
Источники структуры 1С
|
||||
Импорт конфигурации
|
||||
Среды
|
||||
Агенты
|
||||
Расширения
|
||||
Knowledge sources
|
||||
Privacy
|
||||
AI policy
|
||||
Task/session policy
|
||||
Пользователи и доступ
|
||||
Интеграции задач
|
||||
Docker/runtime adapter
|
||||
ITS/documentation access
|
||||
Audit
|
||||
Backup/restore
|
||||
```
|
||||
|
||||
## 3. Основные Сведения
|
||||
|
||||
Поля:
|
||||
|
||||
- Название проекта;
|
||||
- Код проекта;
|
||||
- Описание;
|
||||
- Workspace;
|
||||
- Владелец;
|
||||
- Тип проекта;
|
||||
- Язык интерфейса;
|
||||
- Язык кода 1С по умолчанию: русский / английский;
|
||||
- Версия платформы;
|
||||
- Режим совместимости.
|
||||
|
||||
## 4. Источники Структуры 1С
|
||||
|
||||
Поддерживаемые источники:
|
||||
|
||||
- `.cf` файл;
|
||||
- `.cfe` файл;
|
||||
- XML dump;
|
||||
- Live infobase через Designer CLI;
|
||||
- EPF agent snapshot;
|
||||
- CFE agent snapshot;
|
||||
- EDT project;
|
||||
- Архив выгрузки;
|
||||
- BSL/XML file tree;
|
||||
- Context-only configuration;
|
||||
- Reference configuration.
|
||||
|
||||
Для каждого источника:
|
||||
|
||||
- тип;
|
||||
- статус;
|
||||
- последний импорт;
|
||||
- последняя ошибка;
|
||||
- версия платформы;
|
||||
- режим совместимости;
|
||||
- количество объектов;
|
||||
- количество модулей;
|
||||
- количество форм;
|
||||
- количество расширений.
|
||||
|
||||
## 5. Среды
|
||||
|
||||
- Dev;
|
||||
- Test;
|
||||
- Stage;
|
||||
- Prod.
|
||||
|
||||
Для среды:
|
||||
|
||||
- тип;
|
||||
- подключение;
|
||||
- агент;
|
||||
- источник данных;
|
||||
- privacy mode;
|
||||
- разрешение data preview;
|
||||
- версия платформы;
|
||||
- активные расширения.
|
||||
|
||||
## 6. Агенты
|
||||
|
||||
- EPF agent;
|
||||
- CFE agent;
|
||||
- runtime agent;
|
||||
- diagnostic agent.
|
||||
|
||||
Поля:
|
||||
|
||||
- agent id;
|
||||
- version;
|
||||
- environment;
|
||||
- last heartbeat;
|
||||
- status;
|
||||
- compatibility;
|
||||
- download/update.
|
||||
|
||||
## 7. Расширения
|
||||
|
||||
Таблица:
|
||||
|
||||
- имя;
|
||||
- версия;
|
||||
- назначение;
|
||||
- активно;
|
||||
- безопасный режим;
|
||||
- защита от опасных действий;
|
||||
- область действия;
|
||||
- источник;
|
||||
- последний import;
|
||||
- статус применимости.
|
||||
|
||||
Действия:
|
||||
|
||||
- загрузить `.cfe`;
|
||||
- получить из live base;
|
||||
- обновить snapshot;
|
||||
- проверить применимость;
|
||||
- сравнить с основной конфигурацией;
|
||||
- построить effective configuration.
|
||||
|
||||
## 8. ITS/Documentation Access
|
||||
|
||||
Документация 1С используется для проверки 1С-specific поведения.
|
||||
|
||||
Источники:
|
||||
|
||||
- ITS;
|
||||
- v8.1c.ru;
|
||||
- 1C DN;
|
||||
- локальные knowledge packs.
|
||||
|
||||
ITS credentials нельзя хранить в репозитории.
|
||||
|
||||
Использовать только переменные окружения:
|
||||
|
||||
```dotenv
|
||||
SFERA_ITS_URL=<ITS_URL>
|
||||
SFERA_ITS_USERNAME=<ITS_USERNAME>
|
||||
SFERA_ITS_PASSWORD=<ITS_PASSWORD>
|
||||
```
|
||||
|
||||
Локальный файл:
|
||||
|
||||
```text
|
||||
.env.local
|
||||
```
|
||||
|
||||
Пример для локальной настройки:
|
||||
|
||||
```dotenv
|
||||
SFERA_ITS_URL=https://its.1c.ru/db/v838doc#browse:13:-1:7
|
||||
SFERA_ITS_USERNAME=<set locally>
|
||||
SFERA_ITS_PASSWORD=<set locally>
|
||||
```
|
||||
|
||||
Запрещено:
|
||||
|
||||
- коммитить логин или пароль;
|
||||
- писать логин или пароль в markdown;
|
||||
- писать логин или пароль в Dockerfile;
|
||||
- выводить логин или пароль в logs.
|
||||
|
||||
## 9. Privacy
|
||||
|
||||
- `METADATA_ONLY`;
|
||||
- `SANITIZED_SAMPLE`;
|
||||
- `TEST_DATA`;
|
||||
- `FULL_DATA`.
|
||||
|
||||
По умолчанию:
|
||||
|
||||
- `METADATA_ONLY`.
|
||||
|
||||
## 10. Task/Session Policy
|
||||
|
||||
- `STRICT`;
|
||||
- `SOFT`;
|
||||
- `LOCAL_DEV`.
|
||||
|
||||
Enterprise default:
|
||||
|
||||
- `STRICT`.
|
||||
Reference in New Issue
Block a user