DocsICP FilingConsole
Documentation
Home Page Container Service for Kubernetes ACK One Use Cases CI/CD Best practice for ACK One GitOps ACK One GitOps sample application

ACK One GitOps sample application

Updated at:
Copy as MD
Product
My Favorites

This topic describes a sample application deployed using ACK One GitOps.

Directory structure of the deployment repository

A complete CI/CD pipeline involves two main types of repositories: a business code repository and a deployment repository. Because this guide requires you to modify repository configurations, you must fork the following repositories to your own account.

  • Business code repositories: The echo-server project and the echo-web-server project.

  • Deployment repository: Stores the YAML files for the applications that you want to deploy to your clusters. For more information, see the Alibaba Cloud GitOps Demo project (example branch). The main directory structure is as follows. This guide provides examples for development, staging, and production environments, covering a complete development workflow. It includes both Helm and Kustomize methods. Choose a deployment method based on your requirements.

    manifests
├── helm
│   ├── echo-server
│   │   ├── .argocd-source-app-helm-dev.yaml
│   │   ├── .argocd-source-app-helm-production.yaml
│   │   ├── .argocd-source-app-helm-staging.yaml
│   │   ├── Chart.yaml
│   │   ├── templates
│   │   │   ├── NOTES.txt
│   │   │   ├── _helpers.tpl
│   │   │   ├── deployment-echo-server.yaml
│   │   │   ├── deployment-echo-web-server.yaml
│   │   │   ├── external-secret.yaml
│   │   │   ├── hpa.yaml
│   │   │   ├── ingress.yaml
│   │   │   ├── rollout.yaml
│   │   │   ├── service-echo-server.yaml
│   │   │   ├── service-echo-web-server.yaml
│   │   │   ├── serviceaccount.yaml
│   │   │   └── tests
│   │   │       └── test-connection.yaml
│   │   ├── values-dev.yaml
│   │   ├── values-production.yaml
│   │   ├── values-staging.yaml
│   │   └── values.yaml
│   └── web-demo
│       ├── Chart.yaml
│       ├── templates
│       │   ├── deployment.yaml
│       │   └── service.yaml
│       └── values.yaml
└── kustomize
    ├── base
    │   ├── deployment.yaml
    │   ├── kustomization.yaml
    │   └── service.yaml
    └── overlay
        ├── dev
        │   ├── .argocd-source-app-kust-dev.yaml
        │   ├── deployment.yaml
        │   └── kustomization.yaml
        ├── production
        │   ├── .argocd-source-app-kust-production.yaml
        │   ├── deployment.yaml
        │   └── kustomization.yaml
        └── staging
            ├── .argocd-source-app-kust-staging.yaml
            ├── deployment.yaml
            └── kustomization.yaml

    The echo-server project in this deployment repository is managed by Helm and demonstrates capabilities such as multi-environment or multi-cluster deployments, multiple Deployments, multi-cluster secret management, and Rollouts.

Multi-environment or multi-cluster deployment

The following sections describe the configurations for applications managed by Helm and Kustomize.

  • Applications managed by Helm

    You can use different values.yaml files for environment-specific deployments, such as values-dev.yaml, values-staging.yaml, and values-production.yaml from the directory structure.

    • For example, if you want to disable Rollout-based rolling updates in the Dev environment but enable them in the Staging and Production environments, you can configure these settings in the respective values.yaml files.

    • In each values-****.yaml file, change the image repository information to match your Container Registry Enterprise Edition (ACR EE) instance. This guide uses an ACR EE instance named demo-test and a namespace named cidemo. Configure these settings based on your actual environment.

      image:
  echoServer:
    repository: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server
    tag: "v1.0"
  echoWebServer:
    repository: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-web-server
    tag: "v1.0"
  pullPolicy: IfNotPresent

  • Applications managed by Kustomize

    For applications managed by Kustomize, resource modifications are made using a base and overlay approach. To create environment-specific configurations, you can use different directories within the overlay directory.

