mirror of
https://github.com/hanzoai/cd.git
synced 2026-10-30 14:56:45 +00:00
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.
3.1 KiB
Executable File
3.1 KiB
Executable File
PagerDuty V2
Parameters
The PagerDuty notification service is used to trigger PagerDuty events and requires specifying the following settings:
serviceKeys- a dictionary with the following structure:service-name: $pagerduty-key-service-namewhereservice-nameis the name you want to use for the service to make events for, and$pagerduty-key-service-nameis a reference to the secret that contains the actual PagerDuty integration key (Events API v2 integration)
If you want multiple Hanzo CD apps to trigger events to their respective PagerDuty services, create an integration key in each service you want to setup alerts for.
To create a PagerDuty integration key, follow these instructions to add an Events API v2 integration to the service of your choice.
Configuration
The following snippet contains sample PagerDuty service configuration. It assumes the service you want to alert on is called my-service.
apiVersion: v1
kind: Secret
metadata:
name: <secret-name>
stringData:
pagerduty-key-my-service: <pd-integration-key>
apiVersion: v1
kind: ConfigMap
metadata:
name: cd-notifications-cm
data:
service.pagerdutyv2: |
serviceKeys:
my-service: $pagerduty-key-my-service
Template
Notification templates support specifying subject for PagerDuty notifications:
apiVersion: v1
kind: ConfigMap
metadata:
name: cd-notifications-cm
data:
template.rollout-aborted: |
message: Rollout {{.rollout.metadata.name}} is aborted.
pagerdutyv2:
summary: "Rollout {{.rollout.metadata.name}} is aborted."
severity: "critical"
source: "{{.rollout.metadata.name}}"
The parameters for the PagerDuty configuration in the template generally match with the payload for the Events API v2 endpoint. All parameters are strings.
summary- (required) A brief text summary of the event, used to generate the summaries/titles of any associated alerts.severity- (required) The perceived severity of the event with respect to the affected system. Allowed values:critical,warning,error,infosource- (required) The unique location of the affected system, preferably a hostname or FQDN.component- Component of the source machine that is responsible for the event.group- Logical grouping of components of a service.class- The class/type of the event.url- The URL that should be used for the link "View in Hanzo CD" in PagerDuty.dedupKey- A string used by PagerDuty to deduplicate and correlate events. Events with the samededupKeywill be grouped into the same incident. If omitted, PagerDuty will create a new incident for each event.
The timestamp and custom_details parameters are not currently supported.
Annotation
Annotation sample for PagerDuty notifications:
apiVersion: apps.hanzo.ai/v1alpha1
kind: Rollout
metadata:
annotations:
notifications.apps.hanzo.ai/subscribe.on-rollout-aborted.pagerdutyv2: "<serviceID for PagerDuty>"