Skip to content

Conversation

@k37y
Copy link
Contributor

@k37y k37y commented Dec 15, 2025

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 15, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 15, 2025

@k37y: This pull request references KFLUXMIG-940 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 sub-task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Add documentation explaining that Jenkins images from OpenShift 4.12 onward bundle a newer oc client by default and show how to pin a specific oc version using the tools stanza in Jenkins pipelines.

Version(s):

4.12
4.13
4.14
4.15
4.16
4.17
4.18
4.19
4.20

Issue:

https://issues.redhat.com/browse/KFLUXMIG-940

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 15, 2025
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 15, 2025
@k37y k37y force-pushed the kfluxmig-940 branch 5 times, most recently from 5ab537b to e4afc33 Compare December 15, 2025 17:35
@k37y
Copy link
Contributor Author

k37y commented Dec 16, 2025

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 16, 2025
@prdhamdh
Copy link

/verified by @prdhamdh

@k37y
Copy link
Contributor Author

k37y commented Dec 16, 2025

/cherry-pick release-4.20 release-4.19 release-4.18 release-4.17 release-4.16 release-4.15 release-4.14 release-4.13 release-4.12

@openshift-cherrypick-robot

@k37y: once the present PR merges, I will cherry-pick it on top of release-4.20 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-4.20 release-4.19 release-4.18 release-4.17 release-4.16 release-4.15 release-4.14 release-4.13 release-4.12

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.

@k37y
Copy link
Contributor Author

k37y commented Dec 16, 2025

/cherry-pick enterprise-4.20

@openshift-cherrypick-robot

@k37y: once the present PR merges, I will cherry-pick it on top of enterprise-4.20 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick enterprise-4.20

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.

@ShaunaDiaz ShaunaDiaz added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Dec 16, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 16, 2025

@k37y: This pull request references KFLUXMIG-940 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 sub-task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Add documentation explaining that Jenkins images from OpenShift 4.12 onward bundle a newer oc client by default and show how to pin a specific oc version using the tools stanza in Jenkins pipelines.

Version(s):

4.12
4.13
4.14
4.15
4.16
4.17
4.18
4.19
4.20

Issue:

https://issues.redhat.com/browse/KFLUXMIG-940

Link to docs preview:
https://103911--ocpdocs-pr.netlify.app/openshift-dedicated/latest/cicd/jenkins/important-changes-to-openshift-jenkins-images.html
https://103911--ocpdocs-pr.netlify.app/openshift-enterprise/latest/cicd/jenkins/important-changes-to-openshift-jenkins-images.html
https://103911--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/cicd/jenkins/important-changes-to-openshift-jenkins-images.html
https://103911--ocpdocs-pr.netlify.app/openshift-rosa/latest/cicd/jenkins/important-changes-to-openshift-jenkins-images.html

QE review:

  • QE has approved this change.

Additional information:

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.

Copy link
Contributor

@ShaunaDiaz ShaunaDiaz left a comment

Choose a reason for hiding this comment

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

Looks good! I know, a lot of comments. We are preparing for a docs tooling conversion and don't want to introduce new errors to the repo.


If your Jenkins pipelines require a *specific* `oc` client version for compatibility or reproducibility, you must explicitly configure the desired client version in the Jenkins pipeline DSL.

== OpenShift Jenkins release vs Bundled `oc` client version
Copy link
Contributor

Choose a reason for hiding this comment

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

this should be a separate Reference module

@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 17, 2025
@@ -0,0 +1,98 @@
// Module included in the following assemblies:
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.


:_mod-docs-content-type: PROCEDURE

[id="about-the-openshift-cli-in-jenkins-images_{context}"]
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID.

[role="_abstract"]
You can ensure that your Jenkins pipeline uses your specified `oc` client version with the Jenkins container image by configuring the version you require.
* Define the `oc` tool version explicitly in the pipeline configuration to use a specific OpenShift client version in a Jenkins pipeline as shown in the following example:
.Example pipeline configuration
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskTitle: Unsupported titles cannot be mapped to DITA tasks.

Copy link
Contributor

Choose a reason for hiding this comment

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

this error will go away once you have this procedure in a standalone module


