openshift-docs
openshift-docs copied to clipboard
OSDOCS#7763: Updating OSD documentation to be cloud agnostic or have GCP references included
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
- Log output types - added cloudlogging into the Output type descriptions section.
- Enabling stream-based retention for Loki - Added two examples - Example global stream-based retention for GCP and Example per-tenant stream-based retention for GCP.
- Cloudwatch recommendation for OpenShift Dedicated - Removed "Cloudwatch recommendation for OpenShift Dedicated section.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
Note: Before and after images are attached to OSDOCS-7763 for ease of viewing.
QE review:
- [x] QE has approved this change.
Additional information:
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
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.
🤖 Thu May 16 22:13:19 - Prow CI generated the docs preview: https://75001--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview: General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview: General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS. Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent. Using bound service account tokens - Added GCP IAM to first paragraph.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview: General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS. Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent. Using bound service account tokens - Added GCP IAM to first paragraph. Scope of the network reply - The last bullet point now includes OCP reference and link, as well.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview: General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS. Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent. Using bound service account tokens - Added GCP IAM to first paragraph. Scope of the network reply - The last bullet point now includes OCP reference and link, as well. oc adm release extract - Added note before the example. oc image mirror - Added note before the example. Showing data collected by Telemetry
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview: General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS. Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent. Using bound service account tokens - Added GCP IAM to first paragraph. Scope of the network reply - The last bullet point now includes OCP reference and link, as well. oc adm release extract - Added note before the example. oc image mirror - Added note before the example. Showing data collected by Telemetry - Added note before the example. Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network reply - The last bullet point now includes OCP reference and link, as well.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network reply - The last bullet point now includes OCP reference and link, as well.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network reply - The last bullet point now includes OCP reference and link, as well.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
- Log output types - added cloudlogging into the Output type descriptions table.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: This pull request references OSDOCS-7763 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 epic to target the "4.16.0" version, but no target version was set.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
- Log output types - added cloudlogging into the Output type descriptions section.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@eohartman: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.
In response to this:
Version(s): 4.15
Issue: OSDOCS-7763
Link to docs preview:
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Using bound service account tokens - Added GCP IAM to first paragraph.
- Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
- Log output types - added cloudlogging into the Output type descriptions section.
The following have a note added above the example:
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
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.
@lento-sun @shreyansvm @abhgupta Can y'all please take a look at this PR? I still have a couple more questions that need answering, but I'd like to go ahead and at least get a preliminary review.
Thank you!
@yuwang-RH Can you please QE this PR? Thank you!
Network Verifier feature is today supported on ROSA and OSD-AWS, but NOT on OSD-GCP. There is a roadmap item to support this during 2H-2025. Here's the feature tracking Network Verifier support on OSD-GCP - XCMSTRAT-477
- Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
As per OCP 4.15 documentation, "gcp-gke" is not a supported value for PodIdentity. Reference OCP 4.15 documentation.
- Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
This link is broken. So couldn't review.
- Log output types - added cloudlogging into the Output type descriptions section.
These updates look okay
- General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
- Using bound service account tokens - Added GCP IAM to first paragraph.
@lento-sun, @xueli181114 / QE team : can you please confirm the following along with rest of the review?
- Information collected by the Insights Operator - The fifth bullet point no longer mentions AWS. Additionally, removed a period from another bullet point so they're all consistent.
- Enabling stream-based retention for Loki - Added two examples - Example global stream-based retention for GCP and Example per-tenant stream-based retention for GCP.
"CloudWatch recommendation for OpenShift Dedicated" was a section header. Now that this is removed, QE team - can you please check if the rest of the flow, logging requirements and configurations look okay?
- Cloudwatch recommendation for OpenShift Dedicated - Removed "Cloudwatch recommendation for OpenShift Dedicated section.
These look okay. QE team, do you have corresponding GCP examples that we can add here?
- oc adm release extract - Added note before the example.
- oc image mirror - Added note before the example.
- Showing data collected by Telemetry - Added note before the example.
- Understanding how to use pod disruption budgets to specify the number of pods that must be up - Added note before the example.
Network Verifier feature is today supported on ROSA and OSD-AWS, but NOT on OSD-GCP. There is a roadmap item to support this during 2H-2025. Here's the feature tracking Network Verifier support on OSD-GCP - XCMSTRAT-477
-
I have removed network verifier reference.
-
Apologies on broken link for log output types - this is what happens when multiple writers are working on projects simultaneously. I have corrected the link in the origin description, and it's also here: https://75001--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/logging/log_collection_forwarding/logging-output-types#logging-output-types-descriptions
/retest
@eohartman: 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.
/lgtm
/cherrypick enterprise-4.15
/cherrypick enterprise-4.16
@EricPonvelle: new pull request created: #76204
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.
@EricPonvelle: new pull request created: #76205
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.