Skip to content

TELCODOCS-2304: Make the operator configuration persistent during clu… #95124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

StephenJamesSmith
Copy link
Contributor

@StephenJamesSmith StephenJamesSmith commented Jun 23, 2025

Make the operator configuration persistent during cluster/operator upgrades

Version(s):
openshift-4.19
KMMO 2.4

Issue:
https://issues.redhat.com/browse/TELCODOCS-2304

Link to docs preview:
https://95124--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hardware_enablement/kmm-kernel-module-management.html#kmm-configuring-kmmo_kernel-module-management-operator

Dev: @ybettan
QE: @cdvultur

QE review:

  • QE has approved this change.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 23, 2025

@StephenJamesSmith: This pull request references TELCODOCS-2304 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 story to target the "4.20.0" version, but no target version was set.

In response to this:

Make the operator configuration persistent during cluster/operator upgrades

Version(s):
openshift-4.19
KMMO 2.4

Issue:
https://issues.redhat.com/browse/TELCODOCS-2304

Link to docs preview:

Dev: @ybettan
QE: @cdvultur

QE review:

  • QE has approved this change.

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.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 23, 2025
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 23, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jun 23, 2025

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 23, 2025

@StephenJamesSmith: This pull request references TELCODOCS-2304 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 story to target the "4.20.0" version, but no target version was set.

In response to this:

Make the operator configuration persistent during cluster/operator upgrades

Version(s):
openshift-4.19
KMMO 2.4

Issue:
https://issues.redhat.com/browse/TELCODOCS-2304

Link to docs preview:
https://95124--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hardware_enablement/kmm-kernel-module-management.html#kmm-configuring-kmmo_kernel-module-management-operator

Dev: @ybettan
QE: @cdvultur

QE review:

  • QE has approved this change.

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.

@StephenJamesSmith
Copy link
Contributor Author

@ybettan @cdvultur Changes made. Please review and /lgtm if all is good.

@ybettan
Copy link
Member

ybettan commented Jun 24, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 24, 2025
Copy link

@cdvultur cdvultur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@StephenJamesSmith
Copy link
Contributor Author

/label telco

@openshift-ci openshift-ci bot added the telco Label for all Telco PRs label Jun 24, 2025
@StephenJamesSmith
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 24, 2025
@jldohmann jldohmann added peer-review-in-progress Signifies that the peer review team is reviewing this PR branch/enterprise-4.19 branch/enterprise-4.20 labels Jun 24, 2025
@jldohmann jldohmann added this to the Continuous Release milestone Jun 24, 2025
Copy link
Contributor

@jldohmann jldohmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice work! mostly just left some questions and suggestions below


[NOTE]
====
If you want to configure `KMM Hub`, create the `ConfigMap` using the name `kmm-operator-hub-manager-config` in the KMM-hub controller's namespace.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it KMM-hub, or KMM Hub? both variations being used here without any additional context is kind of confusing

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are the same. You can rephrase this to use only KMM-hub or KMM Hub.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to "KMM Hub".

|`webhook.disableHTTP2`
|If `true`, disables HTTP/2 for the webhook server, as a mitigation for link:https://access.redhat.com/security/cve/cve-2023-44487[cve-2023-44487]. The recommended value is `true`.
|`metrics.bindAddress`
|Determines the bind address for the metrics server. If unspecified, the default is `:8080`. To disable the metrics server, set to `0`. The default value is `0.0.0.0:8443`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so is the default :8080 or 0.0.0.0:8443?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:8080 is a mistake. I am currently fixing it in the dev documentation with kubernetes-sigs/kernel-module-management#1147.
@StephenJamesSmith you can use the diff from the PR I have linked to fix this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made @ybettan's change.

|`metrics.bindAddress`
|Determines the bind address for the metrics server. If unspecified, the default is `:8080`. To disable the metrics server, set to `0`. The recommended value is `0.0.0.0:8443`.
|`webhook.disableHTTP2`
|If `true`, disables HTTP/2 for the webhook server, as a mitigation for link:https://access.redhat.com/security/cve/cve-2023-44487[cve-2023-44487]. The default value is `true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|If `true`, disables HTTP/2 for the webhook server, as a mitigation for link:https://access.redhat.com/security/cve/cve-2023-44487[cve-2023-44487]. The default value is `true`.
|If `true`, disables HTTP/2 for the webhook server, as a mitigation for link:https://access.redhat.com/security/cve/cve-2023-44487[CVE-2023-44487]. The default value is `true`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.


|`worker.seLinuxType`
|Determines the value of the `seLinuxOptions.type` field of the worker container's security context. For more information, see link:https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[SecurityContext]. The recommended value is `spc_t`.
|Determines the value of the `seLinuxOptions.type` field of the worker container's security context. For more information, see link:https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[SecurityContext]. The default value is `spc_t`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|Determines the value of the `seLinuxOptions.type` field of the worker container's security context. For more information, see link:https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[SecurityContext]. The default value is `spc_t`.
|Determines the value of the `seLinuxOptions.type` field of the worker container's security context. For more information, see link:https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[SecurityContext]. The default value is `spc_t`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

|`worker.setFirmwareClassPath`
|Sets the kernel's firmware search path into the `/sys/module/firmware_class/parameters/path` file on the node. The recommended value is `/var/lib/firmware` if you need to set that value through the worker app. Otherwise, unset.
|`worker.firmwareHostPath`
|If set, the value of this field is written by the worker into the /sys/module/firmware_class/parameters/path file on the node. For more information see link:https://openshift-kmm.netlify.app/documentation/firmwares/#setting-the-kernels-firmware-search-path[Setting the kernel's firmware search path]. The default value is `/var/lib/firmware`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

worker container? might be useful to specify here to avoid confusion with worker node

Suggested change
|If set, the value of this field is written by the worker into the /sys/module/firmware_class/parameters/path file on the node. For more information see link:https://openshift-kmm.netlify.app/documentation/firmwares/#setting-the-kernels-firmware-search-path[Setting the kernel's firmware search path]. The default value is `/var/lib/firmware`.
|If set, the value of this field is written by the worker container into the /sys/module/firmware_class/parameters/path file on the node. For more information see link:https://openshift-kmm.netlify.app/documentation/firmwares/#setting-the-kernels-firmware-search-path[Setting the kernel's firmware search path]. The default value is `/var/lib/firmware`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added "container".

@jldohmann jldohmann added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 24, 2025
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 25, 2025
Copy link

openshift-ci bot commented Jun 25, 2025

New changes are detected. LGTM label has been removed.

Copy link

openshift-ci bot commented Jun 25, 2025

@StephenJamesSmith: all tests passed!

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.19 branch/enterprise-4.20 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files. telco Label for all Telco PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants