Skip to content

Commit

Permalink
Remove multi-NIC feature flag, add documentation (#1014)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Carl Jones <[email protected]>
  • Loading branch information
dannycjones authored Sep 13, 2024
1 parent abae870 commit bb42045
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
20 changes: 20 additions & 0 deletions doc/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,26 @@ The cache directory is not reusable by other Mountpoint processes and will be cl
When running multiple Mountpoint processes concurrently on the same host,
you should use unique cache directories to avoid different processes interfering with the others' cache content.

## Using multiple network cards

By default, Mountpoint will use the network interface associated with the default route on the host (such as that specified by `ip route list`).

You can use the `--bind <INTERFACE_NAME>` command-line argument to specify a different network interface for Mountpoint network requests to be routed over.
This argument can be specified multiple times to allow requests to be fanned-out over multiple network interfaces.

As an example, this command binds to two network interfaces and Mountpoint traffic will be distributed over them both:

```
mount-s3 DOC-EXAMPLE-BUCKET /path/to/mount --bind ens0 --bind ens1
```

This feature is a work-in-progress.
We welcome feedback on how this works for your applications and workloads.

> [!NOTE]
> This feature requires either Linux 5.7+ or running Mountpoint as the root user.
> We recommend using a newer Linux kernel version to make use of this feature.
## Logging

By default, Mountpoint emits high-severity log information to [syslog](https://datatracker.ietf.org/doc/html/rfc5424) if available on your system. You can change what level of information is logged, and to where it is logged. See [LOGGING.md](LOGGING.md) for more details on configuring logging.
5 changes: 5 additions & 0 deletions mountpoint-s3/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
## Unreleased

### New features

* Mountpoint now supports specifying one or more network interfaces using `--bind <INTERFACE_NAME>` to be used when making requests to Amazon S3.
This feature is work-in-progress and we welcome feedback on it.

### Other changes

* Fix an issue where `credential_process` field would not be picked up correctly when using `source_profile`. ([awslabs/aws-c-auth#245](https://github.com/awslabs/aws-c-auth/pull/245))
Expand Down
3 changes: 1 addition & 2 deletions mountpoint-s3/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -315,10 +315,9 @@ pub struct CliArgs {
)]
pub upload_checksums: Option<UploadChecksums>,

#[cfg(feature = "multiple-nw-iface")]
#[clap(
long,
help = "One or more network interfaces for Mountpoint to use when accessing S3. Requires Linux 5.7+ or running as root.",
help = "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.",
help_heading = CLIENT_OPTIONS_HEADER,
value_name = "NETWORK_INTERFACE",
)]
Expand Down

1 comment on commit bb42045

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: bb42045 Previous: abae870 Ratio
time_to_first_byte_read 191.73631680000003 milliseconds 73.2188686 milliseconds 2.62

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.