Skip to content

Commit 6738ca0

Browse files
committed
rename docs
1 parent c776613 commit 6738ca0

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/source/contributor-guide/s3-credential-provider-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ under the License.
1919

2020
# S3 Credential Provider SPI: Design Notes
2121

22-
This page captures why the `org.apache.comet.cloud.s3.CometS3CredentialProvider` SPI is shaped the way it is. The user-facing contract and operator setup live in the user guide page on cloud credential providers; this page is for maintainers and reviewers who want the design rationale.
22+
This page captures why the `org.apache.comet.cloud.s3.CometS3CredentialProvider` SPI is shaped the way it is. The user-facing contract and operator setup live in the user guide page on S3 credential providers; this page is for maintainers and reviewers who want the design rationale.
2323

2424
## The gap the SPI fills
2525

docs/source/user-guide/latest/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,5 @@ to read more.
5050
Tuning Guide <tuning>
5151
Metrics Guide <metrics>
5252
Iceberg Guide <iceberg>
53-
Cloud Credential Providers <cloud-credential-providers>
53+
S3 Credential Providers <s3-credential-providers>
5454
Kubernetes Guide <kubernetes>

docs/source/user-guide/latest/cloud-credential-providers.md renamed to docs/source/user-guide/latest/s3-credential-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
1717
under the License.
1818
-->
1919

20-
# Cloud Credential Providers
20+
# S3 Credential Providers
2121

2222
Comet's native S3 readers normally fetch credentials from the standard AWS credential chain (static keys, instance profiles, environment variables, etc.). Some clusters use a vendor-managed mechanism instead, where credentials are issued per request based on a JWT or per S3 path. For those clusters, Comet supports loading a vendor-supplied bridge class that routes every native credential request through the vendor's Java code.
2323

spark/src/main/java/org/apache/comet/cloud/s3/CometS3CredentialProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
*
4646
* <p>Comet does not maintain a TTL cache, broadcast catalog state, or schedule refresh. Vendors own
4747
* caching, refresh, and any executor-side state distribution. Returns credentials or throws; there
48-
* is no fall-through return value. See the user guide on cloud credential providers for the full
48+
* is no fall-through return value. See the user guide on S3 credential providers for the full
4949
* contract and examples.
5050
*/
5151
public interface CometS3CredentialProvider {

0 commit comments

Comments
 (0)