llms.txt

# Alauda GitOps Documentation

> Documentation for Alauda GitOps, a platform-managed Argo CD distribution with operator-based lifecycle and integrated UI workflows.

## Root

- [README.md](README.md): Contributor setup notes for the docs site itself: install Node.js/npm, run `yarn install`, and recommends VS Code with the MDX extension for authoring. Lists the three local commands `yarn dev` (live-reloading dev server, with a note that left-nav changes require a restart), `yarn build` (produces static output in `dist`), and `yarn serve` (preview the built site).

## docs

- [docs/en/apis/advanced_apis/gitops/applications.mdx](docs/en/apis/advanced_apis/gitops/applications.mdx): OpenAPI reference for the GitOps Application HTTP endpoints under `/gitops/v1/project/{project}/applications`, including list, get-by-name, events, refresh, and sync operations. Rendered from the OpenAPI spec via the `<OpenAPIPath>` component so users can drive Argo CD Application lifecycle actions through the platform's project-scoped REST API.
- [docs/en/apis/advanced_apis/gitops/applicationsets.mdx](docs/en/apis/advanced_apis/gitops/applicationsets.mdx): OpenAPI reference for the ApplicationSet endpoints under `/gitops/v1/project/{project}/applicationsets`, covering list/get/delete of ApplicationSets plus nested routes for their generated applications, per-application sync, events, refresh, sync, topology, and PrometheusRule management. Rendered from the OpenAPI spec via `<OpenAPIPath>` for project-scoped ApplicationSet operations.
- [docs/en/apis/advanced_apis/gitops/core.mdx](docs/en/apis/advanced_apis/gitops/core.mdx): OpenAPI reference for the GitOps core endpoints: the GraphQL endpoint `/gitops/v1/gql` and the repository helpers `/gitops/v1/project/{project}/repository/apps` and `/repository/refs`, used to discover applications and Git refs available in a connected source repository.
- [docs/en/apis/advanced_apis/gitops/index.mdx](docs/en/apis/advanced_apis/gitops/index.mdx): Landing page for the GitOps Advanced API section, rendering an `<Overview>` directory listing of the nested core, applications, and applicationsets API references.
- [docs/en/apis/advanced_apis/index.mdx](docs/en/apis/advanced_apis/index.mdx): Top-level landing page for the Advanced APIs category that uses the `<Overview>` component to enumerate domain-specific advanced API groupings (e.g., the GitOps subgroup).
- [docs/en/apis/index.mdx](docs/en/apis/index.mdx): Root index page of the API Reference section, titled "API Reference" via i18n front matter, that renders an `<Overview>` table of contents linking into Advanced APIs and other API groupings exposed by Alauda GitOps.
- [docs/en/argocd_troubleshooting.mdx](docs/en/argocd_troubleshooting.mdx): FAQ-style troubleshooting guide for common Argo CD operational issues: deleting apps whose repo is missing (`--cascade=false`), persistent `OutOfSync` and `Progressing` states (Ingress / StatefulSet / SealedSecret quirks), disabling the admin user via `argocd-cm`, air-gapped Helm chart dependencies, why `helm ls` doesn't see Argo-managed apps, cluster-secret labeling, Kustomize `instance` label collisions, polling interval tuning, oversized JWT cookies, the `--grpc-web` CLI workaround, and rotating Redis keys plus restarting `argocd-server`, `argocd-repo-server`, and `argocd-application-controller`.
- [docs/en/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx](docs/en/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx): Introduces Alauda Container Platform GitOps as a Kubernetes-native GitOps distribution built on Argo CD that watches Git for manifests (Application, ApplicationSet) and reconciles them to clusters. Highlights why Argo CD was chosen (declarative engine, multi-source Helm/Kustomize/YAML, multi-cluster control plane, CNCF ecosystem) and Alauda's value-adds: enterprise Argo CD Operator support, visual multi-environment distribution, visual ops with live Workload logs/events, visual cluster-config management, and closed-loop integration with platform DevOps, CrossPlane, MySQL, and the Developer Portal.
- [docs/en/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd_status.mdx](docs/en/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd_status.mdx): Defines how Alauda GitOps aggregates resource state into Application and ApplicationSet status. Documents the four sync states (`Sync Failed`, `OutOfSync`, `Syncing`, `Synced`) and six health states (`Unknown`, `Missing`, `Degraded`, `Paused`, `Progressing`, `Healthy`), each with priority rules for roll-up, and lists the "Healthy" recognition criteria for Deployment, StatefulSet, ReplicaSet, DaemonSet, Ingress, Service, PVC, Pod, Job, and HPA resources.
- [docs/en/concept/alauda_gitops_concept_info/index.mdx](docs/en/concept/alauda_gitops_concept_info/index.mdx): Section landing page for Alauda Container Platform GitOps Concepts, rendering an `<Overview>` of the introduction and sync/health-status pages beneath it.
- [docs/en/concept/argocd_concept_info/concept_argocd_application.mdx](docs/en/concept/argocd_concept_info/concept_argocd_application.mdx): Explains the Argo CD `Application` CRD (`argoproj.io/v1alpha1`) as a declarative grouping of Kubernetes resources for single-component, statically configured, single-cluster deployments. Includes an exhaustive YAML example covering `source` variants (Helm parameters/valueFiles/valuesObject/version, Kustomize patches/images/replicas/components, raw directory with Jsonnet extVars/tlas, CMP plugin parameters), multi-source `sources`, `destination`, `syncPolicy` with automated prune/selfHeal and sync options (`Validate=false`, `CreateNamespace=true`, `PrunePropagationPolicy`, `PruneLast`, `RespectIgnoreDifferences`, `ApplyOutOfSyncOnly`), retry backoff, `ignoreDifferences` via jsonPointers / jqPathExpressions / managedFieldsManagers, and `revisionHistoryLimit`.
- [docs/en/concept/argocd_concept_info/concept_argocd_applicationset.mdx](docs/en/concept/argocd_concept_info/concept_argocd_applicationset.mdx): Describes the Argo CD ApplicationSet controller and CRD for templating many Applications from a single spec, with use cases for fan-out deployment of similar microservices, multi-cluster rollout with per-cluster parameters, and dynamic Application generation from Git branches/tags. Includes a list-generator YAML example using `goTemplate: true` to expand `{{.cluster}}` and `{{.url}}` into per-cluster Applications targeting `engineering-dev`, `engineering-prod`, and `finance-preprod`.
- [docs/en/concept/argocd_concept_info/concept_argocd_health.mdx](docs/en/concept/argocd_concept_info/concept_argocd_health.mdx): Concept summary of Argo CD's resource health model, listing the four states `Health`, `Progressing`, `Degraded`, and `Suspended` (e.g., paused Deployment or suspended CronJob) and noting that built-in checks for standard Kubernetes types bubble up to the overall Application health, with a pointer to Argo CD's custom health-check extensibility.
- [docs/en/concept/argocd_concept_info/concept_argocd_sync.mdx](docs/en/concept/argocd_concept_info/concept_argocd_sync.mdx): Conceptual overview of Argo CD's Sync engine, contrasting Desired State (Git) with Live State (cluster) and explaining how reconciliation is driven manually, by webhook/commit/tag events, or on a poll. Defines the application Sync Status values (`Synced`, `OutOfSync`, `Syncing`) and Sync Operation Status values (`Succeeded`, `Failed`, `Running`), plus the Refresh operation that re-fetches Git and re-diffs against the cluster.
- [docs/en/concept/argocd_concept_info/concept_argocd_tool.mdx](docs/en/concept/argocd_concept_info/concept_argocd_tool.mdx): Introduces Argo CD's Tool concept for generating Kubernetes manifests, covering the four supported approaches (Kustomize, Helm, Directory of YAML/JSON/Jsonnet files, and custom Config Management Plugins) and the `argocd app sync APPNAME --local` workflow for uploading local manifests during development. Includes a feature-comparison matrix scoring Helm, Kustomize, and Directory on templating method, reusability, multi-environment support, progressive delivery, learning curve, and typical use cases.
- [docs/en/concept/argocd_concept_info/concept_argocd_tool_directory.mdx](docs/en/concept/argocd_concept_info/concept_argocd_tool_directory.mdx): Describes Argo CD's Directory source type, which loads plain `.yml`, `.yaml`, or `.json` manifests from a repo path without requiring `spec.source.directory` configuration. Provides a declarative `argoproj.io/v1alpha1 Application` example pointing at the argocd-example-apps guestbook directory, explains advantages (simplicity, low maintenance) for small-scale GitOps adoption, and warns that Argo CD will fail to render the path if it detects Kustomize, Helm, or Jsonnet files.
- [docs/en/concept/argocd_concept_info/concept_argocd_tool_helm.mdx](docs/en/concept/argocd_concept_info/concept_argocd_tool_helm.mdx): Explains Argo CD's Helm integration, defining the core Chart, Release, and Values concepts and showing declarative `Application` manifests for both a standard HTTPS chart repo (sealed-secrets from bitnami-labs) and an OCI registry (nginx chart). Notes that the Application's lifecycle is managed by Argo CD rather than Helm, documents the value-source priority order (`parameters` > `valuesObject` > `values` > `valueFiles` > repo `values.yaml`), and covers Helm's gotpl templating, packaging, dependency, and install/upgrade/rollback lifecycle features.
- [docs/en/concept/argocd_concept_info/concept_argocd_tool_kustomize.mdx](docs/en/concept/argocd_concept_info/concept_argocd_tool_kustomize.mdx): Covers Argo CD's Kustomize integration via Base, Overlay, and `kustomization.yaml` composition, including a declarative `Application` example sourcing the kubernetes-sigs/kustomize `examples/helloWorld` path. Enumerates supported configuration options such as `namePrefix`, `nameSuffix`, `images`, `replicas`, `commonLabels`, `labelWithoutSelector`, `forceCommonLabels`, `commonAnnotations`, `namespace`, `commonAnnotationsEnvsubst`, `patches`, and `components`, and highlights its template-free, kubectl-native approach for multi-environment distribution and progressive delivery.
- [docs/en/concept/argocd_concept_info/gitops_concept_argocd.mdx](docs/en/concept/argocd_concept_info/gitops_concept_argocd.mdx): Argo CD primer that frames the five core concepts to learn first: Application (CRD grouping Kubernetes resources), ApplicationSet (controller templating bulk Applications), Tool (Kustomize/Helm config management), Sync (reconciling live state to desired state), and Health. Includes a side-by-side Application vs ApplicationSet comparison across definition, configuration, deployment scope, use cases, and core concepts, plus a table defining the Synced, OutOfSync, and Syncing status values.
- [docs/en/concept/argocd_concept_info/index.mdx](docs/en/concept/argocd_concept_info/index.mdx): Section landing page for Argo CD core concepts that renders an `<Overview />` index of the child topics — Application, ApplicationSet, Tool (Kustomize/Helm/Directory), Sync, Health, and the Argo CD introduction.
- [docs/en/concept/gitops_concept_infro.mdx](docs/en/concept/gitops_concept_infro.mdx): Introduces GitOps as the practice of using Git as the authoritative source for infrastructure and application config, and lays out its four core principles: declarative configuration, versioned and immutable state (rollbacks via `git revert`), automated reconciliation, and controller-driven self-healing. Also enumerates benefits (collaboration, rapid rollback, multi-environment governance, security/compliance via Git RBAC, audit logs, and branch protections) and surveys popular tools — Argo CD, Flux, and Jenkins X.
- [docs/en/concept/index.mdx](docs/en/concept/index.mdx): Landing page for the Concepts section that embeds an `<Overview />` component to surface the GitOps Introduction and the Argo CD Concept subsection (Application, ApplicationSet, Tool, Sync, Health).
- [docs/en/functions/argocd_observability/argocd_operator_observability.mdx](docs/en/functions/argocd_observability/argocd_operator_observability.mdx): Walks operators through monitoring Argo CD components from the web console: logging in as Administrator, selecting the `global` cluster, then navigating Operations Center > Monitoring > Monitoring Dashboard, clicking Switch to choose the `container-platform` source, and opening the ArgoCD dashboard to view resource and operational state metrics. Lists installing Alauda Container Platform GitOps and the Monitoring plugin as prerequisites.
- [docs/en/functions/argocd_observability/gitops_application_alert.mdx](docs/en/functions/argocd_observability/gitops_application_alert.mdx): Day-2 operations guide for GitOps Applications in the web console, covering creation of alert rules under the Alerts tab — including the `gitops.applicationset.healthy` metric (0 = Unknown/Lost/Degraded/Paused, 1 = Syncing, 2 = Healthy) and `gitops.applicationset.synced` metric (0 = Sync Failed/Pending, 1 = Syncing, 2 = Synced). Also shows how to inspect workload logs from Kubernetes Resources and aggregated events from the Events tab without requiring the Log cluster plugin.
- [docs/en/functions/argocd_observability/index.mdx](docs/en/functions/argocd_observability/index.mdx): Landing page for the GitOps Observability function section, embedding `<Overview />` to surface the Argo CD Component Monitoring and GitOps Applications Ops (alerts, logs, events) child topics.
- [docs/en/functions/create_argocd_application/create_application_via_platform.mdx](docs/en/functions/create_argocd_application/create_application_via_platform.mdx): Step-by-step procedure for creating an Argo CD Application via Alauda Container Platform GitOps, with three creation paths: the Container Platform > GitOps Applications visual form (configuring Type, Source — Platform integrated vs ArgoCD integrated GitLab/GitHub/Bitbucket/Gitee/Gitea, Version Identifiers of Branch/Tag/Commit, Source File Type of Kustomize/Helm/Directory, Destination, and Sync Policy with 3-minute reconciliation), a raw `argoproj.io/v1alpha1 Application` YAML tab (with `automated.prune`, `selfHeal`, and `CreateNamespace=true`), and `kubectl apply -f application.yaml` via the web-cli plugin. Also explains the sync-ignore template UI and the resulting `ignoreDifferences` block.
- [docs/en/functions/create_argocd_application/create_applicationset_via_platform.mdx](docs/en/functions/create_argocd_application/create_applicationset_via_platform.mdx): Procedure for creating an Argo CD ApplicationSet through the Alauda Container Platform GitOps web console for cross-cluster/cross-namespace deployments with differentiated configuration. Covers the same Basic Info, Code Repository, Destination, and Sync Policy parameters as the Application flow, then documents lifecycle management actions in the GitOps Application list — Update (overwrites all child instances), Manually Sync, Delete (cascade-removes children), Automatic Sync (3-minute reconciliation), Source navigation back to the parent, and Application Distribution via `Applications > Add Distribution`.
- [docs/en/functions/create_argocd_application/index.mdx](docs/en/functions/create_argocd_application/index.mdx): Section index for Creating GitOps Application that uses `<Overview />` to list the Application and ApplicationSet creation procedures.
- [docs/en/functions/index.mdx](docs/en/functions/index.mdx): Top-level landing page for the Guides (functions) section, rendering an `<Overview />` of the available task-oriented guides such as creating GitOps Applications/ApplicationSets and GitOps observability.
- [docs/en/how_to/argocd_git.mdx](docs/en/how_to/argocd_git.mdx): Walks Administrators through connecting Git source repositories through the native Argo CD dashboard: opening Settings, using the REPO card's CONNECT REPO action with credentials, and then attaching the repository URL to a Project's SOURCE REPOSITORIES so it surfaces in the web console's GitOps Applications create flow. Assumes the Alauda Container Platform GitOps plugin is installed with the Native Argo CD UI switch enabled.
- [docs/en/how_to/argocd_info.mdx](docs/en/how_to/argocd_info.mdx): Explains how to obtain Argo CD dashboard access information for both deployment paths: the Alauda Container Platform GitOps cluster plugin (via the Marketplace cluster-plugins details page, optionally with Single Sign-On) and the Alauda Build of Argo CD Operator (by exposing the argocd-gitops-server Service as NodePort against a control-plane node IP). Also documents retrieving and patching the default admin password through `kubectl` against the `argocd-gitops-cluster` secret.
- [docs/en/how_to/create_application_by_argocd_dashoard.mdx](docs/en/how_to/create_application_by_argocd_dashoard.mdx): Step-by-step guide to creating an Argo CD Application from the native Argo CD dashboard using the +NEW APP button, including the guestbook example: setting the application name, default project, Manual sync policy, the `argocd-example-apps` repository URL with HEAD revision and `guestbook` path, and an in-cluster destination at `https://kubernetes.default.svc` in the `default` namespace.
- [docs/en/how_to/create_gitops_app.mdx](docs/en/how_to/create_gitops_app.mdx): Tutorial for creating an Argo CD Application via the web console's GitOps Applications entry, walking through Code Repository integration, Basic Info and Code Repository parameters (Type=Application, Source=Argo CD Integration, integrated project `argocd-example-apps`, master branch, Helm source type with `helm-guestbook` directory and `values.yaml`), platform-recommended namespace selection, and Manually Sync policy to deploy a SpringBoot demo.
- [docs/en/how_to/index.mdx](docs/en/how_to/index.mdx): Section landing page for the How To guides, rendered via the `<Overview />` component to enumerate task-oriented topics such as Argo CD dashboard repository integration, obtaining access information, and creating Applications through both the native Argo CD UI and the platform's GitOps Applications console.
- [docs/en/index.mdx](docs/en/index.mdx): Top-level navigation entry for the English documentation set, using the `<Overview />` component with empty headers to act as the root index that links to Overview, Install, Concepts, How To, and other Alauda Container Platform GitOps sections.
- [docs/en/install_gitops/index.mdx](docs/en/install_gitops/index.mdx): Landing page for the Install section, rendered with the `<Overview />` component to surface the installation paths: deploying the Alauda Container Platform GitOps cluster plugin on the `global` cluster and installing/upgrading the standalone Alauda Build of Argo CD Operator.
- [docs/en/install_gitops/install_argocd_operator.mdx](docs/en/install_gitops/install_argocd_operator.mdx): Installation procedure for the Alauda Build of Argo CD Operator: uploading the architecture-matched package, installing the Operator from OperatorHub on the alpha channel in Cluster install mode with auto upgrades, creating an Argo CD instance (toggling `ha.enabled=false` when the global cluster lacks HA), and optionally creating a `cpaas-system` AppProject (with wildcard cluster resources, destinations, and source repos) to unlock platform-managed Cluster Configuration Management.
- [docs/en/install_gitops/install_gitops_plugin.mdx](docs/en/install_gitops/install_gitops_plugin.mdx): Procedure for installing the Alauda Container Platform GitOps cluster plugin onto the `global` cluster from the Marketplace Cluster Plugins page, documenting each parameter (Native Argo CD UI toggle, HTTPS-only OIDC Single Sign-On, dynamically generated Access Address, account/password, and minimum/recommended resource quotas), the constraint that it restricts operations on argocd-operator's ArgoCD instance, and verification steps confirming the Cluster Config and GitOps Applications entries appear.
- [docs/en/install_gitops/upgrade_argocd_operator.mdx](docs/en/install_gitops/upgrade_argocd_operator.mdx): Upgrade procedure for the Alauda Build of Argo CD Operator: uploading the new package, using the Operator page's Cross-Cluster Sync to push the new Sync Version to the target cluster's argocd-operator, then waiting for auto-upgrade through OperatorHub. Includes a warning that upgrading from versions earlier than v4.2.0 moves Argo CD from v2.x to v3.x with breaking changes per the upstream Argo CD 2.14-3.0 upgrade notes.
- [docs/en/overview/architecture.mdx](docs/en/overview/architecture.mdx): Architectural overview explaining how GitOps treats Git as the single source of truth and how Argo CD reconciles cluster state against repository configuration to prevent drift. Describes Alauda Container Platform GitOps as a cluster plugin deployed on the `global` cluster that uses Argo CD to distribute applications and infrastructure to multiple business Kubernetes clusters, supported by accompanying architecture diagrams.
- [docs/en/overview/index.mdx](docs/en/overview/index.mdx): Section landing page for the Overview area, rendered through the `<Overview />` component to link the Introduction, Architecture, Lifecycle Policy, and Release Notes pages that orient new users to Alauda Container Platform GitOps.
- [docs/en/overview/intro.mdx](docs/en/overview/intro.mdx): Introduces GitOps as a continuous delivery paradigm with Git as the single source of truth and outlines representative use cases (containerized application delivery on Kubernetes, multi-environment management, microservices operations, IaC integration with Terraform/Ansible, cross-team collaboration). Lists Alauda Container Platform GitOps's differentiators including an enterprise-grade Argo CD Operator, Operator safety service, visual multi-environment distribution, visual Ops and cluster configuration management, and closed-loop integration with platform products.
- [docs/en/overview/lifecycle_policy.mdx](docs/en/overview/lifecycle_policy.mdx): Version lifecycle policy for Alauda Container Platform GitOps, presenting a release-date and end-of-life table; currently lists v4.2.0 with a 2025 release date and a 2027 end-of-life placeholder.
- [docs/en/overview/release_notes.mdx](docs/en/overview/release_notes.mdx): Release notes for Alauda Container Platform GitOps, presenting a supported-versions table that aligns v4.2.0 with the corresponding `<Term name="product"/>` and Alauda Build of ArgoCD v4.2 releases, and summarizing v4.2.0 highlights: upgrade of Argo CD to v3 and independently releasable cadence decoupled from the core product.
- [docs/en/upgrade/index.mdx](docs/en/upgrade/index.mdx): Section landing page for the Upgrade chapter of the Alauda Container Platform GitOps documentation; renders an <Overview /> component that links to the underlying upgrade procedures.
- [docs/en/upgrade/upgrade_gitops_plugin.mdx](docs/en/upgrade/upgrade_gitops_plugin.mdx): Step-by-step procedure for upgrading the Alauda Container Platform GitOps cluster plugin on the `global` cluster, covering prerequisites (downloading the architecture-specific package, uploading via Platform Management > Marketplace > Upload Packages, and installing through the cluster plugins mechanism) and the upgrade flow via Clusters > global > Functional Components > Upgrade. Includes a post-upgrade step required only when upgrading from ACP 3.16.0 — running `kubectl delete cm -n argocd argocd-redis-ha-configmap` and verifying recreation with `kubectl get cm` — plus verification that the Config entry and GitOps Applications navigation entries appear after the upgrade.