After an application image is updated, Image Updater automatically writes the latest image information back to the .argocd-source-app-helm-xxx.yaml and .argocd-source-app-kust-xxx.yaml files in the Git repository. The content is similar to the following example. For more information about Application configurations, see Build a CI/CD pipeline by using ACK One GitOps and ACR.

helm:
  parameters:
  - name: image.echoServer.repository
    value: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server
    forcestring: true
  - name: image.echoServer.tag
    value: v2.1
    forcestring: true
  - name: image.echoWebServer.repository
    value: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-web-server
    forcestring: true
  - name: image.echoWebServer.tag
    value: v1.0
    forcestring: true

Distribute environment-specific credentials

If you need to use different configurations and credentials, such as database usernames and passwords, across multiple clusters, you can use Secrets Manager to encrypt and manage them. After that, you can import Alibaba Cloud KMS credentials for your application in each cluster. For more information about how to use Secrets Manager, see Quick start for Secrets Manager.

To use this feature, you must add a corresponding YAML file (external-secret.yaml) to the deployment repository. When the application is deployed, this file creates an ExternalSecret resource, which triggers the retrieval of credentials from KMS. The corresponding Secret is then mounted in deployment-echo-server.yaml.

In this guide, the values-****.yaml files for each environment require different settings. For example, you can disable the secretManager capability in the development environment. Modify the configuration based on your requirements.

Canary release

In staging and production environments, you typically need to perform progressive releases using the Rollout capability. To do this, add a corresponding YAML file, rollout.yaml, to the deployment repository. This file deploys a Rollout resource to trigger a canary release or a rolling update. For more information about canary releases, see Perform a canary release by using ACK One GitOps and Argo Rollouts and Use Kruise Rollout to implement a canary release (Canary & A/B Testing).

Application manifests

The following sections provide sample Application YAML manifests for deploying with Helm and Kustomize in development, staging, and production environments. Modify the argocd-image-updater.argoproj.io/image-list and repoURL settings based on your actual environment.

Helm

The following manifests are for the Helm application in each environment.

  • Development environment

    Application manifest

    apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: app-helm-dev
  annotations:
    argocd-image-updater.argoproj.io/image-list: echoserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server,webserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-web-server
    argocd-image-updater.argoproj.io/echoserver.helm.image-name: image.echoServer.repository
    argocd-image-updater.argoproj.io/echoserver.helm.image-tag: image.echoServer.tag
    argocd-image-updater.argoproj.io/echoserver.update-strategy: latest
    argocd-image-updater.argoproj.io/webserver.helm.image-name: image.echoWebServer.repository
    argocd-image-updater.argoproj.io/webserver.helm.image-tag: image.echoWebServer.tag
    argocd-image-updater.argoproj.io/webserver.update-strategy: latest
    argocd-image-updater.argoproj.io/write-back-method: git
spec:
  destination:
    namespace: app-helm-dev
    # https://XX.XX.XX.XX:6443
    server: ${url}
  source:
    path: manifests/helm/echo-server
    repoURL: 'git@github.com:ivan-cai/gitops-demo.git'
    targetRevision: stable-example
    helm:
      valueFiles:
        - values-dev.yaml
  sources: []
  project: default
  syncPolicy:
    automated: {}
    syncOptions:
      - CreateNamespace=true

  • Staging environment

    Application manifest

    apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: app-helm-staging
  annotations:
    argocd-image-updater.argoproj.io/image-list: echoserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server,webserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-web-server
    argocd-image-updater.argoproj.io/echoserver.helm.image-name: image.echoServer.repository
    argocd-image-updater.argoproj.io/echoserver.helm.image-tag: image.echoServer.tag
    argocd-image-updater.argoproj.io/echoserver.update-strategy: latest
    argocd-image-updater.argoproj.io/webserver.helm.image-name: image.echoWebServer.repository
    argocd-image-updater.argoproj.io/webserver.helm.image-tag: image.echoWebServer.tag
    argocd-image-updater.argoproj.io/webserver.update-strategy: latest
    argocd-image-updater.argoproj.io/write-back-method: git
