Начало работы с TrueCharts

Содержание

Ниже приведены рекомендации по переходу от пустой или свежей установки TrueNAS SCALE к использованию TrueCharts с максимально возможной эффективностью и производительностью по мнению команды TrueCharts. Это не заменяет руководства по конкретным приложениям и/или руководства по отдельным темам (PVC, VPN, связывание приложений и т.д.), поэтому продолжайте знакомиться с документацией по конкретным приложениям и руководствами по TrueNAS SCALE, которые мы разместили на нашем сайте. Если требуется дополнительная информация о TrueNAS SCALE, пожалуйста, ознакомьтесь с нашей страницей Введение в SCALE.

Требования #

Приложения TrueCharts совместно используют вычислительные ресурсы вашей системы. Пожалуйста, ознакомьтесь с рекомендуемыми системными требованиями.
Набор данных приложения (apps dataset) должен быть достаточно большим для хранения контейнеров, конфигурационных файлов, моментальных снимков и других данных постоянного тома (PVC). Позже вы всегда сможете настроить дополнительное хранилище с помощью пулов жестких дисков (например, папка downloads) для определенных приложений.
Убедитесь, что в вашей установке SCALE есть рабочий пул хранения (storage pool), который вы хотите использовать для TrueCharts. Подробнее об этом читайте в руководстве по SCALE.
Убедитесь, что у вас есть рабочее подключение к Интернету и вы можете связаться с хост-системой по адресам https://github.com, https://truecharts.org и https://tccr.io.
Убедитесь, что время в системе актуально и в настройках SCALE выбран предпочтительный часовой пояс. Установленные приложения будут работать по умолчанию в этом часовом поясе.
Вы вошли в веб-интерфейс TrueNAS SCALE с правами root или пользователя, который может выполнять команды с правами root.
Пул приложений должен быть настроен до добавления TrueCharts. При первом открытии пункта меню Apps на SCALE вам будет предложено выбрать пул хранения для ваших приложений.

КРАТКИЕ РУКОВОДСТВА #
Ниже приведены краткие описания полной настройки для определенных случаев использования. Прокрутите страницу вниз, чтобы получить краткую информацию о каждом шаге и о том, почему они рекомендуются.

Минимальная начальная установка SCALE #

Добавьте каталог со следующими разделами (trains): stable, enterprise, operators -> Добавление TrueCharts
Добавьте следующие операторы из раздела operators с настройками по умолчанию: cloudnative-pg, prometheus-operator, cert-manager -> Руководство по установке операторов

Начало использования Charts в собственном домене #

Шаги выше -> Минимальное руководство по началу работы с SCALE
Использование Cloudflare для DNS и создание API-токена -> Руководство
Добавить Clusterissuer -> Clusterissuer How-to
Перенести порт TrueNAS на 81, 444 -> Инструкции TrueNAS WebUI
Добавить Traefik -> Traefik How-To
Добавить Blocky -> Инструкция по настройке Blocky
Настройте ингресс (ingress) на каждом Chart, который вы хотите выставить наружу -> Настройте ингресс с помощью сертификатов Clusterissuer

Полная настройка TrueCharts на TrueNAS SCALE #

Все, что описано ниже (включает в себя шаги, перечисленные выше, а также дополнительные возможности, такие как Heavyscript, MetalLB и Authelia)

Добавление TrueCharts #

Чтобы добавить TrueCharts в SCALE, выполните следующие действия:

