Skip to content

ROX-33792: make operator bundle reproducible #19657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
janisz wants to merge 2 commits into from
Closed

ROX-33792: make operator bundle reproducible #19657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ddd7f4
ROX-33792: make operator bundle builds reproducible
janisz Mar 27, 2026
9197e6b
fix(operator): move SOURCE_DATE_EPOCH ARG to bundle.Dockerfile.extra
janisz Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion operator/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,10 @@ bundle: yq manifests kustomize operator-sdk ## Generate bundle manifests and met
bundle/manifests/rhacs-operator.clusterserviceversion.yaml
$(OPERATOR_SDK) bundle validate ./bundle --select-optional suite=operatorframework

# Use git commit timestamp for reproducible builds
SOURCE_DATE_EPOCH ?= $(shell git log -1 --format=%ct)
export SOURCE_DATE_EPOCH

.PHONY: bundle-post-process
bundle-post-process: test-bundle-helpers operator-sdk ## Post-process CSV file to include correct operator versions, etc.
# Note: Python venv is always needed because dispatch.sh may use yaml-normalizer.py
Expand Down Expand Up @@ -532,7 +536,7 @@ bundle-post-process: test-bundle-helpers operator-sdk ## Post-process CSV file t

.PHONY: bundle-build
bundle-build: bundle.Dockerfile bundle-post-process ## Build the bundle image.
docker build $(if $(DOCKER_BUILD_LOAD),--load) -f $< -t $(BUNDLE_IMG) .
docker build $(if $(DOCKER_BUILD_LOAD),--load) --build-arg SOURCE_DATE_EPOCH=$(SOURCE_DATE_EPOCH) -f $< -t $(BUNDLE_IMG) .

.PHONY: bundle-test
bundle-test: operator-sdk bundle-post-process ## Run scorecard tests against bundle files.
Expand Down
3 changes: 3 additions & 0 deletions operator/bundle.Dockerfile.extra
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Reproducible builds support
ARG SOURCE_DATE_EPOCH

# Labels for operator certification https://redhat-connect.gitbook.io/certified-operator-guide/ocp-deployment/operator-metadata/bundle-directory
LABEL com.redhat.delivery.operator.bundle=true

Expand Down
17 changes: 15 additions & 2 deletions operator/bundle_helpers/pkg/csv/patcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
"errors"
"fmt"
"os"
"sort"
"strconv"
"strings"
"time"

Expand Down Expand Up @@ -40,7 +42,14 @@
// PatchCSV modifies the CSV document in-place according to options
func PatchCSV(doc chartutil.Values, opts PatchOptions) error {
// Update createdAt timestamp
if err := values.CoalesceValue(doc, "metadata.annotations.createdAt", time.Now().UTC().Format(time.RFC3339)); err != nil {
// Use SOURCE_DATE_EPOCH if set (for reproducible builds), otherwise use current time
createdAt := time.Now().UTC()
if epoch := os.Getenv("SOURCE_DATE_EPOCH"); epoch != "" {
if timestamp, err := strconv.ParseInt(epoch, 10, 64); err == nil {
createdAt = time.Unix(timestamp, 0).UTC()
}
}
if err := values.CoalesceValue(doc, "metadata.annotations.createdAt", createdAt.Format(time.RFC3339)); err != nil {
return fmt.Errorf("failed to set createdAt: %w", err)
}

Expand Down Expand Up @@ -172,7 +181,11 @@
relatedImages := make([]map[string]any, 0)

// Collect all RELATED_IMAGE_* env vars
for _, envVar := range os.Environ() {
// Sort environment variables for deterministic order
envVars := os.Environ()
sort.Strings(envVars)

Check failure on line 186 in operator/bundle_helpers/pkg/csv/patcher.go

View workflow job for this annotation

GitHub Actions / style-check 

Use slices.Sort instead of sort.Strings, as it is more efficient/ergonomic (https://pkg.go.dev/slices).

for _, envVar := range envVars {
if strings.HasPrefix(envVar, "RELATED_IMAGE_") {
parts := strings.SplitN(envVar, "=", 2)
if len(parts) != 2 {
Expand Down
5 changes: 5 additions & 0 deletions operator/konflux.bundle.Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
FROM brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_golang_1.25@sha256:bd531796aacb86e4f97443797262680fbf36ca048717c00b6f4248465e1a7c0c AS builder

# Reproducible builds support
ARG SOURCE_DATE_EPOCH
ENV SOURCE_DATE_EPOCH=$SOURCE_DATE_EPOCH

# This installs PyYAML (with Python) needed by bundle_helpers.
RUN dnf -y install --allowerasing python3.12-pyyaml && \
alternatives --install /usr/bin/python3 python3 /usr/bin/python3.12 1
Expand Down
Loading