在 Cloud Code for IntelliJ 中管理 Cloud API 和库

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

借助 Cloud API,您可以通过自己的代码访问 Google Cloud 产品和服务。这些 Cloud API 提供了一个简单的 JSON REST 接口,您可以通过客户端库调用该接口。

本文介绍如何启用 Cloud API 并将 Cloud 客户端库添加到您的项目中。

浏览 Cloud API

如需浏览您的 IDE 中所有可用的 Google Cloud API,请按照以下步骤操作:

  1. 工具菜单中,选择 Cloud Code > Cloud API
  2. 展开 Google Cloud API 资源管理器树,查看所有可用的 API。 该资源管理器按类别对 Cloud API 分组。 您还可以使用 Search API 搜索栏查找特定的 API。
  3. 显示资源管理器树中所示 Cloud API 列表的屏幕截图。
  4. 点击某个 API 以查看更多详细信息,例如其状态、相应客户端库的特定语言的安装说明以及相关文档。

启用 Cloud API

如需使用 API 详细信息为项目快速启用 Cloud API,请按照以下步骤操作:

  1. 在 Cloud API 详细信息视图中,选择要为其启用 Cloud API 的 Google Cloud 项目。
  2. 点击启用 API

    启用 API 后,您会看到一条有关这项更改的确认消息。

添加 Cloud 客户端库

如需在 IntelliJ 中向项目添加库,请按照以下步骤操作:

对于 Java Maven 项目

  1. 工具菜单中,选择 Cloud Code > Cloud API
  2. Add Google Cloud Libraries 对话框会显示支持的库。

    显示“管理 Google Cloud API”对话框的屏幕截图。此对话框可让您选择要添加库的模块,显示可供添加的 API 列表,并提供显示每个 API 相关信息的工作区。
  3. 从 Google Cloud 客户端库(对于大多数项目建议)或 Java Spring GCP(如果您的项目使用 Java Spring 中建议)中选择您的首选库类型。
  4. Module 下拉菜单中,选择要向其中添加库的模块。
  5. 点击 Add Maven Dependency,向您的项目添加物料清单和客户端库。

对于其他所有项目

  1. 工具菜单中,选择 Cloud Code > Cloud API
  2. Add Google Cloud Libraries 对话框会显示支持的库。

    显示“管理 Google Cloud API”对话框的屏幕截图。
                      此对话框显示可供添加的 API 列表,并提供显示 API 相关信息的工作区。
  3. 按照 API 详细信息页面上针对您的首选语言列出的安装说明安装 API。

使用 API 示例

如需在 API Explorer 中搜索和使用每个 API 的代码示例,请按以下步骤操作:

  1. 工具菜单中,选择 Cloud Code > Cloud API

  2. 如需打开详细信息视图,请点击 API 的名称。

  3. 要查看该 API 的代码示例,请点击代码示例标签页。

  4. 如需过滤示例列表,请输入要搜索的文本或从语言下拉菜单中选择编程语言。

设置身份验证

启用所需的 API 并添加必要的客户端库后,您需要对应用进行配置,以便成功通过身份验证。您的配置取决于您的开发类型和运行所在的平台。

完成相关身份验证步骤后,您的应用即可进行身份验证并准备好部署。

本地开发

本地机器

如果您通过 IDE 登录 Google Cloud,则 Cloud Code 会确保设置您的应用默认凭据 (ADC)。如果您未使用 Cloud Code 登录,请手动运行 gcloud auth application-default login

minikube

  1. 如果您通过 IDE 登录 Google Cloud,则 Cloud Code 会确保设置您的应用默认凭据 (ADC)。如果您未使用 Cloud Code 登录,请手动运行 gcloud auth application-default login
  2. 使用 minikube start --addons gcp-auth 启动 minikube。此操作会将您的 ADC 装载到 pod 中。如需详细了解 Google Cloud 的 minikube 身份验证指南,请参阅 minikube gcp-auth 文档

其他本地 K8s 集群

  1. 如果您通过 IDE 登录 Google Cloud,则 Cloud Code 会确保设置您的应用默认凭据 (ADC)。如果您未使用 Cloud Code 登录,请手动运行 gcloud auth application-default login
  2. 通过在 Pod 或部署清单中修改 Pod 规范,在 Kubernetes Pod 中装载本地 gcloud 目录,以便 Google Cloud 客户端库能够找到您的凭据。Kubernetes pod 配置示例:
    apiVersion: v1
    kind: Pod
    metadata:
      name: my-app
      labels:
        name: my-app
    spec:
      containers:
      - name: my-app
        image: gcr.io/google-containers/busybox
        ports:
          - containerPort: 8080
        volumeMounts:
          - mountPath: /root/.config/gcloud
            name: gcloud-volume
      volumes:
        - name: gcloud-volume
          hostPath:
            path: /path/to/home/.config/gcloud

Cloud Run

如果您通过 IDE 登录 Google Cloud,则 Cloud Code 会确保设置您的应用默认凭据 (ADC)。如果您未使用 Cloud Code 登录,请手动运行 gcloud auth application-default login

远程开发

Google Kubernetes Engine

根据您的项目范围,您可以选择在 GKE 上对 Google Cloud 服务进行身份验证的方式:

  • (仅限开发)
    1. 使用以下设置创建 GKE 集群
      • 确保您使用的是 GKE 默认使用的服务帐号、Compute Engine 默认服务帐号,并且访问权限范围设置为授予对所有 Cloud API 的完整访问权限(这两种设置均可在节点池 > 安全部分中访问)。
        由于 Compute Engine 服务帐号由部署在节点上的所有工作负载共享,因此此方法会过度预配权限,并且应该仅用于开发。
      • 确保集群上未启用 Workload Identity(在集群 > 安全部分中)。
    2. 为 Compute Engine 默认服务帐号分配必要的角色:
  • (建议用于生产用途)
    1. 使用 Workload Identity 配置 GKE 集群和应用,以对 GKE 上的 Google Cloud 服务进行身份验证。此操作会将您的 Kubernetes 服务帐号与您的 Google 服务帐号相关联。
    2. 通过在 Kubernetes 部署 YAML 文件中设置 .spec.serviceAccountName 字段,配置 Kubernetes 部署以引用 Kubernetes 服务帐号。
      如果您使用的是基于 Cloud Code 模板创建的应用,则此文件位于 kubernetes-manifests 文件夹下。
    3. 如果您尝试访问的 Google Cloud 服务需要其他角色,请为您用于开发应用的 Google 服务帐号授予角色。

Cloud Run

  1. 如需创建用于部署 Cloud Run 应用的新唯一服务帐号,请在“服务帐号”页面上选择存储密文的项目。

    转到“服务帐号”页面

  2. 点击创建服务帐号
  3. 创建服务帐号对话框中,为服务帐号输入一个描述性名称。
  4. 服务帐号 ID 更改为一个可识别的唯一值,然后点击创建
  5. 如果您尝试访问的 Google Cloud 服务需要其他角色,请授予角色,点击继续,然后点击完成
  6. 如需将 Kubernetes 服务帐号添加到部署配置,请导航到 Cloud Run:部署 (Cloud Run: Deploy) 运行配置,展开高级修订版本设置 (Advanced revision settings) 部分,然后在服务帐号字段中指定您的服务帐号。
    “Cloud Run:部署”中展开了“高级修订版本设置”部分,并且“服务帐号”字段中已填写服务帐号名称(格式为 service-account-name@project-name.iam.gserviceaccount.com)

Cloud Run

根据您的项目范围,您可以选择在 GKE 上对 Google Cloud 服务进行身份验证的方式:

  • (仅限开发)
    1. 使用以下设置创建 GKE 集群
      • 确保您使用的是 GKE 默认使用的服务帐号、Compute Engine 默认服务帐号,并且访问权限范围设置为授予对所有 Cloud API 的完整访问权限(这两种设置均可在节点池 > 安全部分中访问)。
        由于 Compute Engine 服务帐号由部署在节点上的所有工作负载共享,因此此方法会过度预配权限,并且应该仅用于开发。
      • 确保集群上未启用 Workload Identity(在集群 > 安全部分中)。
    2. 为 Compute Engine 默认服务帐号分配必要的角色:
  • (建议用于生产用途)
    1. 使用 Workload Identity 配置 GKE 集群和应用,以对 GKE 上的 Google Cloud 服务进行身份验证。此操作会将您的 Kubernetes 服务帐号与您的 Google 服务帐号相关联。
    2. 如需将 Kubernetes 服务帐号添加到部署配置,请导航至 Cloud Run:部署 (Cloud Run:Deploy) 运行配置,展开高级修订版本设置 (Advanced revision settings) 部分,然后在服务帐号字段中指定您的 Kubernetes 服务帐号。
      “Cloud Run:部署”中展开了“高级修订版本设置”部分,并且“服务帐号”字段中已填写 Kubernetes 服务帐号名称
    3. 如果您尝试访问的 Google Cloud 服务需要其他角色,请为您用于开发应用的 Google 服务帐号授予角色。

已启用 Secret Manager 权限的远程开发

如果您正在进行远程开发并通过使用服务帐号进行身份验证,且您的应用使用密文,则除了 远程开发说明以外,您还需要完成一些其他步骤。以下步骤为您的 Google 服务帐号授予访问特定 Secret Manager 密文所需的角色

  1. 点击 Cloud Code 右侧边栏中的 Secret Manager 标签页,打开 Secret Manager 面板。

  2. 选择您希望在代码中访问的密文。

  3. 切换到“权限”标签页,然后点击 “修改”图标 修改权限来配置您的 Secret 权限。Secret 的 Secret Manager 配置页面将在网络浏览器中打开。

    在 Secret Manager 中选择了“权限”标签页且突出显示了“修改权限”图标

  4. 在 Google Cloud Console 中,点击显示信息面板,然后点击添加主帐号

  5. 为您的服务帐号分配 Secret Manager Secret Accessor 角色。

    您的服务帐号有权访问此 Secret。

获取支持

如需在 IntelliJ IDE 中提交反馈或报告问题,请转到工具 > Cloud Code > 帮助/简介 > 提交反馈或报告问题 (Submit feedback or report an issue),在 GitHub 上报告问题或在 Stack Overflow 上提问。

您还可以加入属于 Google Cloud Slack 社区#cloud-code 频道。