> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/resources/depot/supported-sources/gcs.md). # Google Cloud Storage (GCS) To create a GCS Depot you must have the following details: ## Pre-requisites specific to DataOS To create a Depot, you need the Data Admin role. Contact the DataOS Operator or Tenant Admin to get it. Run this command to see your assigned roles. ```bash dataos-ctl user get #Expected Output: time="2026-03-30T17:49:18+05:30" level=info msg="😃 user get..." time="2026-03-30T17:49:19+05:30" level=info msg="😃 user get...complete" NAME │ ID │ TYPE │ EMAIL │ TAGS ──────────────┼───────────────────┼────────┼──────────────────────┼──────────────────────────────────────── I Am Groot │ iamgroottmdcio │ person │ iam.groot@tmdc.io │ roles:id:ct-onboarding-data-developer, │ │ │ │ roles:id:data-dev, │ │ │ │ roles:id:system-dev, │ │ │ │ roles:id:user, │ │ │ │ users:id:iamgroottmdcio ``` ## Pre-requisites specific to the source system * **GCS Bucket**: The name of the Google Cloud Storage bucket you want to access. You can find the bucket name in the Google Cloud Console under the "Storage" section, where all your buckets are listed. * **Relative Path**: The path to the specific file or directory within the GCS bucket. This path can be obtained by navigating to the file or directory in the Google Cloud Console and copying the relative path from the bucket. * **GCS Project ID**: The unique identifier of the Google Cloud project associated with the GCS bucket. This can be found in the Google Cloud Console under "Project Info" on your project dashboard. * **GCS Account Email**: The email address associated with the Google Cloud service account that has access to GCS. This can be found in the IAM & Admin section of the Google Cloud Console under the "Service Accounts" tab. * **GCS Key**: The JSON key file associated with the Google Cloud service account used for authentication. You can download this key by going to the IAM & Admin > Service Accounts section in the Google Cloud Console, selecting the service account, and clicking "Add Key" > "JSON". * **Data format (`format`)**: `format` specifies the type of table format used to store the data in the container. Common values are `iceberg` or `delta`, depending on how the data is organized. * **Iceberg Catalog Type (`icebergCatalogType`)**: (Optional) Specifies the type of Iceberg catalog to use when the format is set to 'ICEBERG'. This parameter is only required when working with Iceberg-formatted data and you need to specify a custom catalog type. * **Metastore URL (`metastoreUrl`)**: (Optional) The URL of the metastore service that manages metadata for Iceberg tables. This parameter is only required when using Iceberg format and you need to connect to an external metastore for metadata management. ## Create a GCS Depot A Depot connects to Google Cloud Storage and reads data from it. To create a Depot for Google Cloud Storage, follow these steps: ### **Step 1: Create a Secret for securing GCS credentials** Create a Secret Resource using the [Google Cloud Storage (GCS)](/concepts/resources/secret/data-sources/google-cloud-storage-gcs.md) guide. ### **Step 2: Create a GCS Depot manifest file** Create a manifest file for your GCS Depot. {% tabs %} {% tab title="Manifest file" %} ```yaml name: ${{gcs-name}} version: v2alpha type: depot tags: - GCS - depot - storage description: "Google Cloud Storage depot" spec: type: gcs spec: bucket: ${{gcs-bucket}} relativePath: ${{gcs-relative-path}} format: ${{gcs-format}} secrets: - id: "${{tenant-id}}:${{gcs-secret-name}}" purpose: scan ``` {% endtab %} {% tab title="Example" %} ```yaml name: ${{gcs-name}} version: v2alpha type: depot tags: - GCS - depot - storage description: "Google Cloud Storage depot" spec: type: gcs spec: bucket: ${{gcs-bucket}} relativePath: ${{gcs-relative-path}} format: ${{gcs-format}} secrets: - id: "${{tenant-id}}:${{gcs-secret-name}}" purpose: scan ``` {% endtab %} {% endtabs %} ### **Step 3: Apply the Depot manifest file** Apply the manifest with the DataOS CLI: ```bash dataos-ctl resource apply -f ${{manifest-file-path}} ``` ## Verify the Depot creation Verify the Depot in two ways: * List Depots where you are the owner: ```bash dataos-ctl resource get -t depot ``` * List all Depots in the current Tenant: ```bash dataos-ctl resource get -t depot -a ``` ## Delete a Depot {% hint style="warning" %} Best practice: Delete Resources that are no longer in use to save time and reduce costs. {% endhint %} To delete a Depot, use the DataOS CLI: {% tabs %} {% tab title="Command 1" %} ```bash dataos-ctl resource delete -t depot -n ${{name}} ``` {% endtab %} {% tab title="Command 2 " %} ```bash dataos-ctl resource delete -i "${{resource-name}}|v2alpha|depot" ``` {% endtab %} {% tab title="Command 3" %} ```bash dataos-ctl resource delete -f ${{manifest-file-path}} ``` {% endtab %} {% endtabs %} Specify the Resource type and Depot name in the `delete` command. **Example:** {% tabs %} {% tab title="Command 1" %} ```bash dataos-ctl resource delete -t depot -n testdepot #output time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..." time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..." time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted" time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete" time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete" ``` {% endtab %} {% tab title="Command 2" %} ```bash dataos-ctl resource delete -i "testdepot|v2alpha|depot" #output time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete..." time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..." time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted" time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete...complete" ``` {% endtab %} {% tab title="Command 3" %} ```bash dataos-ctl resource delete -f /path/to/depot.yaml #output time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..." time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..." time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted" time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete" ``` {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://v2.dataos.info/concepts/resources/depot/supported-sources/gcs.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.