CNV - API object style changes by aburdenthehand · Pull Request #27562 · openshift/openshift-docs

aburdenthehand · 2020-11-20T15:46:35Z

Virt update for the OpenShift docs style changes:
https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#api-object-formatting

This required some rephrasing, and while I was doing the sweep I noticed some mistakes like double-spacing, mismatched UI, fun stuff like that. Also un-hard wrapped a couple of modules while I was at it. Not all since I figured it would create noise for my reviewers but some since the hard wrapping was messing with my checks.

openshift-docs-preview-bot · 2020-11-20T15:49:50Z

The preview will be available shortly at:

https://cnv-api-style-test--ocpdocs.netlify.com/

ousleyp

This looks really good overall. I have some comments and a few questions. Some of my nits might be out of scope for this PR, take 'em or leave 'em. Thanks for undertaking this herculean effort :)

ousleyp · 2020-11-20T18:01:33Z

"Controllers such as virtual machine then spawn..." sounds weird. Maybe just "Controllers then spawn..."? Or "VirtualMachine controllers then spawn..."?

This whole assembly could do with a review, tbh. Raised BZ#1901643
I've rewritten the para for now

ousleyp · 2020-11-20T18:13:25Z

maybe s/file/object

In context this is creating a file (following command is 'touch...'
There's a better way to doc this but it's out of scope for this PR. Stay tuned!

ousleyp · 2020-11-20T18:53:32Z

s/configuration/manifest

?

This is monitoring an existing object so I think it should stay as 'config'

ousleyp · 2020-11-20T18:55:37Z

s/nodeSelector/nodeSelector spec

(I'm experiencing deja vu...)

Didn't you just say that? :groundhogs_day:

ousleyp · 2020-11-20T18:57:40Z

Suggested change

. List the node network enactments to see if the policy was successful on any of the nodes. If the policy failed for only a subset it suggests the problem is with specific node configuration; if the policy failed on all nodes it suggest the problem is with the policy.

. List the node network enactments to see if the policy was successful on any of the nodes. If the policy failed for only a subset of nodes, it suggests that the problem is with a specific node configuration. If the policy failed on all nodes, it suggests that the problem is with the policy.

ousleyp · 2020-11-20T18:58:56Z

s/Builds/builds

?

aburdenthehand · 2020-11-26T13:29:15Z

-When a VirtualMachineInstance (VMI) fails, _liveness probes_ stop the VMI.
-Controllers such as VirtualMachine then spawn other VMIs, restoring virtual
-machine responsiveness.
+_Liveness probes_ determine if a virtual machine instance (VMI) is still responding. If the probe fails, the VMI is stopped. A replacement VMI is then created to restore virtual machine responsiveness.


@ILpinto Thank you

aburdenthehand · 2020-11-26T15:10:22Z

/cherry-pick enterprise-4.6

openshift-cherrypick-robot · 2020-11-26T15:10:34Z

@aburdenthehand: new pull request created: #27677

Details

In response to this:

/cherry-pick enterprise-4.6

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.

aburdenthehand · 2020-11-26T15:10:40Z

/cherry-pick enterprise-4.7

openshift-cherrypick-robot · 2020-11-26T15:10:46Z

@aburdenthehand: #27562 failed to apply on top of branch "enterprise-4.7":

Applying: This is a pretty crazy test and I'll be surprised as anyone if it worked
.git/rebase-apply/patch:888: trailing whitespace.
new data volume, the name and namespace of the source PVC, 
.git/rebase-apply/patch:1903: trailing whitespace.
. Click *Save* to update the config map. 
.git/rebase-apply/patch:1978: trailing whitespace.
The following example is of a config map created from `ca.pem` TLS certificate. 
.git/rebase-apply/patch:2031: trailing whitespace.
These examples use the `ethernet` interface type to simplify the example while showing the related context in the policy configuration. These IP management examples can be used with the other interface types. 
.git/rebase-apply/patch:2070: trailing whitespace.
<1> Name of the policy. 
warning: squelched 3 whitespace errors
warning: 8 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_map.yml
M	modules/virt-cloning-a-datavolume.adoc
A	modules/virt-creating-a-service-from-a-virtual-machine.adoc
M	modules/virt-creating-bridge-nad-cli.adoc
M	modules/virt-importing-vm-wizard.adoc
M	modules/virt-pxe-booting-with-mac-address.adoc
M	modules/virt-understanding-smart-cloning.adoc
M	virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc
M	virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc
Falling back to patching base and 3-way merge...
Auto-merging virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc
Auto-merging virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc
CONFLICT (content): Merge conflict in virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc
Auto-merging modules/virt-understanding-smart-cloning.adoc
CONFLICT (content): Merge conflict in modules/virt-understanding-smart-cloning.adoc
Auto-merging modules/virt-pxe-booting-with-mac-address.adoc
Auto-merging modules/virt-importing-vm-wizard.adoc
Auto-merging modules/virt-creating-bridge-nad-cli.adoc
CONFLICT (modify/delete): modules/virt-creating-a-service-from-a-virtual-machine.adoc deleted in HEAD and modified in This is a pretty crazy test and I'll be surprised as anyone if it worked. Version This is a pretty crazy test and I'll be surprised as anyone if it worked of modules/virt-creating-a-service-from-a-virtual-machine.adoc left in tree.
Auto-merging modules/virt-cloning-a-datavolume.adoc
CONFLICT (content): Merge conflict in modules/virt-cloning-a-datavolume.adoc
Auto-merging _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 0001 This is a pretty crazy test and I'll be surprised as anyone if it worked
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".

Details

In response to this:

/cherry-pick enterprise-4.7

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.

aburdenthehand · 2020-11-26T16:06:37Z

/cherry-pick enterprise-4.7

openshift-cherrypick-robot · 2020-11-26T16:06:42Z

@aburdenthehand: #27562 failed to apply on top of branch "enterprise-4.7":

Applying: This is a pretty crazy test and I'll be surprised as anyone if it worked
.git/rebase-apply/patch:888: trailing whitespace.
new data volume, the name and namespace of the source PVC, 
.git/rebase-apply/patch:1903: trailing whitespace.
. Click *Save* to update the config map. 
.git/rebase-apply/patch:1978: trailing whitespace.
The following example is of a config map created from `ca.pem` TLS certificate. 
.git/rebase-apply/patch:2031: trailing whitespace.
These examples use the `ethernet` interface type to simplify the example while showing the related context in the policy configuration. These IP management examples can be used with the other interface types. 
.git/rebase-apply/patch:2070: trailing whitespace.
<1> Name of the policy. 
warning: squelched 3 whitespace errors
warning: 8 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_map.yml
A	modules/virt-creating-a-service-from-a-virtual-machine.adoc
M	modules/virt-creating-bridge-nad-cli.adoc
M	modules/virt-importing-vm-wizard.adoc
M	modules/virt-pxe-booting-with-mac-address.adoc
M	virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc
Falling back to patching base and 3-way merge...
Auto-merging virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc
Auto-merging modules/virt-pxe-booting-with-mac-address.adoc
Auto-merging modules/virt-importing-vm-wizard.adoc
Auto-merging modules/virt-creating-bridge-nad-cli.adoc
CONFLICT (modify/delete): modules/virt-creating-a-service-from-a-virtual-machine.adoc deleted in HEAD and modified in This is a pretty crazy test and I'll be surprised as anyone if it worked. Version This is a pretty crazy test and I'll be surprised as anyone if it worked of modules/virt-creating-a-service-from-a-virtual-machine.adoc left in tree.
Auto-merging _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 0001 This is a pretty crazy test and I'll be surprised as anyone if it worked
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".

Details

In response to this:

/cherry-pick enterprise-4.7

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.

aburdenthehand · 2020-11-26T16:32:18Z

/cherry-pick enterprise-4.7

openshift-cherrypick-robot · 2020-11-26T16:32:33Z

@aburdenthehand: new pull request created: #27682

Details

In response to this:

/cherry-pick enterprise-4.7

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.

aburdenthehand added the CNV Label for all CNV PRs label Nov 20, 2020

openshift-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Nov 20, 2020

aburdenthehand added this to the Next Release milestone Nov 20, 2020

aburdenthehand added branch/enterprise-4.6 branch/enterprise-4.7 labels Nov 20, 2020

aburdenthehand force-pushed the cnv-api-style-test branch from eb9ee98 to acc1884 Compare November 20, 2020 17:00

ousleyp reviewed Nov 20, 2020

View reviewed changes

aburdenthehand force-pushed the cnv-api-style-test branch from acc1884 to c896c8a Compare November 24, 2020 13:50

This is a pretty crazy test and I'll be surprised as anyone if it worked

e862aa5

aburdenthehand force-pushed the cnv-api-style-test branch from 232af1b to e862aa5 Compare November 25, 2020 17:37

aburdenthehand commented Nov 26, 2020

View reviewed changes

aburdenthehand merged commit 424d668 into openshift:master Nov 26, 2020

openshift-cherrypick-robot mentioned this pull request Nov 26, 2020

[enterprise-4.6] CNV - API object style changes #27677

Merged

aburdenthehand mentioned this pull request Nov 26, 2020

CNV-1396_2 Fixing Vikram's comments from merged PR #26676

Merged

aburdenthehand mentioned this pull request Nov 26, 2020

CNV-2705 Creating and exposing a VM-backed service #25387

Merged

openshift-cherrypick-robot mentioned this pull request Nov 26, 2020

[enterprise-4.7] CNV - API object style changes #27682

Merged

aburdenthehand deleted the cnv-api-style-test branch July 12, 2021 16:31

	. List the node network enactments to see if the policy was successful on any of the nodes. If the policy failed for only a subset it suggests the problem is with specific node configuration; if the policy failed on all nodes it suggest the problem is with the policy.
	. List the node network enactments to see if the policy was successful on any of the nodes. If the policy failed for only a subset of nodes, it suggests that the problem is with a specific node configuration. If the policy failed on all nodes, it suggests that the problem is with the policy.

Conversation

aburdenthehand commented Nov 20, 2020

Uh oh!

openshift-docs-preview-bot commented Nov 20, 2020

Uh oh!

ousleyp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aburdenthehand Nov 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aburdenthehand commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-cherrypick-robot commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aburdenthehand commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-cherrypick-robot commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aburdenthehand commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-cherrypick-robot commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aburdenthehand commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-cherrypick-robot commented Nov 26, 2020 • edited by openshift-ci-robot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

aburdenthehand Nov 26, 2020 •

edited

Loading

aburdenthehand commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

openshift-cherrypick-robot commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

aburdenthehand commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

openshift-cherrypick-robot commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

aburdenthehand commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

openshift-cherrypick-robot commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

aburdenthehand commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading

openshift-cherrypick-robot commented Nov 26, 2020 •

edited by openshift-ci-robot

Loading