Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#5315] doc(iceberg): add credential vending document for Iceberg REST Server #5314

Merged
merged 7 commits into from
Oct 29, 2024

Conversation

FANNG1
Copy link
Contributor

@FANNG1 FANNG1 commented Oct 28, 2024

What changes were proposed in this pull request?

add credential vending document for Iceberg REST Server

Why are the changes needed?

Fix: #5315

Does this PR introduce any user-facing change?

no

How was this patch tested?

just document

@FANNG1 FANNG1 changed the title [] doc(iceberg): add credential vending document for Iceberg REST Server [#5315] doc(iceberg): add credential vending document for Iceberg REST Server Oct 28, 2024
@FANNG1
Copy link
Contributor Author

FANNG1 commented Oct 28, 2024

@jerryshao @yuqi1129 @jerqi please help to review when you have time, thanks

@@ -361,7 +371,7 @@ For example, we can configure Spark catalog options to use Gravitino Iceberg RES
--conf spark.sql.catalog.rest.uri=http://127.0.0.1:9001/iceberg/
```

You may need to adjust the Iceberg Spark runtime jar file name according to the real version number in your environment. If you want to access the data stored in cloud, you need to download corresponding jars (please refer to the cloud storage part) and place it in the classpath of Spark, no extra config is needed because related properties is transferred from Iceberg REST server to Iceberg REST client automatically.
You may need to adjust the Iceberg Spark runtime jar file name according to the real version number in your environment. If you want to access the data stored in cloud, you need to download corresponding jars (please refer to the cloud storage part) and place it in the classpath of Spark, no extra config is needed if you enable credential vending in the server side by setting `credential-provider-type` and enable credential vending request in client side by setting `spark.sql.catalog.rest.header.X-Iceberg-Access-Delegation` = `vended-credentials`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This sentence is too long, you should break it into several short sentences.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@@ -371,7 +371,7 @@ For example, we can configure Spark catalog options to use Gravitino Iceberg RES
--conf spark.sql.catalog.rest.uri=http://127.0.0.1:9001/iceberg/
```

You may need to adjust the Iceberg Spark runtime jar file name according to the real version number in your environment. If you want to access the data stored in cloud, you need to download corresponding jars (please refer to the cloud storage part) and place it in the classpath of Spark, no extra config is needed if you enable credential vending in the server side by setting `credential-provider-type` and enable credential vending request in client side by setting `spark.sql.catalog.rest.header.X-Iceberg-Access-Delegation` = `vended-credentials`.
You may need to adjust the Iceberg Spark runtime jar file name according to the real version number in your environment. If you want to access the data stored in cloud, you need to download corresponding jars (please refer to the cloud storage part) and place it in the classpath of Spark. If you want to enable credential vending, please setting `credential-provider-type` to proper value in server side, setting `spark.sql.catalog.rest.header.X-Iceberg-Access-Delegation` = `vended-credentials` in client side.
Copy link
Contributor

Choose a reason for hiding this comment

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

There are "two" whitespaces before "please", please remove one.

"please set xxx to a proper value in the server side, set xxx in the client side."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@FANNG1 FANNG1 added the branch-0.7 Automatically cherry-pick commit to branch-0.7 label Oct 29, 2024
@FANNG1 FANNG1 merged commit 608b53c into apache:main Oct 29, 2024
26 checks passed
github-actions bot pushed a commit that referenced this pull request Oct 29, 2024
…T Server (#5314)

### What changes were proposed in this pull request?

 add credential vending document for Iceberg REST Server

### Why are the changes needed?

Fix: #5315 

### Does this PR introduce _any_ user-facing change?

no

### How was this patch tested?

just document
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch-0.7 Automatically cherry-pick commit to branch-0.7
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Improvement] add credential vending document for IcebergRESTServer
2 participants