Add pre-install/upgrade environment verification script and docs - #57
Merged
Merged
Conversation
Add scripts/precheck.py, a portable Python 3 (stdlib-only) tool that validates the cluster before helm install/upgrade: required secrets, persistent volumes, and cert-manager/TLS. Reports PASS/FAIL/WARN and exits non-zero on failure so it can gate an install in CI. Includes a --self-test mode that guards the chart-derived resource naming. Document all assertions in docs/pre-install-verification.md and link it from a new Requirements & Dependencies subsection in the README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
steven-schattenberg-itential
approved these changes
Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an automated pre-flight check that validates a cluster before
helm install/helm upgradeof the IAP chart, so environment problems surface in seconds instead of as failed installs, crash-looping pods, or silently broken TLS.scripts/precheck.py— portable Python 3 (standard library only) tool. Shells out to thekubectlandopensslbinaries operators already have — nopip installrequired — and runs on Linux, macOS, and Windows.docs/pre-install-verification.md— documents every assertion, the available flags, and the manualkubectlequivalent of each check.README.md— new Pre-Install / Pre-Upgrade Verification subsection under Requirements & Dependencies, linking the doc.What it verifies (23 checks, 3 groups)
itential-platform-secretsexists/Opaque, 6 required keys present & non-empty, image pull secret, CA secretChecks marked (upgrade) run only in
upgrademode. ReportsPASS/FAIL/WARN; a name that can't be resolved isWARN(skipped), never a falseFAIL.Design notes
-f; any value can be overridden with a flag. PyYAML is optional (only needed to read the values file); without it, pass names via flags.--self-testmode (no cluster needed) locks the resource-name derivation to the chart's_helpers.tpl/ StatefulSet templates so it can't silently drift.Usage