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

Edge for Private Cloud версии 4.17.09

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

• Postgres устанавливается до установки портала. Вы можете установить Postgres как часть установки Edge или установить Postgres отдельно для использования порталом.
  • Если вы устанавливаете Postgres отдельно, он может находиться на том же узле, что и портал.
  • Если вы подключаетесь к Postgres, установленному в составе Edge, и Postgres настроен в режиме master/standby, укажите IP-адрес главного сервера Postgres.
• Вы устанавливаете 64-разрядную версию поддерживаемой операционной системы Red Hat Enterprise Linux, CentOS или Oracle. Список поддерживаемых версий приведен в статье Поддерживаемое программное обеспечение и его версии.
• Yum установлен.

Установщик включает только модули, предоставленные Drupal, которые требуются для портала Apigee Developer Services (или просто портала). Информацию об установке других модулей можно найти в статье Расширение Drupal 7.

Общие сведения об установке

После установки утилиты Edge apigee-setup на узле используйте ее для установки портала на узле. Утилита apigee-setup имеет следующий формат:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Передайте утилите apigee-setup файл конфигурации, содержащий информацию об установке. Если в файле конфигурации отсутствует какая-либо обязательная информация, утилита apigee-setup предложит ввести ее в командной строке.

Единственное требование – файл конфигурации должен быть доступен или доступен для чтения пользователю apigee.

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

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Подробнее о том, как установить утилиту apigee-setup для Edge…

Как создать файл конфигурации

Ниже приведен пример файла конфигурации для автоматической установки портала. При необходимости измените этот файл в соответствии с вашей конфигурацией. Чтобы включить этот файл, используйте параметр -f для setup.sh.

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres. 
PG_NAME=devportal 

# Specify the Postgres admin credentials. 
# The portal connects to Postgres by using the 'apigee' user. 
# If you changed the Postgres password from the default of 'postgres' 
# then set PG_PWD accordingly. 
# If connecting to a Postgres node installed with Edge, 
# contact the Edge sys admin to get these credentials. 
PG_USER=apigee 
PG_PWD=postgres 

# The IP address of the Postgres server. 
# If it is installed on the same node as the portal, specify that IP. 
# If connecting to a remote Postgres server,specify its IP address. 
PG_HOST=$IP1 

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# You must configure the SMTP server used by the portal. 
# The properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

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

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

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

Или:

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/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"
}

2. Удалите версии 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

Удалите пакеты PHP с помощью следующей команды:

yum remove <package-name>

3. Установите Postgres

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

• Если вы подключаетесь к Postgres, установленному в составе Edge, и Postgres настроен в режиме master/standby, укажите IP-адрес главного сервера Postgres.
• Если вы устанавливаете Postgres отдельно, он может находиться на том же узле, что и портал.

Информацию об установке Postgres в рамках установки Edge можно найти в статье Как установить компоненты Edge на узел.

Чтобы установить Postgres в качестве отдельного приложения:

1. Установите утилиту Edge apigee-setup на узел, используя процедуру с подключением к интернету или без него. Подробнее о том, как установить утилиту apigee-setup для Edge…
2. Создайте файл конфигурации для Postgres, как показано ниже:
   
   # Должно разрешаться в IP-адрес или DNS имя хоста — не 127.0.0.1 или localhost.
   HOSTIP=$(hostname -i)
   
   # The pod and region of Postgres. Используйте значения по умолчанию, указанные ниже.
   MP_POD=gateway
   REGION=dc-1
   
   # Set the Postgres password. Значение по умолчанию – postgres.
   PG_PWD=postgres
3. В командной строке запустите скрипт настройки, чтобы установить Postgres:
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   Параметр -p pdb указывает, что нужно установить Postgre.
   
   Файл конфигурации должен быть доступен или доступен для чтения пользователю apigee.

4. Установите портал

Чтобы установить портал:

1. Установите утилиту Edge apigee-setup на узел, используя процедуру с подключением к интернету или без него. Подробнее о том, как установить утилиту apigee-setup для Edge…
2. Убедитесь, что вы установили Postgres как отдельный компонент или в составе Edge.
3. В командной строке запустите скрипт настройки:
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   Параметр -p dp указывает, что нужно установить портал.
   
   Файл конфигурации должен быть доступен или доступен для чтения пользователю apigee.
4. Перейдите на главную страницу портала по адресу http://localhost:8079 или по DNS-имени портала.
5. Чтобы убедиться, что портал работает правильно, войдите в него, используя учетные данные администратора, которые вы задали в файле конфигурации.
6. В меню Drupal выберите Reports (Отчеты) > Status Report (Отчет о статусе), чтобы проверить текущий статус портала.

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

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

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

> drush pm-info update

Эту команду нужно выполнить в корневом каталоге сайта. По умолчанию портал для разработчиков устанавливается в каталог /opt/apigee/apigee-drupal/wwwroot. Поэтому перед выполнением команды необходимо перейти в каталог /opt/apigee/apigee-drupal/wwwroot. Если вы установили портал не в каталог по умолчанию, перейдите в каталог установки.

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

6. Настройте поисковую систему 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.

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

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

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

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

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

Если вы устанавливаете и используете модуль JQuery Update в среде без доступа к интернету, вам нужно настроить модуль так, чтобы он использовал локальную версию JQuery. Если вы настроите модуль на использование CDN для установки без доступа к интернету, он попытается подключиться к CDN, что приведет к задержкам при загрузке страниц. Подробнее о модуле jQuery Update читайте на странице https://www.drupal.org/project/jquery_update.

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

1. Войдите на портал как пользователь с правами администратора или создания контента.
2. В меню Drupal выберите Configuration (Конфигурация) > Development (Разработка) > JQuery Update (Обновление JQuery).
3. Нажмите Эффективность на панели навигации слева.
4. В раскрывающемся меню JQuery and JQuery UI CDN (CDN для JQuery и JQuery UI) выберите None (Нет).
5. Нажмите Сохранить конфигурацию.

9. Что дальше

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

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

/opt/apigee/apigee-drupal-devportal-opdk_version/source/conf/settings.php