与万神殿合作

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

Apigee 使用 Pantheon(一种网站管理服务)来托管开发者服务门户的云端版本。Pantheon 旨在与 Drupal 搭配使用,让您在安全的环境中开发、测试和发布门户。Pantheon 的网站管理服务面向全球具有托管和开发运营需求的客户。

以下部分介绍了如何使用 Pantheon 开发和管理您的门户。

访问 Pantheon 信息中心

当 Apigee 向您发送门户网址时,您也会收到 Pantheon 信息中心的网址:https://dashboard.getpantheon.com/

首次登录 Pantheon 信息中心时,您会进入网站页面,如下所示:

在信息中心内,您可以访问自己的网站、配置您的帐号,以及执行其他操作。

选择您网站的图片(例如 apigeedocs),以打开该网站的信息中心:

管理您的环境

在 Pantheon 信息中心,页面顶部列出了三种环境:Dev、Test 和 Live。下表中分别介绍了这两种方法。

环境

说明

开发者版

Dev 环境已连接到您的 Git 代码库。您推送到 Git 的任何更改都会立即显示在开发环境中。

此网站的网址采用以下格式,其中 org_name 是贵组织的名称:

http://dev-{org_name}.devportal.apigee.io/

测试

Test 环境使用来自 Live 环境的数据副本来测试您的最新代码。您可以在此环境中测试代码更改,然后再将其推送到实际环境。

此网站的网址采用以下格式,其中 org_name 是贵组织的名称:

http://test-{org_name}.devportal.apigee.io/

直播

实际环境是您可供客户访问的生产环境。

此网站的网址采用以下格式,其中 org_name 是贵组织的名称:

http://live-{org_name}.devportal.apigee.io/

开发门户内容

以下部分介绍如何开发门户内容。

此外,如需详细了解如何自定义门户,请参阅以下部分。

如果您想要...

您可以

更多信息

更改网站的外观和风格

基本 - 使用门户网站上的外观菜单项进行更改,例如修改徽标和网站颜色。

请参阅自定义外观

高级 - 如需修改网站的完整外观和风格,请扩展 Apigee 自适应主题背景。

请参阅自定义主题背景

更改网站功能的行为

基本 - 使用门户上的管理员设置来更改/配置网站的行为方式。

请参阅此处的 Apigee 文档

高级 - 创建自定义模块以更改网站的任何行为。

请参阅 Drupal 文档中的创建自定义模块

Git 代码库概览

Drupal 代码的 Git 代码库包含您的所有门户代码,并且按以下结构进行整理。

注意:请仅修改 /sites/all 目录中的内容。如果您修改了 /sites/all 目录之外的内容,则会在升级到新版本时遇到问题,并且在签入 Git 的更改时可能会遇到合并冲突。

Git 代码库中的文件夹

说明

/profiles/apigee

Apigee 维护了多个模块和主题,包括:

  • /profiles/apigee/modules/contrib:由 Apigee 维护的 Drupal contrib 模块
  • /profiles/apigee/themes/contrib:由 Apigee 维护的 Drupal contrib 主题
  • /profiles/apigee/modules/custom:Apigee 创建的自定义模块
  • /profiles/apigee/themes/custom:Apigee 创建的自定义主题

注意:请勿修改 /profiles/apigee 目录中的内容,否则在升级到新版本时会遇到问题,并且在签入 Git 的更改时可能会遇到合并冲突。如需了解 Drupal 最佳实践,请参阅永不入侵核心

/sites/all

您的自定义 Drupal 模块和主题。如需了解如何管理此文件夹中的内容,请参阅添加自定义模块和主题背景以及替换 Drupal 配置文件模块和主题背景

注意:请只修改 /sites/all 目录中的内容。

访问代码

为了访问 Git 中的代码库,您需要执行下面几部分中介绍的任务:

另请参阅如何访问 Drupal 7 开发者门户源代码?

启用对服务器的 SSH 访问权限

您必须先将 SSH 密钥上传到 Pantheon,以允许 SSH 访问您的服务器,然后才能使用 Git 管理 Drupal 代码。

要启用对服务器的 SSH 访问,请执行以下操作:

  1. 通过 https://dashboard.getpantheon.com/ 登录 Pantheon。
  2. 在信息中心内,选择帐号
  3. 在左侧菜单中,选择 SSH Keys
  4. 添加您的密钥,然后选择添加密钥
    如果您需要帮助,请选择了解如何生成 SSH 密钥链接。

访问 Git 中的代码库

注意:如需简要了解 Git 代码库结构,请参阅 Git 代码库概览

