Установка портала служб для разработчиков

Edge для частного облака v4.18.01

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

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

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

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

После установки утилиты Edge the 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

Дополнительные сведения см. в разделе Установка утилиты Edge apigee-setup .

Устаревание свойства 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=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 

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

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 .

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

{
  "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

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 configFile

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

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

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

1. Установите утилиту Edge apigee-setup на узле, используя процедуру через Интернет или без Интернета. Дополнительные сведения см. в разделе Установка утилиты Edge apigee-setup .
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, чтобы убедиться, что вы видите текущий статус портала.

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 на портале Developer Services таким образом, чтобы документация по 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. Что дальше?

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

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