Application Catalog

Platform9 supports deploying any Helm 3 application that is stored within public and private repositories. To get started you first need to attach a repository, you are then able to deploy application and once they're deployed view their status and make updates.

To get started try out apps from these great public Helm repositories

  • NGINX https://helm.nginx.com/stable
  • CertManager https://charts.jetstack.io
  • ``Harbor https://helm.goharbor.io

Or visit Artifact Hub to explore many great applications that are packaged using Helm.

Application Catalog

Application Catalog

Repository Management

Add a Helm Repository

Adding a Helm repository can be achieved on the Repositories tab of the Apps dashboard, follow the following steps to add or edit a Helm repository

  1. Click on the Apps tab within the lefthand navigation bar and then select the Repositories tab
  2. On the Repositories tab click "Add New Repository"
  3. On the Add New Repository screen provide the Repository Name, Repository URL, select if the repository is public or private and select the clusters to link the repository with.
  4. Repository Name: This is used to identify the repository
  5. Repository URL: this is the public endpoint for the repository, for example https://helm.nginx.com/stable
  6. Public or Private: If the repository is Private provide the username and Password to authenticate
  7. Clusters: Select each cluster that needs to be associated to the repository

Edit a Helm Repository

A Helm repository can be edited form the Repositories tab.

  1. Click on the Apps tab within the lefthand navigation bar and then select the Repositories tab
  2. On the Repositories tab select the repository and click Edit from the table action bar
  3. Update the Repository as required.

Update a Helm Repository

When a repository is added the Platform9 Helm 3 Service catalogs the applications and the available versions, when the repository is updated the Platform9 Helm 3 Service will need to updated to catalog the new applications and new application versions.

  1. Click on the Apps tab within the lefthand navigation bar and then select the Repositories tab
  2. On the Repositories tab select the repository and click Update from the table action bar

Delete a Helm Repository

A Helm repository can be removed at any time.

  1. Click on the Apps tab within the lefthand navigation bar and then select the Repositories tab
  2. On the Repositories tab select the repository and click Delete from the table action bar

Removing a repository will not remove any associated applications that are running and have been deployed.

Deploying and Managing Applications

Applications can be deployed using the Apps Catalog tab of Apps Dashboard. Applications can only be deployed to clusters that have been registered with a repository.

Deploy an Application

To deploy an application follow the steps below:

  1. Ensure at least one repository has been added and registered to your cluster
  2. Navigate to the Apps dashboard Apps Catalog tab and search for your application. Use the repository and cluster filters if required.
  3. Click 'Deploy' on the application card
  4. On the Deploy app screen provide a name for the Helm Release (a Release is an individual deployment of an app), Select the target cluster, select the target name space, select a version and review the values.yaml
  5. Name: This the the Helm Release Name used to identify a deployment of an applicaiton
  6. Cluster: The cluster where the app will be deployed
  7. Namespace: The Namespace within the cluster to deploy the app into
  8. Version: The version of the application to deploy
  9. values.yaml: Edit, upload or use the default values.yaml
  10. Click deploy and the application will be deployed into the target cluster.

The default values.yaml configuration may cause the application deployment to fail, for help visit Helm values.yaml

View Deployed Application

Deployed applications can be viewed in two locations, the Apps dashboard Deployed Applications tab or when viewing the Clusters Details dashboard.

To view a deploy app on the Apps dashboard follow the steps below:

  1. Navigate to Apps dashboard Deployed Apps Tab
  2. Using the Table Action bar select your cluster and the namespace where the application is running.

To view a running application from a given clusters details dashboard follow the steps below:

  1. Navigate to the Infrastructure dashboard Clusters tab and click the name of your cluster
  2. On the Cluster Details dashboard click the Deployed Apps tab

Delete an Application

To delete a deploy app use the Apps dashboard follow the steps below:

  1. Navigate to Apps dashboard Deployed Apps Tab
  2. Using the Table Action bar select your cluster and the namespace where the application is running.
  3. Select the application and use the Delete action in the table action bar to delete the app.

Update an Application

To update a running applications configuration or versions use the Apps dashboard follow the steps below:

  1. Navigate to Apps dashboard Deployed Apps Tab
  2. Using the Table Action bar select your cluster and the namespace where the application is running.
  3. Select the application and use the Update action in the table action bar to delete the app.
  4. On the edit application dashboard update the application with your required changes.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard