Skip to content

Commit c5036bb

Browse files
committed
Add Mountpoint-specific options section to CONFIGURATION.md
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
1 parent 796ba8b commit c5036bb

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/CONFIGURATION.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,35 @@
22

33
This document covers how to configure the CSI driver: be it through driver install-time configuration or in the volume specs.
44

5+
## Mountpoint-specific configuration
6+
57
Most Mountpoint-specific configuration can be found in [the Mountpoint documentation](https://github.com/awslabs/mountpoint-s3/blob/main/doc/CONFIGURATION.md) and should be specified as `mountOptions`.
68
One notable exception is for Mountpoint's local data caching, which should be specified using volume attributes. See the dedicated [Mountpoint S3 CSI driver caching documentation](https://github.com/awslabs/mountpoint-s3-csi-driver/blob/main/docs/CACHING.md) for more information on cache configuration.
79

10+
Common options that can be passed directly to Mountpoint via `mountOptions` include:
11+
12+
- `--prefix` to mount only a specific prefix within your bucket
13+
- `--maximum-throughput-gbps` to hint desired bandwidth usage
14+
- `--write-part-size` to adjust upload part sizes
15+
16+
Below shows an example `mountOptions` value for these options
17+
18+
```yaml
19+
mountOptions:
20+
- prefix hello world/
21+
- maximum-throughput-gbps 25
22+
- write-part-size 16777216
23+
```
24+
25+
> [!IMPORTANT]
26+
> Mount options are passed directly to Mountpoint without shell interpretation.
27+
> Unlike in a shell, quoted strings like `"my value"` are treated as literal quotes,
28+
> not as a way to group words with spaces.
29+
> The `prefix` argument provided above highlights this,
30+
> it will be interpreted by Mountpoint similar to `--prefix="hello world/"`.
31+
32+
See [the Mountpoint documentation](https://github.com/awslabs/mountpoint-s3/blob/main/doc/CONFIGURATION.md) for all available configuration options.
33+
834
## Static Provisioning
935

1036
The CSI driver supports only static provisioning for an existing S3 bucket.

0 commit comments

Comments
 (0)