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

add missing parameter and ChecksumSHA256 details #3314

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/docs/setting-up/other-specifications/publishers/s3.md
Original file line number Diff line number Diff line change
@@ -30,7 +30,9 @@ Results published to S3 are stored as objects that can also be used as inputs to
- **VersionID**: The version ID of the stored object, enabling versioning support for retrieving specific versions of stored data.
- **ChecksumSHA256**: The SHA-256 checksum of the stored object, providing a method to verify data integrity.

**Note:** `ChecksumSHA256` and `VersionID` are only returned when the `Compress` option is enabled, offering users a method to verify the integrity of the compressed data and to track different versions of the stored objects.
**Note:**
- `ChecksumSHA256` and `VersionID` are only returned when the `Compress` option is enabled, offering users a method to verify the integrity of the compressed data and to track different versions of the stored objects.
- `ChecksumSHA256` is set only when working with AWS S3, but is not set for all other S3-compatible services.


## Dynamic Naming
@@ -41,9 +43,11 @@ Bacalhau supports the following dynamic placeholders that will be replaced with

- `{executionID}`: Replaced with the specific execution ID.
- `{jobID}`: Replaced with the ID of the job.
- `{nodeID}`: Replaced with the ID of the node where the execution took place
- `{date}`: Replaced with the current date in the format `YYYYMMDD`.
- `{time}`: Replaced with the current time in the format `HHMMSS`.


Additionally, if you are publishing an archive and the object key does not end with `.tar.gz`, it will be automatically appended. Conversely, if you're not archiving and the key doesn't end with a `/`, a trailing slash will be added.

**Example**