[release-1.10] fix(orchestrator): lowercase and truncate DB creation Job name for compliance [RHDHBUGS-3450]

[rm3l]

Description of the change

The versioned Job name introduced in e767157 (PR #427) embedded .Chart.Version into the orchestrator DB creation Job name without sanitizing it. Chart versions containing uppercase characters (e.g., 1.10-147-CI) produce a Job name like redhat-developer-hub-create-sf-db-1-10-147-CI, which violates Kubernetes RFC 1123 subdomain naming rules.

Which issue(s) does this PR fix or relate to

• RHDHBUGS-3450

How to test changes / Special notes to the reviewer

A CI chart version should work properly once this is merged. Also, installing a very long release name should truncate to 63 chars with version suffix preserved.

Checklist

• For each Chart updated, version bumped in the corresponding Chart.yaml according to Semantic Versioning.
• For each Chart updated, variables are documented in the values.yaml and added to the corresponding README.md. The pre-commit utility can be used to generate the necessary content. Run pre-commit run --all-files to run the hooks and then push any resulting changes. The pre-commit Workflow will enforce this and warn you if needed.
• JSON Schema template updated and re-generated the raw schema via the pre-commit hook.
• Tests pass using the Chart Testing tool and the ct lint command.
• If you updated the orchestrator-infra chart, make sure the versions of the Knative CRDs are aligned with the versions of the CRDs installed by the OpenShift Serverless operators declared in the values.yaml file. See Installing Knative Eventing and Knative Serving CRDs for more details.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[rm3l]

/hold

This is for 1.10.3 as it only affects pre-release/CI builds of the downstream chart. On hold until 1.10.2 is out.

[rhdh-qodo-merge]

Code Review by Qodo

Sorry, something went wrong

We weren't able to complete the code review on our side. Please try again

[rhdh-qodo-merge]

PR Summary by Qodo

Fix orchestrator DB creation Job name for RFC 1123 compliance

🐞 Bug fix ⚙️ Configuration changes 📝 Documentation 🕐 20-40 Minutes

AI Description

• Add a Helm helper to generate RFC 1123-compliant orchestrator DB Job names.
• Replace inline Job naming with the shared helper in the sonataflows Job template.
• Bump chart version to 5.12.7 and refresh README install/version references.

Diagram

graph TD
  A["Helm release name"] --> B["sonataflows.yaml"] --> C["dbJobName helper"] --> D["_helpers.tpl"] --> E["Job metadata.name"] --> F{{"Kubernetes (RFC 1123)"}}
  H["README.md"] --> G["Chart.yaml (5.12.7)"] --> B

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Inline sanitization in sonataflows.yaml

• ➕ Minimal indirection; logic stays next to the Job definition
• ➖ Repeats logic if other templates need the same naming behavior
• ➖ Harder to test/maintain consistently across templates

2. Sanitize only the version suffix (lower/regex) and keep full prefix

• ➕ Avoids truncation complexity for the release-name prefix
• ➖ Still risks exceeding the 63-character constraint for long release names
• ➖ Does not address length issues unless additional guards are added

3. Use a hash-based suffix when exceeding limits

• ➕ Guaranteed uniqueness and length compliance regardless of inputs
• ➖ Loses human-readable version in the resource name (unless dual labels/annotations added)
• ➖ Slightly more complex and less transparent for operators

Recommendation: Current approach (helper + lowercase + prefix truncation while preserving the full version suffix) is the best tradeoff here: it centralizes naming logic, fixes RFC 1123 violations from uppercase chart versions, and proactively handles the 63-character constraint without sacrificing the version signal in the name. The main alternatives either leave length risks unaddressed or reduce readability by introducing hashes.

Files changed (4) +14 / -4

Bug fix (2) +11 / -1

_helpers.tplAdd helper to generate RFC 1123-compliant DB Job name +10/-0

Add helper to generate RFC 1123-compliant DB Job name

• Introduces rhdh.orchestrator.dbJobName to build the Job name by preserving the full version suffix, truncating the release-name-derived prefix to fit within 63 characters, and lowercasing the final result.

charts/backstage/templates/_helpers.tpl

sonataflows.yamlUse shared helper for orchestrator DB creation Job name +1/-1

Use shared helper for orchestrator DB creation Job name

• Replaces the inline Job metadata.name expression with an include of rhdh.orchestrator.dbJobName to ensure consistent sanitization and length handling.

charts/backstage/templates/sonataflows.yaml

Documentation (1) +2 / -2

README.mdUpdate README version badge and install example +2/-2

Update README version badge and install example

• Refreshes the displayed chart version badge and the example helm install command to reference 5.12.7.

charts/backstage/README.md

Other (1) +1 / -1

Chart.yamlBump chart version to 5.12.7 +1/-1

Bump chart version to 5.12.7

• Updates the chart version from 5.12.6 to 5.12.7 to publish the naming fix.

charts/backstage/Chart.yaml

[rm3l]

/hold cancel