Skip to content

Commit

Permalink
add missing parameter and ChecksumSHA256 details (#3314)
Browse files Browse the repository at this point in the history
Add missing {nodeID} parameter, add note that ChecksumSHA256 works with
AWS only
  • Loading branch information
AlekseyKorzik authored Jan 25, 2024
1 parent 2d441ec commit e9c24c1
Showing 1 changed file with 5 additions and 1 deletion.
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
Expand Up @@ -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
Expand All @@ -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**
Expand Down

0 comments on commit e9c24c1

Please sign in to comment.