DanielCarter-stack opened a new pull request, #11764:
URL: https://github.com/apache/seatunnel/pull/11764

   ### Improve S3File, HdfsFile, FtpFile, CosFile and ObsFile connector docs
   
   This batch continues the connector documentation improvement series and 
covers five file-system connectors. Each connector now has an additional 
example showing the production-shape authentication or deployment path most 
users actually exercise, and a few option descriptions were tightened to call 
out runtime caveats that the in-tree options do not surface on their own.
   
   #### S3File (source and sink)
   
   * Add an STS AssumeRole example (`TemporaryAWSCredentialsProvider` + 
temporary access key / secret / session token passed through 
`hadoop_s3_properties`) for cross-account or federated reads and writes.
   * Call out the SSO / Profile-provider equivalent by name so users can find 
the right provider class.
   
   #### HdfsFile (source and sink)
   
   * Source: add an HA HDFS nameservice example using `fs.defaultFS = 
hdfs://mycluster` and an external `hdfs_site_path`; explain when ViewFS vs 
standard HDFS is the right pick.
   * Sink: add an HA + Kerberos-enabled write example (`kerberos_principal` + 
`krb5_path`) and clarify that the connector does not run `kinit` itself, so 
keytab discovery is a cluster-side concern.
   
   #### FtpFile (source and sink)
   
   * Add a full SFTP example (`sftp://` URI, `fs.sftp.keyfile`, 
`fs.sftp.knownHosts`) for both source and sink.
   * Note that the connector does not cache or refresh `known_hosts` itself and 
that a missing trust file will surface as an `SftpException` on the first read.
   
   #### CosFile
   
   * Expand the `secret_id` / `secret_key` / `region` option descriptions with 
the Tencent Cloud CAM guidance (SecretId issuance path, STS-based temporary 
keys for production, region match vs cross-region cost).
   
   #### ObsFile
   
   * Add an OBS STS temporary-credential example for read paths 
(`hadoop_obs_properties` for access key, secret key and session token), plus 
the ECS Agency recommendation for jobs running inside Huawei Cloud.
   
   ### Validation
   
   * `git diff --stat` shows 16 files changed, 308 insertions, 6 deletions.
   * All code fences remain balanced (no dangling `\`\`\`` markers).
   * All HOCON examples mirror the real connector option keys exactly.
   
   ### Notes
   
   * No support-version rows were added.
   * No connectors touched in the last 7 days (by either merged or open PRs) 
were modified.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to