Skip to content

chore(docs): Create runbook to update Chart dependency#2400

Merged
javirln merged 2 commits intochainloop-dev:mainfrom
javirln:feat/2391-runbook
Aug 28, 2025
Merged

chore(docs): Create runbook to update Chart dependency#2400
javirln merged 2 commits intochainloop-dev:mainfrom
javirln:feat/2391-runbook

Conversation

@javirln
Copy link
Member

@javirln javirln commented Aug 27, 2025

This pull request adds a comprehensive runbook for upgrading Helm chart dependencies in the Chainloop project. The runbook provides strict guidelines for upgrade types, version compatibility, and step-by-step instructions to ensure upgrades are performed safely and consistently. It also includes troubleshooting, rollback, and escalation procedures to help maintain system stability during chart upgrades.

Documentation: Helm Chart Upgrade Process

  • Added a detailed runbook (docs/runbooks/chart-upgrade-process.md) describing the upgrade process for Chainloop Helm chart dependencies, including PostgreSQL, Vault, and Dex.

Upgrade Guidelines and Restrictions

  • Defined strict rules for patch, minor, and major version upgrades, explicitly forbidding major upgrades without manual review and escalation.
  • Provided mandatory version compatibility checks and stop conditions to prevent unsafe upgrades.

Step-by-Step Upgrade Procedures

  • Outlined separate processes for specific image upgrades and minor chart upgrades, including commands for validation, chart extraction, image update, and dependency management.
  • Included checklist for pre-upgrade, during upgrade, and post-upgrade stages to ensure completeness and safety.

Verification, Troubleshooting, and Emergency Procedures

  • Added verification steps (linting, testing, image consistency checks), troubleshooting guides for common issues, and emergency rollback and escalation instructions.

Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
@javirln javirln self-assigned this Aug 27, 2025
Copy link
Member

@migmartri migmartri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd make sure we do not upgrade container images without updating the chart, we always must upgrade the chart, the trick is to find which version of the chart

Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
@javirln javirln merged commit 14b6391 into chainloop-dev:main Aug 28, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants