Set up billing with pods with the Workbench CLI

Purpose: This document describes how Verily Workbench admins can create pods for Workbench billing purposes.

Note: This guide includes steps for setting up and managing billing via the Workbench CLI. For Workbench UI instructions, please see Set up billing with pods in the Workbench UI.

Introduction

You can use the Workbench CLI to create and manage pods.

A pod is a way of organizing workspaces, people, and resources within an organization, so that they share the same cloud platform and billing. Each pod is linked to a cloud account, which is used for billing. One pod can be used for many workspaces. Since pods are linked to cloud accounts, the pod used determines which cloud platform the workspace belongs to.

Create a pod

Prerequisites

Complete steps 1-3 in Set up billing with pods in Verily Workbench to create a Cloud Billing account and grant Workbench permission to use it.

Step 1. Install the Workbench CLI (command-line interface) and set its credentials

You can access the CLI in several ways. If you're already a member of an existing pod, or have Writer/Owner access to a Workbench workspace, you can create a cloud app where the Workbench CLI is automatically installed and run the commands there.

You can also install the CLI on your own workstation, or you may find it convenient to install the Workbench CLI in a Google Cloud Shell. For a first-time user, Google Cloud Shell may be a smoother experience, as you will not need to install the required dependencies.

To open a Cloud Shell, click the Activate Cloud Shell icon () at the top of the Google Cloud console. Then follow the instructions for Installing and running the Workbench CLI .

Step 2: Provide credentials to the Workbench CLI

You must log in with Google Application Default Credentials to create a Workbench pod for Google Cloud via the CLI. This allows Workbench to check whether you have access to the billing account information that you will provide.

Run the following command in order to create credentials that will be used by the Workbench CLI in the next step:

gcloud auth application-default login

Next, authorize the Workbench CLI using your application-default credentials:

wb auth login --mode=APP_DEFAULT_CREDENTIALS

Step 3: Create a pod

Determine the org ID for the pod:

wb org list

Create a pod:

wb pod create gcp \
  --id ID \
  --description DESCRIPTION \
  --billing-account-id YOUR-BILLING-ACCOUNT-ID \
  --org YOUR-ORG-ID

Where:

• ID is an identifier that you choose. The pod ID must be globally unique.
  • Tip: Choose an ID that will make sense to others you add to the pod. When you create workspaces, you can see the pods you’re a part of. It could be the name of your team, department, program, or something meaningful to you and others you work with.
• DESCRIPTION is a description of the pod. It should be something meaningful to you.
• YOUR-BILLING-ACCOUNT-ID is your 18-character Google Billing account ID. You can find this information at https://console.cloud.google.com/billing.
• YOUR-ORG-ID is the identifier for the organization under which you want to place the new pod.

You can now use the pod when creating new workspaces and data collections. See below for more details.

Manage your pod (for pod admins)

Grant permission or revoke users’ access

Run the following command to grant a particular role to a user for your pod:

wb pod role grant --email=<user-email> --org=<org-id> --pod=<pod-id> --role=<role>

The following command revokes the specified user's access to a particular pod:

wb pod role revoke --email=<user-email> --org=<org-id> --pod=<pod-id> --role=<role>

The valid --role values are ADMIN or USER.

Update a pod's billing information or description

Use wb pod update gcp to update a pod's description, billing account, or pod ID. The organization with which the pod is associated cannot be modified.

Delete a pod

Delete a pod by running the following:

wb pod delete --org=<id> --pod=<id>

Use a pod when creating resources

If you're creating a workspace or data collection via the Workbench CLI, specify the pod you want to associate to. For example:

wb workspace create --id=<workspace-id> --pod=<pod-id>

Additional pod operations

See the wb pod reference documentation for a list of the available operations on pods, including:

• List the pods that you are a member of, which you can use for new workspace creation (wb pod list)
• Describe a pod (wb pod describe --org=<id> --pod=<id>)