Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Include cloud permissions in doc handling docs #5274

Merged
merged 4 commits into from
Mar 20, 2025
Merged

feat: Include cloud permissions in doc handling docs #5274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f27f612
feat: Include cloud permissions in doc handling docs
georgios-goulos Mar 17, 2025
8540d0c
style(formatting): grammatical tweaks
christinaausley Mar 18, 2025
94a9778
Add missing permission for signing URLs with GCP service accounts
georgios-goulos Mar 19, 2025
78fab84
improved mesasge
georgios-goulos Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/components/concepts/document-handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ To set what storage should be used, accepted values for `DOCUMENT_DEFAULT_STORE_
| DOCUMENT_STORE_AWS_BUCKET_TTL | Represents the time-to-live (TTL) for documents stored in the S3 bucket. This could be used to set an expiration policy, meaning documents will be deleted automatically after a specified duration. |
| DOCUMENT_STORE_AWS_CLASS | io.camunda.document.store.aws.AwsDocumentStoreProvider |

### AWS API client permission requirements

To ensure seamless integration and functionality of document handling with AWS services, the API client utilized must be configured with the appropriate permissions. The following AWS Identity and Access Management (IAM) permissions are necessary for the execution of operations related to document handling:

| Permission | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `s3:ListBucket` | This permission allows the application to verify it has access to the specified S3 bucket. Lack of this permission does not prevent the application from starting, but it logs a warning on application start-up. |
| `s3:GetObject` | This permission is required to retrieve contents and metadata of objects from Amazon S3. The API client will utilize this permission to download or access the contents of the documents that have been uploaded to the bucket. |
| `s3:PutObject` | To upload documents to an Amazon S3 bucket, the API client must have this permission. |
| `s3:DeleteObject` | This permission authorizes the API client to remove objects from the specified S3 bucket. |

</TabItem>

<TabItem value='gcp'>
Expand All @@ -67,6 +78,19 @@ To set what storage should be used, accepted values for `DOCUMENT_DEFAULT_STORE_
| DOCUMENT_STORE_GCP_BUCKET | Defines the name of the Google Cloud Storage bucket where documents are stored. |
| DOCUMENT_STORE_GCP_CLASS | io.camunda.document.store.gcp.GcpDocumentStoreProvider |

### GCP API client permission requirements

To ensure seamless integration and functionality of document handling with GCP services, the API client utilized must be configured with the appropriate permissions. The following permissions are necessary for the execution of operations related to document handling:

| Permission | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `storage.buckets.get` | This permission allows the application to verify it has access to the specified bucket. Lack of this permission does not prevent the application from starting, but it logs a warning on application start-up. |
| `storage.objects.get` | This permission allows the API client to retrieve objects from Google Cloud Storage. It is vital for downloading or accessing the contents of stored objects. |
| `storage.objects.create` | With this permission, the API client can upload new objects to a bucket. It is essential for adding new documents to the storage. |
| `storage.objects.update` | This permission enables the API client to update contents and metadata of existing objects within a bucket. |
| `storage.objects.delete` | This permission grants the API client the ability to delete objects from a bucket. |
| `iam.serviceAccounts.signBlob` | This permission allows the service account to sign data as part of the process to create secure, signed URLs for accessing uploaded documents. |

</TabItem>

<TabItem value='local'>
Expand Down
24 changes: 24 additions & 0 deletions versioned_docs/version-8.7/components/concepts/document-handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ To set what storage should be used, accepted values for `DOCUMENT_DEFAULT_STORE_
| DOCUMENT_STORE_AWS_BUCKET_TTL | Represents the time-to-live (TTL) for documents stored in the S3 bucket. This could be used to set an expiration policy, meaning documents will be deleted automatically after a specified duration. |
| DOCUMENT_STORE_AWS_CLASS | io.camunda.document.store.aws.AwsDocumentStoreProvider |

### AWS API client permission requirements

To ensure seamless integration and functionality of document handling with AWS services, the API client utilized must be configured with the appropriate permissions. The following AWS Identity and Access Management (IAM) permissions are necessary for the execution of operations related to document handling:

| Permission | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `s3:ListBucket` | This permission allows the application to verify it has access to the specified S3 bucket. Lack of this permission does not prevent the application from starting, but it logs a warning on application start-up. |
| `s3:GetObject` | This permission is required to retrieve contents and metadata of objects from Amazon S3. The API client will utilize this permission to download or access the contents of the documents that have been uploaded to the bucket. |
| `s3:PutObject` | To upload documents to an Amazon S3 bucket, the API client must have this permission. |
| `s3:DeleteObject` | This permission authorizes the API client to remove objects from the specified S3 bucket. |

</TabItem>

<TabItem value='gcp'>
Expand All @@ -67,6 +78,19 @@ To set what storage should be used, accepted values for `DOCUMENT_DEFAULT_STORE_
| DOCUMENT_STORE_GCP_BUCKET | Defines the name of the Google Cloud Storage bucket where documents are stored. |
| DOCUMENT_STORE_GCP_CLASS | io.camunda.document.store.gcp.GcpDocumentStoreProvider |

### GCP API client permission requirements

To ensure seamless integration and functionality of document handling with GCP services, the API client utilized must be configured with the appropriate permissions. The following permissions are necessary for the execution of operations related to document handling:

| Permission | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `storage.buckets.get` | This permission allows the application to verify it has access to the specified bucket. Lack of this permission does not prevent the application from starting, but it logs a warning on application start-up. |
| `storage.objects.get` | This permission allows the API client to retrieve objects from Google Cloud Storage. It is vital for downloading or accessing the contents of stored objects. |
| `storage.objects.create` | With this permission, the API client can upload new objects to a bucket. It is essential for adding new documents to the storage. |
| `storage.objects.update` | This permission enables the API client to update contents and metadata of existing objects within a bucket. |
| `storage.objects.delete` | This permission grants the API client the ability to delete objects from a bucket. |
| `iam.serviceAccounts.signBlob` | This permission allows the service account to sign data as part of the process to create secure, signed URLs for accessing uploaded documents. |

</TabItem>

<TabItem value='local'>
Expand Down
Loading