Merge pull request #39535 from lmandavi/CNV-12600-templates-namespace

CNV-12600: Deploy virtual machine templates to a custom namespace

Author: sjhala-ccs

_topic_maps/_topic_map.yml

@@ -3084,6 +3084,8 @@ Topics:
     File: virt-editing-vm-template
   - Name: Enabling dedicated resources for a virtual machine template
     File: virt-dedicated-resources-vm-template
+  - Name: Deploying a virtual machine template to a custom namespace
+    File: virt-deploying-vm-template-to-custom-namespace
   - Name: Deleting a virtual machine template
     File: virt-deleting-vm-template
 # Virtual machine live migration

modules/virt-adding-templates-to-custom-namespace.adoc

@@ -0,0 +1,46 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_templates/virt-deploying-vm-template-to-custom-namespace.adoc
+
+[id="virt-adding-templates-to-custom-namespace_{context}"]
+= Adding templates to a custom namespace
+
+The `ssp-operator` deploys virtual machine templates to the `openshift` namespace by default. Templates in the `openshift` namespace are publicly availably to all users. When a custom namespace is created and templates are added to that namespace, you can modify or delete virtual machine templates in the `openshift` namespace. To add templates to a custom namespace, edit the `HyperConverged` custom resource (CR) which contains the `ssp-operator`.
+
+.Procedure
+
+. View the list of virtual machine templates that are available in the `openshift` namespace.
++
+[source,terminal]
+----
+$ oc get templates -n openshift
+----
++
+. Edit the `HyperConverged` CR in your default editor by running the following command:
++
+[source,terminal]
+----
+$ oc edit hco -n openshift-cnv kubevirt-hyperconverged
+----
++
+. View the list of virtual machine templates that are available in the custom namespace.
++
+[source,terminal]
+----
+$ oc get templates -n customnamespace
+----
++
+. Add the `commonTemplatesNamespace` attribute and specify the custom namespace. Example:
++
+[source,yaml]
+----
+apiVersion: hco.kubevirt.io/v1beta1
+kind: HyperConverged
+metadata:
+  name: kubevirt-hyperconverged
+spec:
+  commonTemplatesNamespace: customnamespace <1>
+----
+<1> The custom namespace for deploying templates.
++
+. Save your changes and exit the editor. The `ssp-operator` adds virtual machine templates that exist in the default `openshift` namespace to the custom namespace.

modules/virt-creating-custom-namespace-for-templates.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_templates/virt-deploying-vm-template-to-custom-namespace.adoc
+
+[id="virt-creating-custom-namespace-for-templates_{context}"]
+= Creating a custom namespace for templates
+
+You can create a custom namespace that is used to deploy virtual machine templates for use by anyone who has permissions to access those templates. To add templates to a custom namespace, edit the `HyperConverged` custom resource (CR), add  `commonTemplatesNamespace` to the spec, and specify the custom namespace for the virtual machine templates. After the `HyperConverged` CR is modified, the `ssp-operator` populates the templates in the custom namespace.
+
+.Prerequisites
+
+* Install the {product-title} CLI `oc`.
+* Log in as a user with cluster-admin privileges.
+
+.Procedure
+
+* Use the following command to create your custom namespace:
++
+----
+$ oc create namespace <mycustomnamespace>
+----
++

modules/virt-deleting-templates-from-custom-namespace.adoc

@@ -0,0 +1,45 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_templates/virt-deploying-vm-template-to-custom-namespace.adoc
+
+[id="virt-deleting-templates-from-custom-namespace_{context}"]
+= Deleting templates from a custom namespace
+
+To delete virtual machine templates from a custom namespace, remove the `commonTemplateNamespace` attribute from the `HyperConverged` custom resource (CR) and delete each template from that custom namespace.
+
+.Procedure
+
+. Edit the `HyperConverged` CR in your default editor by running the following command:
++
+[source,terminal]
+----
+$ oc edit hco -n openshift-cnv kubevirt-hyperconverged
+----
++
+. Remove the `commonTemplateNamespace` attribute.
++
+[source,yaml]
+----
+apiVersion: hco.kubevirt.io/v1beta1
+kind: HyperConverged
+metadata:
+  name: kubevirt-hyperconverged
+spec:
+  commonTemplatesNamespace: customnamespace <1>
+----
+<1> The `commonTemplatesNamespace` attribute to be deleted.
++
+. Delete a specific template from the custom namespace that was removed.
++
+[source,terminal]
+----
+$ oc delete templates -n customnamespace <template_name>
+----
+
+.Verification
+* Verify that the template was deleted from the custom namespace.
++
+[source,terminal]
+----
+$ oc get templates -n customnamespace
+----

virt/vm_templates/virt-deploying-vm-template-to-custom-namespace.adoc

@@ -0,0 +1,16 @@
+[id="virt-deploying-vm-template-to-custom-namespace"]
+= Deploying a virtual machine template to a custom namespace
+include::modules/virt-document-attributes.adoc[]
+:context: virt-deploying-vm-template-to-custom-namespace
+
+toc::[]
+
+Red Hat provides preconfigured virtual machine templates that are installed in the `openshift` namespace. The `ssp-operator` deploys virtual machine templates to the `openshift` namespace by default. Templates in the `openshift` namespace are publicly available to all users. These templates are listed in the *Templates* tab within the *Virtualization* page for different operating systems.
+
+include::modules/virt-creating-custom-namespace-for-templates.adoc[leveloffset=+1]
+include::modules/virt-adding-templates-to-custom-namespace.adoc[leveloffset=+1]
+include::modules/virt-deleting-templates-from-custom-namespace.adoc[leveloffset=+1]
+
+[id="additional-resources_deploying-vm-templates-to-custom-namespace"]
+== Additional resources
+* xref:../../virt/vm_templates/virt-creating-vm-template.adoc#virt-creating-vm-template[Creating virtual machine templates]