If your Jenkins pipelines require a *specific* `oc` client version for compatibility or reproducibility, you must explicitly configure the desired client version in the Jenkins pipeline DSL.

// Module included in the following assemblies:
Copy link
Contributor

Choose a reason for hiding this comment

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

this should start a new module

| 4.16, 4.17, 4.18, 4.19, 4.20
|===

// Module included in the following assemblies:
Copy link
Contributor

Choose a reason for hiding this comment

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

this should start a new module

:_mod-docs-content-type: PROCEDURE
[id="specify-oc-ocp-jenkins-image_context"]
= Specify a fixed `oc` client version for OpenShift Jenkins images
[role="_abstract"]
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
[role="_abstract"]
[role="_abstract"]

need a line space here

[role="_abstract"]
You can ensure that your Jenkins pipeline uses your specified `oc` client version with the Jenkins container image by configuring the version you require.
* Define the `oc` tool version explicitly in the pipeline configuration to use a specific OpenShift client version in a Jenkins pipeline as shown in the following example:
.Example pipeline configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

this error will go away once you have this procedure in a standalone module

// * cicd/jenkins/important-changes-to-openshift-jenkins-images.adoc

:_mod-docs-content-type: REFERENCE
[id="ocp-jenkins-release-oc-client-table_{context}"]
Copy link
Contributor

Choose a reason for hiding this comment

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

you can use the id as the filename to keep things consistent; so make this a module that is called:

ocp-jenkins-release-oc-client-table.adoc

(same with the procedure; you can reuse the ID as the filename)

include::modules/customizing-the-jenkins-image-stream-tag.adoc[leveloffset=+1]

include::modules/usage-of-latest-openshift-client.adoc[leveloffset=+1]

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
include::modules/specify-oc-ocp-jenkins-image[leveloffset=+1]
include::modules/ocp-jenkins-release-oc-client-table.adoc[leveloffset=+1]

after you make the module files, you add the include statements to the assembly

@k37y k37y force-pushed the kfluxmig-940 branch 3 times, most recently from cbc9ace to bbc648c Compare December 17, 2025 12:34
@@ -0,0 +1,31 @@
// Module included in the following assemblies:
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.

// * cicd/jenkins/important-changes-to-openshift-jenkins-images.adoc

:_mod-docs-content-type: PROCEDURE
[id="specifying-oc-ocp-jenkins-image_context"]
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID.

:_mod-docs-content-type: PROCEDURE
[id="specifying-oc-ocp-jenkins-image_context"]
= Specifying a fixed `oc` client version for OpenShift Jenkins images
[role="_abstract"]
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.AuthorLine: Author lines are not supported for topics.

* Define the `oc` tool version explicitly in the pipeline configuration to use a specific OpenShift client version in a Jenkins pipeline as shown in the following example:
.Example pipeline configuration
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskTitle: Unsupported titles cannot be mapped to DITA tasks.

@ShaunaDiaz
Copy link
Contributor

/test validate-portal

* Define the `oc` tool version explicitly in the pipeline configuration to use a specific OpenShift client version in a Jenkins pipeline as shown in the following example:
.Example pipeline configuration
[source,groovy,subs="attributes+"]
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
[source,groovy,subs="attributes+"]
[source,terminal,subs="attributes+"]

try this and let's see if it builds
i see a rather cryptic error: "�[31m�[1mattributes construct error, line 1597, column 17 (master.xml, line 1597)�[0m"

Add documentation explaining that Jenkins images from OpenShift 4.12 onward
bundle a newer oc client by default and show how to pin a specific oc version
using the tools stanza in Jenkins pipelines.

Signed-off-by: Vinu Kochukuttan <[email protected]>
@k37y
Copy link
Contributor Author

k37y commented Dec 18, 2025

/test validate-portal

3 similar comments
@k37y
Copy link
Contributor Author

k37y commented Dec 18, 2025

/test validate-portal

@k37y
Copy link
Contributor Author

k37y commented Dec 18, 2025

/test validate-portal

@k37y
Copy link
Contributor Author

k37y commented Dec 19, 2025

/test validate-portal

@openshift-ci
Copy link

openshift-ci bot commented Dec 19, 2025

@k37y: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-portal 0167e9a link true /test validate-portal

Full PR test history. Your PR dashboard.

Details

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants