Skip to main content

Argo CD

vCluster.Pro provides several points of integration with Argo CD, a popular GitOps tool for Kubernetes. This Argo CD integration is designed to help users take advantage not just of the speed and ease of creating virtual clusters, but also of Argo CD for managing and deploying applications within those virtual clusters.

Argo CD Integration has three major components or levels, each layer adding additional integration touch points.

  1. Sync virtual clusters to Argo CD
  2. Enable SSO Integration (sign in to ArgoCD via vCluster.Pro)
  3. Create Argo CD App Project per vCluster.Pro Project

The simplest level of integration is syncing virtual clusters into Argo CD as available clusters for deployments. In this deployment model, virtual clusters that are part of an Argo enabled project, and have the loft.sh/import-argocd label set to true will be automatically "synced" to Argo CD. These virtual clusters will show up as clusters that are available for deployments in the Argo CD UI. When the virtual clusters are deleted, vCluster.Pro will automatically remove the deleted cluster from Argo CD.

The second integration level is enabling SSO integration -- this is a project level setting that will configure Argo CD to allow users to authenticate via vCluster.Pro. After enabling this setting users who browse to the Argo CD instance will see a button to login via vCluster.Pro. All members of the project will be able to log in via vCluster.Pro and gain access to Argo CD.

The final integration level is the App Project/Argo CD Project integration. This tier configures an App Project in Argo CD that corresponds to the vCluster.Pro project. This option allows for configuring the Argo CD Project's source repositories (repositories that can be deployed to cluster(s) in the given project), as well as RBAC roles to apply to the project.

Configuration of each of these integration modes all starts at the vCluster.Pro project object. Argo CD can be enabled on a per-project basis, where multiple projects can be configured to integrate with a single Argo CD instance, or with different Argo CD instances depending on your requirements.

Enable Argo CD Integration​

Argo CD integration is enabled on a per-project basis. You can enable Argo CD integration during project creation, or on an existing project.

  1. Select the Projects field on the left menu bar.
  2. Click the blue symbol next to the project selector dropdown menu.
  3. In the drawer that appears from the right, create your project as normal.
  4. Click the Argo CD configuration tab.
  5. Slide the Enable Argo CD Integration slider to enabled.
  6. In the new configurations that appeared under the Enable Argo CD Integration slider, select either Clusters orVirtual Clusters from the dropdown box in the Where is Argo CD running dropdown. This tells vCluster.Pro if your Argo CD instance lives in a connected physical cluster, or if it is running inside of a virtual cluster.
  7. In the next drop down to the right, select the name of the cluster or virtual cluster that your Argo CD instance is deployed in.
  8. If your Argo CD instance is deployed in a namespace other than `argocd`, enter the name of the namespace in the Argo CD Namespace box.
  9. Finish configuring anything else you'd like on your project, then click the button.
Integration Errors

If there are any errors establishing Argo CD integration, an ArgoCD Error message will appear under the 'Project Settings' button.

Enable Argo CD SSO Integration​

Projects may also enable SSO integration with Argo CD -- this integration will allow all members of the vCluster.Pro project to log in to Argo CD via vCluster.Pro.

Pre-Requisites

The loftHost vCluster.Pro configuration must be set to enable this integration. The loftHost can be configured via loft helm values, or in the Admin section of the UI on the Config pane.

  1. Select the Projects field on the left menu bar.
  2. Click the blue symbol next to the project selector dropdown menu.
  3. In the drawer that appears from the right, create your project as normal.
  4. Click the Argo CD configuration tab.
  5. Slide the Enable Argo CD Integration slider to enabled.
  6. In the new configurations that appeared under the Enable Argo CD Integration slider, select either Clusters orVirtual Clusters from the dropdown box in the Where is Argo CD running dropdown. This tells vCluster.Pro if your Argo CD instance lives in a connected physical cluster, or if it is running inside of a virtual cluster.
  7. In the next drop down to the right, select the name of the cluster or virtual cluster that your Argo CD instance is deployed in.
  8. If your Argo CD instance is deployed in a namespace other than `argocd`, enter the name of the namespace in the Argo CD Namespace box.
  9. Slide the Enable SSO Integration slider to enabled.
  10. In the `ArgoCD Url` field, enter the resolvable and reachable (from vCluster.Pro) URL of your Argo CD instance.
  11. [Optional] select the desired RBAC role to assign to project members who log into Argo CD via vCluster.Pro.
  12. Finish configuring anything else you'd like on your project, then click the button.

Enable Argo CD App Project Integration​

App Project integration, can be enabled by editing a project manifest and setting the argoCD.project.enabled field of the project spec to 'true'. Additionally, users may provide metadata fields to apply the Argo CD App Project object, Argo CD RBAC roles to apply, and an array of permissible source repositories that may be accessed within the project.

Enable Virtual Cluster Import​

Once a project has Argo CD enabled, virtual clusters within that project are eligible to be synced to the Argo instance as available clusters. You can enable virtual cluster import into Argo CD during the virtual cluster creation step, or by enabling this feature on existing virtual clusters.

Make Sure Your Project Has Argo CD Enabled!

If the project your virtual cluster resides in does not have Argo CD integration enabled, you will not see the Argo CD import option!

  1. Select the Projects field on the left menu bar.
  2. From the project drop-down menu, select the project you'd like to create the Argo CD enabled virtual cluster in.
  3. Click on Virtual Clusters and the button.
  4. In the popup, optionally select the virtual cluster template, then click the button.
  5. Click the Argo CD configuration tab.
  6. Slide the Add to Argo CD slider to enabled.
  7. Finish configuring anything else you'd like on your virtual cluster, then click the button.
Disabling Argo CD Integration

Upon disabling of Argo integration at the project, all virtual clusters will be removed from Argo CD, so be careful when disabling Argo CD at the project level!

Integration Errors

If there are any errors adding your virtual cluster to Argo CD, the virtual cluster status will show a warning, clicking on the warning will give you a message indicating the cause of the issue(s).

Last updated on