• 简体中文

argocdapp Plugin

This plugin creates an Argo CD Application custom resource.

Notes:

• Argo CD itself must have been already installed before the usage of this plugin. To install Argo CD, use the helm-installer plugin. Or you can use both plugins(argocd+argocdapp) at the same time. See GitOps Toolchain for more info.
• Currently, only the Helm chart is supported when creating the Argo CD application.

Usage

The following content is an example of the "tool file".

For more information on the main config, the tool file and the var file of DevStream, see Core Concepts Overview and DevStream Configuration.

YAML

tools:
# name of the tool
- name: argocdapp
  # id of the tool instance
  instanceID: default
  # format: name.instanceID; If specified, dtm will make sure the dependency is applied first before handling this tool.
  dependsOn: [ "argocd.ARGOCD_INSTANCE_NAME" ]
  # options for the plugin
  options:
    # information on the ArgoCD Application
    app:
      # name of the ArgoCD Application
      name: hello
      # where the ArgoCD Application custom resource will be created
      namespace: argocd
    # destination of the ArgoCD Application
    destination:
      # on which server to deploy
      server: https://kubernetes.default.svc
      # in which namespace to deploy
      namespace: default
    # source of the application
    source:
      # which values file to use in the Helm chart
      valuefile: values.yaml
      # path of the Helm chart
      path: charts/go-hello-http
      # Helm chart repo URL, this is only an example, do not use this
      repoURL: YOUR_CHART_REPO_URL
      # Helm chart repo branch
      repoBranch: YOUR_CHART_REPO_BRANCH
    # if repo doesn't contain path, use imageRepo to create a helm config
    imageRepo:
      # imageRepo address
      url: IMAGE_REPO_ADDRESS
      user: IMAGE_REPO_OWNER
      # config inital image tag
      initalTag: IMAGE_REPO_TAG

Automatically Create Helm Configuration

This plugin can push helm configuration automatically when your source.path helm config does not exist so that you can use this plugin with helm configured already. For example:

YAML

---
tools:
- name: go-webapp-argocd-deploy
  plugin: argocdapp
  dependsOn: ["repo-scaffolding.golang-github"]
  options:
    app:
      name: hello
      namespace: argocd
    destination:
      server: https://kubernetes.default.svc
      namespace: default
    source:
      valuefile: values.yaml
      path: charts/go-hello-http
      repoURL: https://github.com/devstream-io/testrepo.git
    imageRepo:
      url: http://test.barbor.com/library
      user: test_owner
      tag: "1.0.0"

This config will push the default helm config](https://github.com/devstream-io/dtm-pipeline-templates/tree/main/argocdapp/helm) to repo testrepo, and the generated config will use the image http://test.barbor.com/library/test_owner/hello:1.0.0 as the initial image for Helm.

Use Together with the repo-scaffolding Plugin

This plugin can be used together with the repo-scaffolding plugin (see document here.)

For example, you can first use repo-scaffolding to bootstrap a Golang repo, then use this plugin to set up basic GitHub Actions CI workflows. In this scenario:

• This plugin can specify repo-scaffolding as a dependency, so that the dependency is first satisfied before executing this plugin.
• This plugin can refer to repo-scaffolding's output to reduce copy/paste human error.

See the example below:

YAML

---
tools:
- name: repo-scaffolding
  instanceID: golang-github
  options:
    destinationRepo:
      owner: [[ githubUsername ]]
      org: ""
      name: [[ repoName ]]
      branch: [[ defaultBranch ]]
      scmType: github
    vars:
      imageRepo: "[[ dockerhubUsername ]]/[[ repoName ]]"
    sourceRepo:
      org: devstream-io
      name: dtm-scaffolding-golang
      scmType: github
- name: go-webapp-argocd-deploy
  plugin: argocdapp
  dependsOn: ["repo-scaffolding.golang-github"]
  options:
    app:
      name: hello
      namespace: argocd
    destination:
      server: https://kubernetes.default.svc
      namespace: default
    source:
      valuefile: values.yaml
      path: charts/go-hello-http
      repoURL: ${{repo-scaffolding.golang-github.outputs.repoURL}}

In the example above:

• We put repo-scaffolding.golang-github as dependency by using the dependsOn keyword.
• We used repo-scaffolding.golang-github's output as input for the github-actions plugin.

Pay attention to the ${{ xxx }} part in the example. ${{ TOOL_NAME.PLUGIN.outputs.var}} is the syntax for using an output.