Sage - это платформа real-time аналитики и мониторинга на базе логов и метрик, разработанная в Тинькофф. Подробнее о платформе здесь.

В этом репозитории лежит скрипт установки Сommunity-версии Sage. Она бесплатная, но имеет ряд ограничений. Устанавливая ее, вы принимаете пользовательское соглашение.

• Сравнение версий
• Требования к ресурсам
• Необходимые навыки и умения
• Управление установкой
• Процесс установки
• Работа в Sage Community
• Добавление групп Sage
• Удаление Sage Community
• Поддержка

• Процессор x86-64 с числом ядер не менее 8;
• Оперативная память: 16 Gb;
• Пространство для установки на жестком диске: 30 Gb;
• Операционная система: Ubuntu 20.04/22.04;
• Монитор с разрешением 1600х1200 и выше;
• Установленный Docker v.20.10.16 и выше;
• Установленный модуль Docker Compose;
• Установленный Python версии 3.8 и выше;
• Установленный unzip;
• Учетная запись с root-правами для установки Sage Community;
• Доступ в Интернет.

Установка и использование Sage Community предполагают наличие опыта в следующих областях:

• сети:
  • IP-адресация, маски подсети, сетевые порты;
• системы виртуализации:
  • работа с подсистемой контейнерной виртуализации (Docker);
• опыт работы с командной строкой ОС Linux;
• практический опыт администрирования:
  • ElasticSearch;
  • VictoriaMetrics;
  • Kafka;
  • PostgreSQL;
• опыт работы с Ansible.

Развертывание Sage Community выполняется с помощью вспомогательного скрипта sage-community.sh, который обеспечивает высокоуровневое управление инсталляцией.

Если кратко, то он делает следующее:

1. Поднимает отдельный ssh на localhost, создает для него ключ
2. Скачивает из облака и запускает docker-образ с установщиком
3. Установщик создает отдельную подсеть докера, скачивает из облака docker-образы остальных компонент и конфигурирует их
4. Запускает Sage с помощью модуля Docker Compose

Скрипт содержит следующие команды:

Для установки Sage Community выполните следующие команды:

1. Скачайте файл sage-community.sh и положите его в директорию, из которой планируете разворачивать Sage Community.

2. Выполните проверку рабочей станции на соответствие требованиям:

./sage-community.sh check

• При выявлении критичных отклонений от требований, выполнение команды завершается выводом сообщения о невозможности установки Sage Community с указанием причины.

• Если рабочая станция соответствует требованиям, скрипт выведет сообщение "OK".

  Примечание: Мы настоятельно рекомендуем выполнить команду при первой установке Sage Community. Если вы уверены, что рабочая станция соответствует требованиям, шаг можно пропустить.

3. Установите Sage Community. Команда

./sage-community.sh install

установит Sage Community на рабочей станции в локальной сети docker, автоматически использовав доменное имя, доступное только с рабочей станции. Для задания параметров подсети, в которой будет разворачиваться Sage, при помощи ключа командной строки -c передайте заполненный соответствующим образом конфигурационный файл, пример которого можно найти в файле sage-config.yml.sample.

Если Вы хотите установить Sage Community с использованием определённого доменного имени, выполните команду

./sage-demo.sh install --hostname <your-domain-name>

Убедитесь, однако, что выбранное Вами доменное имя может быть разрешено, и соответствующий ему сетевой адрес отличен от loopback. Внимание! Перед установкой Sage Community, пожалуйста, ознакомьтесь с Пользовательским соглашением.

Выполнение команды может занять продолжительное время. В результате на вашей рабочей станции будет развернут Sage Community.

1. Чтобы начать работу с Sage Community, перейдите по ссылке, выведенной инсталлятором в терминал последним сообщением. Для корректной работы приложения рекомендуется использовать Google Chrome.

Внимание! Sage Community использует самоподписанные сертификаты безопасности, поэтому при попытке перейти по указанной ссылке может отображаться предупреждение о переходе на небезопасный сайт. Данное предупреждение можно проигнорировать.

2. Выполните вход в Sage Community, используя одну из существующих учетных записей: sage_admin, sage_user, superviewer, alice или bob. Пароль: password.

Для добавления существующих пользователей в новые группы используйте команду:

sage-community.sh group-add <groups.yml>

Последним аргументом в команду передается имя файла, содержащего список новых групп manul_groups. Пример минимального файла, добавляющего группу NewWowGroup:

---
manul_groups:
  - name: NewWowGroup
    description: New group added

Чтобы удалить Sage Community, выполните команду:

sage-community.sh wipe

Данная команда свернет инсталляцию и удалит все временные файлы с рабочей станции.

Если на любом этапе вам понадобится техническая поддержка, заведите issue в этом репозитории или пишите в телеграм-чат