Application Catalog

The PCD Application Catalog, also known as the App Catalog, is the key orchestration component that enables automation of advance use cases. The App catalog enables creation of applications that are composed of one or more virtual machines, networks, storage volumes, and other components that need to be created and managed as a single unit.

The App Catalog uses Terraform as the technology under the hood to enable application automation. The catalog requires and integrates with a user supplied Github repository to manage and deploy Terraform based applications.

NOTE

The App Catalog is currently in beta for Private Cloud Director

Following steps describe how to connect a repository, create application templates, and deploy applications from those templates.

Step 1: Connect a repository

The Private Cloud Director App Catalog requires a Github repository to read and optionally write terraform templates. Ensure you have administrator access to connect your repository and create templates from your Terraform modules.

  1. Log in to your Private Cloud Director console using your credentials.

  2. Navigate to Orchestration > Repository and then select Add Repository to access Repository Configuration.

  3. On the Repository Configuration, enter the required information.

Field

Description

Repository URL

Enter the complete URL to your repository

SSH Key Name

Enter a descriptive name for your SSH key

Description

Add details about the repository contents

SSH Key Type

Select the appropriate SSH key type for authentication

Private SSH Key

Enter your private SSH key content

  1. Select Validate SSH Key to verify the connection. The system validates your SSH key and repository access before proceeding.

  2. Select Add Repository to complete the configuration.

Your successfully added repository will be visible on Orchestration > Repository. PCD now has access to your Terraform modules from this repository for template creation.

Step 2: Create a template from your repository

Create reusable Terraform based templates from modules stored in your connected repository. The Terraform module defined in each template serves as the source of truth for application deployments.

  1. Navigate to Orchestration > Apps > Templates and then select Create a Template.

  2. To create a new template, enter the required details.

Field

Description

Template Name

Enter a descriptive name for your template

Description

It is recommended you provide details about the template like the purpose and configuration

Upload Template Icon

To upload a template icon, perform the following steps: - Choose Click to upload or drag and drop a file. - Private Cloud Director console only supports .jpg and .png files - You can preview the uploaded template icon in PREVIEW

  1. Select Next to continue configuring the Terraform module.

  2. Specify Terraform Module is already selected by default. Continue to enter the required details.

Field
Description

Terraform Module path

Specify the path to your module within the repository. If your module is located in the base path of the repository, you are not required to enter the path.

Branch

Select Tag to identify the specific version or branch

  1. Select Fetch Your Terraform Module. When successful, you will see a preview of the module contents.

  2. Define Terraform Variables You can choose customize your Terraform template by adding Key and Value to the module

  3. Select Create Template to finalize the template.

Your successfully added template will be visible on Orchestration > Apps > Templates.

Step 3: Create an application from a template

Deploy new applications using your predefined templates. This process creates application instances derived from the Terraform modules in your templates.

  1. Navigate to Orchestration > Apps > My Apps.

  2. Select Create New App.

NOTE

Ensure you have at least one existing template available for deployment.

  1. To configure a new application from a template, enter the following details.

Field

Description

Application Name

Enter a unique name for your application

Template

Select from the dropdown menu of available templates

Creation Strategy

Use default template properties is selected by default

  1. Review the configuration. PCD populates the configuration based on your selected template where you can review the VM specifications, networking settings, and resource allocations.

  2. Select Create Application to start the deployment process.

Your successfully deployed application will be visible on Orchestration > Apps > My Apps or Orchestration > Apps > All Apps.

Step 4: Manage your deployed applications

Manage your deployed applications through the App Catalog. Only you as the application administrator or authorized users can perform these operations.

  1. Navigate to Orchestration > Apps > My Apps.

  2. Application Operations:

Operations

Actions

Play

Start the application and power on all VMs in the correct sequence - Powers on all virtual machines within the application - Follows any predefined startup dependencies between VMs - Application is operational and ready for use

Stop

Shuts down the running application and all associated VMs - Performs a clean shutdown of all virtual machines - Preserves data and configurations for the next startup - Application becomes unavailable until restarted

Resume

Restart suspended VM instances - Restore suspended VMs to their previous running state - VMs continue from where they were suspended - All processes and memory contents are restored

  1. Advanced application management:

  • Clone : Create a duplicate application instance using the same configuration.

    • Select Clone corresponding to any specific application.

    • The cloned application appears with the same template configuration.

  • Web Server Cluster - VMs : View and manage individual VM instances within the configured application.

    • Access detailed VM level controls to stop or resume operations.

    • Monitor individual VM performance and status.

  1. Application Monitoring:

  • View real-time application status and resource utilization

  • Monitor CPU, memory, storage, and network usage across all VMs

  • Track application deployment history and current state

Applications remain linked to their original templates, but any customizations you make apply only to your specific app instance. You can deploy the same template multiple times, with each instance consuming its own resource quota.

Last updated

Was this helpful?