[MOSIP-43841] Changes related to alerting setup via rapid deployment.

[Mohanraj209]

Summary by CodeRabbit

• Chores
  • Refactored monitoring and alerting configurations to accept environment-specific parameters (Slack details, cluster identifiers) through placeholders instead of hardcoded values, enabling flexible deployment across different environments.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This PR refactors hardcoded configuration values in Helmsman deployment files and hook scripts, replacing concrete values (cluster IDs, Slack credentials, channel names, environment identifiers) with template placeholders, enabling environment-specific configuration during deployment.

Changes

Cohort / File(s)	Summary
Configuration parameterization Helmsman/dsf/prereq-dsf.yaml	Updated rancher-monitoring app cluster ID reference from hardcoded string to <cluster-id> placeholder; modified postInstall script invocation to pass <slack-channel-name>, <slack-api-url>, and <env-name> as arguments instead of relying on internal defaults.
Hook script refactoring Helmsman/hooks/alerting-setup.sh	Modified installing_alerting function to consume Slack channel, Slack API URL, and environment name via positional parameters ($1, $2, $3) instead of hardcoded defaults, while preserving sed substitution and kubectl patching logic.
Alerting configuration templates Helmsman/utils/alerting/alertmanager.yaml, Helmsman/utils/alerting/patch-cluster-name.yaml	Replaced concrete Slack webhook URL and channel credentials with <YOUR-SLACK-API-URL> and <YOUR-CHANNEL-HERE> placeholders in alertmanager config; replaced hardcoded cluster name "soil" with <YOUR-CLUSTER-NAME-HERE> in external labels patch.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Verify all hardcoded Slack credentials and cluster identifiers have been identified and replaced with appropriate placeholders
• Confirm hook script parameter order and usage align across prerequisite config and alerting-setup.sh invocation
• Cross-check placeholder naming conventions are consistent across all configuration files

Possibly related PRs

• [MOSIP-43525]Removed hardcoded domain name and added placeholder #104: Also modifies Helmsman/dsf/prereq-dsf.yaml helm hook invocations, changing how parameters are passed to postInstall/postUpgrade scripts with similar parameterization patterns.

Suggested reviewers

• ckm007

Poem

🐰 With whiskers twitched and paws so quick,
We swapped the secrets—such a trick!
From soil and URLs so plain,
To placeholders in the chain,
Now gardens bloom in any rain! 🌧️

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: introducing placeholders and parameterization for alerting setup configuration across multiple deployment files.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

Helmsman/hooks/alerting-setup.sh (1)

17-19: Non-idempotent in-place file modifications may cause issues on credential rotation or redeploy.

The sed -i commands modify alertmanager.yaml and patch-cluster-name.yaml in-place. This works correctly for the first invocation, but subsequent runs with different credentials will not find the original placeholders to replace, potentially leaving stale values in place.

Recommended mitigation: Consider one of the following:

1. Regenerate template files before each sed run — ensure alertmanager.yaml and patch-cluster-name.yaml are restored to their template state (with placeholders) before this hook executes.
2. Use intermediate copies — apply sed to temporary copies and patch from those, or use kubectl create/replace with stdin instead of modifying source files.
3. Document the expectation — clarify that the rapid deployment pattern assumes fresh file state per invocation.

For a true multi-environment or credential-rotation scenario, approach #1 is preferable.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28a4448 and 91a16d9.

📒 Files selected for processing (4)

• Helmsman/dsf/prereq-dsf.yaml (1 hunks)
• Helmsman/hooks/alerting-setup.sh (1 hunks)
• Helmsman/utils/alerting/alertmanager.yaml (2 hunks)
• Helmsman/utils/alerting/patch-cluster-name.yaml (1 hunks)

🔇 Additional comments (11)

Helmsman/utils/alerting/patch-cluster-name.yaml (1)

3-3: Placeholder introduction aligns with templating strategy.

The hardcoded cluster name is properly replaced with a placeholder that will be substituted at runtime by the alerting-setup.sh hook (line 19 of that script).

Helmsman/utils/alerting/alertmanager.yaml (2)

4-4: Slack API URL placeholder introduced correctly.

The hardcoded URL is replaced with <YOUR-SLACK-API-URL>, which will be substituted by alerting-setup.sh line 18.

---

107-107: Slack channel placeholder introduced correctly.

The hardcoded channel is replaced with <YOUR-CHANNEL-HERE>, which will be substituted by alerting-setup.sh line 17.

Helmsman/dsf/prereq-dsf.yaml (3)

45-46: Cluster ID placeholders align with templating approach.

Both grafana.global.cattle.clusterId and global.cattle.clusterId are correctly updated to use the <cluster-id> placeholder, which users should replace with their actual cluster identifier before deployment.

---

48-48: Trailing whitespace cleanup.

Benign formatting improvement.

---

52-52: Verify: placeholders in postInstall hook require user substitution.

The hook invocation passes <slack-channel-name> <slack-api-url> <env-name> as placeholders that users must replace with actual values in their deployment configuration before running Helmsman. These three values directly map to positional parameters $1, $2, $3 expected by alerting-setup.sh (which uses them for sed substitutions in lines 17-19).

Consider adding inline documentation to make this substitution requirement explicit, or verify whether these placeholders should be processed by a Helmsman template engine instead.

Helmsman/hooks/alerting-setup.sh (5)

9-11: Parameter-driven substitution enables flexible templating.

The function now correctly receives Slack channel, API URL, and environment name as positional parameters ($1, $2, $3) instead of hardcoded defaults. This aligns with the Helmsman hook invocation pattern in prereq-dsf.yaml line 52.

---

17-19: Sed substitution patterns correctly match placeholder names.

The sed patterns precisely target the placeholder strings in the template files:

• Line 17: <YOUR-CHANNEL-HERE> → alertmanager.yaml line 107 ✓
• Line 18: <YOUR-SLACK-API-URL> → alertmanager.yaml line 4 ✓
• Line 19: <YOUR-CLUSTER-NAME-HERE> → patch-cluster-name.yaml line 3 ✓

All placeholders are properly accounted for.

---

24-24: kubectl patch operations use sed-modified files correctly.

Both kubectl patch commands (lines 24 and 28) operate on files that have been substituted with actual values by the preceding sed operations (lines 17-19). The patch flow is correct.

Also applies to: 28-28

---

35-39: Comprehensive error handling configuration.

The error handling is well-configured with set -e, set -o nounset, set -o errtrace, and set -o pipefail. This ensures the script fails loudly on undefined variables or command failures rather than silently proceeding with invalid state.

---

9-11: Validate sed handling of special characters in credentials.

If Slack URLs or channel names contain sed metacharacters (e.g., |, &, \, /), the substitution may fail or produce incorrect results. The current sed delimiter (|) is a reasonable choice to avoid conflicts with URLs (which contain /), but verify that:

• Slack webhook URLs do not contain literal | characters
• Channel names do not contain literal | characters

Alternatively, consider escaping the variables or using a different delimiter if special characters are expected.

Also applies to: 17-19

[ckm007]

Need documentation aroind clusterid and slack url in README.