Skip to content

Conversation

@aburdenthehand
Copy link
Contributor

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.

@aburdenthehand aburdenthehand added the CNV Label for all CNV PRs label Nov 20, 2020
@openshift-ci-robot openshift-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Nov 20, 2020
@aburdenthehand aburdenthehand added this to the Next Release milestone Nov 20, 2020
@openshift-docs-preview-bot

The preview will be available shortly at:

Copy link
Member

@ousleyp ousleyp left a comment

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

maybe s/file/object

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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!

Copy link
Member

Choose a reason for hiding this comment

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

s/configuration/manifest

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

s/nodeSelector/nodeSelector spec

(I'm experiencing deja vu...)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Didn't you just say that? :groundhogs_day:

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

s/Builds/builds

?

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.
Copy link
Contributor Author

@aburdenthehand aburdenthehand Nov 26, 2020

Choose a reason for hiding this comment

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

@ILpinto Thank you

Copy link

Choose a reason for hiding this comment

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

lgtm

@aburdenthehand aburdenthehand merged commit 424d668 into openshift:master Nov 26, 2020
@aburdenthehand
Copy link
Contributor Author

aburdenthehand commented Nov 26, 2020

/cherry-pick enterprise-4.6

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Nov 26, 2020

@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
Copy link
Contributor Author

aburdenthehand commented Nov 26, 2020

/cherry-pick enterprise-4.7

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Nov 26, 2020

@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
Copy link
Contributor Author

aburdenthehand commented Nov 26, 2020

/cherry-pick enterprise-4.7

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Nov 26, 2020

@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
Copy link
Contributor Author

aburdenthehand commented Nov 26, 2020

/cherry-pick enterprise-4.7

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Nov 26, 2020

@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 aburdenthehand deleted the cnv-api-style-test branch July 12, 2021 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.6 branch/enterprise-4.7 CNV Label for all CNV PRs size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants