Skip to main content
An existing GCS bucket becomes a folder tree, with one file per object, reached through the S3-compatible XML API at https://storage.googleapis.com.

Setup

GCS signs S3 requests with an HMAC key that belongs to a service account.
  1. In the Google Cloud console, open Cloud Storage > Settings > Interoperability.
  2. Under Service account HMAC, pick Create a key for a service account, choose the service account, then Create key.
  3. Grant that service account Storage Object Viewer on the bucket, or Storage Object User (or Storage Object Admin) for writes.
  4. Copy the Access key and Secret. Google shows the secret only once.
  • Creating a key takes the Storage HMAC Key Admin role. A new key can take up to a minute to work.

Connect

workspace.yaml

Layout

  • Each object key is a file path; folders are key prefixes, and the bucket holds no directory objects.
  • key_prefix (keyPrefix in TypeScript) mounts one subpath of the bucket as the root.
  • grep -r, find and du stop after 1000 files; a glob matching more, tar -c, cp -r and rm -r are refused.

Sample runs

On a write mount, redirects, cp, mv and rm change objects in the bucket. For write: conditional, see S3-compatible VFSes.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.