Skip to main content

Use In Templates

Apps are a way for admins to package applications and scripts in consumable packages. These applications can then be deployed into namesspaces or virtual clusters through their templates.

Virtual clusters or namespaces combined with Apps are a great way to create repeatable, pre-packaged development, testing, or even production environments. Once an App has been created in the vCluster Platform instance, it can be installed into any virtual cluster or namespace -- either at time of creation, or into existing resources. This gives administrators the capability to create fully populated development, test, or even production, environments in a single easy to manage package.

Templates can take this combination of virtual clusters/namespaces and apps to the next level, by creating simple, reusable, version-able templates that define a reproducible environment.When an App is included in a template, that app will be deployed in the given resource upon creation.

  1. Select the Templates field on the left menu bar.

  2. From the Templates sub-menu, select the Virtual Clusters option.

  3. Edit an existing template, or create a new virtual cluster template.

  4. Click the Apps configuration tab.


    Note: the apps defined in this section of the template configuration are apps to be deployed in the virtual cluster!

  5. From the drop down menu Add a new App ... select an App that you would like to be included as part of the template. You can select as many Apps as you would like here by simply selecting another App from the drop down menu. If you accidentally add one, or add one you do not want, click the trash icon next to the Apps name to remove it from the template.

  6. For each App you added to the template, you can configure the default namespace, and any App parameters supplied by the App. For helm Apps you can also configure the helm release-name.

  7. Click the Space configuration tab.

  8. Expand the Space Apps configuration section.



    Note: the apps defined in this section of the template configuration are apps to be deployed in the space the virtual cluster will be deployed in (not inside the virtual cluster itself).

  9. From the drop down menu Add a new App ... select an App that you would like to be included as part of the template. You can select as many Apps as you would like here by simply selecting another App from the drop down menu. If you accidentally add one, or add one you do not want, click the trash icon next to the Apps name to remove it from the template.

  10. For each App you added to the template, you can any App parameters supplied by the App. For helm Apps you can also configure the helm release-name.

  11. Finish configuring anything else you'd like on your template, then click the button.