Руководство по установке#

Установка программного продукта Platform V DevOps Tools (DOT) представляет собой индивидуальную установку входящих (в зависимости от поставки) в его состав программных компонентов:

  1. CIJE Build Tools

  2. CDJE Deploy Tools

  3. AENG AutoInstaller

  4. DTDS Delivery Tools

При этом каждый компонент устанавливается независимо друг от друга в соответствии с собственным документом «Руководство по установке» для каждого из компонентов.

В состав поставки продукта Platform V DevOps Tools включены:

  • owned-distrib.zip – дистрибутив продукта производства SberTech (АО «СберТех»);

  • party-distrib.zip – внешние opensource jar библиотеки.

Перед началом установки составных компонентов продукта DevOps Tools необходимо дополнить дистрибутив продукта внешними jar библиотеками с помощью Pipeline дополнения продукта зависимостями (solution-merger).

По результатам работы solution-merger в репозитории Nexus (указанном в файле настроек solution-merger – merger.yml) будет опубликован дистрибутив продукта Platform V DevOps Tools (owned часть которого будет обогащена party частью), который необходимо загрузить на локальную машину, после чего распаковать, и разместить компоненты продукта в соответствующих репозиториях GitLab/Bitbucket и Nexus.

Необходимо перенести содержимое архивов со всеми лежащими в них ветками и коммитами, для этого требуется перейти в архив с соответствующим артефактом и выполнить следующий перечень команд:
git remote add solution-target ssh://<git_repo>
git push --all solution-target
git push --tags solution-target
При первичном размещении артефактов Solution в репозиториях (созданных в GitLab/Bitbucket), данные репозитории должны быть пустыми. При обновлении Solution (когда в репозиториях уже присутствует предыдущая версия артефактов Solution) очищать данные репозитории не требуется.

Репозитории в GitLab/Bitbucket и Nexus необходимо предварительно подготовить согласно таблице ниже:

Все репозитории (GitLab/Bitbucket) должны быть созданы в одной инсталляции GitLab/Bitbucket и в одной проектной области.

№

Название артефакта*

Репозиторий для размещения

Пример названия репозитория

1.

BuildTools.ufs-pipeline
ufs-pipeline-CIJE-x.y.z-distrib.zip

GitLab/Bitbucket

ufs-pipeline

2.

BuildTools.jenkinsfiles
jenkinsfiles-CIJE-x.y.z-distrib.zip

GitLab/Bitbucket

jenkinsfiles

3.

DeployTools.pipeline
pipeline-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

pipeline

4.

DeployTools.scripts
scripts-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

scripts

5.

DeployTools.service
service-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

pipeline/service
(ветка в pipeline)

6.

DeployTools.service_release
release-service-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

pipeline/release_service
(ветка в pipeline)

7.

DeployTools.service_configuration
service-configuration-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

pipeline/service_configuration
(ветка в pipeline)

8.

DeployTools.orch_job
orch-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

release_orch
(ветка в pipeline)

9.

DeployTools.default_common
default-common-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

default_common
(ветка в pipeline)

10.

Installer.Migration
CI01027846_AS_EFS_Installer.Migration-D-02.001.00-number-distrib.zip

Nexus

Installer-Migration

11.

Installer.Common
Installer.Common-D-xy.abc.de-h-distrib.zip

Nexus

Installer-Common

12.

Autoinstaller.bin
AUTOINSTALLER-D-xy.abc.de-fgj-distrib.zip

Nexus

Autoinstaller

13.

Autoinstaller.pipeline
autoinstaller-AENG-x.y.z-distrib.zip

GitLab/Bitbucket

Autoinstaller-pipeline

14.

DeliveryTools.solution-packer
 DTDS-x.y.z-solution-packer-distrib.zip *

GitLab/Bitbucket

solution-packer

15.

DeliveryTools.solution-unpacker
 DTDS-x.y.z-solution-unpacker-distrib.zip

GitLab/Bitbucket

solution-unpacker

16.

DeliveryTools.solution-merge
 DTDS-x.y.z-solution-merger-distrib.zip

GitLab/Bitbucket

solution-merger

17.

DeliveryTools.dependency-resolver
 DTDS-x.y.z-dependency-resolver-distrib.zip

GitLab/Bitbucket

dependency-resolver

18.

DeliveryTools.lib-nexus
 DTDS-x.y.z-lib-nexus-distrib.zip

GitLab/Bitbucket

lib-nexus

19.

DeliveryTools.lib-docker
 DTDS-x.y.z-lib-docker-distrib.zip

GitLab/Bitbucket

lib-docker

20.

DeliveryTools.lib-extension
 DTDS-x.y.z-lib-extension.zip

GitLab/Bitbucket

lib-extension

21.

DeliveryTools.lib-exception
 DTDS-x.y.z-lib-exception.zip

GitLab/Bitbucket

lib-exception

22.

DeliveryTools.delivery-lite
 DTDS-x.y.z-delivery-lite.zip

GitLab/Bitbucket

delivery-lite

23.

version.conf
scripts-version-CDJE-x.y.z-distrib.zip

GitLab/Bitbucket

versionDeployTools.scripts

24.

DOT-doc-x.y.z-distrib.zip

Nexus

documentation

* Актуальные версии указаны в файле version.conf (DOT-x.y.z-n-distrib\DOT-x.y.z-n-owned-distrib\scripts-version-CDJE-x.y.z-n-distrib) в ветке (branch) release/artifact-versions-1.9.1.

Системные требования#

Рекомендуемые настройки безопасности окружения#

Настройки безопасности окружения и перечень платформенных (дополнительных внешних) продуктов, используемых для установки, настройки и контроля в конечной информационной системе (далее — ИС), выбираются при разработке конечной ИС, исходя из характера обрабатываемой в ней информации и иных требований информационной безопасности (далее — ИБ), предъявляемых к ней.

