使用 Pantheon

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

Apigee 使用 Pantheon 網站管理服務, 託管雲端版本的開發人員服務入口網站。Pantheon 的運作方式 Drupal 可讓你在安全的環境中開發、測試及發布入口網站。Pantheon 網站 管理服務適用於有代管和開發作業需求的客戶, 更是如此

以下各節說明如何使用 Pantheon 開發及管理入口網站。

存取 Pantheon 資訊主頁

當 Apigee 將入口網站的網址傳送給您時,您也會收到 Pantheon 的網址 資訊主頁:https://dashboard.getpantheon.com/

登入 Pantheon 資訊主頁後,您會先來到「網站」頁面。 如下所示:

您可以從資訊主頁存取自己的網站、設定帳戶,以及執行其他 作業。

選取網站的映像檔 (例如 apigeedocs),即可開啟相關資訊主頁 網站:

管理環境

Pantheon 資訊主頁的頁面頂端會列出三種環境:開發人員、 測試和直播。下表說明每個參數。

環境

說明

開發人員版

Dev 環境會連線至您的 Git 存放區。不限 您推送至 Git 的變更會立即顯示在 Dev 環境。

這個網站的網址格式如下,其中 org_name 是 您的組織名稱:

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

測試

Test 環境可讓您使用 來自 Live 環境的資料副本。這個環境是 ,再推送程式碼變更 Live 環境。

這個網站的網址格式如下,其中 org_name 是 您的組織名稱:

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

直播

「Live」環境是您的實際工作環境。 是您可以讓消費者接觸到的 Android 平台

這個網站的網址格式如下,其中 org_name 是 您的組織名稱:

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

開發入口網站內容

以下各節將說明如何開發入口網站內容。

此外,請參閱下列章節,進一步瞭解如何自訂 入口網站。

您的目標

您可以

更多資訊

變更網站的外觀和風格

基本 - 使用「外觀」選單項目 變更 (例如修改標誌和網站顏色)。

請參閱「自訂」一節 外觀

進階:修改整體的外觀和風格 請延伸 Apigee 回應式主題。

請參閱自訂 主題

變更網站功能的行為

基本:使用入口網站的管理員設定來變更/設定 以及網站的運作方式

請按這裡查看 Apigee 說明文件

「Advanced」:建立自訂模組來變更 網站。

請參閱建立自訂 Drupal 說明文件中的模組

Git 存放區總覽

Drupal 程式碼的 Git 存放區包含所有入口網站程式碼,且系統已完成整理 使用下列結構

注意:請只修改 /sites/all 目錄中的內容。如果 如果您修改的是 /sites/all 目錄外的內容,您將發生問題 升級到新版本時,在檢查變更至新版本時,可能會發生合併衝突 Git。

Git 存放區中的資料夾

說明

/profiles/apigee

Apigee 維護的模組和主題,包括:

  • /profiles/apigee/modules/contrib:Drupal 模組由 Google 維護 Apigee
  • /profiles/apigee/themes/contrib:由 Google 維護的 Drupal Contrib 主題 Apigee
  • /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 存取伺服器,才能使用 Git 管理 Drupal 程式碼 方法是將 SSH 金鑰上傳至 Pantheon

如何啟用透過 SSH 存取伺服器的功能:

  1. 前往 https://dashboard.getpantheon.com/ 登入 Pantheon。
  2. 在資訊主頁中選取「帳戶」
  3. 選取左側選單中的「SSH 金鑰」
  4. 新增金鑰,然後選取「新增金鑰」
    若您需要協助,請選取瞭解如何產生 SSH 連線 鍵連結。

存取 Git 中的程式碼存放區

注意:請參閱 Git 總覽 存放區,以瞭解 Git 存放區結構的概況。

如要在 Git 中存取程式碼存放區,請按照下列步驟操作:

  1. 登入 Pantheon 資訊主頁。
  2. 在協作平台主頁面中,選取入口網站的圖示。
  3. Git 存放區的網址會顯示在「Connection」(連線) 右側的頁面中。 模式,如上圖所示。
  4. 複製 Git 存放區的網址,然後使用 指令:
    &gt;Git 複製 gitURL <網站名稱>
    例如:
    &gt;Git 本機副本 ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repository.git devportal

