Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .ci-operator.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
build_root_image:
name: boilerplate
namespace: openshift
tag: image-v8.3.6
tag: image-v8.4.0
2 changes: 0 additions & 2 deletions OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ aliases:
- cjnovak98
srep-functional-team-hulk:
- ravitri
- devppratik
- Tafhim
- tkong-redhat
- TheUndeadKing
Expand Down Expand Up @@ -81,7 +80,6 @@ aliases:
- ravitri
srep-team-leads:
- rafael-azevedo
- iamkirkbater
- dustman9000
- bmeng
- typeid
Expand Down
2 changes: 1 addition & 1 deletion boilerplate/_data/backing-image-tag
Original file line number Diff line number Diff line change
@@ -1 +1 @@
image-v8.3.6
image-v8.4.0
2 changes: 1 addition & 1 deletion boilerplate/_data/last-boilerplate-commit
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1cb129aed5a91f2098f70c0e141561e00b1e16fc
a2d5909871fcc9a363b131d31b05f941841941c3
7 changes: 6 additions & 1 deletion boilerplate/_lib/container-make
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ if [[ "${CONTAINER_ENGINE##*/}" == "podman" ]] && [[ $OSTYPE == *"linux"* ]]; th
else
CE_OPTS="${CE_OPTS} -v $REPO_ROOT:$CONTAINER_MOUNT"
fi
container_id=$($CONTAINER_ENGINE run -d ${CE_OPTS} $IMAGE_PULL_PATH sleep infinity)
container_id=$($CONTAINER_ENGINE run --rm -d ${CE_OPTS} $IMAGE_PULL_PATH sleep infinity)

if [[ $? -ne 0 ]] || [[ -z "$container_id" ]]; then
err "Couldn't start detached container"
fi

trap "$CONTAINER_ENGINE stop $container_id >/dev/null 2>&1" EXIT

# Now run our `make` command in it with the right UID and working directory
args="exec -it -u $(id -u):0 -w $CONTAINER_MOUNT $container_id"
banner "Running: make $@"
Expand All @@ -52,6 +54,9 @@ if [[ $rc -ne 0 ]]; then
fi
fi

# Disarm the interrupt trap -- normal cleanup handles it from here
trap - EXIT

# Finally, remove the container
banner "Cleaning up the container"
$CONTAINER_ENGINE rm -f $container_id >/dev/null
Expand Down
141 changes: 113 additions & 28 deletions boilerplate/_lib/subscriber-propose-update
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Quirks and Limitations:
- Is still slightly interactive, because 'gh pr create' likes to ask
questions about your origin and upstream.
EOF
exit -1
exit 1
}