Перейдите на страницу Apps из меню SCALE верхнего уровня.
Выберите вкладку Manage Catalogs (Управление каталогами) на странице Apps (Приложения)
Нажмите кнопку Add Catalog (Добавить каталог)
После прочтения уведомления iXsystems нажмите кнопку Continue (продолжить) и введите необходимую информацию: Name: truecharts Repository: [github.com/truecharts/catalog](https://github.com/truecharts/catalog) Preferred Trains: enterprise, stable и operators (введите каждый из них вручную) Branch: main
Нажмите кнопку Save (сохранить) и позвольте SCALE обновить свой каталог с TrueCharts (это может занять несколько минут).

Если вам нужна дополнительная информация по этому процессу, посмотрите видеоролик с веб-сайта документации TrueNAS, посвященный добавлению каталогов сторонних производителей.

ВВЕДЕНИЕ В РУКОВОДСТВО ПО TRUENAS SCALE #
Пожалуйста, ознакомьтесь с нашим руководством Введение в TrueNAS SCALE, в котором содержится конкретная информация по установке, редактированию, откату и командам CLI для работы с приложениями на TrueNAS SCALE.

Обзор разделов TrueCharts #

TrueCharts имеет несколько «разделов» (trains), или ветвей приложений, которые вы можете выбрать для установки. Ниже приводится краткое описание каждого раздела и его назначение.

stable содержит приложения, которые были тщательно протестированы и, как ожидается, будут работать стабильно. Стабильная версия приложения всегда является лучшей из доступных версий.
incubator содержит приложения, которые все еще находятся в разработке и/или не считаются достаточно стабильными и работающими, чтобы быть перемещенными в стабильную ветку.
dependency содержит приложения, которые в основном используются в качестве зависимостей. Эта ветка не поддерживается, за исключением исправления ошибок.
enterprise содержит приложения для основных функций TrueCharts и, в будущем, будет охвачена дополнительной поддержкой для профессиональных случаев использования.
operators содержит операторы для некоторых приложений и может потребоваться для их работы, поэтому рекомендуется оставить эту опцию включенной.

Список всех приложений, доступных для каждого состава TrueCharts, см. здесь.

Heavyscript #

После добавления каталога TrueCharts мы также рекомендуем установить Heavyscript и настроить его на ночной запуск с помощью задания cron. Это bash-скрипт для управления приложениями TrueNAS SCALE, автоматического обновления приложений, резервного копирования наборов данных приложений, открытия оболочки для контейнеров и многих других функций. Для получения дополнительной информации посетите страницу Heavyscript на GitHub.

Установка MetalLB и отключение встроенного LoadBalancer #

Этот шаг может быть необязательным, но рекомендуется для опытных пользователей и/или тех, кто хочет назначить определенные IP-адреса своим SCALE-приложениям. На странице MetalLB-Config Setup Guide мы разместили полное руководство по настройке MetalLB и отключению интегрированного Loadbalancer. Пожалуйста, обратитесь к этой странице для получения дополнительной информации.

Руководство по установке и переносу CNPG/Prometheus Operators для старых пользователей #

Многие из наших популярных приложений для TrueNAS SCALE используют CloudNativePG или сокращенно CNPG и требуют установки операторов Cloudnative-PG и Prometheus ДО установки приложений, использующих CNPG. Поэтому, если вы не уверены, что используете какие-либо приложения с CNPG, мы рекомендуем пользователям сначала установить операторы cloudnative-pg/prometheus-operator, прежде чем пытаться установить приложения. Если вы переходите с другого оператора CNPG, пожалуйста, ознакомьтесь с руководством по миграции CNPG, в котором описаны шаги по установке оператора cloudnative-pg и миграции. Кроме того, см. статью в этом выпуске новостей об удалении старого встроенного оператора prometheus

Для новых пользователей, только начинающих работать с TrueNAS SCALE, можно просто установить cloudnative-pg и prometheus-operator из каталога сообщества TrueCharts.

Установка Traefik для поддержки Ingress / Reverse-Proxy в приложениях TrueCharts #

Traefik, наше решение для ingress или обратного прокси (reverse proxy), интегрировано во все наши приложения, чтобы максимально упростить защиту ваших приложений. Для этого мы поставляем отдельное приложение Traefik «ingress», которое предварительно настроено для обеспечения безопасных и быстрых соединений. Пожалуйста, ознакомьтесь с инструкциями и видеороликом в разделе Traefik How-To.

В исключительно редких случаях, если установка Traefik не удалась, перед повторной попыткой может потребоваться выполнить в shell от имени root:

k3s kubectl apply --server-side --force-conflicts -k https://github.com/truecharts/manifests/manifests

Одной из дополнительных функций, поддерживаемых Traefik и многими приложениями Truecharts Community Catalog, такими как Nextcloud, является возможность использования middleware (промежуточного ПО) для удаленного использования ваших приложений. Настроить middleware ПО basicAuth можно с помощью нашего руководства Add Traefik Basic Auth to Apps.

Установка Cert-Manager (оператор) и Clusterissuer для управления сертификатами #

TrueCharts поддерживает использование только Cert-Manager (как операторской части, так и clusterissuer) для управления сертификатами в приложениях для TrueNAS SCALE. Использование сертификатов TrueNAS SCALE через графический интерфейс deprecated (устарело) и может перестать работать в будущих обновлениях. Мы настоятельно рекомендуем настраивать clusterissuer с помощью нашего руководства по настройке clusterissuer перед добавлением Ingress в приложения.

Установка и руководство по использованию Blocky DNS для split-DNS #

Blocky — это необязательное, но предпочтительное DNS-решение для TrueCharts. Это DNS-прокси, DNS-улучшатель и блокировщик рекламы, поддерживающий «split-DNS» через K8S-Gateway и обладающий высокой степенью доступности. В руководстве BlockySetup-Guide рассматриваются основные параметры настройки, которые помогут вам начать работу, но не являются исчерпывающими.

Установка Authelia #

Authelia — это многофакторный портал Single Sign-On для веб-приложений, который является предпочтительным решением для защиты приложений TrueCharts при открытии их наружу с использованием Traefik в качестве Ingress. Мы подготовили подробное руководство по настройке Authelia, а также по использованию LLDAP в качестве бэкенда для Authelia и настройке секции forwardAuth в Traefik для обработки перенаправления и обеспечения безопасности приложений. Более подробная информация приведена в руководстве по настройке Authelia. Это не является строгим требованием, однако в противном случае рекомендуется задать очень надежный пароль на предыдущих шагах.