cd/docs/operator-manual/notifications/troubleshooting.md at main

mirror of https://github.com/hanzoai/cd.git synced 2026-10-30 14:56:45 +00:00

Files

T

zeekay 7461a16638 docs: drop Argo branding, delete pre-fork upstream history, fix broken links

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.

2026-09-05 01:14:03 -07:00

2.8 KiB

Raw Permalink Blame History

cd admin notifications is a CLI command group that helps to configure the controller settings and troubleshoot issues. Full command details are available in the command reference.

Global flags

The following global flags are available for all sub-commands:

--config-map - path to the file containing cd-notifications-cm ConfigMap. If not specified then the command loads cd-notification-cm ConfigMap using the local Kubernetes config file.
--secret - path to the file containing cd-notifications-secret ConfigMap. If not specified then the command loads cd-notification-secret Secret using the local Kubernetes config file. Additionally, you can specify :empty to use empty secret with no notification service settings.

Examples:

Get a list of triggers configured in the local config map:

cd admin notifications trigger get \
  --config-map ./cd-notifications-cm.yaml --secret :empty

Trigger notification using in-cluster config map and secret:

cd admin notifications template notify \
  app-sync-succeeded guestbook --recipient slack:cd admin notifications

Kustomize

If you are managing cd-notifications config using Kustomize you can pipe whole kustomize build output into stdin using --config-map - flag:

kustomize build ./cd-notifications | \
  cd-notifications \
  template notify app-sync-succeeded guestbook --recipient grafana:cd \
  --config-map -

How to get it

On your laptop

You can download the cd CLI from the GitHub release attachments.

The binary is available in the ghcr.io/hanzoai/cd image. Use the docker run and volume mount to execute binary on any platform.

Example:

docker run --rm -it -w /src -v $(pwd):/src \
  ghcr.io/hanzoai/cd:<version> \
  /app/cd admin notifications trigger get \
  --config-map ./cd-notifications-cm.yaml --secret :empty

In your cluster

SSH into the running cd-notifications-controller pod and use kubectl exec command to validate in-cluster configuration.

Example

kubectl exec -it cd-notifications-controller-<pod-hash> \
  /usr/local/bin/cd admin notifications trigger get

Commands

The following commands may help debug issues with notifications:

Errors

{!docs/operator-manual/notifications/troubleshooting-errors.md!}

2.8 KiB Raw Permalink Blame History