source $REPO_ROOT/boilerplate/_lib/subscriber.sh
Expand All @@ -34,47 +34,101 @@ source $REPO_ROOT/boilerplate/_lib/subscriber.sh
[[ $# -eq 0 ]] && usage

TMPD=$(mktemp -d)
echo $TMPD;
trap "rm -fr $TMPD" EXIT

run_step() {
local title=$1
local log_file="$TMPD/$title.log"
log_file=$(tr '[:upper:]' '[:lower:]' <<< "$log_file")
log_file=$(tr ' ' '-' <<< "$log_file")
shift

if [[ $1 != "--" ]]; then
echo "ERR: expected '--' but got '$1'"
exit 1
fi
shift
echo -n "$title... "

if ! "$@" > "$log_file" 2>&1; then
echo " FAILED"
echo "!!!"
echo "!!! Boilerplate update failed for $subscriber"
echo "!!!"
echo ""
cat "$log_file"
exit 1
fi
echo " DONE"
}

sync_main() {
local main_branch=$1
shift

git pull upstream $main_branch
git push origin $main_branch
}

git_clean_and_push() {
local branch=$1
shift

git push --delete origin $branch || true
git push -u origin $branch
}

propose_update() {
local subscriber=$1
local proj=${subscriber#*/}

if [[ -z "$DRY_RUN" ]]; then
echo "DRY RUN: Would propose update for $subscriber"
return 0
fi

(
# Clone my fork of the subscriber repo
cd $TMPD
# This
# - uses the existing fork if one exists
# - sets 'origin' and 'upstream' remotes
gh repo fork $subscriber --clone=true --remote=true
# only clones the default branch to save disk space and time

run_step "Creating fork" -- gh repo fork $subscriber --clone=true --default-branch-only
cd $proj

# Current branch is 'master' or 'main'
cur_branch=$(current_branch .)
# Make sure our origin is synced with upstream, so our update
# commit is based off of the latest code.
# WARNING: This changes your fork!
git pull upstream $cur_branch
git push origin $cur_branch

# Create the update commit
make boilerplate-update
make boilerplate-commit

# And create the PR
# TODO: This is interactive. How do we tell gh "Yes, please use
# upstream as upstream and origin as origin?"
gh pr create -f
# Current branch is 'master' or 'main' or 'trunk'
main_branch=$(current_branch .)
run_step "Syncing Fork" -- sync_main $main_branch
# run_step "Pushing fork" -- git push origin $main_branch

# Create the update commit - only cat logs if something goes wrong.
run_step "Updating boilerplate" -- make boilerplate-update
run_step "Committing boilerplate update" -- make boilerplate-commit

boilerplate_branch=$(git rev-parse --abbrev-ref HEAD)
# By pushing to the origin boilerplate branch explicitly before opening a PR,
# we make don't get prompted for the branch to push to.
# If we still find that it's giving us an interactive prompt, we can otherwise
# use `gh api` to create the PR programmatically.
if [[ "$boilerplate_branch" == "$main_branch" ]]; then
echo "CRITICAL ERROR: boilerplate branch '$boilerplate_branch' is the same as main branch '$main_branch'"
echo "If you see this, something has gone terribly wrong"
echo "Skipping"
exit 20
fi
run_step "pushing update" -- git_clean_and_push $boilerplate_branch

gh pr create --repo $subscriber -f $DRY_RUN_FLAG
)
}

bp_master=$(git rev-parse master)

DRY_RUN_FLAG=""
if [[ -z "$DRY_RUN" ]]; then
echo "DRY RUN: ENABLED"
DRY_RUN_FLAG="--dry-run"
fi


for subscriber in $(subscriber_args "$@"); do

# Does this one need an update?
Expand All @@ -89,14 +143,45 @@ for subscriber in $(subscriber_args "$@"); do
continue
fi

# Is there already a PR proposed for this level?
existing_pr=$(gh pr list --repo $subscriber | grep -P ":boilerplate-\S+-$bp_master\s")
# Is there already a PR proposed for this commit?
pr_list=$(gh pr list --repo $subscriber --json headRefName,url,number | jq -r '. | map(select(.headRefName | startswith("boilerplate-update--")))')
existing_pr=$(jq -r ".[] | select(.headRefName == \"boilerplate-update--$bp_master\")" <<< "$pr_list")
if [[ -n "$existing_pr" ]]; then
echo "Subscriber '$subscriber' already has an open PR:"
echo "https://github.com/$subscriber/pull/$existing_pr"
echo "Subscriber '$subscriber' already has an open PR for this boilerplate commit:"
jq -r .url <<< "$existing_pr"
continue
fi

# Pull the trigger
propose_update "$subscriber"
if ! propose_update "$subscriber"; then
echo "Error: failed to propose update for '$subscriber'"
continue
fi

new_pr="XXXX"
# Get the new PR URL
# only run if not dry-run - otherwise the new_pr var will be empty
if [[ -n $DRY_RUN ]]; then
new_pr=$(gh pr list --repo $subscriber --json headRefName,number | jq -r ".[] | select(.headRefName == \"boilerplate-update--$bp_master\") | .number")
if [[ -z "$new_pr" ]]; then
echo "error: unable to find new PR for boilerplate update '$bp_master' on subscriber '$subscriber'"
continue
fi
fi

# Add comments to existing PRs to say they're superseded by this new one
if [[ -n "$pr_list" ]]; then
prs=$(jq -r '. | map(.number) | @tsv' <<< "$pr_list")
echo "Closing old PRs: $prs"
for pr in $prs; do
if [[ -z $DRY_RUN ]]; then
echo "Dry run - would close $pr with comment:"
echo " \"Superseded by #$new_pr.\""
continue
fi

gh pr close --repo $subscriber --comment "Superseded by #$new_pr." $pr
done
fi

done
11 changes: 8 additions & 3 deletions boilerplate/openshift/golang-osd-e2e/update
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,30 @@ source $CONVENTION_ROOT/_lib/common.sh

REPO_ROOT=$(git rev-parse --show-toplevel)
OPERATOR_NAME=$(sed -n 's/.*OperatorName .*=.*"\([^"]*\)".*/\1/p' "${REPO_ROOT}/config/config.go")
GO_MODULE_PATH=$(awk '/^module / { print $2; exit }' "${REPO_ROOT}/go.mod")
E2E_SUITE_DIRECTORY=$REPO_ROOT/test/e2e

if [[ -z "${GO_MODULE_PATH}" ]]; then
err "Could not read module path from ${REPO_ROOT}/go.mod"
fi

# Update operator name in templates
OPERATOR_UNDERSCORE_NAME=${OPERATOR_NAME//-/_}
OPERATOR_PROPER_NAME=$(echo "$OPERATOR_NAME" | sed 's/-/ /g' | awk '{for(i=1;i<=NF;i++){ $i=toupper(substr($i,1,1)) substr($i,2) }}1')
OPERATOR_NAME_CAMEL_CASE=${OPERATOR_PROPER_NAME// /}

mkdir -p "${E2E_SUITE_DIRECTORY}"

E2E_SUITE_BUILDER_IMAGE=registry.ci.openshift.org/openshift/release:rhel-9-release-golang-1.25-openshift-4.21
E2E_SUITE_BUILDER_IMAGE=registry.ci.openshift.org/openshift/release:rhel-9-release-golang-1.26-openshift-4.22
if [[ -n ${KONFLUX_BUILDS} ]]; then
E2E_SUITE_BUILDER_IMAGE="brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_1.25"
E2E_SUITE_BUILDER_IMAGE="brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_1.26"
fi

echo "syncing ${E2E_SUITE_DIRECTORY}/Dockerfile"
tee "${E2E_SUITE_DIRECTORY}/Dockerfile" <<EOF
# THIS FILE IS GENERATED BY BOILERPLATE. DO NOT EDIT.
FROM ${E2E_SUITE_BUILDER_IMAGE} as builder
WORKDIR /go/src/github.com/openshift/$OPERATOR_NAME/
WORKDIR /go/src/${GO_MODULE_PATH}/
COPY . .
RUN CGO_ENABLED=0 GOFLAGS="-mod=mod" go test ./test/e2e -v -c --tags=osde2e -o /e2e.test

Expand Down
2 changes: 0 additions & 2 deletions boilerplate/openshift/golang-osd-operator/OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ aliases:
- cjnovak98
srep-functional-team-hulk:
- ravitri
- devppratik
- Tafhim
- tkong-redhat
- TheUndeadKing
Expand Down Expand Up @@ -81,7 +80,6 @@ aliases:
- ravitri
srep-team-leads:
- rafael-azevedo
- iamkirkbater
- dustman9000
- bmeng
- typeid
Expand Down
5 changes: 5 additions & 0 deletions boilerplate/openshift/golang-osd-operator/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@ updates:
labels:
- "area/dependency"
- "ok-to-test"
- "lgtm"
- "approved"
schedule:
interval: "weekly"
day: "monday"
time: "03:00"
timezone: "UTC"
ignore:
- dependency-name: "redhat-services-prod/openshift/boilerplate"
# don't upgrade boilerplate via these means
Expand Down
11 changes: 4 additions & 7 deletions boilerplate/openshift/golang-osd-operator/docs/pre-commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,12 @@
[uv](https://github.com/astral-sh/uv) is recommended for Python dependency management. It provides dependency locking with package hashes (supply-chain protection), virtual environment management, and is 10-100x faster than pip.

**Install uv:**
```bash
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
To avoid piping unverified remote scripts and avoid using `sudo`, install `uv` via `pip` into your user directory:

# Via pip
pip install uv
```bash
# Install to user directory (never use sudo)
pip install --user uv
```

**First-time setup:**
Expand Down
8 changes: 3 additions & 5 deletions build/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM quay.io/redhat-services-prod/openshift/boilerplate:image-v8.3.6 AS builder
FROM quay.io/redhat-services-prod/openshift/boilerplate:image-v8.4.0 AS builder

WORKDIR /workspace
# Copy the Go Modules manifests
Expand All @@ -16,11 +16,9 @@ COPY pkg/ pkg/
# Build
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -mod=mod -a -o manager main.go

# Use distroless as minimal base image to package the manager binary
# Refer to https://github.com/GoogleContainerTools/distroless for more details
FROM registry.access.redhat.com/ubi9/ubi-minimal:9.8-1780378819
FROM registry.access.redhat.com/ubi9/ubi-minimal:9.8-1781496742
WORKDIR /
COPY --from=builder /workspace/manager .
USER nonroot:nonroot
USER 65534:65534

ENTRYPOINT ["/manager"]
2 changes: 1 addition & 1 deletion build/Dockerfile.olm-registry
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ COPY ${SAAS_OPERATOR_DIR} manifests
RUN initializer --permissive

# ubi-micro does not work for clusters with fips enabled unless we make OpenSSL available
FROM registry.access.redhat.com/ubi9/ubi-minimal:9.8-1780378819
FROM registry.access.redhat.com/ubi9/ubi-minimal:9.8-1781496742

COPY --from=builder /bin/registry-server /bin/registry-server
COPY --from=builder /bin/grpc_health_probe /bin/grpc_health_probe
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# THIS FILE IS GENERATED BY BOILERPLATE. DO NOT EDIT.
FROM brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_1.25 as builder
FROM brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_1.26 as builder

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify current Dockerfile base-image tag patterns for RH builder images
# and check whether floating tags are used elsewhere in the repo.
rg -n --iglob '*Dockerfile*' 'brew\.registry\.redhat\.io/.+openshift-golang-builder:.+'

Repository: openshift/managed-node-metadata-operator

Length of output: 191


🏁 Script executed:

#!/bin/bash
# Find all Dockerfile* files in the repository
fd -t f 'Dockerfile' --type f
# Then show their content to check base image tag patterns
for file in $(fd -t f 'Dockerfile' --type f); do
  echo "=== $file ==="
  head -20 "$file" | grep -E '^FROM|^ARG'
done

Repository: openshift/managed-node-metadata-operator

Length of output: 1270


Use a floating Red Hat builder tag instead of a fixed patch tag.

Change rhel_9_1.26 to rhel_9_1 to allow Red Hat's automated patch updates. Per the Dockerfile security guidelines, Red Hat images must use floating tags.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@test/e2e/Dockerfile` at line 2, In the Dockerfile at the FROM instruction,
replace the fixed Red Hat builder tag from `rhel_9_1.26` to `rhel_9_1`. This
changes the image reference from
`brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_1.26` to
`brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_9_1`, which
allows Red Hat's automated security patch updates to be applied automatically
rather than being pinned to a specific patch version.

Source: Coding guidelines

WORKDIR /go/src/github.com/openshift/managed-node-metadata-operator/
COPY . .
RUN CGO_ENABLED=0 GOFLAGS="-mod=mod" go test ./test/e2e -v -c --tags=osde2e -o /e2e.test
Expand Down