Remove note about cloning and editing templates #4296
Conversation
github-actions
bot
added
Needs tech review
I'm not sure if job templates support custom snippets the same way as provisioning templates. That would require further research. |
Lennonka
left a comment
Lennonka
left a comment
There was a problem hiding this comment.
The change LGTM, but I would appreciate a tech ack.
Lennonka
added
style review done
maximiliankolb
force-pushed
the
fix_4256_custom_snippets
branch
from
288b4bf to
7fe05f7
Compare
Users should never clone and edit templates. Instead, if they really need to run custom code before or after registration or provisioning workflows, they should use "custom pre" and "custom post" snippets as documented. This way they do not lose support by the community/vendor. Also, there's configuration management. Fixes theforeman#4256
maximiliankolb
force-pushed
the
fix_4256_custom_snippets
branch
from
7fe05f7 to
5ffa48f
Compare
|
Rebased to HEAD of "master" and resolved all merge conflicts. @stejskalleos Can you please review my PR? Does it make sense to you from a technical perspective? |
| If you require modification to an original template, clone the template, edit the clone, and associate the clone instead of the original template. | ||
| For more information, see xref:running-custom-code-during-host-provisioning-by-using-web-ui[]. |
There was a problem hiding this comment.
I'm not sure if we should recommend users to not clone provisioning template, since those are locked by default and how users would add pre/post snippets to it without cloning?
There was a problem hiding this comment.
The idea is to not clone and edit at all. Instead, users can write "custom pre" and "custom post" snippets that are automatically picked up by supported templates. Example in foreman on "develop":
app/views/unattended/provisioning_templates/provision/kickstart_default.erb
222:<%= snippet_if_exists(template_name + " custom pre") %>
So locked template pick up user-provided snippets if present, which avoids the whole "clone+edit and lose updates/support" kinda situation.
There was a problem hiding this comment.
As Max is saying, the custom pre/post snippets do not have to be added to templates because the code is there by default (example). If the snippets don't exist, nothing happens. Once the user creates them, the templates pick them up automatically.
Therefore, the user doesn't have to clone and edit templates to add the snippets to the provisioning process.
There was a problem hiding this comment.
@stejskalleos Can you please ack this ^^ and this PR?
There was a problem hiding this comment.
If the snippets don't exist, nothing happens. Once the user creates them, the templates pick them up automatically.
Correct.
Therefore, the user doesn't have to clone and edit templates to add the snippets to the provisioning process.
Also correct.
| ==== | ||
| You can use the original templates shipped in {Project} as described below. | ||
| If you require modification to an original template, clone the template, edit the clone, and associate the clone instead of the original template. | ||
| For more information, see xref:running-custom-code-during-host-provisioning-by-using-web-ui[]. |
There was a problem hiding this comment.
I think this isn't a correct link for the clone guide, which should be either https://docs.theforeman.org/nightly/Provisioning_Hosts/index-katello.html#cloning-provisioning-templates, right?
cc @stejskalleos @ShimShtein
There was a problem hiding this comment.
Why is this relevant when we're removing it?
4 participants
What changes are you introducing?
Users should never clone and edit templates. Instead, if they really need to run custom code before or after registration or provisioning workflows, they should use "custom pre" and "custom post" snippets as documented. This way they do not lose support by the community/vendor.
Also, there's configuration management.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Fixes #4256
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Should we also drop the hint about cloning and editing in
guides/common/modules/proc_setting-up-job-templates.adoc?Contributor checklists
Please cherry-pick my commits into: