配置 Webhook 部署 Secret

Webhook 部署端点会提示 Looker 实例从 Git 分支、提交 SHA 或标记名称部署更改,然后将更改推送到项目的生产版本。(如需了解 Looker 部署 webhook 格式,请参阅使用 webhook 进行部署部分。)对于大多数项目,Looker 会处理 Git 集成并将更新部署到生产环境,因此您无需设置部署 webhook。

但是,如果出现以下任何情况,您 确实 需要使用部署 webhook 将更改推送到生产环境:

如果您是 Looker 管理员,则可以将部署 webhook 配置为需要密钥,以便只有经过授权的一方才能触发它。非管理员的 Looker 开发者可以查看项目配置 页面,但无法更改其中的选项。

添加部署密钥

Looker 支持以下 Git 提供商的网络密钥:GitHub、Bitbucket Server 和 GitLab。

如需为项目设置 webhook 部署密钥,请执行以下操作:

  1. 开发模式下,打开您的项目,然后选择 IDE 导航栏中的设置图标以打开项目设置面板。
  2. 在项目设置面板中,选择配置
  3. 滚动到 Webhook 部署密钥 部分,然后点击设置 Webhook 密钥 。Looker 会自动生成一个密钥令牌。您可以使用此自动生成的密钥,也可以输入自己的密钥令牌。
  4. 无论您是使用自动生成的 Secret 还是创建自己的 Secret,请复制 webhook 部署 Secret 并将其粘贴到文本文件中,以便在需要将 Secret 添加到代码库的 webhook时使用。请务必在此处复制。离开或刷新项目配置页面后,您将无法再访问 webhook 部署密钥,并且必须更改移除 webhook 部署密钥才能重新访问您的项目。
  5. 点击保存项目配置

现在,项目的部署 webhook 需要此密钥。对于使用 Looker 暂存实例的项目,您需要在 HTTP 标头中添加 webhook 部署密钥,才能部署到生产环境。对于集成 Git 拉取请求 的项目,您需要前往 Git 提供商的界面,将密钥添加到代码库的 webhook

为 Git 代码库的 webhook 配置密钥

对于集成 Git 拉取请求的项目,如果您已向 LookML 项目添加部署 webhook 密钥,则需要前往 Git 提供商的界面,将密钥添加到代码库的 webhook。例如,以下是在 GitHub 中执行此操作的方法:

  1. 在 Git 提供商的网站上,导航到项目的代码库设置。

    提示:如果您已为项目设置 Git 集成,则可以在 Looker 中使用项目 Git 菜单中的在 Git 上查看项目 选项。

  2. 在代码库的设置中,点击 Webhooks

  3. 找到 LookML 项目的 webhook,然后点击其修改 按钮。

  4. 密钥 字段中,粘贴您从 Looker 的 Webhook 部署密钥 部分复制的 webhook 部署密钥。

  5. 点击 Update webhook

现在,您需要提供 webhook 密钥,才能将更改部署到项目的生产版本。如果需要,您可以更改密钥从项目中移除密钥

更改部署密钥

将 webhook 部署密钥 添加到项目后,如果您是 Looker 管理员,则可以按照以下步骤更改密钥:

  1. 在项目中,从导航栏中选择设置图标。
  2. 滚动到 Webhook 部署密钥 部分,然后点击重置密钥 。Looker 会自动生成一个新的密钥令牌。您可以使用此自动生成的密钥,也可以输入自己的新密钥令牌。
  3. 无论您是使用自动生成的 Secret 还是创建自己的 Secret,请复制 webhook 部署 Secret 并将其粘贴到文本文件中,以便在需要将 Secret 添加到代码库的 webhook时使用。请务必在此处从剪贴板中复制。离开或刷新项目配置 页面后,您将无法再访问 webhook 部署密钥,并且必须返回并更改或完全移除该密钥。
  4. 点击保存项目配置

如果您的项目配置了 Git 拉取请求集成,您还需要前往 Git 提供商的界面,更新代码库的 webhook 密钥

移除部署密钥

将 webhook 部署密钥 添加到项目后,如果您是 Looker 管理员,则可以按照以下步骤移除密钥:

  1. 在项目中,从导航栏中选择设置图标。
  2. 滚动到 Webhook 部署密钥 部分,然后点击移除密钥 。此时,您可以点击 Don't Remove 以取消操作并保留部署密钥。
  3. 如需从项目中永久移除 webhook 部署密钥,请点击保存项目配置

您的项目不再需要部署 webhook 的密钥。如果您的项目配置了 Git 拉取请求集成,您现在可以前往 Git 提供商的界面,从代码库中移除 webhook 密钥。Looker 本身将不再检查 Git 提供商端的密钥,因此,如果您的 Git 代码库 webhook 仍配置了密钥,也不会有任何影响。如果您确实想从 Git 代码库中移除密钥,请参阅为 Git 代码库的 Webhook 配置密钥,了解如何在 Git 提供商的界面上修改密钥。