Skip to content

[OCPBUGS-46004]: Various HCP doc improvements #87017

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 15, 2025
Merged

[OCPBUGS-46004]: Various HCP doc improvements #87017

merged 1 commit into from
Jan 15, 2025

Conversation

lahinson
Copy link
Contributor

@lahinson lahinson commented Jan 14, 2025 •
edited
Loading

Version(s): 4.17+

Issue: https://issues.redhat.com/browse/OCPBUGS-46004

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 14, 2025
@lahinson lahinson force-pushed the ocpbugs-46004-hcp-improvements branch from 9425fd1 to 431c830 Compare January 14, 2025 17:35
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jan 14, 2025 •
edited
Loading

🤖 Wed Jan 15 17:32:21 - Prow CI generated the docs preview:

https://87017--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-aws.html
https://87017--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-bm.html
https://87017--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.html
https://87017--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.html
https://87017--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.html

@SirVL
Copy link

SirVL commented Jan 15, 2025

lgtm

sjenning
sjenning reviewed Jan 15, 2025
View reviewed changes
modules/hcp-bm-hc.adoc Outdated
<7> Specify the path to your SSH public key. The default file path is `~/.ssh/id_rsa.pub`.
<8> Specify your hosted cluster namespace.
<9> The default value for the control plane availability policy is `HighlyAvailable`.
<9> Specify the availability policy for the hosted cluster components. Supported options are `SingleReplica` and `HighlyAvailable`. The default value is `HighlyAvailable`.
Copy link

Choose a reason for hiding this comment

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

nit: s/hosted cluster/hosted control plane/ to align with the flag name and to distinguish it from --infra-availability-policy which is the availability policy of platform components running within the hosted cluster.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good suggestion. I'll fix that. Thanks!

@lahinson lahinson force-pushed the ocpbugs-46004-hcp-improvements branch from 431c830 to be657c2 Compare January 15, 2025 17:15
@sjenning
Copy link

lgtm

@lahinson lahinson added this to the Continuous Release milestone Jan 15, 2025
@jiezhao16
Copy link

lgtm

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jan 15, 2025

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

@lahinson lahinson added the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 15, 2025
@jeana-redhat jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jan 15, 2025
jeana-redhat
jeana-redhat approved these changes Jan 15, 2025
View reviewed changes
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

LGTM

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

@openshift-ci openshift-ci bot 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 Jan 15, 2025
@lahinson lahinson merged commit ab6ad58 into openshift:main Jan 15, 2025
2 checks passed
@lahinson
Copy link
Contributor Author

/cherrypick enterprise-4.17

@lahinson
Copy link
Contributor Author

/cherrypick enterprise-4.18

@openshift-cherrypick-robot
Copy link

@lahinson: new pull request created: #87092

In response to this:

/cherrypick enterprise-4.17

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jan 15, 2025
Merged
@openshift-cherrypick-robot
Copy link

@lahinson: new pull request created: #87093

In response to this:

/cherrypick enterprise-4.18

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jan 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sjenning sjenning sjenning left review comments

@jeana-redhat jeana-redhat jeana-redhat approved these changes

Assignees
No one assigned
Labels
branch/enterprise-4.17 branch/enterprise-4.18 peer-review-done Signifies that the peer review team has reviewed this PR size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
Continuous Release
Development

Successfully merging this pull request may close these issues.
7 participants
@lahinson @ocpdocs-previewbot @SirVL @sjenning @jiezhao16 @openshift-cherrypick-robot @jeana-redhat