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

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

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

Прежде чем приступать к установке, создайте резервную копию всего корневого каталога Drupal. По умолчанию это /var/www/html, но вы могли изменить его при установке. После выполнения описанных ниже шагов по установке вы сможете восстановить свои настройки из резервной копии.

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. Убедитесь, что ваша система соответствует требованиям

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

1. Убедитесь, что вы выполняете установку на 64-разрядной версии поддерживаемой версии Red Hat Enterprise Linux, CentOS или Oracle. Ознакомьтесь со списком поддерживаемых версий.
2. Убедитесь, что у вас установлен Yum.
3. (Для установки на сервере без подключения к интернету) Сначала скачайте все необходимые файлы на сервер с подключением к интернету в виде одного файла .tar.gz. Затем скопируйте этот файл на сервер без подключения к интернету и выполните установку.
   1. Войдите на сервер с подключением к интернету как пользователь root или администратор.
   2. Создайте каталог для установочных файлов, например portal_tar.
   3. Перейдите в новый каталог и скачайте файл 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. Затем скопируйте этот файл на сервер, не подключенный к интернету, чтобы завершить установку.
4. Проверьте подключение к серверу управления 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. Как установить Developer Channel Services с помощью скрипта автоматической установки

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

1. Войдите на сервер как администратор.
2. Создайте каталог для установочных файлов, например portal.
3. На сервере с подключением к интернету:
   1. Перейдите в новый каталог portal и скачайте файл Developer Channel Services DeveloperServices_x.y.z.tar, где x.y.z – номер версии портала.
      
      Вы можете скачать файл по ссылке, отправленной вам Apigee, в браузере или скопировав ее и добавив в следующую команду cURL:
      > curl -kOL <вставьте ссылку сюда>
   2. Распакуйте содержимое TAR-файла Developer Channel Services с помощью следующей команды:
      > tar -xvf <tar file>
   3. Перейдите в каталог DeveloperServices-4.x.y.z.
   4. Запустите скрипт установки с помощью следующей команды:
      > ./networked-install.sh
4. На сервере без подключения к интернету:
   1. Скопируйте файл TAR.GZ, созданный в разделе 2. Убедитесь, что ваша система соответствует системным требованиям.
   2. Извлеките содержимое файла TAR.GZ с помощью следующей команды:
      > tar -xvf <tar file>
   3. Перейдите в каталог, созданный командой tar.
   4. Задайте разрешения для скрипта install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
   5. Запустите скрипт install-from-rpm-bundle.sh с помощью команды:
      > ./install-from-rpm-bundle.sh
5. Ответьте на вопросы.
6. После завершения установки перейдите по URL сервера в браузере, например
   http://localhost. Если у вас настроен определенный IP-адрес или DNS, перейдите по адресу http://IP_address или http://DNS_name.
   
   Вы будете перенаправлены на страницу настройки базы данных профиля Apigee.
   
   Примечание. Обычно имя хоста уже настроено и зарегистрировано на DNS-сервере, поэтому использовать http://localhost не нужно.
7. Настройте подключение к MySQL. Если MySQL находится на удаленном компьютере, разверните раздел Расширенные настройки и введите информацию о подключении к этому компьютеру, а затем нажмите Сохранить и продолжить.
8. Настройте подключение к конечной точке Apigee, указав следующую информацию, а затем нажмите Save (Сохранить):
   Дополнительную информацию об этих значениях можно найти в разделе "Information Required Before You Start the Install" (Информация, необходимая перед началом установки) на странице Developer Services portal requirements (Требования к порталу Developer Services).
   1. Dev Portal Org
   2. Dev Portal Endpoint URL
   3. Пользователь, прошедший аутентификацию на конечной точке
   4. Пароль пользователей, прошедших аутентификацию
9. Когда появится запрос, нажмите кнопку Install Sample SmartDocs WADL (Установить пример WADL-файла SmartDocs). Если вы пропустите этот шаг, пример SmartDocs API не появится на вашем портале.
   Примечание. Если ваш портал подключается к установке Apigee Edge для частного облака и у этой установки нет внешнего подключения к интернету, то, прежде чем использовать SmartDocs, вам необходимо выполнить дополнительную настройку модуля SmartDocs. Дополнительную информацию о SmartDocs можно найти на странице http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
10. Задайте настройки SMTP-сервера. Для отправки электронных писем с портала Apigee требуется настроить SMTP-сервер.
    Подробную информацию можно найти на странице http://apigee.com/docs/developer-services/content/configuring-email.
11. Настройте пользователя с правами администратора, указав следующую информацию, и нажмите "Сохранить". Обратите внимание, что Drupal по умолчанию создает администратора с именем admin, поэтому не используйте это имя пользователя.
    Если вы пропустите этот шаг, то сможете создать администратора с помощью Drush, как описано ниже в пункте 4. Создайте администратора.
    1. Имя и фамилия разработчика
    2. Имя пользователя на портале разработчиков
    3. Пароль
    4. Адрес электронной почты.
12. После завершения установки задайте разрешения для файла settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
13. Перейдите на главную страницу портала по адресу http://localhost/ или по DNS-имени портала.
14. Войдите на портал, используя учетные данные администратора.

4. Как создать пользователя с правами администратора

Создайте администратора для установки 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, где вы можете найти дополнительную информацию: