Skip to content

Commit

Permalink
Merge pull request #563 from cgwalters/doc-cred-helper
Browse files Browse the repository at this point in the history
secrets: Doc credential helper
  • Loading branch information
cgwalters authored May 29, 2024
2 parents 282ec39 + 562028f commit 23c779d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/src/building/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
# Secrets (e.g. container pull secrets)

To have `bootc` fetch updates from registry which requires authentication,
you must include a pull secret in `/etc/ostree/auth.json`.
you must include a pull secret in `/etc/ostree/auth.json` (or
as of recent versions in `/usr/lib/ostree/auth.json`).

Another common case is to also fetch container images via
`podman` or equivalent. There is a [pull request to add `/etc/containers/auth.json`](https://github.com/containers/image/pull/1746)
Expand All @@ -12,6 +13,13 @@ Regardless, injecting this data is a good example of a generic
"secret". The bootc project does not currently include one
single opinionated mechanism for secrets.

## Using a credential helper

In order to use a credential helper as configured in `registries.conf`
such as `credential-helpers = ["ecr-login"]`, you must currently
also write a "no-op" authentication file with the contents `{}` (i.e. an
empty JSON object, not an empty file) into the pull secret location.

## Embedding in container build

This was mentioned above; you can include secrets in
Expand Down

0 comments on commit 23c779d

Please sign in to comment.