Инструкции

В этой инструкции описывается процесс подготовки виртуальной машины и установки анализатора кода AppScreener.

Создание сети и подсети

Примечание

Если сервер анализатора кода AppScreener предполагается разместить в созданном ранее VPC и подсети, этот пункт можно пропустить.

  1. Войдите в консоль управления Cloud.

  2. В главном меню выберите раздел Network console → Virtual Private Cloud.

  3. В правом верхнем углу нажмите Create VPC.

  4. В открывшемся окне заполните следующие поля в блоке Basic Information:

    1. Укажите название облачной сети VPC в поле Name.

    2. В CIDR Block укажите диапазон IP-адресов, например, выберем рекомендуемый диапазон 10.0.0.0/8-24.

  5. Выберите проект в Enterprise Project, если он был создан ранее, или оставьте по умолчанию.

  6. Создайте подсеть в блоке Default Subnet:

    • В CIDR Block укажите диапазон IP-адресов.

      Предупреждение

      После создания подсети диапазон IP-адресов изменить нельзя.

    • Раскройте настройку Advanced Settings и в блоке DNS Server Address одним из адресов DNS-сервера назначьте адрес «8.8.8.8».

  7. Нажмите Create Now.

Создание виртуального сервера AppScreener

В панели управления облаком Cloud выберите Elastic Cloud Server в разделе Computing.

  1. Нажмите Create ECS.

  2. Выберите зону доступности AZ1, AZ2 или AZ3.

  3. Выберите спецификацию на вкладке Dedicated general-purpose. Выберите спецификацию не ниже 8 CPU и 32 ГБ RAM. Подходящие варианты:

    • c3.2xlarge.4

    • c6.2xlarge.4

    • c6nl.4xlarge.2

  4. Выберите образ операционной системы — Public Image. И в выпадающем списке выберите Ubuntu, в списке правее — Ubuntu 20.04 server 64bit(10GB).

    • Выберите системный диск — High I/O (диск типа SAS).

    • Установите размер — 500 GiB.

  5. Перейдите к шагу настройки сети.

  6. Выберите ранее созданную VPC (облачную выделенную сеть), подсеть и назначьте IP-адрес.

  7. Группу безопасности оставьте по умолчанию — default.

  8. Перейдите к следующему шагу.

  9. В поле ECS Name дайте название виртуальной машине. Например, «ecs-AppScreener».

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

    • Username — root.

    • Password — укажите надежный пароль.

  11. Подтвердите создание виртуальной машины.

  12. Проверьте спецификацию, выберите Enterprise Project и еще раз подтвердите создание.

Виртуальная машина создастся в течение нескольких секунд.

Создание группы безопасности для AppScreener

В панели управления облаком Cloud выберите Virtual Private Cloud в разделе Network.

  1. В левой части панели управления Network Console выберите меню Access Control и подменю Security Groups.

  2. Нажмите Create Security Group в верхнем правом углу экрана.

    • Укажите название создаваемой Security Group, например, «sg-AppScreener».

    • Выберите Enterprise Project в выпадающем меню.

    • Выберите шаблон TemplateCustom.

  3. Нажмите ОК.

  4. В появившемся окне выберите Manage Rule.

  5. Перейдите на вкладку Inbound Rules и нажмите Add Rule.

  6. Добавьте TCP-порт 80:

    ../_images/s__inbound-rule-tcp-80.png
  7. Сохраните изменения.

Аналогичным образом добавьте TCP-порты 8080, 8005, 8009, 5432, 61616, 8161 и сохраните изменения.

Подключение группы безопасности и EIP к ВМ анализатора кода AppScreener

  1. В панели управления облаком Cloud выберите Elastic Cloud Server → Computing.

  2. Нажмите на название созданной виртуальной машины (в нашем примере это «ecs-AppScreener») и перейдите к ее настройкам.

  3. В настройках виртуальной машины перейдите на вкладку Security Groups и выберите Change Security Group.

  4. В выпадающем меню выберите ранее созданную группу (в нашем примере это «sg-AppScreener») и уберите из выбранных группу «default».

  5. Перейдите на вкладку EIP (внешний IP-адрес). Нажмите Bind EIP.

  6. Добавьте EIP для NIC виртуальной машины.

    ../_images/s__bind-new-eip.png

