GCP Storage Bucket binding spec

Detailed documentation on the GCP Storage Bucket binding component

Component format

To setup GCP Storage Bucket binding create a component of type bindings.gcp.bucket. See this guide on how to create and apply a binding configuration.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5.   namespace: <NAMESPACE>
  6. spec:
  7.   type: bindings.gcp.bucket
  8.   version: v1
  9.   metadata:
  10.   - name: bucket
  11.     value: mybucket
  12.   - name: type
  13.     value: service_account
  14.   - name: project_id
  15.     value: project_111
  16.   - name: private_key_id
  17.     value: *************
  18.   - name: client_email
  19.     value: name@domain.com
  20.   - name: client_id
  21.     value: '1111111111111111'
  22.   - name: auth_uri
  23.     value: https://accounts.google.com/o/oauth2/auth
  24.   - name: token_uri
  25.     value: https://oauth2.googleapis.com/token
  26.   - name: auth_provider_x509_cert_url
  27.     value: https://www.googleapis.com/oauth2/v1/certs
  28.   - name: client_x509_cert_url
  29.     value: https://www.googleapis.com/robot/v1/metadata/x509/<project-name>.iam.gserviceaccount.com
  30.   - name: private_key
  31.     value: PRIVATE KEY

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

FieldRequiredBinding supportDetailsExample
bucketYOutputThe bucket name“mybucket”
typeYOutputTge GCP credentials type“service_account”
project_idYOutputGCP project idprojectId
private_key_idYOutputGCP private key id“privateKeyId”
private_keyYOutputGCP credentials private key. Replace with x509 cert12345-12345
client_emailYOutputGCP client email“client@email.com”
client_idYOutputGCP client id0123456789-0123456789
auth_uriYOutputGoogle account OAuth endpointhttps://accounts.google.com/o/oauth2/auth
token_uriYOutputGoogle account token urihttps://oauth2.googleapis.com/token
auth_provider_x509_cert_urlYOutputGCP credentials cert urlhttps://www.googleapis.com/oauth2/v1/certs
client_x509_cert_urlYOutputGCP credentials project x509 cert urlhttps://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com

Binding support

This component supports output binding with the following operations:

  • create

Create file

To perform a create operation, invoke the GCP Storage Bucket binding with a POST method and the following JSON body:

Note: by default, a random UUID is generated. See below for Metadata support to set the name

  1. {
  2.   "operation": "create",
  3.   "data": "YOUR_CONTENT"
  4. }

Examples

Save text to a random generated UUID file

On Windows, utilize cmd prompt (PowerShell has different escaping mechanism)

  1. curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
  1. curl -d '{ "operation": "create", "data": "Hello World" }' \
  2.       http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
Save text to a specific file
  1. curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"name\": \"my-test-file.txt\" } }" \
  2.       http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
  1. curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "name": "my-test-file.txt" } }' \
  2.       http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
Upload a file

To upload a file, pass the file contents as the data payload; you may want to encode this in e.g. Base64 for binary content.

Then you can upload it as you would normally:

  1. curl -d "{ \"operation\": \"create\", \"data\": \"(YOUR_FILE_CONTENTS)\", \"metadata\": { \"name\": \"my-test-file.jpg\" } }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
  1. curl -d '{ "operation": "create", "data": "$(cat my-test-file.jpg)", "metadata": { "name": "my-test-file.jpg" } }' \
  2.       http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

Last modified September 20, 2021 : Merge pull request #1800 from greenie-msft/gRPC_proxying_video (36dff3c)