CNV-32614: Document deprecate templates functionality #72894
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@aspauldi: This pull request references CNV-32614 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 story to target the "4.16.0" version, but no target version was set. In response to this:
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. |
|
/label cnv |
openshift-ci
bot
added
CNV
openshift-ci
bot
added
size/M
|
@aspauldi: This pull request references CNV-32614 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 story to target the "4.16.0" version, but no target version was set. In response to this:
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. |
|
Hi @ksimon1 , can you please review this doc update? Two comments:
Thanks. |
|
@aspauldi: This pull request references CNV-32614 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 story to target the "4.16.0" version, but no target version was set. In response to this:
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. |
|
@aspauldi: This pull request references CNV-32614 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 story to target the "4.16.0" version, but no target version was set. In response to this:
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. |
|
@ksimon1, if you have a chance, can you take a look at this doc update? (I'm going to be out of the office from March 13 through March 29, so this isn't urgent.) Thanks! |
|
/lgtm |
|
@geetikakay, can you please review this PR? Thanks! |
|
@geetikakay, can you please review this PR? Thanks! (I was on PTO for two weeks but am back now.) |
|
@aspauldi: This pull request references CNV-32614 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 story to target the "4.16.0" version, but no target version was set. In response to this:
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. |
|
@geetikakay, can you please review this PR? Thanks! |
|
lgtm |
|
@aspauldi: This pull request references CNV-32614 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 story to target the "4.16.0" version, but no target version was set. In response to this:
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. |
|
New changes are detected. LGTM label has been removed. |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
|
/label peer-review-in-progress |
openshift-ci
bot
added
the
peer-review-in-progress
| [id="virt-customizing-vm-template-web_{context}"] | ||
| = Customizing a VM template by using the web console | ||
|
|
||
| You can customize an existing VM template by modifying the VM or template parameters, such as data sources, cloud-init, or SSH keys, before you start the VM. If you customize a template by copying it and including all of its labels and annotations, the customized template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. |
There was a problem hiding this comment.
I'd suggest spelling out virtual machine on the first mention in this new section:
| You can customize an existing VM template by modifying the VM or template parameters, such as data sources, cloud-init, or SSH keys, before you start the VM. If you customize a template by copying it and including all of its labels and annotations, the customized template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. | |
| You can customize an existing virtual machine (VM) template by modifying the VM or template parameters, such as data sources, cloud-init, or SSH keys, before you start the VM. If you customize a template by copying it and including all of its labels and annotations, the customized template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. |
| @@ -23,6 +23,11 @@ You can customize the disk source and VM parameters before you start the VM: | |||
|
|
|||
| * See the xref:../../../virt/getting_started/virt-web-console-overview.adoc#virtualmachine-details-overview_virt-web-console-overview[*Overview*], xref:../../../virt/getting_started/virt-web-console-overview.adoc#virtualmachine-details-yaml_virt-web-console-overview[*YAML*], and xref:../../../virt/getting_started/virt-web-console-overview.adoc#virtualmachine-details-configuration_virt-web-console-overview[*Configuration*] tab documentation for details about VM settings. | |||
|
|
|||
| [NOTE] | |||
| ==== | |||
| If you copy a VM template with all its labels and annotations, your version of the template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. You can remove this designation. See xref:../../virt/virtual_machines/creating_vms_rh/virt-customizing-vm-template-web.adoc#virt-customizing-vm-template-web_virt-creating-vms-from-templates[Customizing a VM template]. | |||
There was a problem hiding this comment.
This xref seems to be broken and I think there might be more than one issue with it. For one, I do believe it's missing one more ../ level since this assembly is three levels deep. The xrefs above on line 24 seem to confirm that.
But I also believe the adoc filename is wrong since the file doesn't seem to exist. If this xref is supposed to point to the module you're adding to this assembly, here's what it should look like:
| If you copy a VM template with all its labels and annotations, your version of the template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. You can remove this designation. See xref:../../virt/virtual_machines/creating_vms_rh/virt-customizing-vm-template-web.adoc#virt-customizing-vm-template-web_virt-creating-vms-from-templates[Customizing a VM template]. | |
| If you copy a VM template with all its labels and annotations, your version of the template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. You can remove this designation. See xref:../../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc#virt-customizing-vm-template-web_virt-creating-vms-from-templates[Customizing a VM template]. |
skopacz1
added
peer-review-done
|
@skopacz1: Those labels are not set on the issue: In response to this:
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. |
|
@aspauldi: 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/test-infra repository. I understand the commands that are listed here. |
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
skopacz1
added
merge-review-in-progress
|
Hey @aspauldi I'm proceeding with the merge review, but I just have a question - do you know if this needs change management? If this is the first time the feature is being mentioned in published docs (i.e. if it wasn't mentioned in a release note when the functionality first became GA), I feel like it might, but I'm not sure. Let me know what you think! |
|
Hi Sebastian, we don't do change management in CNV. Thanks for checking! |
|
/cherrypick enterprise-4.14 |
|
/cherrypick enterprise-4.15 |
|
/cherrypick enterprise-4.16 |
|
@skopacz1: new pull request created: #74469 In response to this:
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. |
|
@skopacz1: new pull request created: #74470 In response to this:
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. |
|
@skopacz1: new pull request created: #74471 In response to this:
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. |
skopacz1
removed
merge-review-in-progress
Version(s): 4.14+
Issue: CNV-32614
Links to docs previews:
QE review: