Skip to content

Commit 431c647

Browse files
authored
S3 integration infographics (windmill-labs#543)
* S3 integration infographics * Fixed path
1 parent 51d64e6 commit 431c647

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

docs/core_concepts/11_persistent_storage/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ On heavier data objects & unstructured data storage, [Amazon S3](https://aws.ama
6262

6363
Windmill comes with a [native integration with S3 and Azure Blob](./large_data_files.mdx#connect-your-windmill-workspace-to-your-s3-bucket-or-your-azure-blob-storage), making it the recommended storage for large objects like files and binary data.
6464

65+
![S3 Integration Infographic](./s3_infographics.png "S3 Integration Infographic")
66+
6567
All details at:
6668

6769
<div className="grid grid-cols-2 gap-6 mb-4">

docs/core_concepts/11_persistent_storage/large_data_files.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,10 @@ Windmill comes with a [native integration with S3 and Azure Blob](#connect-your-
1212

1313
## Connect your Windmill workspace to your S3 bucket or your Azure Blob storage
1414

15-
Once you've created an [S3 or Azure Blob resource](../../integrations/s3.mdx) in Windmill, go to the workspace settings > S3 Storage. Select the resource and click Save.
15+
Once you've created an [S3 or Azure Blob resource](#use-amazon-s3-r2-minio-and-azure-blob-directly) in Windmill, go to the workspace settings > S3 Storage. Select the resource and click Save.
1616

1717
![S3 storage workspace settings](./workspace_settings.png)
1818

19-
The resource can be set to be public with toggle "S3 resource details can be accessed by all users of this workspace".
20-
21-
In this case, the [permissions](../16_roles_and_permissions/index.mdx#path) set on the resource will be ignored when users interact with the S3 bucket via Windmill. Note that when the resource is public, the users might be able to access all of its details (including access keys and secrets) via some Windmill endpoints.
22-
When the resource is not set to be public, Windmill guarantees that users who don't have access to the resource won't be able to retrieve any of its details. That being said, access to a specific file inside the bucket will still be possible, and downloading and uploading objects will also be accessible to any workspace user. In short, as long as the user knows the path of the file they want to access, they will be able to read its content. The main difference is that users won't be able to browse the content of the bucket.
23-
2419
From now on, Windmill will be connected to this bucket and you'll have easy access to it from the code editor and the job run details. If a script takes as input a `s3object`, you will see in the input form on the right a button helping you choose the file directly from the bucket.
2520
Same for the result of the script. If you return an `s3object` containing a key `s3` pointing to a file inside your bucket, in the result panel there will be a button to open the bucket explorer to visualize the file.
2621

@@ -32,6 +27,14 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,
3227
}
3328
```
3429

30+
![S3 Integration Infographic](./s3_infographics.png "S3 Integration Infographic")
31+
32+
The resource can be set to be public with toggle "S3 resource details can be accessed by all users of this workspace".
33+
34+
In this case, the [permissions](../16_roles_and_permissions/index.mdx#path) set on the resource will be ignored when users interact with the S3 bucket via Windmill. Note that when the resource is public, the users might be able to access all of its details (including access keys and secrets) via some Windmill endpoints.
35+
36+
When the resource is not set to be public, Windmill guarantees that users who don't have access to the resource won't be able to retrieve any of its details. That being said, access to a specific file inside the bucket will still be possible, and downloading and uploading objects will also be accessible to any workspace user. In short, as long as the user knows the path of the file they want to access, they will be able to read its content. The main difference is that users won't be able to browse the content of the bucket.
37+
3538
When a script accepts a S3 file as input, it can be directly uploaded or chosen from the bucket explorer.
3639

3740
![S3 file upload](./file_upload.png)
Loading

docs/integrations/s3.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Feel free to create your own S3 scripts on [Windmill](../getting_started/00_how_
5858

5959
Once you've created an S3 or Azure Blob resource in Windmill, you can use Windmill's native integration with S3 and Azure Blob, making it the recommended storage for large objects like files and binary data.
6060

61+
![S3 Integration Infographic](../core_concepts/11_persistent_storage/s3_infographics.png "S3 Integration Infographic")
62+
6163
<div className="grid grid-cols-2 gap-6 mb-4">
6264
<DocCard
6365
title="Object Storage for Large Data: S3, R2, MinIO, Azure Blob"

0 commit comments

Comments
 (0)