eric/distributor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Update documentation to clarity bundle_id and idempotency_key usage and distinctions

Browse Source
This commit is contained in:
Eric Rakestraw
2026-06-07 20:45:29 -05:00
parent 25fbfc4677
commit f98e528c90
6 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/operations.md
View File

@@ -138,7 +138,7 @@ curl -X POST http://127.0.0.1:8080/upload \
--data-binary @bundle.tar.gz
```
For safe producer retries, include an idempotency key that is stable for the producer operation:
For safe producer retries, include an idempotency key that is stable for the same producer run and different for each distinct run:
```sh
curl -X POST http://127.0.0.1:8080/upload \
@@ -150,7 +150,7 @@ curl -X POST http://127.0.0.1:8080/upload \
Go producer applications can use `pkg/upload` instead of constructing archives and HTTP requests directly. See [Upstream Producer Integration](consumers/api.md) for the copyable producer implementation guide.
The maintained example client uses the local upload server and reads the token from `DISTRIBUTOR_EXAMPLE_UPLOAD_TOKEN`. It generates an idempotency key by default; set `DISTRIBUTOR_EXAMPLE_UPLOAD_IDEMPOTENCY_KEY` when a retry must be stable across separate process runs.
The maintained example client uses the local upload server and reads the token from `DISTRIBUTOR_EXAMPLE_UPLOAD_TOKEN`. It generates an idempotency key by default; set `DISTRIBUTOR_EXAMPLE_UPLOAD_IDEMPOTENCY_KEY` when retrying the same producer run across separate process runs.
```sh
go run ./examples/upload-client