openshift-docs
openshift-docs copied to clipboard
openshift
OSDOCS-9984: Port BuildConfig and Jenkins books to OSD and ROSA
This PR adds the CI/CD "Builds with BuildConfig" and "Jenkins" books to the OSD and ROSA docs using single-sourcing. The CI/CD layered products (Shipwright, Pipelines, and GitOps) will be added in separate PRs.
Version(s):
enterprise-4.15+
Issue: https://issues.redhat.com/browse/OSDOCS-9984
Link to docs preview:
QE review:
- [ ] QE has approved this change.
@bhardesty: This pull request references OSDOCS-9984 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.16.0" version, but no target version was set.
In response to this:
This PR adds the CI/CD "Builds with BuildConfig" and "Jenkins" books to the OSD and ROSA docs using single-sourcing. The CI/CD layered products (Shipwright, Pipelines, and GitOps) will be added in separate PRs.
Version(s):
enterprise-4.15+Issue: https://issues.redhat.com/browse/OSDOCS-9984
Link to docs preview:
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.
🤖 Wed May 22 15:31:27 - Prow CI generated the docs preview: https://73661--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt
@bhardesty: This pull request references OSDOCS-9984 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.16.0" version, but no target version was set.
In response to this:
This PR adds the CI/CD "Builds with BuildConfig" and "Jenkins" books to the OSD and ROSA docs using single-sourcing. The CI/CD layered products (Shipwright, Pipelines, and GitOps) will be added in separate PRs.
Version(s):
enterprise-4.15+Issue: https://issues.redhat.com/browse/OSDOCS-9984
Link to docs preview:
- OSD: https://73661--ocpdocs-pr.netlify.app/openshift-dedicated/latest/cicd/
- ROSA: https://73661--ocpdocs-pr.netlify.app/openshift-rosa/latest/cicd/
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.
Unaffected file right now but I think this should be fixed as a part of this task: in the modules/images-other-jenkins-env-var.adoc in the table row for JAVA_FIPS_OPTIONS there is a Red Hat doc link and the link does not work.
Also current unaffected file but needs a check for this specific task: modules/images-other-jenkins-config-kubernetes.adoc has product version specific notes. However we did not document Jenkins for the OSD/ROSA products in these versions. Maybe condition these notes out for OSD/ROSA?
Also maybe double-check if the cicd/images/important-changes-to-openshift-jenkins-images.adoc assembly applies to OSD/ROSA? Note that there is at least one xref pointing to it too.
In modules/images-other-jenkins-agent-pod-retention.adoc there is a note about "count against resource quotas". Does OpenShift Dedicated have resource quotas?
In modules/builds-strategy-pipeline-build.adoc and modules/builds-understanding-openshift-pipeline.adoc and modules/builds-strategy-pipeline-environment-variables.adoc (might be others I didn't notice) there is a note that includes the statement "Equivalent and improved functionality is present in the Red Hat OpenShift Service on AWS Pipelines based on Tekton." (Copied from ROSA but obviously {product-title} is used)
That functionality is Pipelines and as of now it is not documented in ROSA and OSD - maybe condition all or part of these notes out for ROSA and OSD?
In modules/images-other-jenkins-config-kubernetes.adoc and maybe other places too (please check), there are notes about "version 4.10 and later" and they render for ROSA too. Yet ROSA does not have 4.xx versions, it is just 4, so I would suggest finding all such notes and conditioning them out for ROSA (and possibly OSD). The "Important changes" part does not seem to make sense for ROSA at all because it relies on 4.xx versions.
Unaffected file right now but I think this should be fixed as a part of this task: in the modules/images-other-jenkins-env-var.adoc in the table row for JAVA_FIPS_OPTIONS there is a Red Hat doc link and the link does not work.
I fixed the link.
Also current unaffected file but needs a check for this specific task: modules/images-other-jenkins-config-kubernetes.adoc has product version specific notes. However we did not document Jenkins for the OSD/ROSA products in these versions. Maybe condition these notes out for OSD/ROSA?
That's true. However, OSD and ROSA are versionless. Once we publish the Jenkins content for OSD and ROSA, it will be available to all customer regardless of what version of OpenShift they're actually running. It's possible (though unlikely) that some could even be running 4.11.
Also maybe double-check if the cicd/images/important-changes-to-openshift-jenkins-images.adoc assembly applies to OSD/ROSA? Note that there is at least one xref pointing to it too.
This should still apply to OSD and ROSA.
In modules/images-other-jenkins-agent-pod-retention.adoc there is a note about "count against resource quotas". Does OpenShift Dedicated have resource quotas?
Yep :-)
"Equivalent and improved functionality is present in the
For now, I'm just going to condition these sections out of the OSD/ROSA docs. Since the feature is deprecated, OSD/ROSA users shouldn't be using it. Once the OpenShift Pipelines content is added to the OSD/ROSA docs, we can uncondition this content to add it back.
In modules/images-other-jenkins-config-kubernetes.adoc and maybe other places too (please check), there are notes about "version 4.10 and later" and they render for ROSA too. Yet ROSA does not have 4.xx versions, it is just 4, so I would suggest finding all such notes and conditioning them out for ROSA (and possibly OSD). The "Important changes" part does not seem to make sense for ROSA at all because it relies on 4.xx versions.
This is one of the challenging aspects of OSD/ROSA - they are versionless products, but customers still install and upgrade to specific versions of OpenShift. So we have one set of docs that apply to all supported OpenShift versions. Practically, this means that we still need to call out OpenShift version-specific things, because users do need to be aware of what version they're running.
In modules/images-other-jenkins-config-kubernetes.adoc and maybe other places too (please check), there are notes about "version 4.10 and later" and they render for ROSA too. Yet ROSA does not have 4.xx versions, it is just 4, so I would suggest finding all such notes and conditioning them out for ROSA (and possibly OSD). The "Important changes" part does not seem to make sense for ROSA at all because it relies on 4.xx versions.
This is one of the challenging aspects of OSD/ROSA - they are versionless products, but customers still install and upgrade to specific versions of OpenShift. So we have one set of docs that apply to all supported OpenShift versions. Practically, this means that we still need to call out OpenShift version-specific things, because users do need to be aware of what version they're running.
I would, in this case, suggest changing the text (and other version-specific texts) for OSD and ROSA to use "OpenShift version" instead of "{product-name} version" to make things clearer.
@bhardesty: 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.
![openshift-ci[bot] avatar](https://avatars.githubusercontent.com/in/91280?v=4 "Published by a pub.dev verified publisher"){kind=small}
@jeana-redhat: new pull request created: #76366
In response to this:
/cherrypick enterprise-4.16
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.
@jeana-redhat: new pull request created: #76367
In response to this:
/cherrypick enterprise-4.15
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.