Skip to content

📚 Documentation needed for commit b7c195e #41

@github-actions

Description

@github-actions

Documentation Update Needed

Commit: b7c195e
Commit Message: fix: Update ArgoCD notifications configuration for context variables

What Changed

This commit introduces breaking changes to the ArgoCD notifications configuration structure:

  1. Configuration Structure Change:

    • Before: Flat fields cluster-name and resource-group in the ConfigMap
    • After: Nested context object containing clusterName and resourceGroup
  2. Setup Script Update:

    • Modified setup-cluster-name.sh to patch ConfigMap with new nested structure
    • Changed from: {"data":{"cluster-name":"...","resource-group":"..."}}
    • Changed to: {"data":{"context":"clusterName: ...\nresourceGroup: ...\n"}}
  3. Template Variable Syntax:

    • Changed from: $cluster-name and $resource-group
    • Changed to: {{.context.clusterName}} and {{.context.resourceGroup}}
  4. Safety Improvements:

    • Added nil checks to triggers: app.status.operationState != nil &&
    • Prevents errors when status objects are not yet populated

Documentation Files to Update

Priority 1: Act-3/SETUP.md

  • Section "Configure Cluster Name Context" (lines ~35-45) needs to be updated
  • Current documentation shows the old flat structure
  • Need to update the kubectl patch command example to use the new nested context format
  • Update all references from clusterName to context.clusterName

Priority 2: Act-3/README.md

  • Review and update any ArgoCD notifications configuration examples
  • Ensure variable reference syntax is updated to use {{.context.*}} format

Migration Notes Required

Users upgrading from the previous version need to:

  1. Re-run the setup-cluster-name.sh script to migrate to the new format
  2. Or manually patch their ConfigMap with the new structure:
    kubectl patch configmap argocd-notifications-cm -n argocd \
      -p '{"data":{"context":"clusterName: YOUR_CLUSTER\nresourceGroup: YOUR_RG\n"}}'
  3. Restart the notifications controller after the change

Breaking Changes Alert

⚠️ This is a breaking change. Existing deployments using the old configuration format will need to update their ConfigMap structure or the notifications will fail to interpolate the cluster/resource group values correctly.


This issue was automatically created by analyzing commit b7c195e

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions