OCPNODE-3372: Update defaultRuntime doc to show options and set default to crun #2370
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@ngopalak-redhat: This pull request references OCPNODE-3372 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.20.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
Skipping CI for Draft Pull Request. |
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
Hello @ngopalak-redhat! Some important instructions when contributing to openshift/api: |
openshift-ci
bot
added
the
size/XS
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
|
/assign @sairameshv @haircommander |
|
/test lint |
ngopalak-redhat
force-pushed
the
ngopalak/OCPNODE-3372_defaultRuntime
branch
from
0684334 to
6cf242b
Compare
|
/retest |
ngopalak-redhat
force-pushed
the
ngopalak/OCPNODE-3372_defaultRuntime
branch
from
6cf242b to
4a4c7f8
Compare
openshift-ci
bot
added
size/S
|
/retest-required |
|
/test images |
|
/test minor-images |
|
/test images |
|
/test minor-images |
|
/retest-required |
|
/test e2e-azure |
|
/test okd-scos-e2e-aws-ovn |
|
/test minor-e2e-upgrade-minor |
|
/test okd-scos-e2e-aws-ovn |
5 similar comments
1 similar comment
ngopalak-redhat
force-pushed
the
ngopalak/OCPNODE-3372_defaultRuntime
branch
from
9334ab7 to
01d83a6
Compare
… set default to crun
…ommitted value handled in MCO
…MCO with additional test cases
…MCO with additional test cases
…MCO with additional test cases
…O with additional test cases
…O with additional test cases
…CO with additional test cases
ngopalak-redhat
force-pushed
the
ngopalak/OCPNODE-3372_defaultRuntime
branch
from
01d83a6 to
3ae73f9
Compare
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: haircommander, JoelSpeed, ngopalak-redhat 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 |
|
@ngopalak-redhat: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
openshift-merge-bot
bot
merged commit ed654ed
into
openshift:master
|
[ART PR BUILD NOTIFIER] Distgit: ose-cluster-config-api |
This PR addresses an issue in the generated documentation for the defaultRuntime option
Previously, the documentation at https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1 did not list crun and runc as valid options for defaultRuntime.
While crun became the default runtime in OpenShift 4.18 (as per release notes: https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/release_notes/ocp-4-18-release-notes), the internal constant reflecting this default was not updated, though the functionality itself was correct.
This change updates the internal documentation comments and the relevant constant to accurately reflect:
Valid options: crun and runc
Default runtime: crun
Based on the review I have also added enum validation so that the failure can be caught earlier. Unit tests are added to ensure that it doesn't break any existing functionality.