Webhook 部署端點會提示 Looker 例項部署 Git 分支、修訂版本 SHA 或標記名稱的變更,然後將變更推送至專案的正式版本。(如要瞭解 Looker 部署 webhook 格式,請參閱「透過 webhook 部署」一節)。對於多數專案,Looker 會處理 Git 整合作業,並將更新部署至正式環境,因此您不需要設定部署 webhook。
不過,如果符合下列任一情況,您必須使用部署 webhook 將變更推送至實際工作環境:
- 您可以將更新內容推送至 Looker IDE 以外的遠端正式分支,這在有階段環境的開發工作流程中很常見。
- 您想使用 進階部署模式,搭配 Webhook 部署 Looker 專案的正式版本,這可讓您指定分支、提交 SHA 或標記名稱。
- 您已使用 Git 提取要求設定 Looker 專案,這表示您必須在合併提取要求後觸發部署 webhook,才能將這些變更推送至 Looker 正式環境。只要將 webhook 新增至 Git 供應商的介面,大多數的 Git 代管服務都有自動化這項操作的方法。
如果您是 Looker 管理員,可以將部署 webhook 設為需要密鑰,這樣只有授權人員才能觸發 webhook。非管理員的 Looker 開發人員可以查看「專案設定」頁面,但無法變更其中的選項。
新增部署密鑰
Looker 支援以下 Git 供應工具的網路密碼:GitHub、Bitbucket Server 和 GitLab。
如要為專案設定 Webhook 部署密鑰,請按照下列步驟操作:
- 在開發模式中,開啟專案,然後選取 IDE 導覽列中的設定圖示,開啟專案設定面板。
- 在專案設定面板中選取「Configuration」。
- 捲動至「Webhook 部署密鑰」部分,然後按一下「設定 Webhook 密鑰」。Looker 會自動產生密碼權杖。您可以使用這個自動產生的密鑰,也可以輸入自己的密鑰符記。
- 無論您是使用自動產生的密鑰,還是自行建立密鑰,請複製 Webhook 部署密鑰並貼到文字檔中,以便日後將密鑰新增至存放區的 Webhook。請務必在此時複製該檔案。離開或重新整理「專案設定」頁面後,您就無法再存取 webhook 部署密鑰,必須變更或移除 webhook 部署密鑰,才能重新存取專案。
- 按一下「儲存專案設定」。
專案的部署 webhook 現在需要這個密鑰。如果專案使用 Looker 的測試環境執行個體,您必須在 HTTP 標頭中加入 Webhook 部署密鑰,才能部署至實際環境。如果專案已整合 Git 提取要求,您必須前往 Git 供應商的介面,將密鑰新增至存放區的 Webhook。
設定 Git 存放區 Webhook 的密鑰
如果專案已啟用 Git 提取要求整合,且您已在 LookML 專案中新增部署 webhook 密鑰,則必須前往 Git 供應商介面,將密鑰新增至存放區的 webhook。舉例來說,以下是使用 GitHub 執行這項操作的方法:
前往 Git 供應商網站,查看專案的存放區設定。
提示:如果您已設定專案的 Git 整合,可以在 Looker 中使用專案的 Git 選單中的「View Project on Git」選項。
在存放區設定中,按一下「Webhook」。
找出 LookML 專案的 webhook,然後按一下「編輯」按鈕。
在「密鑰」欄位中,貼上您從 Looker 的「Webhook 部署密鑰」專區複製的 webhook 部署密鑰。
按一下「更新 webhook」。
您現在必須提供 webhook 密鑰,才能將變更部署至專案的正式版。如有需要,您可以變更機密金鑰或從專案中移除機密金鑰。
變更部署密鑰
將 webhook 部署密鑰新增至專案後,如果您是 Looker 管理員,可以按照下列步驟變更密鑰:
- 在專案中,選取導覽列中的「設定」圖示。
- 捲動至「Webhook Deploy Secret」部分,然後按一下「Reset Secret」。Looker 會自動產生新的密碼符記。您可以使用系統自動產生的密鑰,也可以輸入自己的新密鑰符號。
- 無論您是使用自動產生的密鑰,還是自行建立密鑰,請複製 Webhook 部署密鑰並貼到文字檔中,以便日後將密鑰新增至存放區的 Webhook。請務必在此時從剪貼簿複製這段文字。離開或重新整理「專案設定」頁面後,您就無法存取 webhook 部署密鑰,必須返回並變更或移除該密鑰。
- 按一下「儲存專案設定」。
如果專案已設定 Git 提取要求整合,您還需要前往 Git 供應商的介面,更新存放區的 Webhook 密鑰。
移除部署密鑰
將 webhook 部署密鑰新增至專案後,如果您是 Looker 管理員,可以按照下列步驟移除密鑰:
- 在專案中,選取導覽列中的「設定」圖示。
- 捲動至「Webhook Deploy Secret」部分,然後按一下「Remove Secret」。此時,您可以按一下「不要移除」取消作業,並保留部署機密。
- 如要永久從專案中移除 Webhook 部署金鑰,請按一下「儲存專案設定」。
您的專案不再需要部署 Webhook 的密鑰。如果您的專案已設定 Git 提取要求整合,您現在可以前往 Git 供應商的介面,從存放區中移除 webhook 密鑰。Looker 本身不會再在 Git 供應端檢查密鑰,因此即使 Git 存放區 webhook 仍設定了密鑰,也不會有問題。如果您想從 Git 存放區中移除密鑰,請參閱「設定 Git 存放區 Webhook 的密鑰」,瞭解如何在 Git 供應器介面中編輯密鑰。