Use commands for container push #3023
Conversation
|
The PR preview for b9dc10d is available at theforeman-foreman-documentation-preview-pr-3023.surge.sh The following output files are affected by this PR: |
Lennonka
added
Waiting on contributor
bangelic
force-pushed
the
bangelic-SAT-18579-Document-Container-Push-Workflow
branch
from
a397e98
to
790cdb5
Compare
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
There was a problem hiding this comment.
Thanks for working on this @bangelic, the changes you've made so far made it a lot easier for me to understand the context of your addition more clearly.
In this round of feedback, I'm offering mostly specific suggestions, but I also have a couple of open questions in places where I had trouble understanding what was being described.
| * Content can only be pushed to the {Project} itself. | ||
| * If pushed content needs to be on {SmartProxies} as well, use {SmartProxy} syncing. | ||
| * Podman requires that all characters in the pushed container name contain only lowercase characters. | ||
| * To push content to an organization or product, a user must be able to create repositories. |
There was a problem hiding this comment.
I've seen information about user permissions included under a .Prerequisite heading in other modules. Can you create a heading like that and move this line there?
Also, how do I know that my user is able to create repositories? Are we talking about Foreman roles/permissions? Which ones?
There was a problem hiding this comment.
@ianballou Does a user know if they have permissions to create repositories? Specific role or permissions needed? I am pushing a commit to say that a user must have permissions to create repositories in order to push content to an organization or product.
| * A repository in Katello is created once the content is pushed. | ||
| * If the organization or product does not exist, Katello sends an error telling the user to ensure the proper entities are created first. | ||
| * Subsequent pushes to the same repository updates the contents of that repository. | ||
| * Content is pulled as soon as it is pushed. |
There was a problem hiding this comment.
This is curious. The procedure mentions pulling container images manually. Does this mean that when you push a container image, that image gets automatically pulled afterwards?
I don't know what to do about this sentence, but I felt the need to mention that it confused me in the context of the whole module 🤷
There was a problem hiding this comment.
@ianballou Any chance you can provide some clarity here?
| Writing manifest to image destination | ||
| ---- | ||
|
|
||
| .Limitations on container registries |
There was a problem hiding this comment.
Can you move this subheading for it to be placed somewhere closer to the beginning of the module? I don't think the information here will be relevant after .Procedure, after users have run the command(s).
There was a problem hiding this comment.
Also, feel free to reevaluate whether including the limitations as bullet points still works if/after you implement my suggestions. It's quite possible that after the edits, regular paragraphs will make more sense.
Lennonka
added
Waiting on contributor
Containers are able to be pushed to Satellite's container registry. This command for pushing containers was needed to show the user how to do so.
Moved Limitation section. Added attribute for foreman example. Removed bullet points for continuing sentences. Addressed some style issues.
bangelic
force-pushed
the
bangelic-SAT-18579-Document-Container-Push-Workflow
branch
from
790cdb5
to
b9dc10d
Compare
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
Containers are able to be pushed to Satellite's
container registry.
This command for pushing containers was needed to show the user how to
do so.
Please cherry-pick my commits into: