containerbuildsystem / osbs-docs Goto Github PK

The user documentation says:

Isolated builds will only update the {version}-{release} unique tag and the primary tag in target container registry.

What is "the primary tag"?

I promise to write a pull request to make this documentation clearer :)

We should update the documentation to steer users away from using the go key in container.yaml. This is the old deprecated way of performing container-first builds in OSBS.

Cachito is the replacement. To switch to Cachito, set the remote_source key instead. OSBS does not permit users to specify a go key with a remote_source key.

build_parameters.rst refers to "the downward API". What is that? Is it an OpenShift thing? Can we link to that term or explain that "for dummies"? :)

admins.rst says:

"atomic-reactor captures SIGUSR1".

Could you please give a "for dummies" example of how to send SIGUSR1 here, and what to do once the signal is sent (like how to read the backtrace log easily?)

build_parameters.rst says:

"These may change over time as the environment changes."

What does that mean exactly? Can we give an example of what we're talking about? It's confusing to me to read that "these things change", like who is changing them and why?

This section describes how we can dynamically override the parent image:

https://osbs.readthedocs.io/en/latest/users.html#override-parent-image

It does not mention how this interacts with multi-stage builds. In particular, I want to update the final image's FROM line, but not the earlier builder FROM lines, and the docs clearly tell me OSBS's behavior here.