Skip to content

rhdh-midstream.md

Latest commit

 

History

History
115 lines (80 loc) · 5.54 KB

rhdh-midstream.md

File metadata and controls

115 lines (80 loc) · 5.54 KB
Raw

RHDH midstream layout (4-rhdh)

updateDigests.sh also updates .tekton-templates/*.yaml via TEMPLATEPATH.

Detect which variant applies before editing (see table below). Edit templates and shared pipelines first, then regenerate or patch PLRs.

Layout detection

Marker Variant Typical branches
.tekton-templates/rhdh-pipeline.yaml Unified — one pipelineSpec template + components.yaml rhdh-1-rhel-9, rhdh-1.10-rhel-9, …
.tekton-templates/rhdh-hub.yaml (no rhdh-pipeline.yaml) Shared build-pipeline — PLR wrappers + build-pipeline-rhdh-*.yaml rhdh-1.9-rhel-9

If unsure, run: ls .tekton-templates/rhdh-pipeline.yaml .tekton-templates/rhdh-hub.yaml 2>/dev/null

Variant A: Unified pipeline layout

Used on current stable branches. Hub, operator, and must-gather share rhdh-pipeline.yaml; operator-bundle uses a separate template.

Files to update

Location When to edit
.tekton-templates/rhdh-pipeline.yaml hub, operator, must-gather
.tekton-templates/rhdh-operator-bundle.yaml operator-bundle (different task set)
.tekton-templates/components.yaml Metadata for generatePipelineRuns.sh only
.tekton/rhdh-hub-<N>-{push,pull}.yaml Regenerate from rhdh-pipeline.yaml
.tekton/rhdh-operator-<N>-{push,pull}.yaml Regenerate from rhdh-pipeline.yaml
.tekton/rhdh-must-gather-<N>-{push,pull}.yaml Regenerate from rhdh-pipeline.yaml
.tekton/rhdh-operator-bundle-<N>-{push,pull}.yaml Regenerate from rhdh-operator-bundle.yaml
.tekton/rhdh-rag-content-<N>-{push,pull}.yaml Inline pipelineSpec — edit directly (not in components.yaml)
.tekton/fbc-<version>-push.yaml FBC; build-image-index without prefetch
.tekton/images-mirror-set.yaml Only if task bundles are referenced

Regenerate

cd .tekton
./generatePipelineRuns.sh -t <x.y>    # e.g. 1, 1.10
  • Version 1 → files like rhdh-hub-1-push.yaml, branch rhdh-1-rhel-9
  • Version 1.10 → rhdh-hub-1-10-push.yaml, branch rhdh-1.10-rhel-9
  • Updates component PLRs from templates and FBC target_branch in fbc-*-push.yaml

Generator notes

  • Migrations: edit pipelineSpec.params and task params in rhdh-pipeline.yaml / rhdh-operator-bundle.yaml.
  • components.yaml only when extending generator placeholders (output image, prefetch, storage, etc.).
  • After updateDigests.sh, always run generatePipelineRuns.sh if templates were migrated earlier than PLRs (stale PLRs may still have dev-package-managers).

Variant B: Shared build-pipeline layout (1.9)

Older branch layout. Hub and operator PLRs are thin wrappers (pipelineRef); Tekton Pipeline objects hold the real pipelineSpec.

Files to update

Location When to edit
.tekton/build-pipeline-rhdh-hub.yaml Shared pipeline (hub + operator-bundle paths when component-type matches)
.tekton/build-pipeline-rhdh-operator.yaml Shared pipeline for operator (parallel structure to hub file)
.tekton-templates/rhdh-hub.yaml PLR wrapper — pass new pipeline params in spec.params
.tekton-templates/rhdh-operator.yaml PLR wrapper — same
.tekton-templates/rhdh-operator-bundle.yaml Inline pipelineSpec in template (like unified bundle)
.tekton/rhdh-hub-<N>-{push,pull}.yaml Regenerate from rhdh-hub.yaml
.tekton/rhdh-operator-<N>-{push,pull}.yaml Regenerate from rhdh-operator.yaml
.tekton/rhdh-operator-bundle-<N>-{push,pull}.yaml Regenerate from rhdh-operator-bundle.yaml
.tekton/fbc-<version>-push.yaml FBC pipelines
.tekton/build-pipeline-rhdh-hub.yaml Also updated by updateDigests.sh (not a template)

No must-gather or rag-content PLRs on this layout.

Regenerate

cd .tekton
./generatePipelineRuns.sh -t <x.y>    # e.g. 1.9

Produces rhdh-{hub,operator,operator-bundle}-1-9-{push,pull}.yaml via sed on per-component templates; updates FBC target_branch to rhdh-1.9-rhel-9.

Migration: prefetch-dependencies-oci-ta 0.3

Apply in three places:

  1. Pipeline params on build-pipeline-rhdh-hub.yaml and build-pipeline-rhdh-operator.yaml:
    • Add enable-package-registry-proxy (default "true").
  2. Prefetch tasks prefetch-dependencies-hub and prefetch-dependencies-operator:
    • Remove dev-package-managers; pass enable-package-registry-proxy: $(params.enable-package-registry-proxy).
  3. PLR templates rhdh-hub.yaml / rhdh-operator.yaml:
    • Add spec.params entry so the value reaches the shared pipeline.
  4. Operator-bundle template rhdh-operator-bundle.yaml:
    • Same as unified layout (inline pipelineSpec).

prefetch-dependencies-bundle uses non-OCI task-prefetch-dependencies — no enable-package-registry-proxy change unless MIGRATION.md says so.

Generator notes

  • generatePipelineRuns.sh does not rewrite build-pipeline-*.yaml; edit those files directly for task/digest/migration changes.
  • PLR pipelineRef.name must match pipeline metadata (build-pipeline-rhdh-hub / build-pipeline-rhdh-operator) — generated files already do.

Both variants: commit locally, do not push

Typical outcome on a branch:

  1. updateDigests.sh --minor --no-push → one local commit (digest bumps).
  2. Migration edits + generatePipelineRuns.sh → second commit (or leave unstaged for human review).

Human reviews the full diff across .tekton/ and .tekton-templates/, then pushes or opens a PR.