Bug 1861322 - Common templates - terminationGracePeriodSeconds value should be updated in the templates
Summary: Common templates - terminationGracePeriodSeconds value should be updated in t...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Documentation
Version: 2.4.0
Hardware: Unspecified
OS: Unspecified
unspecified
urgent
Target Milestone: ---
: ---
Assignee: Andrew Burden
QA Contact: Nelly Credi
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-07-28 09:58 UTC by Ruth Netser
Modified: 2020-08-07 10:59 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-08-07 10:59:15 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1861297 0 urgent CLOSED Common templates - terminationGracePeriodSeconds value should be updated in the templates, default is 0 2021-02-22 00:41:40 UTC

Description Ruth Netser 2020-07-28 09:58:27 UTC
Document URL: 

Section Number and Name: 

Describe the issue: 
terminationGracePeriodSeconds value is set to 0 (force stop) in common templates.
If a VM is created using common templates, or from the UI using the wizard, terminationGracePeriodSeconds should be updated before the VM is started.

Suggestions for improvement: 

Additional information:

Comment 1 Ruth Netser 2020-07-28 10:02:42 UTC
@rmohr - can you lease suggest a recommended value?

Comment 2 Roman Mohr 2020-07-28 10:07:57 UTC
That depends on the operating system. For many linux based systems the default of 30 seconds is good enough. For some windows versions which tend to do extensive updates when you reboot the OS, hours could be a good choice.

Comment 3 Lavanya Mandavilli 2020-07-28 12:59:17 UTC
Requesting the following information @rmohr:

The default value in the common templates is zero in common templates?

We recommend that the value be modified and set to 30 seconds for all Linux operating systems, true?

For Windows environments with extensive updates etc, we recommend the value be modified to how many hours?

Comment 4 Roman Mohr 2020-07-28 13:18:26 UTC
(In reply to Lavanya Mandavilli from comment #3)
> Requesting the following information @rmohr:
> 
> The default value in the common templates is zero in common templates?
> 
> We recommend that the value be modified and set to 30 seconds for all Linux
> operating systems, true?

It really depends on what you do. In many cases it is enough already.

> 
> For Windows environments with extensive updates etc, we recommend the value
> be modified to how many hours?

Also here, depends on what the OS does, but it can take a long time until a windows machine shuts down voluntarily.

I don't have exact values at hand to recommend since it is really very specific. I would really make with all suggestions clear that this is not something which we can define 100% correct up front.

Comment 5 Lavanya Mandavilli 2020-07-28 13:26:36 UTC
I created a PR. Adding the link shortly.

Comment 6 Andrew Burden 2020-07-28 14:04:27 UTC
Known Issue PR:
https://github.com/openshift/openshift-docs/pull/24253
(Tagged Roman for review on PR)

Should we also add an admonition to the docs until the fix is in?

Comment 7 Andrew Burden 2020-08-03 10:17:53 UTC
This was verified by Nelly as part of a pre-release sweep in https://issues.redhat.com/browse/CNV-4934
The release note can be viewed here:
https://docs.openshift.com/container-platform/4.5/virt/virt-2-4-release-notes.html#virt-2-4-known-issues

@Ruth: Does this also require a admonition in the docs, or will this be fixed in the templates soon (and known issue will suffice)?

Comment 8 Ruth Netser 2020-08-04 07:47:58 UTC
@Andrew: As this may have severe impact on VMs, I think if should include one.

Comment 9 Andrew Burden 2020-08-06 12:10:33 UTC
Thanks Ruth.
I've added an Important admonition at the end of the procedure for creating a VM using the VM wizard. it links to the workaround in the release notes.
PR: https://github.com/openshift/openshift-docs/pull/24527
(There's no preview build but I've added screenshot of a local build to the PR description)

Our content for creating a VM in the CLI is about posting a VM manifest to the cluster. We do not mention common-templates in the CLI pathway so no admonition added there.

Please note, this is only for the enterprise-4.5 docs as it is expected the fix will be merged before 2.4.1

Comment 10 Ruth Netser 2020-08-06 12:28:13 UTC
Reviewed the patch, LGTM. Moving to "verified".

Comment 11 Andrew Burden 2020-08-07 10:59:15 UTC
The docs PR was merged and is now available:
https://docs.openshift.com/container-platform/4.5/virt/virtual_machines/virt-create-vms.html


Note You need to log in before you can comment on or make changes to this bug.