# Yonote Onprem Charts

## Важная информация

### Статус веток
В настоящее время доступны **2 ветки**:

| Ветка | Версия | Статус |
|--------|---------|--------|
| `master` | yonote Helm Charts v1.x.x | Устаревшая |
| `2.0.0` | yonote Helm Charts v2.x.x | Актуальная |

> **⚠️ Важно:** между этими версиями чартов **нет прямого пути миграции**. При обновлении необходимо внимательно выбирать подходящую версию чарта.

### Рекомендации по развёртыванию
- **Новые развёртывания**: необходимо использовать чарты версии `2.0.0`.
- **Существующие развёртывания**: продолжайте использовать текущую версию.
- **Предстоящие изменения**: в ближайшее время ветка `2.0.0` будет повышена до `master`. Текущая ветка `master` будет перемещена в ветку с пометкой «устаревшая».

---

## Быстрый старт

### Добавление репозитория
```bash
helm repo add yonote https://artifacts.wilix.dev/repository/helm-yonote
helm repo update
```

### Сравнение чартов

| Характеристика | 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
- Путь обновления будет предоставлен в будущем

---

### Настройка значений

Перед развертыванием приложения через Helm необходимо внести валидные значения в файлы values.yaml и secret-values.yaml. Эти файлы содержат параметры конфигурации, которые будут использованы при установке приложения.

Настройте необходимые параметры. В файлах values.yaml и secret-values.yaml вы найдете различные секции, каждая из которых соответствует определенной части конфигурации приложения. Внимательно изучите комментарии в этих файлах; они указывают на места, где необходимо внести изменения. Обратите особое внимание на секцию ingress, так как её настройка важна для правильной работы приложения. Вам потребуется заменить или настроить значения в этой секции в соответствии с вашими требованиями.
Также обратите внимание на все строки с доменом example.com — его необходимо заменить на ваше собственное доменное имя, которое будет использоваться для работы приложения. Учтите, что путь в переменных и в конфигурации Ingress менять не нужно, заменяйте только сам домен.

Более подробно ознакомиться с переменными вы можете по следующей ссылке: https://yo.yonote.ru/share/onprem/doc/peremennye-okruzheniya-mOI8Jl6B05

### Запуск приложения

После настройки значений выполните команду:

```bash
helm install app -f values.yaml -f secret-values.yaml -n yonote-onprem .
```
После выполнения команды начнётся установка приложения и всех дополнительных сервисов к нему. Остаётся только подождать, пока все сервисы запустятся.

---

### Обратная связь

Если у вас есть вопросы или вам нужна помощь, пишите на email: hello@yonote.ru

###

# 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 repo add yonote https://artifacts.wilix.dev/repository/helm-yonote
helm repo update
```

---

## Chart Features

| Feature | yonote-helm-chart |
|---------|------------------------|
| yonote Server | ✅ Included |
| PostgreSQL | ✅ Included |
| MinIO | ✅ Included |

---

## 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.

---

### Configuring the Values

Before deploying the application via Helm, you need to enter valid values in the values.yaml and secret-values.yaml files. These files contain configuration parameters that will be used when installing the application.

Configure the required parameters. In the values.yaml and secret-values.yaml files, you’ll find various sections — each corresponds to a specific part of the application’s configuration. Carefully review the comments in these files; they indicate where changes need to be made.

Pay special attention to the ingress section, as its configuration is crucial for the proper operation of the application. You’ll need to replace or adjust the values in this section according to your requirements.

Also, note all the lines containing the example.com domain — you must replace it with your own domain name that will be used for the application. Keep in mind that you don’t need to change the path in the variables and Ingress configuration; only replace the domain itself.

You can learn more about the variables using the following link.: https://yo.yonote.ru/share/onprem/doc/peremennye-okruzheniya-mOI8Jl6B05

### Application Launch

After configuring the values, run the following command:

```bash
helm install app -f values.yaml -f secret-values.yaml -n yonote-onprem .
```
Once the command is executed, the installation of the application and all additional services will begin. Just wait until all the services are up and running.

---

### Feedback

If you have any questions or need assistance, please send an email to:: hello@yonote.ru