Use On-Demand

Apps are a way for admins to package applications and scripts in consumable packages. These applications can then be deployed into clusters, namespaces, or virtual clusters managed by vCluster Platform. This can be a useful tool for adding pre-defined applications to newly connected clusters, or to newly created namespaces or virtual clusters that are not already using a template that includes Apps.

Installing Apps on a Virtual Cluster

Virtual clusters 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 -- either at time of creation, or into existing virtual clusters. This gives administrators the capability to create fully populated development, test, or even production, environments in a single easy to manage package.

During Virtual Cluster Creation

1. From the project drop-down menu (top left corner), select the project you'd like to create the virtual cluster in.

2. Click on Virtual Clusters.

3. Click the button. Do not select a template.

4. [Optional] Select the cluster in which to create the virtual cluster.

5. Click the to continue.

6. Click the Apps configuration tab.
   

   
   

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

7. From the drop down menu Please select an App..., select an application that you would like to be deployed. You can select as many as you would like by simply selecting another application from the drop down menu. If you accidentally add one, or add one you do not want, click the trash icon next to the names of the applications to remove it from the configuration.

8. For each application that you added to the template, you can configure the default namespace, and any parameters supplied by the application. For Helm applications, you can also configure the Helm release-name.

9. Finish configuring anything else you'd like on your virtual cluster, then click the button.

On Existing Virtual Cluster

1. From the project drop-down menu (top left corner), select the project that has the virtual cluster that you want to deploy the App in.

2. Click on Virtual Clusters.

3. Find the virtual cluster you would like to deploy an App to in the list of virtual clusters and hover over that virtual cluster.

4. Click on Edit.

5. Click the Apps configuration tab.
   

   
   

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

6. From the drop down menu Please select an App..., select an application that you would like to be deployed. You can select as many as you would like by simply selecting another application from the drop down menu. If you accidentally add one, or add one you do not want, click the trash icon next to the names of the applications to remove it from the configuration.

7. For each application that you added to the template, you can configure the default namespace, and any parameters supplied by the application. For Helm applications, you can also configure the Helm release-name.

8. Finish configuring anything else you'd like on your virtual cluster, then click the button.

Installing Apps on a Cluster

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

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

3. Find the cluster you would like to deploy an App to in the list of connected clusters and click on that cluster.

4. In the Cluster Management view, click the button.

5. Select the App you would like to install from the App thumbnails, or, if there are no recommend Apps, click the and find the desired App in the Select an App drop down menu.

6. In the Install App screen enter the namespace to install the App to in the Namespace field.

7. Enter any other required parameters for your App -- this may vary depending on the type of App and whether or not the App creator has specified parameters.

8. Click the button.