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.4 KiB

Executable File

Raw Permalink Blame History

Grafana

To be able to create Grafana annotation with cd-notifications you have to create an API Key inside your Grafana.

Available parameters :

apiURL - the server url, e.g. https://grafana.example.com
apiKey - the API key for the serviceaccount
insecureSkipVerify - optional bool, true or false
maxIdleConns - optional, maximum number of idle (keep-alive) connections across all hosts.
maxIdleConnsPerHost - optional, maximum number of idle (keep-alive) connections per host.
maxConnsPerHost - optional, maximum total connections per host.
idleConnTimeout - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing.

Login to your Grafana instance as admin
On the left menu, go to Configuration / API Keys
Click "Add API Key"
Fill the Key with name Hanzo CD Notification, role Editor and Time to Live 10y (for example)
Click on Add button
Store apiKey in cd-notifications-secret Secret and Copy your API Key and define it in cd-notifications-cm ConfigMap

apiVersion: v1
kind: ConfigMap
metadata:
  name: cd-notifications-cm
data:
  service.grafana: |
    apiUrl: https://grafana.example.com/api
    apiKey: $grafana-api-key

apiVersion: v1
kind: Secret
metadata:
  name: <secret-name>
stringData:
  grafana-api-key: api-key

Create a template in cd-notifications-cm Configmap This will be used to pass the (required) text of the annotation to Grafana (or re-use an existing one) As there is no specific template for Grafana, you must use the generic message:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cd-notifications-cm
data:
  templates:
    template.app-deployed: |
      message: Application {{.app.metadata.name}} is now running new version of deployments manifests.

Create subscription for your Grafana integration

apiVersion: apps.hanzo.ai/v1alpha1
kind: Application
metadata:
  annotations:
    notifications.apps.hanzo.ai/subscribe.<trigger-name>.grafana: tag1|tag2 # list of tags separated with |

Change the annotations settings

2.4 KiB Executable File Raw Permalink Blame History

Grafana

2.4 KiB

Executable File

Raw Permalink Blame History