如需访问 Git 中的代码库,请执行以下操作:

  1. 登录 Pantheon 信息中心。
  2. 在 Google 协作平台主页面上,选择门户的图标。
  3. Git 代码库的网址会显示在连接模式右侧的页面上,如上图所示。
  4. 复制您的 Git 代码库的网址,并使用以下命令将其克隆到本地开发环境:
    > git clone gitURL gitURL
    例如:
    > git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repo.git devportal

推送到 Git 代码库的任何代码更改都会立即显示在门户的开发环境中。

将代码部署到门户环境

如需针对您的门户环境编写代码,请执行以下操作:

  1. 将代码更新推送到 Git,Git 会立即更新开发环境。
  2. 登录 Pantheon 并选择您的网站。
  3. 选择开发环境。
  4. 在左侧菜单中选择 </>Code,查看提交日志中有关代码更改的消息:
  5. 在页面顶部选择测试环境。
    1. 如果您尚未将 Dev 上传到 Test,系统会提示您立即执行此操作。
    2. 如果您已有测试环境,则系统会显示一条消息,指明开发中有一项提交内容可供部署:
  6. 如果您已将网站推送至实时环境,则可以选择第三个复选框,将实时数据库和开发者上传到测试实时上传的所有文件复制到该环境中。如果您想针对 Live 上提供的最新数据测试代码更改,这种方法非常有用。
  7. 选择 Deploy Code from Development 按钮。
  8. 测试环境中测试门户。
  9. Dev 环境进行所有代码修复,然后再次将文件推送到 Test 进行测试。
  10. 测试完成后,在页面顶部选择实际版本环境。
    1. 如果您尚未将 Test 上传到 Live,系统会提示您立即上传。
    2. 如果您已有 Live 环境,则系统会显示一条消息,指示 Test 中有一项提交内容已可部署。按照将这些更改部署到开发中的测试时所用的相同方式进行部署。完成测试后,将代码推送到实际环境。

了解详情

添加自定义模块和主题

您可将自己的自定义模块和主题添加到下表中列出的文件夹中,从而扩展该门户的功能。

注意:请只修改 /sites/all 目录中的内容。如果您修改了 /sites/all 目录之外的内容,则在签入 Git 的更改时可能会遇到合并冲突。

模块/主题 Git 代码库中的文件夹 更多信息(Drupal 文档)
自定义模块 sites/all/modules/custom 创建自定义模块
自定义主题 sites/all/themes 自定义主题
Theming Drupal 7

Dev 环境中添加自定义模块或主题后,您可以将其部署到 Test 以进行测试,然后再将其部署到 Live 环境用于生产环境,如将代码部署到门户环境中所述。

替换 Drupal 配置文件模块和主题

以下目录中的模块和主题会覆盖由 Apigee 在 /profiles/apigee 中维护和分发的 Drupal 配置文件模块和主题。请参阅 Git 代码库概览

例如,在以下情况下,您可能需要替换 Apigee Drupal 发行版中的模块:

  • 您想使用特定模块的其他版本。
  • 您希望在排定的下一个 Apigee 版本发布之前实施安全更新。
模块/主题 Git 代码库中的文件夹 更多信息(Drupal 文档)
Drupal 贡献的模块

sites/all/modules/contrib

注意:存储在 /sites/all/modules 下任何位置的模块将替换 Apigee Drupal 分发模块。

贡献的模块

注意:此目录中的 Drupal 贡献的模块会替换由 Apigee 在 /profiles/apigee/modules 中维护和分发的等效模块。 如果您想要使用 Apigee 维护的 Drupal 配置文件模块,请移除您添加到此文件夹中的所有重复模块。

Drupal 贡献的主题背景 sites/all/themes 贡献的主题背景

注意:此目录中的 Drupal 贡献的主题会覆盖由 Apigee 在 /profiles/apigee/themes 中维护和分发的等效模块。如果希望使用 Apigee 维护的配置文件主题,请移除您添加到此文件夹的任何重复模块。

关于 settings.php 文件

Drupal settings.php 已提交到 Apigee Drupal 开发者门户上游 Git 代码库中。如果您要更改 sites/default/settings.php 文件,请勿直接修改该文件,您可以改为创建一个名为 sites/default/settings.local.php 的文件,并将自定义代码放入其中。sites/default/settings.local.php 包含在 settings.php 文件中。

例如,在为实际网站设置自定义网域时,请按照 Pantheon 提供的说明(而非直接修改 settings.php 文件)在 sites/default/settings.local.php 中添加所需的更新。

保护门户的安全

默认情况下,与开发测试实际环境关联的门户网站均可公开访问。也就是说,知道网站网址的任何人都可以访问该网站,不过他们可能无法注册帐号或登录该网站。如需详细了解如何控制用户注册,请参阅添加和管理用户帐号

