You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "CommanderStorm (via GitHub)" <gi...@apache.org> on 2025/09/27 21:18:20 UTC
[PR] docs: document all the missing keys [arrow-rs-object-store]
CommanderStorm opened a new pull request, #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498
# Which issue does this PR close?
Closes #497
# Rationale for this change
The keys should either all be documented, or all undocumented.
Being partially documented is not quite ideal.
# What changes are included in this PR?
The docs change, that some keys did not have docs for their "Supported keys"
# Are there any user-facing changes?
Yes, this is a docs change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document all the missing keys [arrow-rs-object-store]
Posted by "CommanderStorm (via GitHub)" <gi...@apache.org>.
CommanderStorm commented on code in PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498#discussion_r2400427835
##########
src/aws/builder.rs:
##########
@@ -1191,17 +1212,37 @@ fn parse_bucket_az(bucket: &str) -> Option<&str> {
#[derive(PartialEq, Eq, Hash, Clone, Debug, Copy, Serialize, Deserialize)]
#[non_exhaustive]
pub enum S3EncryptionConfigKey {
- /// Type of encryption to use. If set, must be one of "AES256" (SSE-S3), "aws:kms" (SSE-KMS), "aws:kms:dsse" (DSSE-KMS) or "sse-c".
+ /// Type of encryption to use.
+ ///
+ /// If set, must be one of
+ /// - "AES256" (SSE-S3),
+ /// - "aws:kms" (SSE-KMS),
+ /// - "aws:kms:dsse" (DSSE-KMS) or
+ /// - "sse-c"
+ ///
+ /// Supported keys:
+ /// - `aws_server_side_encryption`
ServerSideEncryption,
- /// The KMS key ID to use for server-side encryption. If set, ServerSideEncryption
- /// must be "aws:kms" or "aws:kms:dsse".
+ /// The KMS key ID to use for server-side encryption.
+ ///
Review Comment:
```suggestion
///
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document missing config keys [arrow-rs-object-store]
Posted by "CommanderStorm (via GitHub)" <gi...@apache.org>.
CommanderStorm commented on code in PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498#discussion_r2470768782
##########
src/aws/builder.rs:
##########
@@ -318,16 +318,25 @@ pub enum AmazonS3ConfigKey {
/// Set the container credentials relative URI when used in ECS
///
/// <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_relative_uri`
Review Comment:
```suggestion
/// - `aws_container_credentials_relative_uri`
/// - `container_credentials_relative_uri`
```
##########
src/aws/builder.rs:
##########
@@ -318,16 +318,25 @@ pub enum AmazonS3ConfigKey {
/// Set the container credentials relative URI when used in ECS
///
/// <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_relative_uri`
ContainerCredentialsRelativeUri,
/// Set the container credentials full URI when used in EKS
///
/// <https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_full_uri`
Review Comment:
```suggestion
/// - `aws_container_credentials_full_uri`
/// - `container_credentials_full_uri`
```
##########
src/aws/builder.rs:
##########
@@ -318,16 +318,25 @@ pub enum AmazonS3ConfigKey {
/// Set the container credentials relative URI when used in ECS
///
/// <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_relative_uri`
ContainerCredentialsRelativeUri,
/// Set the container credentials full URI when used in EKS
///
/// <https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_full_uri`
ContainerCredentialsFullUri,
/// Set the authorization token in plain text when used in EKS to authenticate with ContainerCredentialsFullUri
///
/// <https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_authorization_token_file`
Review Comment:
```suggestion
/// - `aws_container_authorization_token_file`
/// - `container_authorization_token_file`
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document missing config keys [arrow-rs-object-store]
Posted by "CommanderStorm (via GitHub)" <gi...@apache.org>.
CommanderStorm commented on code in PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498#discussion_r2470786453
##########
src/aws/builder.rs:
##########
@@ -1202,17 +1226,37 @@ fn parse_bucket_az(bucket: &str) -> Option<&str> {
#[derive(PartialEq, Eq, Hash, Clone, Debug, Copy, Serialize, Deserialize)]
#[non_exhaustive]
pub enum S3EncryptionConfigKey {
- /// Type of encryption to use. If set, must be one of "AES256" (SSE-S3), "aws:kms" (SSE-KMS), "aws:kms:dsse" (DSSE-KMS) or "sse-c".
+ /// Type of encryption to use.
+ ///
+ /// If set, must be one of
+ /// - "AES256" (SSE-S3),
+ /// - "aws:kms" (SSE-KMS),
+ /// - "aws:kms:dsse" (DSSE-KMS) or
+ /// - "sse-c"
+ ///
+ /// Supported keys:
+ /// - `aws_server_side_encryption`
ServerSideEncryption,
- /// The KMS key ID to use for server-side encryption. If set, ServerSideEncryption
- /// must be "aws:kms" or "aws:kms:dsse".
+ /// The KMS key ID to use for server-side encryption.
+ ///
+ /// If set, [ServerSideEncryption](Self::ServerSideEncryption) must be "aws:kms" or "aws:kms:dsse".
+ ///
+ /// Supported keys:
+ /// - `aws_sse_kms_key_id`
Review Comment:
```suggestion
/// - `aws_sse_kms_key_id`
/// - `sse_kms_key_id`
```
##########
src/aws/builder.rs:
##########
@@ -1202,17 +1226,37 @@ fn parse_bucket_az(bucket: &str) -> Option<&str> {
#[derive(PartialEq, Eq, Hash, Clone, Debug, Copy, Serialize, Deserialize)]
#[non_exhaustive]
pub enum S3EncryptionConfigKey {
- /// Type of encryption to use. If set, must be one of "AES256" (SSE-S3), "aws:kms" (SSE-KMS), "aws:kms:dsse" (DSSE-KMS) or "sse-c".
+ /// Type of encryption to use.
+ ///
+ /// If set, must be one of
+ /// - "AES256" (SSE-S3),
+ /// - "aws:kms" (SSE-KMS),
+ /// - "aws:kms:dsse" (DSSE-KMS) or
+ /// - "sse-c"
+ ///
+ /// Supported keys:
+ /// - `aws_server_side_encryption`
ServerSideEncryption,
- /// The KMS key ID to use for server-side encryption. If set, ServerSideEncryption
- /// must be "aws:kms" or "aws:kms:dsse".
+ /// The KMS key ID to use for server-side encryption.
+ ///
+ /// If set, [ServerSideEncryption](Self::ServerSideEncryption) must be "aws:kms" or "aws:kms:dsse".
+ ///
+ /// Supported keys:
+ /// - `aws_sse_kms_key_id`
KmsKeyId,
/// If set to true, will use the bucket's default KMS key for server-side encryption.
/// If set to false, will disable the use of the bucket's default KMS key for server-side encryption.
+ ///
+ /// Supported keys:
+ /// - `aws_sse_bucket_key_enabled`
BucketKeyEnabled,
/// The base64 encoded, 256-bit customer encryption key to use for server-side encryption.
- /// If set, ServerSideEncryption must be "sse-c".
+ ///
+ /// If set, [ServerSideEncryption](Self::ServerSideEncryption) must be "sse-c".
+ ///
+ /// Supported keys:
+ /// - `aws_sse_customer_key_base64`
Review Comment:
```suggestion
/// - `aws_sse_customer_key_base64`
/// - `sse_customer_key_base64`
```
##########
src/aws/builder.rs:
##########
@@ -1202,17 +1226,37 @@ fn parse_bucket_az(bucket: &str) -> Option<&str> {
#[derive(PartialEq, Eq, Hash, Clone, Debug, Copy, Serialize, Deserialize)]
#[non_exhaustive]
pub enum S3EncryptionConfigKey {
- /// Type of encryption to use. If set, must be one of "AES256" (SSE-S3), "aws:kms" (SSE-KMS), "aws:kms:dsse" (DSSE-KMS) or "sse-c".
+ /// Type of encryption to use.
+ ///
+ /// If set, must be one of
+ /// - "AES256" (SSE-S3),
+ /// - "aws:kms" (SSE-KMS),
+ /// - "aws:kms:dsse" (DSSE-KMS) or
+ /// - "sse-c"
+ ///
+ /// Supported keys:
+ /// - `aws_server_side_encryption`
Review Comment:
```suggestion
/// - `aws_server_side_encryption`
/// - `server_side_encryption`
```
##########
src/aws/builder.rs:
##########
@@ -1202,17 +1226,37 @@ fn parse_bucket_az(bucket: &str) -> Option<&str> {
#[derive(PartialEq, Eq, Hash, Clone, Debug, Copy, Serialize, Deserialize)]
#[non_exhaustive]
pub enum S3EncryptionConfigKey {
- /// Type of encryption to use. If set, must be one of "AES256" (SSE-S3), "aws:kms" (SSE-KMS), "aws:kms:dsse" (DSSE-KMS) or "sse-c".
+ /// Type of encryption to use.
+ ///
+ /// If set, must be one of
+ /// - "AES256" (SSE-S3),
+ /// - "aws:kms" (SSE-KMS),
+ /// - "aws:kms:dsse" (DSSE-KMS) or
+ /// - "sse-c"
+ ///
+ /// Supported keys:
+ /// - `aws_server_side_encryption`
ServerSideEncryption,
- /// The KMS key ID to use for server-side encryption. If set, ServerSideEncryption
- /// must be "aws:kms" or "aws:kms:dsse".
+ /// The KMS key ID to use for server-side encryption.
+ ///
+ /// If set, [ServerSideEncryption](Self::ServerSideEncryption) must be "aws:kms" or "aws:kms:dsse".
+ ///
+ /// Supported keys:
+ /// - `aws_sse_kms_key_id`
KmsKeyId,
/// If set to true, will use the bucket's default KMS key for server-side encryption.
/// If set to false, will disable the use of the bucket's default KMS key for server-side encryption.
+ ///
+ /// Supported keys:
+ /// - `aws_sse_bucket_key_enabled`
Review Comment:
```suggestion
/// - `aws_sse_bucket_key_enabled`
/// - `sse_bucket_key_enabled`
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document missing config keys [arrow-rs-object-store]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498#issuecomment-3458058514
I merged up from main to get a clean CI run
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document missing config keys [arrow-rs-object-store]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498#discussion_r2470738905
##########
src/aws/builder.rs:
##########
@@ -315,16 +315,25 @@ pub enum AmazonS3ConfigKey {
/// Set the container credentials relative URI when used in ECS
///
/// <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_relative_uri`
Review Comment:
I think @jonashaag did this in
- https://github.com/apache/arrow-rs-object-store/pull/500
Is that enough?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document missing config keys [arrow-rs-object-store]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: document all the missing keys [arrow-rs-object-store]
Posted by "CommanderStorm (via GitHub)" <gi...@apache.org>.
CommanderStorm commented on code in PR #498:
URL: https://github.com/apache/arrow-rs-object-store/pull/498#discussion_r2384345265
##########
src/aws/builder.rs:
##########
@@ -315,16 +315,25 @@ pub enum AmazonS3ConfigKey {
/// Set the container credentials relative URI when used in ECS
///
/// <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
+ ///
+ /// Supported keys:
+ /// - `aws_container_credentials_relative_uri`
Review Comment:
not sure if it is intentional that parts of the options have only the aws_ prefix, parts allow both and parts of the keys only the non-aws prefix.
This is a new feature => different issue, but if there is apetite, I can raise an PR.
I think the best way would be support both `aws_suffix` and `suffix` => the most compliant parsing.
Alternative, allowing `suffix` for all and `aws_suffix` is also a fine API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org