0% found this document useful (0 votes)
19 views4 pages

S3 Mountpoint Configuration Guide

The document provides usage instructions for the 'mount-s3' command, which allows users to mount an Amazon S3 bucket to a local directory. It details various options for bucket configuration, AWS credentials, mount settings, client parameters, logging, caching, and advanced features. Users can run the command in foreground mode, specify bucket names, and customize access and performance settings.

Uploaded by

crsudhir123
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
19 views4 pages

S3 Mountpoint Configuration Guide

The document provides usage instructions for the 'mount-s3' command, which allows users to mount an Amazon S3 bucket to a local directory. It details various options for bucket configuration, AWS credentials, mount settings, client parameters, logging, caching, and advanced features. Users can run the command in foreground mode, specify bucket names, and customize access and performance settings.

Uploaded by

crsudhir123
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd

mount-s3 --help

Mountpoint for Amazon S3

Usage: mount-s3 [OPTIONS] <BUCKET_NAME> <DIRECTORY>

Arguments:
<BUCKET_NAME>
Name of bucket to mount

<DIRECTORY>
Directory or FUSE file descriptor to mount the bucket at.

For directory mount points, the passed path must be an existing


directory.

For FUSE file descriptors (Linux-only), it should be of the format


`/dev/fd/N`.
Learn more in Mountpoint's configuration documentation
([Link]).

Options:
-f, --foreground
Run as foreground process

-h, --help
Print help (see a summary with '-h')

-V, --version
Print version

Bucket options:
--prefix <PREFIX>
Prefix inside the bucket to mount, ending in '/' [default: mount the
entire bucket]

--region <REGION>
AWS region of the bucket [default: auto-detect region]

--endpoint-url <ENDPOINT_URL>
S3 endpoint URL [default: auto-detect endpoint]

--force-path-style
Force path-style addressing

--transfer-acceleration
Use S3 Transfer Acceleration when accessing S3. This must be enabled on
the bucket.

--dual-stack
Use dual-stack endpoints when accessing S3

--requester-pays
Set the 'x-amz-request-payer' to 'requester' on S3 requests

--bucket-type <BUCKET_TYPE>
Type of S3 bucket to use [default: inferred from bucket name]

[possible values: general-purpose, directory]


--storage-class <STORAGE_CLASS>
Set the storage class for new objects

--expected-bucket-owner <AWS_ACCOUNT_ID>
Account ID of the expected bucket owner. If the bucket is owned by a
different account, S3 requests fail with an access denied error.

--sse <SSE>
Server-side encryption algorithm to use when uploading new objects

[possible values: aws:kms, aws:kms:dsse, AES256]

--sse-kms-key-id <AWS_KMS_KEY_ARN>
AWS Key Management Service (KMS) key ARN to use with KMS server-side
encryption when uploading new objects. Key ID, Alias and Alias ARN are all not
supported.

--upload-checksums <ALGORITHM>
Checksum algorithm to use for S3 uploads [default: crc32c]

[possible values: crc32c, off]

AWS credentials options:


--no-sign-request
Do not sign requests. Credentials will not be loaded if this argument is
provided.

--profile <PROFILE>
Use a specific profile from your credential file.

Mount options:
--read-only
Mount file system in read-only mode

--allow-delete
Allow delete operations on file system

--allow-overwrite
Allow overwrite operations on file system

--incremental-upload
Enable incremental uploads and support for appending to existing objects

--auto-unmount
Automatically unmount on exit

--allow-root
Allow root user to access file system

--allow-other
Allow other users, including root, to access file system