Системное программное обеспечение#

Ниже приведен список необходимого программного обеспечения (далее — ПО), которое обязательно или не обязательно для установки, настройки, контроля и функционирования продукта. Если в группе указано несколько альтернатив, то клиент может выбрать любой из вариантов, исходя из условий использования конечной информационной системы.

Тип

Наименование ПО и версия**

Обязательность (Да/Нет)*

Программный пакет

Apache Groovy 4.0.15

Да

Утилита

yq 4.25.3

Да

Утилита

jq 1.6

Да

Инструмент сборки, тестирования, развертывания контейнеризированных приложений

Jenkins 2.426.3

Да

Java-машина

OpenJDK 17

Да

Сервис централизованного хранения репозиториев исходного кода

GitLab Community Edition 14.4.5-ee

Да

Сервис централизованного хранения репозиториев исходного кода

Atlassian Bitbucket 7.21.7

Нет

Программный пакет

CUE 0.6+

Да

Утилита

Git CLI 1.8.3.1

Да

Среда контейнеризации

Kubernetes 1.28

Да

Среда контейнеризации

Red Hat OpenShift 4.8

Нет

Менеджер пакетов

Helm 3.13

Нет

Управление конфигурациями kubernetes-ресурсов

Kustomize 4.5.4

Нет

Система управления конфигурациями для автоматизации настройки и развертывания программного обеспечения

Red Hat Ansible 2.9.14

Да

Криптографическая библиотека TLS/SSL

OpenSSL 1.0

Да

Сервер приложений

Platform V SynGX 1.1+

Нет

Управление секретами

HashiCorp Vault 1.20.0

Нет

Операционная система

Альт СП 8.2

Да

Инструмент управления программными проектами

Apache Maven 3.9

Да

Сервер приложений

IBM WebSphere Application Server 8.5.5.19

Нет

Сервер приложений

WildFly 15

Нет

Утилита

kubectl 1.18

Да

Программный пакет

Perl 5.16.3

Да

Утилита

rsync 3.1.3

Да

Утилита

curl 7.61.1

Да

Программный пакет

Python 3.9

Да

Платформа для разработки, доставки и запуска контейнерных приложений

Docker Engine (Docker CE) 20.10.11

Нет

Организация базы знаний

Atlassian Confluence 7.10

Нет

Управление задачами проекта

Atlassian Jira 8.5.10

Нет

Контроль качества кода

SonarQube 9.8.X

Нет

Утилита

CycloneDX Generator (cdxgen) 8.6.2

Да

Утилита

CycloneDX CLI 0.25.0

Да

Синтаксический анализатор

pkg:pypi/pyyaml@6.0.1

Нет

Инструмент сборки Docker-образов

Docker Engine (Docker CE) BuildKit 0.12.3

Нет

Docker плагин для расширенной возможности сборки Dockerfiles с BuildKit

Docker Buildx Docker version 19.03.2

Нет

Библиотека ПО

libxml2 2.9.1

Да

Библиотека ПО

libxslt 1.1.28

Да

Сервис централизованного хранения репозиториев артефактов

Sonatype Nexus Repository 3.69.0-02

Да

Брокер сообщений

Apache Kafka 050.070

Нет

Cистема управления версиями схемы базы данных

Liquibase 4.17.0+

Нет

Система управления базами данных (СУБД)

Oracle Database 8+

Нет

PostgreSQL 42.2.5

Средства мониторинга

Zabbix 3.0+

Нет

Примечание

*
Да — ПО, необходимое для функционирования продукта, без которого не гарантирована работоспособность.
Нет — ПО, необязательное для функционирования продукта, которое не влияет на работоспособность основных функций.

**
Версия ПО, на которой гарантируется работоспособность. «+» после номера версии означает, что возможно использование версий выше до потери обратной совместимости.

Перечень специального программного обеспечения (СПО) для каждого компонента программного продукта Platform V DevOps Tools (DOT) приведен в разделе Документация на компонент DOT → Руководство по установке → Системное программное обеспечение.

Настройка окружения#

Настройка окружения осуществляется индивидуально для каждого из входящих в состав продукта программных компонентов. Подробные шаги описаны в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов.

Установка#

Установка программного продукта представляет собой независимую друг от друга установку входящих в его состав программных компонентов. Каждый компонент устанавливается в соответствии с собственным документом «Руководство по установке».

Чек-лист валидации установки#

Валидация установки осуществляется индивидуально для каждого из входящих в состав продукта программных компонентов. Подробные шаги описаны в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов.

Проверка работоспособности#

Проверка работоспособности продукта осуществляется индивидуально для каждого из входящих в его состав продукта программных компонентов. Данный процесс в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов.

Обновление#

Обновление продукта осуществляется путем индивидуального обновления каждого из входящих в состав продукта программных компонентов. Подробные действия по ручному или автоматическому процессу обновления представлены в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов.

Откат#

Откат на определенную версию продукта осуществляется индивидуально для каждого из входящих в его состав программных компонентов независимо друг от друга. Подробные действия по откату представлены в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов.

Удаление#

Удаление продукта осуществляется путем удаления всех входящих в его состав программных компонентов независимо друг от друга. Подробные действия по удалению представлены в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов.

Часто встречающиеся проблемы и пути их устранения#

Сбор информации о встречающихся проблемы при работе с программным продуктом осуществляется индивидуально для каждого из входящих в его состав программных компонентов. Подробная информация о часто встречающихся проблемах и путях их устранения представлена в соответствующем разделе документа «Руководство по установке» для каждого из программных компонентов