Установка портала Developer Services

Портал сервисов для разработчиков версии 4.16.09

Перед установкой убедитесь, что:

  • Вы устанавливаете 64-разрядную версию поддерживаемой операционной системы Red Hat Enterprise Linux, CentOS или Oracle. Ознакомьтесь со списком поддерживаемых версий.
  • Yum установлен.
  • Вы создаете резервные копии существующих установок. Если вы изменили код в ядре Drupal или в любых нестандартных модулях, ваши изменения будут перезаписаны. В частности, это касается изменений, внесенных в файл .htaccess. Все, что находится за пределами каталога /sites, принадлежит Drupal. Исключением является файл robots.txt. Если он находится в корневом каталоге, то будет сохранен. Прежде чем продолжить установку, создайте резервную копию всего корневого каталога Drupal. По умолчанию это /var/www/html, но вы могли изменить его при установке. После установки вы сможете восстановить свои настройки из резервной копии.

Чтобы установить портал Developer Channel Services, выполните следующие действия:

1. Как получить пакет Developer Channel Services

Перейдите на страницу http://community.apigee.com/content/apigee-customer-support и выберите Login to your Support Portal (Войти на портал поддержки), чтобы запросить TAR-файл Developer Channel Services одним из двух способов:

  • Запросите доступ к каталогу скачивания Edge для частного облака.
  • Запросите URL файла .tar для Developer Channel Services.

2. Проверьте подключение к Apigee Edge

Проверьте подключение к серверу управления Edge, выполнив следующую команду cURL в командной строке на сервере портала:
> curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

где EMAIL и PASSWORD – это адрес электронной почты и пароль администратора для ORGNAME.

Убедитесь, что вы указали имя хоста и номер порта, которые соответствуют вашей установке Edge. Порт 8080 используется Edge по умолчанию. Если вы подключаетесь к организации в облаке, URL запроса будет следующим: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

В случае успеха эта команда возвращает ответ, похожий на следующий:
{
"createdAt" : 1348689232699,
"createdBy" : "USERNAME",
"displayName" : "cg",
"environments" : [ "test", "prod" ],
"lastModifiedAt" : 1348689232699,
"lastModifiedBy" : "foo@bar.com",
"name" : "cg",
"properties" : {
"property" : [ ]
},
"type" : "trial"
}

3. Удалите версии PHP, предшествующие 7.0

Перед началом установки скрипт проверяет, есть ли в системе версии PHP, предшествующие 7.0. Если у вас установлена более ранняя версия PHP, появится следующее предупреждение:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.
php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Для CentOS и Red Hat Enterprise Linux (RHEL) удалите пакеты PHP с помощью следующей команды:

yum remove <package-name>

4. Как установить Developer Channel Services с помощью скрипта автоматической установки

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

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

Чтобы установить Developer Channel Services на сервере с подключением к интернету:

  1. Войдите на сервер как пользователь root или администратор.
  2. Создайте каталог для установочных файлов, например portal.
  3. Перейдите в новый каталог portal и скачайте файл Developer Channel Services DeveloperServices_x.y.z.tar, где x.y.z – номер версии портала.

    Вы можете скачать файл по ссылке, отправленной вам Apigee, в браузере или скопировав ее и добавив в следующую команду cURL:
    > curl -kOL <вставьте ссылку сюда>
  4. Извлеките содержимое TAR-файла Developer Channel Services с помощью следующей команды:
    > tar -xvf <tar file>
  5. Перейдите в каталог DeveloperServices-4.x.y.z.
  6. Запустите скрипт установки с помощью следующей команды:
    > ./networked-install.sh
  7. Ответьте на вопросы.

На сервере без подключения к интернету:

Сначала создайте скрипт установки без подключения к сети на компьютере, подключенном к интернету.

  1. Войдите в систему с подключением к интернету как пользователь root или администратор.
  2. Создайте каталог для установочных файлов, например portal_tar.
  3. Перейдите в каталог portal_tar и скачайте файл Developer Channel Services DeveloperServices_x.y.z.tar, где x.y.z – номер версии портала.
  4. Извлеките содержимое файла .tar Developer Channel Services с помощью следующей команды:
    > tar -xvf <tar file>
  5. Перейдите в каталог DeveloperServices-4.x.y.z.
  6. Создайте файл .tar.gz портала с помощью следующей команды:
    > ./non-networked-install.sh

Будет создан новый файл .tar.gz для установки без подключения к сети.

