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

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

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

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

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

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

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

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

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

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

Обновление версии

При условии развернутой в docker-compose платформы для обновления на новую версию платформы необходимо:

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

Для того, чтобы узнать текущую версию платформы (способ 1: описан в статье "Версия_платформы", способ 2: посмотреть имя/тег любого используемого докер-образа)

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

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

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

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

Обучение работе с платформой 3V

На ресурсе Wiki вы найдете:

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

Ответы на основные вопросы по работе с Wiki вы найдете на Welcome странице

Информационные ресурсы (техническая поддержка)

В статье "Информационные ресурсы" вы найдете всю подробную информацию о технической поддержке пользователей и порядке работы с ней, технической документации и прочих ресурсах, в которые возможно обратиться при возникновении тех или иных вопросов по работе с платформой 3V