Skip to content

Commit

Permalink
Update destinations/gcs.md (#37757)
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-gron committed May 2, 2024
1 parent deabdbb commit 4a49615
Showing 1 changed file with 31 additions and 28 deletions.
59 changes: 31 additions & 28 deletions docs/integrations/destinations/gcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,37 @@ The Airbyte GCS destination allows you to sync data to cloud storage buckets. Ea
| Incremental - Append + Deduped || |
| Namespaces || Setting a specific bucket path is equivalent to having separate namespaces. |



## Getting started

### Requirements

1. Allow connections from Airbyte server to your GCS cluster \(if they exist in separate VPCs\).
2. An GCP bucket with credentials \(for the COPY strategy\).

### Setup guide

- Fill up GCS info
- **GCS Bucket Name**
- See [this](https://cloud.google.com/storage/docs/creating-buckets) for instructions on how to create a GCS bucket. The bucket cannot have a retention policy. Set Protection Tools to none or Object versioning.
- **GCS Bucket Region**
- **HMAC Key Access ID**
- See [this](https://cloud.google.com/storage/docs/authentication/managing-hmackeys) on how to generate an access key. For more information on hmac keys please reference the [GCP docs](https://cloud.google.com/storage/docs/authentication/hmackeys)
- We recommend creating an Airbyte-specific user or service account. This user or account will require the following permissions for the bucket:
```
storage.multipartUploads.abort
storage.multipartUploads.create
storage.objects.create
storage.objects.delete
storage.objects.get
storage.objects.list
```
You can set those by going to the permissions tab in the GCS bucket and adding the appropriate the email address of the service account or user and adding the aforementioned permissions.
- **Secret Access Key**
- Corresponding key to the above access ID.
- Make sure your GCS bucket is accessible from the machine running Airbyte. This depends on your networking setup. The easiest way to verify if Airbyte is able to connect to your GCS bucket is via the check connection tool in the UI.

## Configuration

| Parameter | Type | Notes |
Expand Down Expand Up @@ -204,34 +235,6 @@ These parameters are related to the `ParquetOutputFormat`. See the [Java doc](ht

Under the hood, an Airbyte data stream in Json schema is first converted to an Avro schema, then the Json object is converted to an Avro record, and finally the Avro record is outputted to the Parquet format. Because the data stream can come from any data source, the Json to Avro conversion process has arbitrary rules and limitations. Learn more about how source data is converted to Avro and the current limitations [here](https://docs.airbyte.com/understanding-airbyte/json-avro-conversion).

## Getting started

### Requirements

1. Allow connections from Airbyte server to your GCS cluster \(if they exist in separate VPCs\).
2. An GCP bucket with credentials \(for the COPY strategy\).

### Setup guide

- Fill up GCS info
- **GCS Bucket Name**
- See [this](https://cloud.google.com/storage/docs/creating-buckets) for instructions on how to create a GCS bucket. The bucket cannot have a retention policy. Set Protection Tools to none or Object versioning.
- **GCS Bucket Region**
- **HMAC Key Access ID**
- See [this](https://cloud.google.com/storage/docs/authentication/managing-hmackeys) on how to generate an access key. For more information on hmac keys please reference the [GCP docs](https://cloud.google.com/storage/docs/authentication/hmackeys)
- We recommend creating an Airbyte-specific user or service account. This user or account will require the following permissions for the bucket:
```
storage.multipartUploads.abort
storage.multipartUploads.create
storage.objects.create
storage.objects.delete
storage.objects.get
storage.objects.list
```
You can set those by going to the permissions tab in the GCS bucket and adding the appropriate the email address of the service account or user and adding the aforementioned permissions.
- **Secret Access Key**
- Corresponding key to the above access ID.
- Make sure your GCS bucket is accessible from the machine running Airbyte. This depends on your networking setup. The easiest way to verify if Airbyte is able to connect to your GCS bucket is via the check connection tool in the UI.

## CHANGELOG

Expand Down

0 comments on commit 4a49615

Please sign in to comment.