Чтобы установить Developer Channel Services на сервере без подключения к интернету:

      1. Войдите на сервер как пользователь root или администратор.
      2. Создайте каталог для установочных файлов, например portal.
      3. Перейдите в каталог portal.
      4. Скопируйте файл .tar.gz, созданный для установки без подключения к сети (см. процедуру выше), в каталог portal.
      5. Извлеките содержимое файла .tar.gz с помощью команды:
        > tar -xvf <tar file>
      6. Перейдите в каталог, созданный командой tar.
      7. Задайте разрешения для скрипта install-from-rpm-bundle.sh:
        > chmod 755 install-from-rpm-bundle.sh
      8. Запустите скрипт install-from-rpm-bundle.sh с помощью команды:
        > ./install-from-rpm-bundle.sh
      9. Ответьте на вопросы.

      5. Как настроить портал для разработчиков

      Большая часть настроек портала, например установка модуля Drupal и создание контента по умолчанию, выполняется без вашего участия. Вам будет предложено настроить базу данных, конечную точку Edge и создать нового администратора.

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

      1. В браузере перейдите по URL сервера, например
        http://localhost. Если у вас настроен определенный IP-адрес или DNS, перейдите по адресу http://IP_address или http://DNS_name.

        Вы будете перенаправлены на страницу настройки базы данных профиля Apigee.

        Примечание. Обычно имя хоста уже настроено и зарегистрировано на DNS-сервере, поэтому использовать http://localhost не нужно.
      2. Настройте подключение к базе данных. Если база данных находится на удаленном компьютере, разверните раздел Расширенные настройки, введите информацию для подключения к этому компьютеру и нажмите Сохранить и продолжить.
      3. Настройте подключение к конечной точке Apigee, указав следующую информацию, и нажмите Сохранить.
        Дополнительную информацию об этих значениях можно найти в разделе "Информация, необходимая перед началом установки" на странице Требования к порталу сервисов для разработчиков.
        1. Management API Org
        2. Management API Endpoint URL (URL конечной точки Management API)
        3. Пользователь, прошедший аутентификацию на конечной точке
        4. Пароль пользователей, прошедших аутентификацию
      4. Настройте пользователя с правами администратора, указав следующую информацию, и нажмите "Сохранить". Обратите внимание, что Drupal по умолчанию создает администратора с именем admin, поэтому не используйте это имя пользователя.
        Если вы пропустите этот шаг, то сможете создать администратора с помощью Drush, как описано ниже в пункте 4. Создайте администратора.
        1. Имя и фамилия разработчика
        2. Имя пользователя на портале разработчиков
        3. Пароль
        4. Адрес электронной почты.
      5. После завершения установки задайте разрешения для файла settings.php:
        > chmod 640 /var/www/html/sites/default/settings.php
      6. Перейдите на главную страницу портала по адресу http://localhost/ или по DNS-имени портала.
      7. Войдите на портал, используя учетные данные администратора.

      6. Как создать пользователя с правами администратора (необязательно)

      Создайте администратора для установки Developer Channel Services с помощью Drush. Drupal автоматически создает администратора с именем пользователя admin по умолчанию, поэтому не используйте admin в качестве имени пользователя.

      1. Перейдите в каталог drupal_root/sites/default. Стандартное расположение корневого каталога Drupal – /var/www/html:
        > cd <drupal_root>/sites/default
      2. Убедитесь, что у вас есть разрешение на запись в частные файлы Drupal:
        > drush vget file_private_path

        Эта команда возвращает путь к частным файлам Drupal, например:
        file_private_path: 'sites/default/private'

        Соответствует /var/www/html/sites/default/private/. Чтобы убедиться, что у владельца и группы есть права на запись в этот каталог, используйте следующую команду:
        chmod -R g+w dirPathAndName
        chmod -R o+r dirPathAndName
      3. Чтобы создать пользователя с правами администратора, введите следующие команды, заменив значения в угловых скобках на свои:
        > drush user-create <username> --mail="<email-address>" --password="<password>"
        > drush user-add-role Administrator <username>
      4. Войдите на портал для разработчиков как администратор, используя имя пользователя и пароль, указанные выше.

      5. Как задать пароль пользователя root для MySQL

      Если вы установили MySQL в рамках установки портала, скрипт установки оставит пароль пользователя root для MySQL пустым (значение по умолчанию).

      Чтобы задать пароль root, используйте следующую команду:

      > mysqladmin -u root password NEWPASSWORD

      Если вы уже задали пароль root и хотите его изменить, используйте следующую команду:

      > mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

      Также необходимо обновить пароль в файле /var/www/html/sites/default/settings.php.

      6. Убедитесь, что модуль Update manager включен.

      Чтобы получать уведомления об обновлениях Drupal, убедитесь, что модуль Update manager включен. В меню Drupal выберите Modules (Модули) и прокрутите страницу вниз до модуля Update manager (Менеджер обновлений). Если он не включен, включите его.

      После этого вы сможете просматривать доступные обновления, выбрав в меню Отчеты > Доступные обновления. Вы также можете использовать следующую команду Drush:

      > drush pm-info update

      Чтобы настроить модуль для отправки вам электронных писем о доступных обновлениях и задать частоту проверки обновлений, выберите пункт меню Reports (Отчеты) > Available Updates (Доступные обновления) > Settings (Настройки).

      7. Развертывание на рабочем сервере (необязательно)

      Если вы развертываете портал на рабочем сервере, вам следует выполнить дополнительные действия по обеспечению безопасности, в том числе:

      1. Запустите следующий скрипт, чтобы защитить установку MySQL:
        > /usr/bin/mysql_secure_installation

        Этот скрипт устанавливает пароль пользователя root и позволяет ограничить доступ пользователя root только к локальному хосту, а также удалить тестовые базы данных и анонимного пользователя, созданного по умолчанию. Настоятельно рекомендуем запустить этот скрипт на рабочих серверах.
      2. Если этого требуют корпоративные правила, включите и настройте SELinux.

      8. Настройте поисковую систему Apache Solr (необязательно)

      По умолчанию модули Drupal, которые подключаются к поисковой системе Apache Solr, отключены при установке портала. Большинство порталов используют внутреннюю поисковую систему Drupal, поэтому им не требуются модули Drupal Solr.

      Если вы решите использовать Solr в качестве поисковой системы, вам необходимо установить Solr локально на своем сервере, а затем включить и настроить модули Drupal Solr на портале.

      Чтобы включить модули Drupal Solr, выполните следующие действия:

      1. Войдите на портал как пользователь с правами администратора или создания контента.
      2. В меню Drupal выберите Modules (Модули).
      3. Включите модули Apache Solr Framework и Apache Solr Search.
      4. Сохраните изменения.
      5. Настройте Solr, как описано на странице https://drupal.org/node/1999280.

      9. Установите mod_ssl для поддержки HTTPS (необязательно)

      Модуль mod_ssl используется HTTP-сервером Apache для передачи веб-страниц по протоколу HTTPS. Если вы хотите использовать HTTPS, установите mod_ssl с помощью следующей команды:

      > yum install mod_ssl

      Дополнительную информацию о настройке портала для использования SSL можно найти на странице http://apigee.com/docs/developer-services/content/using-ssl-portal.

      10. Установите SmartDocs (необязательно)

      SmartDocs позволяет документировать API на портале Developer Services так, чтобы документация была полностью интерактивной. Однако, чтобы использовать SmartDocs с порталом, вы должны сначала установить SmartDocs на Edge.

      • Если вы подключаете портал к Edge Cloud, SmartDocs уже установлен и дополнительная настройка не требуется.
      • Если вы подключаете портал к установке Edge для частного облака, убедитесь, что SmartDocs установлен на Edge. Подробнее об установке Edge и SmartDocs…

      Дополнительную информацию о SmartDocs можно найти в статье Использование SmartDocs для документирования API.

      11. Что дальше

      После установки портала Developer Services вам нужно настроить его в соответствии со своими требованиями. В документации на сайте Apigee содержится вся информация о настройке, оформлении и управлении порталом. Документация доступна на странице http://apigee.com/docs/developer-services/content/what-developer-portal.

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

      Задача

      Описание

      Настройка темы

      Тема определяет внешний вид портала, включая цвета, стили и другие визуальные аспекты.

      Настройка внешнего вида

      На главной странице есть главное меню, приветственное сообщение, заголовок, нижний колонтитул и название.

      Добавление аккаунтов пользователей и управление ими

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

      Настройка электронной почты

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

      Добавление аккаунтов пользователей и управление ими

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

      Добавление аккаунтов пользователей и управление ими

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

      Добавление записей в блогах и на форумах

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

      Убедитесь, что вы создаете резервные копии базы данных

      Убедитесь, что вы создаете резервную копию базы данных Drupal. Поскольку все установки отличаются друг от друга, вы должны сами определить, как лучше всего создать резервную копию базы данных.

      Как настроить имя хоста

      Если вы не настроите имя хоста на DNS-сервере, вы всегда сможете получить доступ к сайту по IP-адресу сервера. Если вы хотите использовать имя хоста, настройте DNS для сервера. При базовой настройке этого должно быть достаточно.

      Если вы настроили балансировщик нагрузки или по какой-то другой причине получаете неверные URL на своем сайте, вы можете задать $base_url в файле settings.php портала для разработчиков, который по умолчанию находится в каталоге /var/www/html/sites/default.