Платформа 3V/Инструкция по работе с платформой

Материал из 3v-wiki
Перейти к навигации Перейти к поиску

Здесь вы найдете описание основных блоков по работе с платформой 3V, ссылки на инструкции и регламенты, а также информационные ресурсы по работе с платформой

Как начать использовать платформу 3V?

Существует два способа начать работать с платформой:

Развернуть новый стенд

В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/3v-platform в папке «Manuals» вы найдете:

  1. Файл «Manual.txt» - инструкцию по разворачиванию платформы 3V с использованием существующего postgres-сервера БД и postgres-сервера БД в докер-образе
  2. Файл «Keycloak manual.pdf» - инструкция по разворачиванию и настройке системы авторизации Keycloak. При разворачивании образов с помощью Kubernetes и прочих средств запуска, см. страницу https://www.keycloak.org/getting-started.
  3. Прочие скрипты для подготовки сервера БД, требуемые по инструкции (папка «sql_scripts»)

Также в статье на Wiki вы найдете основные принципы работы с аутентификацией и авторизацией на платформе 3V. При возникновении проблем обращайтесь в техническую поддержку с типом обращения "Консультация".

Для смены версий на стенде необходимо:

  1. При необходимости, проверить, что в вашем репозитории есть все актуальные конфигурационные файлы
  2. Скачать недостающие конфиги и поправить в конфигурационных файлах информацию о текущем стенде или скачать полностью новый репозиторий и в нем поправить по всем конфигурационным файлам информацию о стенде
  3. Изменить версии в конфигурационном файле «.env» и выполнить команду для запуска (docker-compose up).

Важно! Версия бэка (BACK) или вэба (NAVI) должна совпадать в первых двух значениях (например, 0.35), но может не совпадать в номере "патча" (например, версия бэка (BACK) = 0.35.1 или вэба (NAVI)= 0.35.4)

Важно! При переходе на новую версию необходимо обязательно проверить наличие Критических изменений (Breaking changes) во всех версиях между вашей текущей и той, на которую требуется перейти и, соответственно, при необходимости провести работы на стенде, которые требуются в рамках этих критических изменений!

Перечень критических изменений вы найдете в https://gitlab.3v-group.org/open/3v-platform в папке «Release notes», а также в описании соответствующих релизов на их страницах

Создать собственное облачное приложение

При необходимости создания нового приложения ("тенанта") в облаке обратитесь в техническую поддержку с типом обращения "Консультация".

В обращении укажите краткое название латиницей, которое будет подставлено в url "***.3v-cloud.com" и причину создания нового облачного приложения

Облачные приложения всегда поддерживаются в актуальном состоянии и на них вы найдете самый новый функционал

Какой новый функционал появляется и наши планы развития?

Для того, чтобы узнать актуальную версию для вашего стенда с интересующим вас функционалом, вы можете:

  1. Просмотреть, какой функционал появляется в новых версиях между вашей текущей и актуальной в описании соответствующих релизов на их страницах
  2. Проанализировать исправленные ошибки и выполненные требования, которые были направлены от заинтересованных лиц в техническую поддержку. Версия, в которой внесено исправление, будет указана в комментарии от администратора службы поддержки с примечанием является ли версия бэком (BACK) или вэбом (NAVI)
  3. Зайти в https://gitlab.3v-group.org/open/demo-3v в папке «Release notes» и посмотреть последнюю выпущенную версию ядра (BACK) и навигатора (NAVI)

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

  1. Посмотреть по ссылке. Способ описан в статье "Версия_платформы",
  2. Посмотреть имя/тег любого используемого докер-образа

Что почитать о платформе самостоятельно?

В рамках существующей платформы постоянно пополняется наша база знаний. В рамках нее вы найдете следующие информационные ресурсы, которые возможно использовать самостоятельно:

Wiki

Wiki - это открытая энциклопедия, в ней вы найдете:

  1. вводный порядок обучения по работе с платформой с ссылками на видеоролики с настройкой простых информационных объектов
  2. статьи с описанием настройки различного функционала информационных объектов (см. внизу Главной страницы)
  3. рекомендации по использованию и оптимизации информационных объектов
  4. описание кейсов использования

Руководство пользователя

В руководстве пользователя вы найдёте основную информацию по функциональным возможностям платформы от установки до составления сложных нагруженных отчетов.

Техническая документация

В технической документации вы найдете описание JSON свойств объектов. Данная документация собирается на основании последних версии платформы 3V, поэтому является наиболее полной и актуальной.

Как с нами связаться?

Заявка на демонстрацию

Запросить заявку на демонстрацию возможно через trivium.group, либо написав нам письмо на электронную почту: info@trivium.group или обратившись по телефону: +7(495) 369-55-10

Техническая поддержка

Служба позволяет направить обращения при возникновении ошибок работы функционала, а также получить рекомендации по использованию Платформы 3V.

Доступ https://trivium-group.atlassian.net/servicedesk/customer/portals
Авторизация Инструкция по работе с сервисом технической поддержки
Правила пользования Стандарт пользования технической поддержки 3V
При необходимости проведения обучения в формате онлайн по определенным блокам платформы, обратитесь в техническую поддержку с типом обращения "Консультация".
Источник — https://wiki.3v-group.net/index.php?title=Платформа_3V/Инструкция_по_работе_с_платформой&oldid=4722