安装门户

适用于私有云的 Edge v4.18.05

在安装 Apigee Developer Services 门户（简称门户）之前，请确保：

1. 您应先安装 Postgres，然后再安装门户。你可以将 Postgres 作为 或独立安装 Postgres 以供门户使用。
   • 如果您独立安装 Postgres，它可以与门户位于同一节点上。
   • 如果您要连接到作为 Edge 的一部分安装的 Postgres，并且已配置了 Postgres 在主/备用模式下，指定主 Postgres 服务器的 IP 地址。
2. 您在受支持的 Red Hat 的 64 位版本上执行安装 Enterprise Linux、CentOS 或 Oracle。如需查看受支持版本的列表，请访问 支持的软件和支持的版本。
3. 已安装 Yum。

安装程序仅包含由 Drupal 提供的模块，这些模块在 Apigee Developer Services 门户（简称门户）。如需了解如何安装其他贡献模块，请参阅 扩展 Drupal 7。

安装概览

如需安装该门户，您需要执行以下步骤。有关以上每个步骤的说明， 。

1. 测试连接
2. 移除 7.0 之前的 PHP 版本
3. 安装 Postgres
4. 安装门户
5. 确保已启用更新管理器
6. （可选）配置 Apache Solr
7. （可选）安装 SmartDocs
8. （可选）配置 JQuery

即将弃用 SMTPSSL 属性

在之前的版本中，您使用 SMTPSSL 属性来 设置连接到门户的 SMTP 服务器使用的协议。该属性已被 已弃用。

现在，您将使用 SMTP_PROTOCOL 属性， 而不是 SMTPSSL 属性，以设置 与门户连接的 SMTP 服务器使用的协议。有效值为“standard”、 “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 的连接

测试要安装门户的服务器与 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 使用的默认端口。如果您要连接到云端的组织， 则请求网址为 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. 移除 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

如果您不确定自己的服务器上是否安装了 PHP，请使用以下命令：

rpm -qa | grep -i php

3. 安装 Postgres

该门户需要先安装 Postgres，然后才能安装该门户。您可以执行以下任一操作 在安装 Edge 时安装 Postgres，或单独安装 Postgres 以供 。

• 如果您要连接到作为 Edge 的一部分安装的 Postgres，并在 在主/备用模式下，指定主 Postgres 服务器的 IP 地址。
• 如果您独立安装 Postgres，它可以与门户位于同一节点上。

如需了解如何在安装 Edge 的过程中安装 Postgres，请参阅 在节点上安装 Edge 组件。

如需独立安装 Postgres，请执行以下操作：

1. 使用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 时一并安装 Postgres

如需安装门户，请执行以下操作：

1. 在命令提示符处，运行 setup 脚本：

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

   其中：

   • configFile 是门户配置文件，如 创建门户配置文件。
   • -p dp 指示 setup 脚本安装该门户。

如需验证门户安装是否成功，请执行以下操作：

1. 前往门户首页（位于 http://localhost:8079）或相应的 DNS 名称 创建 Deployment 清单
2. 使用您在该门户中设置的管理员凭据登录该门户 配置文件
3. 选择报告 >状态报告，以确保 可以查看门户的当前状态。
4. 确保管理服务器连接成功。如果不是： <ph type="x-smartling-placeholder">
   </ph>
   1. 前往门户“Connection Configuration”页面（例如， http://portal_IP:8079/admin/config/devconnect）。
   2. 点击测试连接按钮。如果连接成功 这样就大功告成了。如果连接失败，请继续。
   3. 检查端点和身份验证设置： <ph type="x-smartling-placeholder">
      </ph>
      • Management API 端点网址：检查协议（HTTP 或 IP 或 DNS 名称以及端口号是否正确；例如：

        http://10.10.10.10:8080/v1

      • 通过端点身份验证的用户：组织管理员的 用户名。
      • 通过身份验证的用户的密码：组织管理员的密码 密码。

      默认值反映的是您在门户配置文件中指定的 会在安装过程中创建。

      这些值应与 ms_IP_or_DNS、email 和 您在步骤中使用的 password 个值 1：测试与 Apigee Edge 的连接。 用户名和密码也应与 USER_NAME 的值相匹配 和 USER_PWD 属性（位于 初始配置配置文件或 拥有 Organization Administrator 角色的任何用户的凭据。

   4. 成功连接到管理服务器后，点击保存 配置按钮，保存更改。

