docs: Add documentation for runtime presets #3053
Conversation
This will help us avoid any unfortunate typos. This commit does not replace instances of the term "OpenShift" in the documentation at this time. This will be addressed in the future.
kowen-rh
added
the
status/peer review required
|
|
||
| [role="_abstract"] | ||
| {prod} presets represent a managed container runtime and the lower bounds of system resources required by the instance to run it. | ||
| {prod} offers presets for {ocp} and the Podman container runtime. |
There was a problem hiding this comment.
I didn't see the need to create one. The attributes for OpenShift largely exist to avoid unfortunate typos when the "f" key is missed. ;)
If we foresee the name of Podman itself (or the podman preset) to change, we should probably create an attribute for it.
| ==== | ||
| You cannot change the preset of an existing {prod} instance. | ||
| Preset changes are only applied when a {prod} instance is created. | ||
| To enable preset changes, you must delete the existing instance and start a new one. |
There was a problem hiding this comment.
Not sure how this will stand out in the documentation. It briefly touches on 'delete'. Will have to check the rendered version.
There was a problem hiding this comment.
I placed the content under an "important" admonition to (hopefully) encourage careful reading of it. Do you think we should make this more visible somehow?
kowen-rh
force-pushed
the
docs-add-presets
branch
from
4531005 to
7efe963
Compare
kowen-rh
force-pushed
the
docs-add-presets
branch
from
7efe963 to
e53c662
Compare
|
Approved |
|
@gbraad Addressed Brian's concerns and the M1 support (just reverted back to our original wording). Are there any other requested changes? |
kowen-rh
force-pushed
the
docs-add-presets
branch
from
e53c662 to
89871d7
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: gbraad, robin-owen The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
4 participants
Solution/Idea
Add documentation for the use and configuration of container runtime presets.
Note that this PR also contains the introduction of the
{openshift}and{ocp}attributes and fixes a few small errors I encountered while updating the content. These changes have all been isolated to their own commits.Proposed changes
crc setupdocumentation to include information about selecting thepodmanpreset for Linux users.