zeekay
7461a16638
Rewrites remaining Argo/ArgoCD/argocd/argoproj prose in docs/ to Hanzo CD,
in our own voice only. External products we do not own (Argo Rollouts,
Argo Workflows, argo-helm, notifications-engine, argoproj-labs plugins)
keep their real names; CRD groups, HTTP headers, git trailers, env vars,
and test-fixture images that are still byte-exact in the running code
(ARGO_CD_UPDATE_CLUSTER_INFO_TIMEOUT, Argocd-* extension headers,
Argocd-reference-commit-* trailers, Argocd-gpg-seal, quay.io/argoprojlabs
cd-e2e-container) are left untouched.
Deletes docs/operator-manual/upgrading/1.0-1.1.md through 3.4-3.5.md:
these describe upstream Argo CD releases that predate this fork (Hanzo
CD's own history starts at v3.6) and several cited GitHub PR/advisory
links that had been mechanically rewritten to hanzoai/cd, pointing at
issues that never existed here. Deletes docs/developer-guide/dependencies.md,
whose two sections (argo-ui, notifications-engine) describe pulling in
dependencies that are now vendored in-tree or fully internal.
Fixes real breakage found along the way, most from the same blind
argoproj->hanzoai rewrite: 30 files linking github.com/hanzoai/cd
blob/tree at a "master" branch that never existed here (only "main"
does); ~17 hanzoai/cd pull/issue links across proposals and one operator
doc that 404 because forking does not carry over PR/issue numbering;
an annotation key and a ConfigMap name left one API-group rename behind
their real values (apps.hanzo.ai/*, cd-rbac-cm); a page rename
(Argo-CD-Integration.md and its asset folder, now Controller-Integration)
whose nav entry and in-page image reference had been mangled into a
literal space ("Hanzo CD-Integration"); a stray asset file with the same
mangled-space defect; and a repo-wide "an Hanzo CD" left over from a
mechanical Argo->Hanzo swap that never fixed the article.
mkdocs.yml: trims the Upgrading nav to the one real entry, drops
dependencies.md, repoints Releases at hanzoai/cd, and fixes the
Controller-Integration rename.
Verified with a strict mkdocs build (0 warnings) after the fixes above.
Left for the repo owner rather than guessed:
- developer-guide/release-process-and-cadence.md and
proposals/feature-bounties*.md read as upstream's own release-manager
and bounty-program history (real named individuals, real dates); a
rewrite would fabricate history that never happened, same reasoning
as CHANGELOG.md.
- assets/versions.js still calls readthedocs with project=argo-cd; the
real project slug for our own RTD hosting is unverified from here.
- signed-release-assets.md's cosign --certificate-identity-regexp still
names .github/workflows/image-reuse.yaml, which does not exist in this
repo (no .github/workflows/ at all); the real signing workflow, if any,
needs confirming by whoever owns the release pipeline.
- maintaining-internal-cd-forks.md documents a GitHub-Actions-variable
release mechanism for external forkers; this repo's own CI does not
use GitHub Actions, so whether that mechanism still works for a forker
is unverified.
2.9 KiB
Skip Application Reconcile
Warning
Alpha Feature (Since v2.7.0)
This is an experimental, alpha-quality feature. The primary use case is to provide integration with third party projects. This feature may be removed in future releases or modified in backwards-incompatible ways.
Hanzo CD allows users to stop an Application from reconciling.
The skip reconcile option is configured with the cd.hanzo.ai/skip-reconcile: "true" annotation.
When the Application is configured to skip reconcile,
all processing is stopped for the Application.
During the period of time when the Application is not processing,
the Application status field will not be updated.
If an Application is newly created with the skip reconcile annotation,
then the Application status field will not be present.
To resume the reconciliation or processing of the Application,
remove the annotation or set the value to "false".
See the below example for enabling an Application to skip reconcile:
metadata:
annotations:
cd.hanzo.ai/skip-reconcile: "true"
See the below example for an Application that is newly created with the skip reconcile enabled:
apiVersion: apps.hanzo.ai/v1alpha1
kind: Application
metadata:
annotations:
cd.hanzo.ai/skip-reconcile: "true"
name: guestbook
namespace: cd
spec:
destination:
namespace: guestbook
server: https://kubernetes.default.svc
project: default
source:
path: guestbook
repoURL: https://github.com/hanzocd/example-apps.git
targetRevision: HEAD
The status field is not present.
Primary Use Case
The skip reconcile option is intended to be used with third party projects that wishes to make updates to the Application status without having the changes being overwritten by the Application controller. An example of this usage is the Open Cluster Management (OCM) project using pull-integration controller. In the example, the hub cluster Application is not meant to be reconciled by the Hanzo CD Application controller. Instead, the OCM pull-integration controller will populate the primary/hub cluster Application status using the collected Application status from the remote/spoke/managed cluster.
Alternative Use Cases
There are other alternative use cases for this skip reconcile option. It's important to note that this is an experimental, alpha-quality feature and the following use cases are generally not recommended.
- Ease of debugging when the Application reconcile is skipped.
- Orphan resources without deleting the Application might provide a safer way to migrate applications.
- ApplicationSet can generate dry-run like Applications that don't reconcile automatically.
- Pause and resume Applications reconcile during a disaster recovery process.
- Provide another alternative approval flow by not allowing an Application to start reconciling right away.