catalog embed-readonly
Embed read-only S3 credentials into the catalog’s git-annex branch.
Lets consumers cloning the catalog fetch annexed content without supplying credentials of their own. One of --env-file or --env-prefix is required.
Before embedding, the command probes the bucket by initiating (and canceling) a multipart upload with the supplied credentials. If that write succeeds, the credentials aren’t read-only and the command raises an error instead of embedding them. Embedding sets embedcreds=yes on the S3 remote config and writes the result to remote.log on the git-annex branch.
Usage
xorq catalog embed-readonly [OPTIONS]Options
| Option | Default | Description |
|---|---|---|
--env-file |
none | Env file for the annex remote (for example .env.catalog.s3; mutually exclusive with –env-prefix). |
--env-prefix |
none | Env-var prefix for the annex remote (for example XORQ_CATALOG_S3_; mutually exclusive with –env-file). |
--gcs |
off | Apply GCS defaults to the S3 remote config. |
Examples
xorq catalog embed-readonly --env-file .env.catalog.readonly
xorq catalog embed-readonly --env-prefix XORQ_CATALOG_RO_