您可能想要对公众隐藏 DevTest 网站,并希望在完成开发之前隐藏您的 Live 网站。借助 Pantheon,您可以添加用户名/密码控件来锁定网站,以便只有拥有适当凭据的用户才能访问。

针对这三个环境中的任意一个,添加锁定设置,方法是在相应环境的左侧菜单中选择安全性。如需了解详情,请参阅锁定您的网站

如果要为您的网站启用 TLS/SSL,请参阅在门户上使用 TLS

将 Apigee 更新应用于您的门户

当 Apigee 发布门户的新版本时,Pantheon 信息中心会显示一条消息。

您通常会将更新应用于开发环境,然后像测试自己的代码更改一样测试这些更改。例如,将开发环境推送到测试,将实时数据从实时推送到测试,然后测试更新。

如需应用更新,请按以下步骤操作

  1. 通过 https://dashboard.getpantheon.com/ 登录 Pantheon,然后选择您的网站。
  2. 选择开发环境。
  3. 选择左侧的</>代码菜单项。系统会列出任何可用的 Apigee 更新。
  4. 应用更新:
    1. 选中拉取代码后运行 update.php 复选框。
    2. 选中拉取代码后清除缓存复选框(如果有)。
    3. 选择部署代码按钮。
  5. 更新完成后,选择信息中心左侧的状态菜单项。
  6. 在环境的状态区域中,您可能会注意到数据库更新错误,如下所示:

    如果您在任何环境中遇到此错误,请手动更新数据库:

    1. 以拥有管理员或内容创建权限的用户身份登录门户。
    2. 选择门户左上角的首页图标 > 运行更新
    3. 按照说明更新您的数据库。
  7. 如上所述,将代码更改推送到测试环境,然后推送实时

迁移自定义功能

如果您向门户添加自定义代码或功能,则必须决定如何维护它们,以及如何将它们从开发环境迁移到测试环境再到实际环境。

对于 Git 代码库中的代码,您可以按照将代码部署到门户环境中所述的过程,将代码从 Dev 迁移到 Test 迁移到 Live

如果您创建了任何自定义配置,请使用以下方法之一进行迁移:

方法 说明
将配置导出到代码 许多常见配置可“导出”至使用功能模块进行编码。例如,视图、面板、图片缓存等。
实现 hook_update_N() 函数 Drupal 使用 hook_update_N() 函数来管理数据库和配置更改。

如果您有自定义模块,则可以:

  • hook_update_N() 函数添加到模块的 .install 文件中,以处理您的更改。
  • 将这些更改与您的代码一起部署。
  • 运行 update.php 以迁移 Stage 和生产环境中的更改。

另请参阅使用 Pantheon 工作流,其中简要介绍了如何开发、测试和推送网站。该文章中包含有关 配置管理的部分。

配置自定义网域

Apigee 为门户提供的域名默认为 apigee.io,如管理您的环境中所述,这可能不是您要向客户公开的域名。

付费门户方案可以为门户配置自定义域名(开发者账号或免费账号无法创建自定义网域)。如需使用自定义网域,请在 DNS 中创建 CNAME 并将您的网域指向 edge.apigee.getpantheon.com

例如,要为名为 Mytech 的公司配置自定义网域,请执行以下操作:

  1. 配置以下 DNS 设置:
    developer.mytech.com. 3600 IN CNAMEedge.apigee.getpantheon.com
    此 DNS 更改最长可能需要 48 小时才会对所有客户端设备生效。
  2. 使用信息中心左侧的网域 / SSL 菜单项,将此网域添加到仅适用于实时环境的 Pantheon 信息中心。
    在大多数情况下,您只需为实际环境配置 DNS,而不会为开发阶段和测试环境配置 DNS。您不应将开发测试环境用于生产环境。

如需了解详情,请点击此处查看 Pantheon 文档。

添加门户管理员

当您收到 Apigee 发送的门户准备就绪电子邮件时,Apigee 已经配置了门户管理员列表。您可以通过选择网站信息中心右上角的团队链接来查看该列表。

要添加其他管理员,请参阅创建管理员用户

备份门户

如需备份您的门户,请使用 Pantheon 信息中心内的备份标签页。您可以创建按需备份或自动备份。在 Pantheon 中,备份由三个单独的归档组成:数据库、文件和代码。

如需了解详情,请参阅 Pantheon 文档中的备份工具

订阅状态更新

您可以在 status.apigee.com 订阅 Apigee 版本和状态更新。点击订阅更新,在出现提示时输入您的联系信息(例如电子邮件地址),然后点击订阅。在电子邮件通知管理页面上,确保已选择开发者门户,根据需要切换其他通知设置,然后点击更新偏好设置

您可以前往 http://status.getpantheon.com 订阅 Pantheon 状态更新和突发事件报告(例如服务中断时)。点击订阅更新进行注册。