您推送至 Git 存放區的所有程式碼變更都會立即顯示在 入口網站的 Dev 環境。

將程式碼部署至入口網站 環境

編寫入口網站環境的程式碼:

  1. 將程式碼更新推送至 Git,立即更新 Dev 環境。
  2. 登入 Pantheon 並選取您的網站。
  3. 選取「Dev」環境。
  4. 選取左側選單中的 [程式碼]</>,即可查看相關訊息 Commit Log 中的程式碼變更:
  5. 選取頁面頂端的「測試」環境。
    1. 如果您尚未將 Dev 上傳到 Test, 。
    2. 如果您已建立「Test」環境,系統會顯示訊息,指出 確定 Dev 有可部署的修訂版本:
  6. 如果已經將網站推送至線上環境,即可 可視需要選取第三個核取方塊,以複製即時資料庫和 開發人員可以透過線上測試功能。如果您要 對照「Live」可用的最新資料來測試程式碼變更。
  7. 選取「Deploy Code from Development」按鈕。
  8. Test 環境中測試入口網站。
  9. 修正任何程式碼至 Dev 環境,然後再次推送檔案。 測試以進行測試。
  10. 測試完成後,選取頂端的「Live」環境 頁面。
    1. 如果您尚未上傳「測試」為「直播」,表示 。
    2. 如果您已經有「Live」環境,系統會顯示訊息,指出 Test 中是否有可部署的修訂版本。部署這些變更 做法與從 Dev 部署到 Test 的方法相同。當您 測試完成,請將程式碼推送至線上環境。

瞭解詳情:

新增自訂模組和主題

您可以新增自訂模組和主題,擴充入口網站的功能。 資料夾。

注意:只能修改 /sites/all 目錄中的內容。如果您修改的內容位於 /sites/all 目錄中,您可以 檢查 Git 變更時會發生合併衝突。

模組/主題 Git 存放區中的資料夾 更多資訊 (Drupal 說明文件)
自訂模組 sites/all/modules/custom 建立自訂 模組
自訂主題 sites/all/themes 自訂 主題
主題設定 Drupal 7

Dev 環境中新增自訂模組或主題之後, 可以部署至 Test 測試 實際工作環境的「Live」環境,如「將程式碼部署至入口網站環境」一文所述。

覆寫 Drupal 設定檔模組和主題

下列目錄中的模組和主題會覆寫 Drupal 設定檔模組, 由 Apigee 在 /profiles/apigee 維護及發布的主題。 請參閱 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 的檔案,並在其中加入自訂程式碼。settings.php 檔案內含 sites/default/settings.local.php

舉例來說,當您按照 Pantheon 提供的操作說明為線上網站設定自訂網域時,請在 sites/default/settings.local.php 中新增必要的更新,而非直接修改 settings.php 檔案。

保護入口網站的安全

DevTest 和 根據預設,「實際」環境可公開存取。也就是說,凡是 網址可以存取,但他們可能無法註冊帳戶或登入 。如要進一步瞭解如何控制使用者註冊,請參閱新增及管理使用者 帳戶

您可能需要在 ,並在完成開發之前隱藏直播網站。Pantheon 可讓你新增使用者名稱/密碼控制項,鎖定網站,確保只有具備適當人物權限的人才能鎖定網站 憑證

在這個環境中,您可以選取「安全性」,為這三種環境新增鎖定功能: 左側選單詳情請參閱鎖定您的網站

如果您要為網站啟用 TLS/SSL,請參閱在入口網站使用 TLS 一文。

將 Apigee 更新套用至您的入口網站

Apigee 發布新版入口網站時,Pantheon 就會顯示訊息 儀表板。

一般來說,您會將更新套用至「Dev」環境,然後測試這些更新 就像測試自己的程式碼變更一樣舉例來說,您可以將 開發環境環境至測試,將即時資料從 「Live」為「測試」,然後測試更新。