--uid <UID>
Owner UID [default: current user's UID]

--gid <GID>
Owner GID [default: current user's GID]
--dir-mode <DIR_MODE>
Directory permissions [default: 0755]

--file-mode <FILE_MODE>
File permissions [default: 0644]

Client options:
--maximum-throughput-gbps <N>
Maximum throughput in Gbps [default: auto-detected on EC2 instances, 10
Gbps elsewhere]

--max-threads <N>
Maximum number of FUSE daemon threads

[default: 16]

--part-size <SIZE>
Part size for multi-part GET and PUT in bytes

[default: 8388608]

--read-part-size <SIZE>
Part size for GET in bytes [default: 8388608]

--write-part-size <SIZE>
Part size for multi-part PUT in bytes [default: 8388608]

--bind <NETWORK_INTERFACE>
One or more network interfaces for Mountpoint to use when accessing S3.
Requires Linux 5.7+ or running as root. This feature is a work-in-progress.

Logging options:
-l, --log-directory <DIRECTORY>
Write log files to a directory [default: logs written to syslog]

--log-metrics
Enable logging of summarized performance metrics

-d, --debug
Enable debug logging for Mountpoint

--debug-crt
Enable debug logging for AWS Common Runtime

--no-log
Disable all logging. You will still see stdout messages.

Caching options:
--cache <DIRECTORY>
Enable caching of object content to the given directory and set metadata
TTL to 60 seconds

--metadata-ttl <SECONDS|indefinite|minimal>
Time-to-live (TTL) for cached metadata in seconds [default: minimal, or
60 seconds if --cache is set]

--max-cache-size <MiB>
Maximum size of the cache directory in MiB [default: preserve 5% of
available space]
--cache-xz <BUCKET>
Enable caching of object content to the specified bucket on S3 Express
One Zone (same region only)

Advanced options:
--user-agent-prefix <PREFIX>
Configure a string to be prepended to the 'User-Agent' HTTP request
header for all S3 requests

Common questions

Powered by AI

Incremental uploads require the `--incremental-upload` option to be enabled when mounting the S3 bucket with the mount-s3 tool. This setting allows for appending data to existing objects. It implies that users need precise control and understanding of how data is uploaded and the state of the existing objects, which can affect data integrity and consistency if not managed correctly. This feature is especially useful for large files or log streaming, where appending is more efficient than rewriting the entire object .

The 'S3 Transfer Acceleration' should be enabled in scenarios where users need faster data transfers over long distances, such as global data distribution or when large amounts of data are being moved to or from S3 over the internet. The bucket must have transfer acceleration enabled for this option to work with mount-s3. This feature leverages optimized network paths and Amazon CloudFront's globally distributed edge locations to reduce latency and improve transfer speeds .

Using the `--no-sign-request` option disables signing of S3 requests, meaning that credentials and authentication information are not required for operations. While this might be convenient for accessing publicly accessible buckets, it poses significant security risks when used inadvertently on buckets that require authentication, potentially leading to unauthorized access and data leaks. It is crucial to ensure that this option is used only in appropriate, secure contexts .

Enabling `--read-only` mode restricts operations to read access only, preventing modifications, deletions, or uploads to the S3 bucket. This provides a safeguard for data integrity, ensuring that no unintended changes occur. It is ideal for scenarios where users need to sandbox access or ensure compliance with data governance policies. However, it sacrifices flexibility as users lose the ability to perform write operations when necessary, potentially complicating workflows that require dynamic data interaction .

The `--cache` option places object content in a specified directory, enhancing performance by reducing access times for frequently used data, as it negates the need to repeatedly fetch the same object data from S3. The `--max-cache-size` option limits the cache directory's size, helping to manage local storage resources. However, these caching mechanisms introduce potential limitations such as outdated data due to cached copies, requiring proper management of cache invalidation strategies, and increased local storage usage .

Using a specific `--user-agent-prefix` allows for customizing the HTTP request User-Agent header with a prefix, which can aid in monitoring, logging, and tracking the source or purpose of traffic in an S3 environment. While the advantage lies in the clarity it provides to differentiate types of requests, misuse or improper configuration might lead to inconsistencies in logging or could be exploited to spoof request origins without proper controls .

Specifying an incorrect AWS Account ID with the `--expected-bucket-owner` option results in access denial for the S3 requests, as the option is designed to enforce security measures by verifying the bucket owner's identity. This prevents unauthorized access or operations on a bucket if its ownership differs from the expected account ID, thus serving as a crucial security control to avoid actions on unintended buckets .

The `--force-path-style` option changes the way S3 endpoints are addressed. By default, S3 uses virtual-hosted-style addressing, where the bucket name is part of the domain name (e.g., bucketname.s3.amazonaws.com). Enabling `--force-path-style` modifies this to use path-style addressing, where the bucket name is part of the path (e.g., s3.amazonaws.com/bucketname). This is necessary for certain scenarios, such as when using non-standard S3-compatible endpoints or certain regional restrictions .

A minimal metadata TTL means that cached metadata is held for the shortest possible time before being updated from S3. This configuration maximizes data consistency, ensuring changes in S3 metadata are quickly reflected locally. However, it can negatively impact performance by increasing the frequency of metadata checks and requests to S3, leading to potential increases in latency and resource usage. It requires balancing the need for updated metadata against system efficiency .

Enabling `--dual-stack` endpoints allows for both IPv4 and IPv6 connectivity to S3 by providing endpoints that support both address families. This is beneficial in modern network environments where IPv6 adoption is increasing, providing flexibility in addressing and connectivity, and ensuring future-proof network configurations for S3 interactions. It may also improve connectivity options in environments that prefer or require IPv6 .

You might also like