Update Yonote v2 branch
This commit is contained in:
@@ -1,82 +1,135 @@
|
||||
# Yonote Helm Chart
|
||||
# Yonote Onprem Charts
|
||||
|
||||
**Критическое изменение**
|
||||
## Важная информация
|
||||
|
||||
Данный чарт предназначен только для новых развертываний!
|
||||
### Статус веток
|
||||
В настоящее время доступны **2 ветки**:
|
||||
|
||||
Версия 2.x.x не совместима с предыдущими версиями 1.x.x данного чарта. Если вы попытаетесь использовать этот чарт для обновления существующего развертывания Yonote, это приведет к потере данных.
|
||||
| Ветка | Версия | Статус |
|
||||
|--------|---------|--------|
|
||||
| `master` | yonote Helm Charts v1.x.x | Устаревшая |
|
||||
| `2.0.0` | yonote Helm Charts v2.x.x | Актуальная |
|
||||
|
||||
Руководство по миграции будет предоставлено в ближайшее время.
|
||||
> **⚠️ Важно:** между этими версиями чартов **нет прямого пути миграции**. При обновлении необходимо внимательно выбирать подходящую версию чарта.
|
||||
|
||||
### Рекомендации по развёртыванию
|
||||
- **Новые развёртывания**: необходимо использовать чарты версии `2.0.0`.
|
||||
- **Существующие развёртывания**: продолжайте использовать текущую версию.
|
||||
- **Предстоящие изменения**: в ближайшее время ветка `2.0.0` будет повышена до `master`. Текущая ветка `master` будет перемещена в ветку с пометкой «устаревшая».
|
||||
|
||||
## Обзор
|
||||
---
|
||||
|
||||
Этот Helm chart позволяет развернуть **Yonote** в Kubernetes. Он предоставляет быстрый и простой способ установки, настройки и управления приложением с помощью Helm.
|
||||
|
||||
Мы запускаем сервисы Yonote в отдельных подах, что улучшает отказоустойчивость и стабильность системы. Такой подход позволяет каждому сервису иметь свою собственную среду выполнения и управлять ресурсами более эффективно.
|
||||
|
||||
## Требования
|
||||
|
||||
- Kubernetes cluster
|
||||
- Helm
|
||||
- Ingress Controller (nginx/traefik)
|
||||
|
||||
## Установка
|
||||
|
||||
### 1. Добавление репозиториев Helm
|
||||
|
||||
Перед установкой зависимостей необходимо добавить репозитории, из которых будут загружаться чарты:
|
||||
## Быстрый старт
|
||||
|
||||
### Добавление репозитория
|
||||
```bash
|
||||
helm repo add dysnix https://dysnix.github.io/charts
|
||||
helm repo add bitnami https://charts.bitnami.com/bitnami
|
||||
helm repo add yonote https://artifacts.wilix.dev/repository/helm-yonote
|
||||
helm repo update
|
||||
```
|
||||
|
||||
### 2. Выполните сборку зависимостей Helm chart
|
||||
### Сравнение чартов
|
||||
|
||||
| Характеристика | yonote-helm-chart |
|
||||
|----------------|-------------------------|
|
||||
| Сервер yonote | ✅ Включён | ✅ Включён |
|
||||
| PostgreSQL | ✅ Включён |
|
||||
| MinIO | ✅ Включён |
|
||||
|
||||
---
|
||||
|
||||
### Матрица версий
|
||||
|
||||
| Версия чарта | Ветка | Статус | Рекомендуется для |
|
||||
|--------------|-------|--------|-------------------|
|
||||
| v1.x.x | master | Устаревшая | Существующие развёртывания v1 |
|
||||
| v2.x.x | 2.0.0 | Актуальная | Все новые развёртывания |
|
||||
|
||||
---
|
||||
|
||||
### Уведомление о миграции
|
||||
|
||||
> **Прямого пути обновления между v1.x.x и v2.x.x не существует**
|
||||
|
||||
Если вы сейчас используете чарты v1.x.x:
|
||||
- **НЕ** пытайтесь выполнить обновление на месте до v2.x.x
|
||||
- Путь обновления будет предоставлен в будущем
|
||||
|
||||
---
|
||||
|
||||
### Документация
|
||||
|
||||
Подробные параметры конфигурации и значения см. в:
|
||||
|
||||
- [yonote-helm-chart/README.md](./yonote-helm-chart/README.md)
|
||||
|
||||
---
|
||||
|
||||
###
|
||||
|
||||
# yonote Onprem Charts
|
||||
|
||||
## Important Information
|
||||
|
||||
### Branch Status
|
||||
There are currently **2 branches** available:
|
||||
|
||||
| Branch | Version | Status |
|
||||
|--------|---------|--------|
|
||||
| `master` | yonote Helm Charts v1.x.x | Legacy |
|
||||
| `2.0.0` | yonote 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.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Add Repository
|
||||
```bash
|
||||
helm dependency build
|
||||
helm repo add yonote https://artifacts.wilix.dev/repository/helm-yonote
|
||||
helm repo update
|
||||
```
|
||||
|
||||
### 3. Настройка значений
|
||||
---
|
||||
|
||||
Перед развертыванием приложения через Helm необходимо внести валидные значения в файлы values.yaml и secret-values.yaml. Эти файлы содержат параметры конфигурации, которые будут использованы при установке приложения.
|
||||
## Chart Features
|
||||
|
||||
Настройте необходимые параметры. В файлах values.yaml и secret-values.yaml вы найдете различные секции, каждая из которых соответствует определенной части конфигурации приложения. Внимательно изучите комментарии в этих файлах; они указывают на места, где необходимо внести изменения. Обратите особое внимание на секцию ingress, так как её настройка важна для правильной работы приложения. Вам потребуется заменить или настроить значения в этой секции в соответствии с вашими требованиями.
|
||||
Также обратите внимание на все строки с доменом example.com — его необходимо заменить на ваше собственное доменное имя, которое будет использоваться для работы приложения. Учтите, что путь в переменных и в конфигурации Ingress менять не нужно, заменяйте только сам домен.
|
||||
| Feature | yonote-helm-chart |
|
||||
|---------|------------------------|
|
||||
| yonote Server | ✅ Included |
|
||||
| PostgreSQL | ✅ Included |
|
||||
| MinIO | ✅ Included |
|
||||
|
||||
Более подробно ознакомиться с переменными вы можете по следующей ссылке: https://yo.yonote.ru/share/onprem/doc/peremennye-okruzheniya-mOI8Jl6B05
|
||||
---
|
||||
|
||||
### 4. Запуск приложения
|
||||
## 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 |
|
||||
|
||||
```bash
|
||||
helm install app -f values.yaml -f secret-values.yaml -n yonote-onprem .
|
||||
```
|
||||
После выполнения команды начнётся установка приложения и всех дополнительных сервисов к нему. Остаётся только подождать, пока все сервисы запустятся.
|
||||
---
|
||||
|
||||
### 5. Keycloak
|
||||
## Migration Notice
|
||||
|
||||
Перед первым входом в Yonote необходимо обновить поле **Valid redirect URIs** клиента yonote в области (realm) Yonote в системе Keycloak.
|
||||
> **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.
|
||||
|
||||
Существующие записи:
|
||||
* http://example.com/*
|
||||
* https://example.com/*
|
||||
---
|
||||
|
||||
Добавить следующие:
|
||||
* http://app.example.com/*
|
||||
* https://app.example.com/*
|
||||
* https://app.example.com/auth/oidc.callback/*
|
||||
* https://team.example.com/*
|
||||
## Documentation
|
||||
|
||||
Примечание: символы * в URL-адресах являются подстановочными знаками и обозначают любые дополнительные пути после указанного базового URL.
|
||||
For detailed configuration options and values, refer to:
|
||||
- [yonote-helm-chart/README.md](./yonote-helm-chart/README.md)
|
||||
|
||||
### Обратная связь
|
||||
|
||||
Если у вас есть вопросы или вам нужна помощь, пишите на email: hello@yonote.ru
|
||||
---
|
||||
Reference in New Issue
Block a user