Buckets

CLI

The hlcloud buckets command gives sub-commands to create and modify buckets conforming to Hall Lab Bucket policies. This command can be found (along with the full GCP CLI) in the halllab/hlcloud_ docker image.

Commands

hlcloud buckets --help
Usage: hlcloud buckets [OPTIONS] COMMAND [ARGS]...

  Commands for Buckets

Options:
  -h, --help  Show this message and exit.

Commands:
  make           make a bucket with correct permissions and policies
  update-labels  add or update bucket labels

Policies

IAM Policies

• Buckets should primarily use IAM for access management
• Google groups and service accounts should be used for ownership/access instead of individual owners
• Collaborators can be added as objectAdmin users

You Need A Group

Since we are using Google Groups to manage, you will need to be in a group that can be used when creating a bucket. Ask Neil, Eddie, or Haley to create a group if you need one.

Showing Policies

Use the hlcloud policies buckets_ command to show the current JSON bindings for our policies.``

Labels

Required: user, pipeline, project

README

There should be a README.yaml in the top level of the bucket.

Use hlcloud buckets readme to print the current README to the screen. Capture, edit, and upload to a bucket.

Current Structure

description: null
groups:
- OWNER-GROUP
- OPTIONAL-USERS-GROUP
- OPTIONAL-USERS-GROUP2
pipeline: null
project: null
service_account: null
software_and_versions:
  SOFTWARE1: v0.1.0
  SOFTWARE2: v4.0.2
used_in_paper: null
user: null