diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4dff12 --- /dev/null +++ b/README.md @@ -0,0 +1,181 @@ +# Loop Onprem Charts + +## Важная информация + +### Статус веток +В настоящее время доступны **2 ветки**: + +| Ветка | Версия | Статус | +|--------|---------|--------| +| `master` | Loop Helm Charts v1.x.x | Устаревшая | +| `2.0.0` | Loop Helm Charts v2.x.x | Актуальная | + +> **⚠️ Важно:** между этими версиями чартов **нет прямого пути миграции**. При обновлении необходимо внимательно выбирать подходящую версию чарта. + +### Рекомендации по развёртыванию +- **Новые развёртывания**: необходимо использовать чарты версии `2.0.0`. +- **Существующие развёртывания**: продолжайте использовать текущую версию. +- **Предстоящие изменения**: в ближайшее время ветка `2.0.0` будет повышена до `master`. Текущая ветка `master` будет перемещена в ветку с пометкой «устаревшая». + +--- + +## Доступные чарты + +Репозиторий предоставляет **2 варианта развёртывания**: + +### 1. loop-enterprise-edition +Развёртывает только сервер Loop. +- Требуется внешняя база данных. +- Требуется внешнее хранилище MinIO (совместимое с S3). + +### 2. loop-enterprise-stack +Развёртывает полный стек: +- Сервер Loop. +- PostgreSQL (включён). +- MinIO (включён). + +--- + +## Быстрый старт + +### Добавление репозитория +```bash +helm repo add loop https://artifacts.wilix.dev/repository/helm-loop +helm repo update +``` + +### Сравнение чартов + +| Характеристика | loop-enterprise-edition | loop-enterprise-stack | +|----------------|-------------------------|----------------------| +| Сервер Loop | ✅ Включён | ✅ Включён | +| PostgreSQL | ❌ Требуется внешняя БД | ✅ Включён | +| MinIO | ❌ Требуется внешнее хранилище | ✅ Включён | +| Сценарий использования | Существующие настройки БД/MinIO | Новые развёртывания | + +--- + +### Матрица версий + +| Версия чарта | Ветка | Статус | Рекомендуется для | +|--------------|-------|--------|-------------------| +| v1.x.x | master | Устаревшая | Существующие развёртывания v1 | +| v2.x.x | 2.0.0 | Актуальная | Все новые развёртывания | + +--- + +### Уведомление о миграции + +> **Прямого пути обновления между v1.x.x и v2.x.x не существует** + +Если вы сейчас используете чарты v1.x.x: +- **НЕ** пытайтесь выполнить обновление на месте до v2.x.x +- Путь обновления будет предоставлен в будущем + +--- + +### Документация + +Подробные параметры конфигурации и значения см. в: + +- [loop-enterprise-edition/README.md](./charts/loop-enterprise-edition/README.md) +- [loop-enterprise-stack/README.md](./charts/loop-enterprise-stack/README.md) + +--- + +### Лицензия + +[Тип лицензии] — подробности см. в файле LICENSE. + +### + +# Loop Onprem Charts + +## Important Information + +### Branch Status +There are currently **2 branches** available: + +| Branch | Version | Status | +|--------|---------|--------| +| `master` | Loop Helm Charts v1.x.x | Legacy | +| `2.0.0` | Loop Helm Charts v2.x.x | Current | + +> **⚠️ Important:** These charts do **not** have a direct migration path between versions. Care must be taken to use the correct chart version for upgrades. + +### Deployment Recommendations +- **New deployments**: Must use version `2.0.0` charts +- **Existing deployments**: Continue using your current version +- **Upcoming changes**: The `2.0.0` branch will be promoted to `master` in the near future. The current `master` will be moved to a deprecated branch. + +--- + +## Available Charts + +The repository provides **2 deployment options**: + +### 1. loop-enterprise-edition +Deploys only the Loop Server. +- External database required +- External MinIO (S3-compatible) storage required + +### 2. loop-enterprise-stack +Deploys the complete stack: +- Loop Server +- PostgreSQL (included) +- MinIO (included) + +--- + +## Quick Start + +### Add Repository +```bash +helm repo add loop https://artifacts.wilix.dev/repository/helm-loop +helm repo update +``` + +--- + +## Chart Comparison + +| Feature | loop-enterprise-edition | loop-enterprise-stack | +|---------|------------------------|----------------------| +| Loop Server | ✅ Included | ✅ Included | +| PostgreSQL | ❌ External required | ✅ Included | +| MinIO | ❌ External required | ✅ Included | +| Use Case | Existing DB/MinIO setups | New deployments | + +--- + +## Version Matrix + +| Chart Version | Branch | Status | Recommended For | +|---------------|--------|--------|-----------------| +| v1.x.x | `master` | Legacy | Existing v1 deployments | +| v2.x.x | `2.0.0` | Current | All new deployments | + +--- + +## Migration Notice + +> **No direct upgrade path exists between v1.x.x and v2.x.x** + +If you are currently using v1.x.x charts: +- **DO NOT** attempt an in-place upgrade to v2.x.x + +The upgrade path will be provided in the future. + +--- + +## Documentation + +For detailed configuration options and values, refer to: +- [loop-enterprise-edition/README.md](./loop-enterprise-edition/README.md) +- [loop-enterprise-stack/README.md](./loop-enterprise-stack/README.md) + +--- + +## License + +[License type] - See LICENSE file for details. \ No newline at end of file