Skip to content

[#6229] docs: add fileset credential vending example#6231

Merged
jerryshao merged 4 commits intoapache:mainfrom
FANNG1:add_credential
Jan 14, 2025
Merged

[#6229] docs: add fileset credential vending example#6231
jerryshao merged 4 commits intoapache:mainfrom
FANNG1:add_credential

Conversation

@FANNG1
Copy link
Contributor

@FANNG1 FANNG1 commented Jan 14, 2025

What changes were proposed in this pull request?

add credential vending document for fileset

Why are the changes needed?

Fix: #6229

Does this PR introduce any user-facing change?

no

How was this patch tested?

just document

@FANNG1 FANNG1 changed the title [#6229] docs: add credential vending document for fileset [#6229] docs: add fileset credential vending example Jan 14, 2025
@FANNG1 FANNG1 added the branch-0.8 Automatically cherry-pick commit to branch-0.8 label Jan 14, 2025
@FANNG1 FANNG1 self-assigned this Jan 14, 2025
Apart from configuration method in [create-adls-hadoop-catalog](#configuration-for-a-adls-hadoop-catalog), properties needed by [adls-credential](./security/credential-vending.md#adls-credentials) should also be set to enable credential vending for ADLS fileset. Take `adls-token` credential provider for example:

### How to access ADLS fileset with credential
```shell
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we need to move this example forward and put it with example without credential?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we mix the example with the example without credentials, it will be hard to distinguish them especially in fileset client side

@yuqi1129
Copy link
Contributor

@mchades Would you like to take a look?

```shell
curl -X POST -H "Accept: application/vnd.gravitino.v1+json" \
-H "Content-Type: application/json" -d '{
"name": "example_catalog",
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please rename example_catalog to make it related to adls? the same goes for S3, GCS and OSS.

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

@jerryshao jerryshao merged commit 5cffeb4 into apache:main Jan 14, 2025
25 checks passed
github-actions bot pushed a commit that referenced this pull request Jan 14, 2025
### What changes were proposed in this pull request?

add credential vending document for fileset

### Why are the changes needed?

Fix: #6229 

### 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.8 Automatically cherry-pick commit to branch-0.8

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Improvement] add credential vending examples for fileset document

3 participants