Quarkus ArgoCD

Generate Argo CD Application or Project as part of the Quarkus build or using the Quarkus CLI.

Features

• Generate the Argo CD Application or AppProject Kubernetes custom resources for the Quarkus application

• Command Line interface to install / uninstall and list Argo CD Application(s)

• Integration with Quarkus Helm

• DevServices able to install Argo CD on kubernetes cluster: kind or k3s

Requirements

• Project added under a version control system and pushed on a repository (e.g. GitHub, etc.)

• A Kubernetes cluster with Argo CD installed and supporting argoproj.io/v1alpha1.

Building

To build the extension use the following command:

mvn clean install

Usage

To get the Argo CD custom resources generated, it is needed to add the quarkus-argocd extension to a Quarkus project.

Add the extension to your project

To add the extension to the project, manually edit the pom.xml or build.gradle file.

Manually editing the pom.xml file

<dependency>
    <groupId>io.quarkiverse.argocd</groupId>
    <artifactId>quarkus-argocd</artifactId>
    <version>999-SNAPSHOT</version>
</dependency>

Manually editing the build.gradle file

dependencies {
    implementation 'io.quarkiverse.argocd:quarkus-argocd:999-SNAPSHOT'
}

After this step the Argo CD yaml files will be generated under the .argocd directory within the project root as part of the build.

Using the CLI

The project provides a companion CLI that can be used to generate, install / uninstall and list the Argo CD Applications. The CLI can be added with the following command:

quarkus plug add io.quarkiverse.argocd:quarkus-argocd-cli:999-SNAPSHOT

Regenerating the files:

To re-trigger the file generation:

quarkus argocd project generate

Note: Several parameters can be used to configure the generated CR. Use quarkus argocd generate -h to display the usage.

To install the generated Application and AppProject (optional) custom resources to the currently connected Kubernetes cluster:

quarkus argocd project install

Note: In case of un-committed or un-pushed changes the command will prompt users to decide if they want to proceed with the installation.

The currently connected Kubernetes cluster is the one that is configured in the ~/.kube/config file. It can be overridden by setting in applcation.properties a different API server URL and token. See the quarkus-kubernetes-client extension for more details.

To uninstall:

quarkus argocd project uninstall

Listing installed applications

To list all Applications installed

quarkus argocd project list