5. 请确保更新管理器模块 已启用

要接收 Drupal 更新的通知，请确保已打开 Drupal 更新管理器模块 。从 Drupal 菜单中选择 Modules 并向下滚动到 更新管理器模块。如果未启用，请启用。

启用后，您可以使用报告 >可用 更新菜单项。您还可以使用以下 Drush 命令：

drush pm-info update

您必须从网站的根目录运行此命令。默认情况下， 门户安装在 /opt/apigee/apigee-drupal/wwwroot。因此， 您应先将目录更改为 /opt/apigee/apigee-drupal/wwwroot，然后再 运行命令。如果您未在默认目录中安装门户，请改用您的 安装目录中。

使用报告 >可用更新 >Settings 菜单项进行配置 该模块在有可用更新时向您发送电子邮件，并设置检查 更新。

6. 配置 Apache Solr 搜索引擎 （选填）

默认情况下，在以下情况下，连接到 Apache Solr 搜索引擎的 Drupal 模块处于停用状态 您需要安装该门户大多数门户都使用内部 Drupal 搜索引擎，因此并不 需要使用 Drupal Solr 模块。

如果您决定使用 Solr 作为搜索引擎，必须在服务器本地安装 Solr 然后在该门户上启用并配置 Drupal Solr 模块。

如需启用 Drupal Solr 模块，请执行以下操作：

1. 以拥有管理员或内容创建权限的用户身份登录门户。
2. 在 Drupal 菜单中选择 Modules。
3. 启用 Apache Solr Framework 模块和 Apache Solr Search 模块。
4. 保存更改。
5. 按照 https://drupal.org/node/1999280 中的说明配置 Solr。

7. 安装 SmartDocs（可选）

借助 SmartDocs，您可以在门户上记录 API 的 API 文档提供全面互动。但是，要通过该门户使用 SmartDocs，您必须先 在 Edge 上安装 SmartDocs。

• 如果您要将门户连接到 Edge Cloud 安装，则 SmartDocs 已经 无需进一步配置。
• 如果要将门户连接到 Edge 以进行私有云安装，您必须确保 SmartDocs 已安装在 Edge 上。如需详细了解如何安装 Edge 和 SmartDocs，请参阅 安装 SmartDocs。

您还必须在该门户上启用 SmartDocs。有关 SmartDocs 的详情，请参阅 使用 SmartDocs 进行记录 API。

8. 配置 适用于非互联网安装的 JQuery 更新模块（可选）

如果您在非互联网安装中安装和使用 JQuery 更新模块，则需要 将模块配置为使用 JQuery 的本地版本。如果您将模块配置为使用 CDN 非互联网安装，它将尝试访问 CDN，并导致网页出现延迟 正在加载。有关 JQuery 更新模块的详情，请参阅 https://www.drupal.org/project/jquery_update.

要将 JQuery 更新模块配置为使用 JQuery 的本地版本，请执行以下操作：

1. 以拥有管理员或内容创建权限的用户身份登录门户。
2. 选择配置 >制作 >Drupal 菜单中的 JQuery 更新。
3. 点击左侧导航栏中的效果。
4. 在 JQuery 和 JQuery 界面 CDN 下拉菜单中，选择无。
5. 点击 Save configuration（保存配置）。

9. 后续步骤

下表列出了安装后执行的一些最常见任务。 中提供了指向 Apigee 文档的链接，您可以在文档中了解更多信息：