spec:
  destination:
    namespace: app-staging
    # https://XX.XX.XX.XX:6443
    server: ${url}
  source:
    path: manifests/helm/echo-server
    repoURL: 'git@github.com:ivan-cai/gitops-demo.git'
    targetRevision: stable-example
    helm:
      valueFiles:
        - values-staging.yaml
  sources: []
  project: default
  syncPolicy:
    syncOptions:
      - CreateNamespace=true

  • Production environment

    Application manifest

    apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: app-helm-production
  annotations:
    argocd-image-updater.argoproj.io/image-list: echoserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server,webserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-web-server
    argocd-image-updater.argoproj.io/echoserver.helm.image-name: image.echoServer.repository
    argocd-image-updater.argoproj.io/echoserver.helm.image-tag: image.echoServer.tag
    argocd-image-updater.argoproj.io/echoserver.update-strategy: latest
    argocd-image-updater.argoproj.io/webserver.helm.image-name: image.echoWebServer.repository
    argocd-image-updater.argoproj.io/webserver.helm.image-tag: image.echoWebServer.tag
    argocd-image-updater.argoproj.io/webserver.update-strategy: latest
    argocd-image-updater.argoproj.io/write-back-method: git
spec:
  destination:
    namespace: app-production
    # https://XX.XX.XX.XX:6443
    server: ${url}
  source:
    path: manifests/helm/echo-server
    repoURL: 'git@github.com:ivan-cai/gitops-demo.git'
    targetRevision: stable-example
    helm:
      valueFiles:
        - values-production.yaml
  project: default
  syncPolicy:
    syncOptions:
      - CreateNamespace=true

Kustomize

The following manifests are for the Kustomize application in each environment.

  • Development environment

    Application manifest

    apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd-image-updater.argoproj.io/image-list: echoserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server:v1.0
    argocd-image-updater.argoproj.io/echoserver.kustomize.image-name: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server
    argocd-image-updater.argoproj.io/echoserver.update-strategy: latest
    argocd-image-updater.argoproj.io/write-back-method: git
  name: app-kust-dev
spec:
  destination:
    namespace: app-kust-dev
    # https://XX.XX.XX.XX:6443
    server: ${url}
  source:
    path: manifests/kustomize/overlay/dev
    repoURL: 'git@github.com:ivan-cai/gitops-demo.git'
    targetRevision: stable-example
    kustomize:
      images: []
  project: default
  syncPolicy:
    automated: {}
    syncOptions:
      - CreateNamespace=true

  • Staging environment

    Application manifest

    apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd-image-updater.argoproj.io/image-list: echoserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server:v1.0
    argocd-image-updater.argoproj.io/echoserver.kustomize.image-name: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server
    argocd-image-updater.argoproj.io/echoserver.update-strategy: latest
    argocd-image-updater.argoproj.io/write-back-method: git
  name: app-kust-staging
spec:
  destination:
    namespace: app-staging-kust
    # https://XX.XX.XX.XX:6443
    server: ${url}
  source:
    path: manifests/kustomize/overlay/staging
    repoURL: 'git@github.com:ivan-cai/gitops-demo.git'
    targetRevision: stable-example
    kustomize:
      images: []
  sources: []
  project: default
  syncPolicy:
    syncOptions:
      - CreateNamespace=true

  • Production environment

    Application manifest

    apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd-image-updater.argoproj.io/image-list: echoserver=demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server:v1.0
    argocd-image-updater.argoproj.io/echoserver.kustomize.image-name: demo-test-registry.cn-hangzhou.cr.aliyuncs.com/cidemo/echo-server
    argocd-image-updater.argoproj.io/echoserver.update-strategy: latest
    argocd-image-updater.argoproj.io/write-back-method: git
  name: app-kust-production
spec:
  destination:
    namespace: app-production-kust
    # https://XX.XX.XX.XX:6443
    server: ${url}
  source:
    path: manifests/kustomize/overlay/production
    repoURL: 'git@github.com:ivan-cai/gitops-demo.git'
    targetRevision: stable-example
    kustomize:
      images: []
  project: default
  syncPolicy:
    syncOptions:
      - CreateNamespace=true

Related documentation

Previous：Best practices overviewNext：Build a container image CI on ACK One