Skip to content

Commit dcbab4b

Browse files
committed
[S3AG] add documentation for S3AG
1 parent 2bc7c41 commit dcbab4b

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!---
2+
Licensed under the Apache License, Version 2.0 (the "License");
3+
you may not use this file except in compliance with the License.
4+
You may obtain a copy of the License at
5+
6+
http://www.apache.org/licenses/LICENSE-2.0
7+
8+
Unless required by applicable law or agreed to in writing, software
9+
distributed under the License is distributed on an "AS IS" BASIS,
10+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
See the License for the specific language governing permissions and
12+
limitations under the License. See accompanying LICENSE file.
13+
-->
14+
15+
# S3 Access Grants
16+
17+
<!-- MACRO{toc|fromDepth=0|toDepth=5} -->
18+
19+
S3 Access Grants is a credential vending service for S3 data. More information:
20+
* https://aws.amazon.com/s3/features/access-grants/
21+
22+
In S3A, S3 Access Grants Plugin is used to support S3 Access Grants. More information:
23+
* https://github.com/aws/aws-s3-accessgrants-plugin-java-v2/
24+
25+
26+
27+
## How to enable S3 Access Grants in S3A
28+
29+
1. Add the `hadoop-aws` JAR on your classpath.
30+
31+
1. Add the `aws-java-sdk-bundle.jar` JAR to your classpath, the minimum version is v2.23.7.
32+
33+
2. Add the `aws-s3-accessgrants-java-plugin-2.0.0.jar` JAR to your classpath.
34+
3. Add the `caffeine.jar` JAR to your classpath.
35+
36+
1. Add configurations to enable S3 Access Grants in `core-site.xml`
37+
38+
39+
40+
Example:
41+
42+
```xml
43+
<configuration>
44+
...
45+
<property>
46+
<name>fs.s3a.accessgrants.enabled</name>
47+
<value>true</value>
48+
<description>Enable S3 Access Grants or not</description>
49+
</property>
50+
<property>
51+
<name>fs.s3a.accessgrants.fallbacktoiam</name>
52+
<value>false</value>
53+
<description>Enable IAM Policy as fallback or not</description>
54+
</property>
55+
...
56+
</configuration>
57+
```
58+
59+
60+
61+

0 commit comments

Comments
 (0)