Установить портал

Прежде чем устанавливать портал Apigee Developer Services (или просто портал ), убедитесь, что:

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

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

Обзор установки

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

1. Проверьте свое соединение
2. Удалите версии PHP до 7.0.
3. Установить Постгрес
4. Установить портал
5. Убедитесь, что диспетчер обновлений включен.
6. (Необязательно) Настройка Apache Solr
7. (Необязательно) Установите SmartDocs
8. (Необязательно) Настройте JQuery

Устаревание свойства SMTPSSL

В предыдущих выпусках свойство SMTPSSL использовалось для установки протокола, используемого SMTP-сервером, подключенным к порталу. Это свойство устарело.

Теперь вы используете свойство SMTP_PROTOCOL вместо свойства SMTPSSL , чтобы задать протокол, используемый SMTP-сервером, подключенным к порталу. Допустимые значения: «стандарт», «ssl» или «tls».

Создайте файл конфигурации портала

Ниже показан пример файла автоматической конфигурации для установки портала. Отредактируйте этот файл, если это необходимо для вашей конфигурации. Используйте опцию -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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

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

# Optionally configure the SMTP server used by the portal.
# If you do, 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

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# 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=YOUR_EMAIL_PASSWORD

1. Проверьте подключение к Apigee 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 .

В случае успеха curl возвращает ответ, подобный следующему:

{
  "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 до 7.0, отображается следующее предупреждающее сообщение:

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

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

rpm -qa | grep -i php

Обратите внимание, что на портале используется PHP версии 4.18.01-0.0.49. Это не означает, что номер версии Apigee Edge для частного облака совпадает.

3. Установите Постгрес

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

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

Информацию об установке Postgres в рамках установки Edge см. в разделе Установка компонентов Edge на узле .

Чтобы установить Postgres автономно:

1. Установите утилиту Edge apigee-setup на узле, используя процедуру через Интернет или без Интернета. Дополнительные сведения см. в разделе Установка утилиты Edge apigee-setup .
2. Создайте файл конфигурации Postgres, как показано в следующем примере:

   # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
   HOSTIP=$(hostname -i)
   
   # The pod and region of Postgres. Use the default values shown below.
   MP_POD=gateway
   REGION=dc-1
   
   # Set the Postgres password. The default value is 'postgres'.
   PG_PWD=postgres

3. В командной строке запустите сценарий установки Postgres:

   /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

   Опция -p pdb указывает на необходимость установки Postgre. Файл конфигурации должен быть доступен или доступен для чтения пользователю «apigee».

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

Прежде чем вы сможете установить портал, убедитесь, что вы выполнили следующие действия, как описано в разделе 3. Установка Postgres :

1. Установите утилиту Edge apigee-setup на узле портала.
2. Установите Postgres либо отдельно, либо как часть установки Edge.

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

1. В командной строке запустите сценарий setup :

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   Где:

   • configFile — это файл конфигурации портала, как описано в разделе Создание файла конфигурации портала .
   • -p dp указывает сценарию setup установить портал.

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

1. Перейдите на домашнюю страницу портала по адресу http://localhost:8079 или DNS-имя вашего портала.
2. Войдите на портал, используя учетные данные администратора, которые вы указали в файле конфигурации портала.
3. Выберите «Отчеты» > «Отчет о состоянии» в меню Drupal, чтобы убедиться, что вы видите текущий статус портала.
4. Убедитесь, что подключение к Серверу управления прошло успешно. Если бы это было не так:
   1. Перейдите на страницу конфигурации подключения портала (например, http:// portal_IP :8079/admin/config/devconnect ).
   2. Нажмите кнопку «Проверить соединение» . Если соединение прошло успешно, все готово. Если соединение не удалось, продолжайте.
   3. Проверьте конечную точку и настройки аутентификации:
      • URL-адрес конечной точки API управления: проверьте правильность протокола (HTTP или HTTPS), IP- или DNS-имени и номера порта; например:

        http://10.10.10.10:8080/v1

      • Пользователь, прошедший проверку подлинности конечной точки: имя пользователя администратора организации.
      • Пароль аутентифицированного пользователя : пароль администратора организации.

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

      Эти значения должны соответствовать значениям ms_IP_or_DNS , email и password , которые вы использовали на шаге 1: проверьте подключение к Apigee Edge . Имя пользователя и пароль также должны соответствовать значениям свойств USER_NAME и USER_PWD в файле конфигурации регистрации или учетным данным любого пользователя, чья роль — администратор организации.

   4. После успешного подключения к серверу управления нажмите кнопку «Сохранить конфигурацию» внизу страницы, чтобы сохранить изменения.

5. Убедитесь, что модуль «Менеджер обновлений» включен.

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

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

drush pm-info update

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

Используйте пункт меню «Отчеты» > «Доступные обновления» > «Настройки» , чтобы настроить модуль для отправки вам электронного письма о доступности обновлений и установить частоту проверки обновлений.

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

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

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

Чтобы включить модули Drupal Solr:

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

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

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

• Если вы подключаете портал к установке Edge Cloud, SmartDocs уже установлен, и дополнительная настройка не требуется.
• Если вы подключаете портал к установке Edge for Private Cloud, вы должны убедиться, что SmartDocs установлен в Edge. Дополнительные сведения об установке Edge и SmartDocs см. в разделе Установка SmartDocs .

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

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

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

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

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

9. Следующие шаги

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