The current documentation for templates and boot sources is scattered in 3 directories and has no clear use case.

Here is a common use case: As a cluster admin, I want to upload an Ubuntu image, use it to create a custom template, and have it automatically updated. (Requested by Adam Litke)

Scope of task:

• Bring together the relevant assemblies and put them in the templates directory. This includes Creating/using boot sources and Autoimport.
• Fix the organization of the Autoimport assembly:
  • Remove note referring to upgrade to 4.10.
  • Remove module on enabling autoupdate because this is enabled by default in 4.10+
  • Disabling and reenabling can be combined, since the only difference is true/false, that is, enabling/disabling the feature gate.
  • Storage class module: (When did we start using "user-defined" instead of "custom"?) A storage class must be defined if a template is copied from an RH template and the cluster does not have a default storage class. Adam Litke's email: It's probably easiest to simply state that "proper functioning of VM templates and boot source management depends on the cluster having a default storage class defined" and "boot sources are created from storage using the default storage class".
  • I recommend creating a level 2 heading called "Custom boot sources". Then put the "user-defined..." modules underneath, at level 3. Recommend changing "user-defined" to "custom" for consistency in the rest of the docs.
  • Enabling autoupdates for custom boot sources is OK. To do: apinnick to check whether feature gate is still relevant.
• Add a boot source overview (requested by Adam Litke) - out of scope
• Make sure that auto-updates for custom templates/boot sources has storage class as a prerequisite. In current docs, that is not called out. It's just inserted as a "You can create a storage class" module.
  • If you can replace UI procedures with a link to the web overview assembly, do so.-

–

> Step 5 of UI procedure should mention all 4 methods to create a boot source.

[pan] IMO, this UI note seems like a bug that should be handled outside of this Jira. apinnick@redhat.com AP: Perhaps include only one example so that it is clearer to the user that the examples are not a comprehensive list of ways to create boot source.