1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-11 21:16:02 +01:00

feat(libstore): add S3 storage class support

Add support for configuring S3 storage class via the storage-class
parameter for S3BinaryCacheStore. This allows users to optimize costs
by selecting appropriate storage tiers (STANDARD, GLACIER,
INTELLIGENT_TIERING, etc.) based on access patterns.

The storage class is applied via the x-amz-storage-class header for
both regular PUT uploads and multipart upload initiation.
This commit is contained in:
Bernardo Meurer Costa 2025-10-23 04:32:58 +00:00
parent 34ac1792f9
commit bff81009c6
No known key found for this signature in database
4 changed files with 75 additions and 1 deletions

View file

@ -0,0 +1,21 @@
---
synopsis: "S3 binary cache stores now support storage class configuration"
prs: [14464]
issues: [7015]
---
S3 binary cache stores now support configuring the storage class for uploaded objects via the `storage-class` parameter. This allows users to optimize costs by selecting appropriate storage tiers based on access patterns.
Example usage:
```bash
# Use Glacier storage for long-term archival
nix copy --to 's3://my-bucket?storage-class=GLACIER' /nix/store/...
# Use Intelligent Tiering for automatic cost optimization
nix copy --to 's3://my-bucket?storage-class=INTELLIGENT_TIERING' /nix/store/...
```
The storage class applies to both regular uploads and multipart uploads. When not specified, objects use the bucket's default storage class.
See the [S3 storage classes documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html) for available storage classes and their characteristics.

View file

@ -122,4 +122,22 @@ TEST(S3BinaryCacheStore, parameterFiltering)
EXPECT_EQ(ref.params["priority"], "10");
}
/**
* Test storage class configuration
*/
TEST(S3BinaryCacheStore, storageClassDefault)
{
S3BinaryCacheStoreConfig config{"s3", "test-bucket", {}};
EXPECT_EQ(config.storageClass.get(), "");
}
TEST(S3BinaryCacheStore, storageClassConfiguration)
{
StringMap params;
params["storage-class"] = "GLACIER";
S3BinaryCacheStoreConfig config("s3", "test-bucket", params);
EXPECT_EQ(config.storageClass.get(), "GLACIER");
}
} // namespace nix

View file

@ -93,6 +93,26 @@ struct S3BinaryCacheStoreConfig : HttpBinaryCacheStoreConfig
Default is 100 MiB. Only takes effect when multipart-upload is enabled.
)"};
const Setting<std::string> storageClass{
this,
"",
"storage-class",
R"(
The S3 storage class to use for uploaded objects. When empty (default),
uses the bucket's default storage class. Valid values include:
- STANDARD (default, frequently accessed data)
- REDUCED_REDUNDANCY (less frequently accessed data)
- STANDARD_IA (infrequent access)
- ONEZONE_IA (infrequent access, single AZ)
- INTELLIGENT_TIERING (automatic cost optimization)
- GLACIER (archival with retrieval times in minutes to hours)
- DEEP_ARCHIVE (long-term archival with 12-hour retrieval)
- GLACIER_IR (instant retrieval archival)
See AWS S3 documentation for detailed storage class descriptions and pricing:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html
)"};
/**
* Set of settings that are part of the S3 URI itself.
* These are needed for region specification and other S3-specific settings.

View file

@ -170,7 +170,19 @@ void S3BinaryCacheStore::upload(
renderSize(sizeHint),
renderSize(AWS_MAX_PART_SIZE));
HttpBinaryCacheStore::upload(path, source, sizeHint, mimeType, contentEncoding);
auto req = makeRequest(path);
req.method = HttpMethod::PUT;
if (contentEncoding) {
req.headers.emplace_back("Content-Encoding", *contentEncoding);
}
if (std::string_view storageClass = s3Config->storageClass.get(); !storageClass.empty()) {
req.headers.emplace_back("x-amz-storage-class", storageClass);
}
req.data = {sizeHint, source};
req.mimeType = mimeType;
getFileTransfer()->upload(req);
}
void S3BinaryCacheStore::uploadMultipart(
@ -299,6 +311,9 @@ std::string S3BinaryCacheStore::createMultipartUpload(
if (contentEncoding) {
req.headers.emplace_back("Content-Encoding", *contentEncoding);
}
if (std::string_view storageClass = s3Config->storageClass.get(); !storageClass.empty()) {
req.headers.emplace_back("x-amz-storage-class", storageClass);
}
auto result = getFileTransfer()->enqueueFileTransfer(req).get();