Служба идентификации и управления доступом "Фидена"

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

Версия 1.0.0

Содержание

    Общие сведения

    Руководство содержит описание общей схемы и последовательности установки продукта «Служба идентификации и управления доступом "Фидена"».

    В общем случае процесс установки состоит из следующих этапов:

    Установка выполняется с использованием дистрибутива продукта «Служба идентификации и управления доступом "Фидена"» от ГК «Иннотех».

    Состав дистрибутива

    Дистрибутив продукта включает компоненты:

    • inno-iam — сборка бэкенда продукта;

    • CHANGELOG.md — файл, содержащий журнал изменений проекта в виде упорядоченного списка версий продукта с датами их выхода и описанием;

    • iam-doc — сопроводительная документация, соответствующая версии продукта.

    Дистрибутив распространяется в виде архивов в формате tar.gz, доступных для загрузки из репозитория https://artifacts.inno.

    Доступ к репозиторию осуществляется с использованием полученных от ГК «Иннотех» реквизитов. Архивы в репозитории сгруппированы по версиям. Для каждой версии предоставляется стандартный набор архивов с файлами для проверки контрольных сумм.

    Схема развертывания

    На Рис. 1 представлена схема развертывания продукта.

    В данной схеме возможен вариант установки всех компонентов на одной машине. Также возможен вариант установки без отдельной БД PostgreSQL и кэша Infinispan, в этом случае будет использоваться встроенная база данных и кэш Keycloak.
    deployment
    Рис. 1. Схема развертывания

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

    Раздел содержит информацию о требованиях к прикладному программному и аппаратному обеспечению.

    Все указанные пароли являются паролями по умолчанию. Пользователь обязан заменить их при работе с приложением.

    Требования к программному обеспечению

    Требования к системному и прикладному программному обеспечению приведены в таблице:

    Название Описание Версия Тип лицензии Правообладатель

    HAProxy

    Серверное программное обеспечение для обеспечения высокой доступности и балансировки нагрузки для TCP и HTTP-приложений, посредством распределения входящих запросов на несколько обслуживающих серверов

    Любая

    GNU General Public License

    Open Source

    Infinispan

    Программное обеспечение распределенного кэша и хранилища данных NoSQL

    14

    Apache 2.0

    Open Source

    Java

    Язык программирования

    17.0

    GNU GPL 2

    Open Source

    Nginx

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

    Любая

    Nginx License

    Open Source

    PostgreSQL

    СУБД для хранения и обработки данных продукта

    15.0

    PostgreSQL Licence

    Open source

    Требования к аппаратному обеспечению

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

    Тип ресурса CPU Оперативная память (RAM), GB Память (HDD, SSD)

    Фидена

    2

    8

    100GB

    HAProxy

    2

    8

    50GB

    Infinispan

    2

    8

    100GB

    Nginx

    2

    8

    50GB

    PostgreSQL

    4

    16

    100GB

    Установка

    Чтобы установить продукт, установите на сервере Deb-пакет inno-iam одним из следующих способов:

    Имена пакетов формируются по шаблону:

    <package_name>_<build_version>-<edition>_<architecture>.deb

    Где:

    • package_name — имя пакета;

    • build_version — версия пакета в соответствии с принципами семантического версионирования (мажорная_версия.минорная_версия.патч-версия);

    • edition — редакция дистрибутива;

    • architecture — архитектура.

    Пример:

    inno-iam-0.0.3-1_amd64.deb

    Установка из apt-репозитория

    Для установки требуется:

    • наименование apt-репозитория в формате https://<repository.domain.name>/repository/<клиент>-<редакция>-apt-packages;

    • файл с публичным ключом для доступа к apt-репозиторию;

    • реквизиты для доступа к apt-репозиторию.

    Для установки пакета на сервере из apt-репозитория:

    1. Добавьте публичный ключ для доступа к apt-репозиторию с пакетом стандартным способом, соответствующим используемому дистрибутиву Linux.

      Например, на Astra Linux 1.7 SE или Ubuntu 20.04 используйте стандартную утилиту apt-key:

      sudo apt-key add keyfile.pgp
      При необходимости установки ключа для проверки подписи исполняемых файлов в защищенном режиме работы Astra Linux 1.7 SE следуйте инструкции в официальной документации.

      На Ubuntu 22.04 и выше используйте следующую команду (от имени пользователя root):

      cat keyfile.gpg | gpg --dearmor > /usr/share/keyrings/innotech-keyring.gpg
    2. Создайте файл /etc/apt/auth.conf.d/innotech.conf и задайте в нем реквизиты для доступа к репозиторию в стандартном формате:

      machine <repo_host> login <repo_user> password <repo_password>
    3. Подключите требуемый apt-репозиторий в соответствии с инструкциями для используемого дистрибутива Linux (см., например, инструкцию в официальной документации Astra Linux).

      Например, при использовании дистрибутива на основе Debian выполните следующую команду:

      echo -e "deb [trusted=yes] https://artifactory.inno.tech/repository/vtb-astra-apt-packages 1.7_x86-64 main" | sudo tee /etc/apt/sources.list.d/innotech.list
    4. Обновите пакеты с помощью стандартной команды.

      Например, при использовании дистрибутива на основе Debian выполните следующую команду:

      sudo apt update
    5. Установите пакет, выполнив команду:

      sudo apt -f -y install inno-iam

    Установка из архива

    Для установки требуется:

    • наименование репозитория с пакетом в формате https://<repository.domain.name>/repository/<клиент>-<редакция>-raw-packages;

    • реквизиты для доступа к apt-репозиторию.

    Для установки пакета на сервере из архива:

    1. Загрузите архив с пакетом требуемых версий и соответствующие файлы контрольных сумм из репозитория https://artifacts.inno.tech/repository/<клиент>-<редакция>-raw-releases любым доступным способом.

    2. Убедитесь в целостности архивов, сравнив их контрольные суммы с контрольными суммами в соответствующих файлах.

      Пример:

      shasum -a 512 -c inno-iam-0.0.3.tar.gz inno-iam-0.0.3.tar.gz.sha512
    3. Создайте временный каталог для распаковки и распакуйте архив.

      Пример:

      mkdir inno-iam
      tar xvf inno-iam-0.0.3-amd64.tar.gz -C inno-iam
    4. Установите Deb-пакет стандартным способом.

      Пример:

      cd inno-iam/packages
      sudo apt install inno-iam-0.0.3_amd64.deb

    Проверка установки

    После успешной установки пакета:

    1. Cоздана systemd-служба iam.

      Для запуска службы выполните команду:

      systemctl start iam

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

      systemctl status iam
    2. Создан пользователь с ролью «Администратор» с логином и паролем: admin/admin для входа в пользовательский интерфейс Keycloak.

      При начале работы с административным интерфейсом обязательно измените пароль администратора.

    Unresolved include directive in modules/ROOT/pages/install-guide-toc.adoc - include::install-guide/checks/checks-overview.adoc[]

    Unresolved include directive in modules/ROOT/pages/install-guide-toc.adoc - include::install-guide/checks/basic-checks.adoc[]

    Unresolved include directive in modules/ROOT/pages/install-guide-toc.adoc - include::install-guide/checks/additional-checks.adoc[]