From 6365ba8f35a8bba46336647612923d226b2e1853 Mon Sep 17 00:00:00 2001 From: Andrew Gaul Date: Fri, 12 Sep 2025 16:27:50 +0900 Subject: [PATCH] Fix typo and examples Use bucket instead of container more consistently. --- Client-compatibility-list.md | 4 ++-- Middleware-alias-blobstore.md | 4 ++-- Middleware-bucket-locator.md | 4 ++-- Middleware-regex.md | 2 +- Middleware-storage-class-override.md | 4 ++-- Tips.md | 8 ++++---- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Client-compatibility-list.md b/Client-compatibility-list.md index ea96f23..4b7a605 100644 --- a/Client-compatibility-list.md +++ b/Client-compatibility-list.md @@ -27,7 +27,7 @@ client.setS3ClientOptions(new S3ClientOptions().withPathStyleAccess(true)); ```java sc.hadoopConfiguration.set("fs.s3a.impl", "org.apache.hadoop.fs.s3a.S3AFileSystem") sc.hadoopConfiguration.set("fs.s3a.endpoint", "127.0.0.1:4242") -sc.hadoopConfiguration.set("fs.s3a.connection.ssl.enabled", "false") // if no SSL suppport +sc.hadoopConfiguration.set("fs.s3a.connection.ssl.enabled", "false") // if no SSL support // if user/password access sc.hadoopConfiguration.set("fs.s3a.aws.credentials.provider", "org.apache.hadoop.fs.s3a.SimpleAWSCredentialsProvider") sc.hadoopConfiguration.set("fs.s3a.access.key", "local-identity") @@ -164,4 +164,4 @@ $ s3fs bucketname dirname \ -o sigv2 \ -o url=http://127.0.0.1:8080 \ -o use_path_request_style -``` \ No newline at end of file +``` diff --git a/Middleware-alias-blobstore.md b/Middleware-alias-blobstore.md index ad9b39b..e08a56a 100644 --- a/Middleware-alias-blobstore.md +++ b/Middleware-alias-blobstore.md @@ -1,8 +1,8 @@ -S3Proxy can use an alias for a backend container. This may be helpful to preserve bucket names when switching backends, for example. The alternate name can be specified as follows: +S3Proxy can use an alias for a backend bucket. This may be helpful to preserve bucket names when switching backends, for example. The alternate name can be specified as follows: ``` s3proxy.alias-blobstore.content=backend-data ``` In the above example, requests for the bucket `content` are redirected to `backend-data`. This does not preclude using the name `backend-data`, however, when listing buckets `backend-data` bucket is replaced with `content` in the listing. -S3Proxy does not allow mapping multiple aliases to the same backend bucket. Future work could expand this middleware to include a prefix, allowing a subset of a bucket to appear as a bucket to the S3Proxy clients. \ No newline at end of file +S3Proxy does not allow mapping multiple aliases to the same backend bucket. Future work could expand this middleware to include a prefix, allowing a subset of a bucket to appear as a bucket to the S3Proxy clients. diff --git a/Middleware-bucket-locator.md b/Middleware-bucket-locator.md index ded622e..a4eda43 100644 --- a/Middleware-bucket-locator.md +++ b/Middleware-bucket-locator.md @@ -1,8 +1,8 @@ s3proxy can be configured to select the backend by the bucket names. Each bucket for the backend must be specified in the properties file. Example: - s3proxy.bucket-locator.1=container1 - s3proxy.bucket-locator.2=container2 + s3proxy.bucket-locator.1=bucket1 + s3proxy.bucket-locator.2=bucket2 The indexing 1, 2, etc is only to differentiate the bucket entries. The `bucket-locator` middleware supports glob syntax for bucket names. diff --git a/Middleware-regex.md b/Middleware-regex.md index 5459465..7f79d4a 100644 --- a/Middleware-regex.md +++ b/Middleware-regex.md @@ -20,7 +20,7 @@ s3proxy.regex-blobstore.match.type_partition=^prefix/(\\w+)/(\\d{4})/(\\d{2})/(\ s3proxy.regex-blobstore.replace.type_partition=prefix/date=$2-$3-$4/type=$1/$5 ``` -will rewrite blob name from: +will rewrite key name from: ``` prefix/test/2023/01/01/test.txt diff --git a/Middleware-storage-class-override.md b/Middleware-storage-class-override.md index 7ead98b..c6389e5 100644 --- a/Middleware-storage-class-override.md +++ b/Middleware-storage-class-override.md @@ -24,8 +24,8 @@ Then with this configuration you can run this test export AWS_ACCESS_KEY_ID=local-identity export AWS_SECRET_ACCESS_KEY=local-credential echo "put me in test" > test.txt -aws s3 --endpoint-url http://127.0.0.1:8080 cp test.txt s3://mcourcy-testia/test.txt -aws s3api head-object --endpoint-url http://127.0.0.1:8080 --bucket mcourcy-testia --key test.txt +aws s3 --endpoint-url http://127.0.0.1:8080 cp test.txt s3://BUCKETNAME/test.txt +aws s3api head-object --endpoint-url http://127.0.0.1:8080 --bucket BUCKETNAME --key test.txt ``` The output diff --git a/Tips.md b/Tips.md index 9e23c01..c2d136b 100644 --- a/Tips.md +++ b/Tips.md @@ -18,10 +18,10 @@ s3proxy.authorization=none You can use `curl` to debug s3proxy when authentication is disabled (see above): -* list containers in a storage account: `curl http:///` -* list blobs in a container: `curl http:///` -* add a new container: `curl -X PUT http:///` -* add a new blob to a container: `curl -X PUT -T http:////` +* list buckets in a storage account: `curl http:///` +* list blobs in a bucket: `curl http:///` +* add a new bucket: `curl -X PUT http:///` +* add a new blob to a bucket: `curl -X PUT -T http:////` # Logging