Подготовка виртуальной машины завершена.

Установка программного обеспечения анализатора кода AppScreener

  1. В строке созданной виртуальной машины ECS нажмите Remote Login для подключения.

    Предупреждение

    Более удобным способом подключения к консоли виртуальной машины может быть подключение через SSH. Для этого необходимо добавить TCP-порт 22 в настройки Security Group (в нашем примере это «sg-AppScreener»). Подключение по SSH можно выполнить к внешнему IP-адресу привязанного EIP.

  2. В качестве логина используйте root. В качестве пароля укажите пароль, который был создан при настройке виртуальной машины.

  3. Создайте папку AppScreener и перейдите в нее.

    mkdir AppScreener
    
    cd AppScreener/
    
  4. Скачайте дистрибутив:

    wget https://appscreener.rt-solar.ru/dist/release-3.11/bundles/6ac6d8b5b63f41e1db63ce6f7a2e67a350565a69b43c51ef78ee60a838626152/appscreener-3.11.4-ubuntu20.04-ru-bundle-full.zip
    
  5. Распакуйте дистрибутив:

    unzip -a appscreener-3.11.4-ubuntu20.04-ru-bundle-full.zip
    

    Пароль от архива: Nith4gaeshaoBae3

  6. Перейдите в папку «appscreener-3.11.4-ubuntu20.04-ru-bundle-full»:

    cd appscreener-3.11.4-ubuntu20.04-ru-bundle-full/
    
  7. Выполните установку:

    sudo apt-get update
    
    sudo bash install.sh | sudo tee -a /tmp/appscreener_install.log
    

Установка может занять несколько минут, по ее завершении появится следующее сообщение.

../_images/s__appscreener-installed.png

После завершения установки проверьте доступность графического интерфейса AppScreener. Для этого:

  1. Скопируйте EIP-адрес виртуальной машины AppScreener.

  2. Вставьте EIP-адрес в строку браузера.

../_images/s__appscreener-start-screen.png

Для получения лицензии обратитесь к вашему аккаунт-менеджеру Cloud и передайте ему идентификатор установки.

../_images/s__install-license.png

Начало использования анализатора кода AppScreener

Предупреждение

Объем загружаемых в систему файлов не должен превышать 1900 МБ.

Предупреждение

Система использует технологию контейнеров Docker и имеет привязку к файловой системе хоста в /var/lib/docker/volumes/.

Не удаляйте тома docker (docker volumes), иначе все данные системы будут потеряны.

  1. Загрузите полученную лицензию через графический интерфейс.

  2. Выполните вход в систему:

    • логин: admin

    • пароль: r@78bJM=45

  3. Смените пароль в разделе Личный кабинет.

  4. Загрузите описания правил на вкладке Администрирование → Настройки системы → Правила.

    Описание правил находится в архиве Rules.zip. Этот архив доступен после распаковки архива с дистрибутивом AppScreener, выполненной на шаге «Установка программного обеспечения анализатора кода AppScreener».

    Предупреждение

    Если планируется использовать дополнительные внешние агенты для анализа (например, на macOS или Windows), необходимо открыть порт 61616 в настройках сервера AppScreener:

    sudo ufw allow 61616/tcp

  5. Перейдите на вкладку Новый проект и начните пользоваться системой.

Примечание

Плагины для интеграций с Teamcity, Jenkins, TFS, Sonarqube, Visual Studio, а также command-line tool расположены в:

/opt/appscreener/plugins

Примечание

При специфическом дисковом разбиении в Linux необходимо наличие свободного места в каталогах, как минимум следующего объема:

  • /tmp - 15 ГБ

  • /opt - 300 ГБ

  • /usr - 25 ГБ

  • /var/lib - 160 ГБ

Примечание

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

  • Базы данных: «backend».

  • Каталоги: /opt/appscreener/files/b, /opt/appscreener/files/s, /var/lib/docker/volumes.

  • Файлы конфигураций: /opt/appscreener/tomcat/gui.properties, /opt/appscreener/daemon/daemon.properties, /etc/nginx/conf.d/appscreener.conf.

Примечание

При подключении и настройке агента на macOS возможно локальная загрузка в виде незашифрованного IPA-архива или в виде исходных файлов Obj-C.