Skip to content
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.

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

[OCPBUGS-3341] Add RHOSP CCM options reference documentation #53068

Merged
merged 17 commits into from
Jan 13, 2023

Conversation

maxwelldb
Copy link
Contributor

@maxwelldb maxwelldb commented Nov 21, 2022

Version(s):
4.12

Issue:
OCPBUGS-3341

Link to docs preview: https://53068--docspreview.netlify.app/openshift-enterprise/latest/installing/installing_openstack/installing-openstack-cloud-config-reference.html

QE review:

  • QE has approved this change.

Additional information: Need to figure out where to put this. It would bloat the installation assemblies. Possible options:

  • Collapsible tables in installation assemblies.
  • Dedicated RHOSP installation reference assembly
  • ???

Will link from installation assemblies to this one after this is merged.

@maxwelldb
Copy link
Contributor Author

@MaysaMacedo @rlobillo This is brand new and not yet situated in the docs, but the module should be ready for a first look if you have time.

Related to: #52294

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Nov 21, 2022

🤖 Updated build preview is available at:
https://53068--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/6926

@openshift-ci
Copy link

openshift-ci bot commented Nov 23, 2022

@MaysaMacedo: GitHub didn't allow me to request PR reviews from the following users: for, confirming.

Note that only openshift members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

I believe this section is not validated by QE and consequently should be removed from docs
/cc @rlobillo for confirming

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/test-infra repository.

@MaysaMacedo
Copy link
Contributor

/cc @dulek @rlobillo

@openshift-ci openshift-ci bot requested a review from dulek November 23, 2022 15:08
@MaysaMacedo
Copy link
Contributor

Should this same doc be included since 4.9?
There are certain options that only are being tested in CCM on 4.12

Copy link
Contributor

@dulek dulek left a comment

Choose a reason for hiding this comment

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

Tiny remark.

modules/cluster-cloud-controller-config-osp.adoc Outdated Show resolved Hide resolved
@maxwelldb maxwelldb requested a review from dulek December 1, 2022 23:57
@maxwelldb
Copy link
Contributor Author

Added docs preview link.

@maxwelldb maxwelldb force-pushed the cloud-config-osp-ocpbugs3341 branch 2 times, most recently from 7ef689e to ba4da5a Compare December 2, 2022 00:19
@maxwelldb
Copy link
Contributor Author

@maxwelldb looks good. Just one last question, do we plan to remove the following configs?

@MaysaMacedo I included those in the "these exist but you should not modify them" section at the bottom of the page based on one of @stephenfin's comments. If you think that they're unhelpful or misleading to include, though, I could pull them.

@maxwelldb
Copy link
Contributor Author

@MaysaMacedo @stephenfin ^^^

Copy link

@stephenfin stephenfin left a comment

Choose a reason for hiding this comment

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

Replied. This is looking better with just a few small comments outstanding.

Co-authored-by: Jon Uriarte <juriarte@redhat.com>
@eurijon
Copy link

eurijon commented Jan 12, 2023

lgtm

Copy link

@stephenfin stephenfin left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 12, 2023
@maxwelldb maxwelldb added the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 12, 2023
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 12, 2023
@openshift-ci
Copy link

openshift-ci bot commented Jan 12, 2023

New changes are detected. LGTM label has been removed.

@jeana-redhat jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jan 12, 2023
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.

Wheeee tables. Just a few small things from me, and a couple questions to evaluate. Otherwise LGTM!

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

modules/cluster-cloud-controller-config-osp.adoc Outdated Show resolved Hide resolved
modules/cluster-cloud-controller-config-osp.adoc Outdated Show resolved Hide resolved
modules/cluster-cloud-controller-config-osp.adoc Outdated Show resolved Hide resolved
modules/cluster-cloud-controller-config-osp.adoc Outdated Show resolved Hide resolved
@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 12, 2023
Co-authored-by: Jeana Routh <61474374+jeana-redhat@users.noreply.github.com>
@maxwelldb maxwelldb merged commit 93f5cc2 into openshift:main Jan 13, 2023
@maxwelldb
Copy link
Contributor Author

/cherry-pick enterprise-4.12

@openshift-cherrypick-robot

@maxwelldb: #53068 failed to apply on top of branch "enterprise-4.12":

Applying: Draft of port of upstream docs info into downstream
Applying: Comment out unsupported options
Applying: Add CCM reference page to topic map
.git/rebase-apply/patch:35: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
Falling back to patching base and 3-way merge...
CONFLICT (add/add): Merge conflict in installing/installing_openstack/installing-openstack-cloud-config-reference.adoc
Auto-merging installing/installing_openstack/installing-openstack-cloud-config-reference.adoc
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0003 Add CCM reference page to topic map
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick enterprise-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/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.12 peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet