openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

OSDOCS#7763: Updating OSD documentation to be cloud agnostic or have GCP references included

Open eohartman opened this issue 1 year ago • 19 comments
trafficstars

Issue: OSDOCS-7763

Link to docs preview:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
  5. Log output types - added cloudlogging into the Output type descriptions section.
  6. 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.
  7. Cloudwatch recommendation for OpenShift Dedicated - Removed "Cloudwatch recommendation for OpenShift Dedicated section.

The following have a note added above the example:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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 avatar Apr 22 '24 19:04 eohartman

@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.

openshift-ci-robot avatar Apr 22 '24 19:04 openshift-ci-robot

🤖 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

ocpdocs-previewbot avatar Apr 22 '24 19:04 ocpdocs-previewbot

@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.

openshift-ci-robot avatar Apr 22 '24 21:04 openshift-ci-robot

@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.

openshift-ci-robot avatar Apr 22 '24 21:04 openshift-ci-robot

@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.

openshift-ci-robot avatar Apr 23 '24 01:04 openshift-ci-robot

@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.

openshift-ci-robot avatar Apr 23 '24 21:04 openshift-ci-robot

@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.

openshift-ci-robot avatar Apr 23 '24 21:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. 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:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 23 '24 21:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. 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:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 23 '24 21:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. Scope of the network reply - The last bullet point now includes OCP reference and link, as well.
  5. 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:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 23 '24 22:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
  5. 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:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 23 '24 22:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
  5. Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
  6. Log output types - added cloudlogging into the Output type descriptions table.

The following have a note added above the example:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 24 '24 00:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
  5. Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
  6. Log output types - added cloudlogging into the Output type descriptions section.

The following have a note added above the example:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 24 '24 00:04 openshift-ci-robot

@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:

  1. General settings table: Balancing-ignored-labels setting uses row - This no longer references AWS.
  2. 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.
  3. Using bound service account tokens - Added GCP IAM to first paragraph.
  4. Scope of the network verification checks - The last bullet point now includes OCP reference and link, as well.
  5. Example trigger authentication with pod authentication providers - Added 'gcp-gke' value to 3 Specifies a pod identity.
  6. Log output types - added cloudlogging into the Output type descriptions section.

The following have a note added above the example:

  1. oc adm release extract - Added note before the example.
  2. oc image mirror - Added note before the example.
  3. Showing data collected by Telemetry - Added note before the example.
  4. 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.

openshift-ci-robot avatar Apr 24 '24 15:04 openshift-ci-robot

@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!

eohartman avatar Apr 26 '24 21:04 eohartman

@yuwang-RH Can you please QE this PR? Thank you!

eohartman avatar Apr 29 '24 21:04 eohartman

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

As per OCP 4.15 documentation, "gcp-gke" is not a supported value for PodIdentity. Reference OCP 4.15 documentation.

This link is broken. So couldn't review.

  • Log output types - added cloudlogging into the Output type descriptions section. image

These updates look okay

@lento-sun, @xueli181114 / QE team : can you please confirm the following along with rest of the review?

"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?

These look okay. QE team, do you have corresponding GCP examples that we can add here?

svmrh avatar Apr 29 '24 21:04 svmrh

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

  1. I have removed network verifier reference.

  2. 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

eohartman avatar May 03 '24 19:05 eohartman

/retest

eohartman avatar May 13 '24 16:05 eohartman

@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.

openshift-ci[bot] avatar May 16 '24 22:05 openshift-ci[bot]

/lgtm

anpingli avatar May 17 '24 06:05 anpingli

/cherrypick enterprise-4.15

EricPonvelle avatar May 17 '24 18:05 EricPonvelle

/cherrypick enterprise-4.16

EricPonvelle avatar May 17 '24 18:05 EricPonvelle

@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.