如何套用更新:

  1. 前往 https://dashboard.getpantheon.com/ 登入 Pantheon,然後選取 你的網站
  2. 選取「Dev」環境。
  3. 選取左側的「Code」</>選單項目。如果 Apigee 更新 您的可用資源就會列出
  4. 套用更新:
    1. 勾選「Run update.php 在提取程式碼後」核取方塊。
    2. 選取「提取程式碼後清除快取」(如果適用的話) 核取方塊。
    3. 選取「Deploy Code」按鈕。
  5. 更新完成後,請在 資訊主頁的左側
  6. 您可能會在環境的「狀態」部分注意到錯誤 資料庫更新時,如下所示:

    如果在任何環境中看到這個錯誤,請手動更新資料庫:

    1. 以具備管理員或內容建立權限的使用者身分登入入口網站。
    2. 選取首頁圖示 >執行更新 入口網站。
    3. 按照操作說明更新資料庫。
  7. 將程式碼變更推送至 Test 環境,然後推送至 直播 (如上所述)。

遷移自訂功能

如果您在入口網站中加入自訂程式碼或功能,就必須決定其維護方式和 瞭解如何從開發人員版開發切換至測試即時 環境

對於 Git 存放區中的程式碼,您可以使用「將程式碼部署至入口網站環境」一文所述的程序,完成以下程序: 將程式碼從「Dev」遷移至「測試」至「即時」

如果您已建立任何自訂設定,請使用下列其中一種方法遷移設定 他們可以:

方法 說明
將設定匯出至程式碼 許多常見的設定是「可匯出」使用功能模組編寫程式碼。例如: 檢視畫面、面板、圖片快取等
實作 hook_update_N() 函式 Drupal 使用 hook_update_N() 函式來管理資料庫和設定變更。

如果您有自訂模組,可以:

  • hook_update_N() 函式新增至 模組的 .install 檔案來處理變更。
  • 隨程式碼部署這些變更。
  • 執行 update.php,遷移階段和實際工作環境中的變更 環境

另請參閱使用 Pantheon Workflow 的概要說明如何開發、測試及推送網站。已包含於 該文章是 設定管理

設定自訂網域

Apigee 為入口網站提供的網域名稱預設為 apigee.io,例如 在「管理環境」中所述,這可能與您 可以向消費者呈現

付費入口網站方案可為入口網站設定自訂網域名稱 (開發人員或免費 帳戶,無法建立自訂網域)。如要使用自訂網域,請在您的 DNS 中建立一個 CNAME, 將網域指向 edge.apigee.getpantheon.com

舉例來說,如要為名為 Mytech 的公司設定自訂網域,請按照下列步驟操作:

  1. 進行下列 DNS 設定:
    developer.mytech.com。 3600 (印度 CNAME) Edge.apigee.getpantheon.com
    這項 DNS 變更最多可能需要 48 小時才會在所有用戶端裝置生效。
  2. 請使用網站左側的 [Domains/SSL] (網域/SSL) 選單項目 資訊主頁,即可將這個網域新增至 的 Pantheon 資訊主頁 僅限 Live 環境。
    在大多數情況下,您只須為「Live」環境設定 DNS,無法設定 適用於 DevTest。請勿使用 DevTest 環境 。

詳情請參閱這裡的 Pantheon 說明文件。

新增入口網站管理員

當您收到 Apigee 傳送的電子郵件,指出您的入口網站已就緒時,Apigee 已 設定入口網站管理員清單如要查看這份清單,請在 網站資訊主頁右上角的「團隊」連結。

如要新增其他管理員,請參閱建立管理員使用者

備份入口網站

如要備份入口網站,請使用 Pantheon 資訊主頁的「備份」分頁。個人中心 建立隨選或自動備份在 Pantheon 中,備份包含三個不同的 封存:資料庫、檔案和程式碼

詳情請參閱「備份 工具

正在訂閱狀態更新

您可以訂閱 Apigee 版本和狀態更新通知 網址是 status.apigee.com。 按一下「訂閱最新消息」,輸入您的聯絡資訊,例如電子郵件 地址,請在系統顯示提示時點選「訂閱」。電子郵件通知 管理頁面,確認已選取「Developer Portal」,然後切換 視需要顯示其他通知設定,然後按一下 [更新偏好設定]

您可以訂閱 Pantheon 狀態更新和事件報告。 例如服務中斷時,請前往 http://status.getpantheon.com。按一下「訂閱」 更新