Skip to content

OCPSTRAT-3150: Add etcd sharding by resource kind support#8705

Open
jhjaggars wants to merge 10 commits into
openshift:mainfrom
jhjaggars:etcd-sharding
Open

OCPSTRAT-3150: Add etcd sharding by resource kind support#8705
jhjaggars wants to merge 10 commits into
openshift:mainfrom
jhjaggars:etcd-sharding

Conversation

@jhjaggars

@jhjaggars jhjaggars commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Implements etcd sharding by resource kind for HyperShift, as described in openshift/enhancements#1979.

Each etcd shard is registered as an independent ControlPlaneComponent using the CPO component framework. KAS is configured with --etcd-servers-overrides to route resources to the appropriate shard.

Key features:

  • Declarative shard configuration via spec.etcd.managed.shards and spec.etcd.unmanaged.shards
  • Per-shard storage (PersistentVolume or EmptyDir), replicas (1 or 3), and scheduling
  • Feature-gated behind EtcdSharding (TechPreviewNoUpgrade)
  • Full CEL validation: resource overlap prevention, immutability, DNS format validation
  • Per-shard TLS certificates, ServiceMonitors, PDBs
  • Both managed and unmanaged etcd support

API types aligned with enhancement proposal including:

  • EtcdShardResource with +listType=map composite keys
  • Per-field CEL immutability on shard specs
  • Explicit Replicas field (enum 1|3) per shard
  • Cross-shard resource overlap CEL validation

Summary by CodeRabbit

  • New Features

    • Etcd sharding: per-resource routing, per-shard storage, scheduling, per-shard control-plane components, per-shard TLS secrets, and feature gate.
    • Kube API server: per-shard etcd endpoint overrides and startup wait for shard DNS.
    • Etcd defrag: configurable leader-election ID.
  • Chores

    • Added local Dockerfile and updated .gitignore to ignore build outputs.
    • Broadened Prometheus etcd recording rules.
    • Component asset-directory override and related defaults/scheduling refinements.
  • Tests

    • Added unit tests for shard derivation and naming logic.

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 9, 2026
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 9, 2026
@openshift-ci

openshift-ci Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci-robot

Copy link
Copy Markdown

@jhjaggars: This pull request explicitly references no jira issue.

Details

In response to this:

Implements etcd sharding by resource kind for HyperShift, as described in openshift/enhancements#1979.

Each etcd shard is registered as an independent ControlPlaneComponent using the CPO component framework. KAS is configured with --etcd-servers-overrides to route resources to the appropriate shard.

Key features:

  • Declarative shard configuration via spec.etcd.managed.shards and spec.etcd.unmanaged.shards
  • Per-shard storage (PersistentVolume or EmptyDir), replicas (1 or 3), and scheduling
  • Feature-gated behind EtcdSharding (TechPreviewNoUpgrade)
  • Full CEL validation: resource overlap prevention, immutability, DNS format validation
  • Per-shard TLS certificates, ServiceMonitors, PDBs
  • Both managed and unmanaged etcd support

API types aligned with enhancement proposal including:

  • EtcdShardResource with +listType=map composite keys
  • Per-field CEL immutability on shard specs
  • Explicit Replicas field (enum 1|3) per shard
  • Cross-shard resource overlap CEL validation

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This pull request implements EtcdSharding: a feature gate and manifest entry; new hostedcluster API types and CEL validations for managed/unmanaged shards; support package to compute effective shards and service names with tests; per-shard control-plane components (StatefulSet, Services, ServiceMonitor, PDB) and PKI helpers with controller reconciliation; KAS wiring for etcd-servers-overrides and wait-for-etcd updates; asset-directory builder and component changes; and ancillary Dockerfile, .gitignore, and Prometheus rule updates.

Sequence Diagram(s)

sequenceDiagram
  participant HostedController
  participant PKI
  participant ShardComponent
  participant EtcdStatefulSet
  participant KubeAPIServer
  HostedController->>PKI: ReconcileEtcdShardServerSecret(ns, shard)
  HostedController->>PKI: ReconcileEtcdShardPeerSecret(ns, shard)
  HostedController->>ShardComponent: NewShardComponent(shard) / apply manifests
  ShardComponent->>EtcdStatefulSet: adaptStatefulSetForShard (replicas, TLS, init/reset, storage, scheduling)
  KubeAPIServer->>EtcdStatefulSet: connect (via etcd-servers-overrides)
Loading

Suggested reviewers

  • sdminonne
🚥 Pre-merge checks | ✅ 10 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Topology-Aware Scheduling Compatibility ⚠️ Warning Shard Replicas field allows 1 or 3 without topology awareness. No validation prevents Replicas=3 on 2-node clusters; no anti-affinity prevents 3 pods pending on limited nodes. Add CEL validation to reject Replicas=3 on SingleReplica/DualReplica topologies, or require anti-affinity + appropriate PDB constraints.
✅ Passed checks (10 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed All 40 test cases use stable, deterministic names with no dynamic content. No UUIDs, timestamps, or generated identifiers present. All tests use standard Go testing, not Ginkgo.
Test Structure And Quality ✅ Passed PR tests use standard Go testing, not Ginkgo; all test files show good quality with table-driven tests, clear assertion messages, and repository pattern consistency.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No Ginkgo e2e tests added in this PR. Three standard Go unit tests were added, not Ginkgo e2e tests, so the IPv6/disconnected network check does not apply.
No-Weak-Crypto ✅ Passed PR adds etcd sharding with TLS certificate generation but uses only standard Go crypto libraries and existing PKI helpers; no weak algorithms, custom crypto, or insecure comparisons detected.
Container-Privileges ✅ Passed PR does not introduce container privilege escalation: no privileged: true, hostPID/Network/IPC, SYS_ADMIN, or allowPrivilegeEscalation flags in any manifests.
No-Sensitive-Data-In-Logs ✅ Passed No explicit logging of sensitive data. EtcdServersOverrides contain internal hostnames/namespace but are not logged; only generic config errors logged.
Title check ✅ Passed The title clearly and specifically describes the main change: adding etcd sharding by resource kind support, which is the central feature implemented across the entire changeset.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@openshift-ci openshift-ci Bot added area/api Indicates the PR includes changes for the API area/cli Indicates the PR includes changes for CLI area/control-plane-operator Indicates the PR includes changes for the control plane operator - in an OCP release area/documentation Indicates the PR includes changes for documentation area/hypershift-operator Indicates the PR includes changes for the hypershift operator and API - outside an OCP release and removed do-not-merge/needs-area labels Jun 9, 2026
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 18:07 Inactive
@codecov

codecov Bot commented Jun 9, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 69.30894% with 151 lines in your changes missing coverage. Please review.
✅ Project coverage is 43.92%. Comparing base (f6e49c5) to head (a726018).
⚠️ Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
...perator/controllers/hostedcontrolplane/pki/etcd.go 0.00% 23 Missing ⚠️
...ostedcontrolplane/hostedcontrolplane_controller.go 20.83% 17 Missing and 2 partials ⚠️
...controllers/hostedcontrolplane/v2/assets/assets.go 51.35% 12 Missing and 6 partials ⚠️
support/controlplane-component/cronjob.go 0.00% 13 Missing ⚠️
support/controlplane-component/job.go 0.00% 13 Missing ⚠️
...or/controllers/hostedcontrolplane/v2/etcd/shard.go 95.32% 8 Missing and 2 partials ⚠️
...ontrollers/hostedcontrolplane/v2/kas/deployment.go 0.00% 8 Missing and 1 partial ⚠️
support/controlplane-component/deployment.go 30.76% 9 Missing ⚠️
support/etcd/shards.go 89.28% 6 Missing and 3 partials ⚠️
support/controlplane-component/generic-adapter.go 0.00% 6 Missing and 1 partial ⚠️
... and 6 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8705      +/-   ##
==========================================
+ Coverage   43.80%   43.92%   +0.12%     
==========================================
  Files         772      774       +2     
  Lines       96100    96576     +476     
==========================================
+ Hits        42097    42423     +326     
- Misses      51084    51217     +133     
- Partials     2919     2936      +17     
Files with missing lines Coverage Δ
...or/controllers/hostedcontrolplane/v2/kas/params.go 90.00% <100.00%> (+1.20%) ⬆️
hypershift-operator/featuregate/feature.go 81.81% <100.00%> (+0.86%) ⬆️
support/controlplane-component/defaults.go 68.15% <100.00%> (ø)
support/controlplane-component/statefulset.go 66.66% <100.00%> (-3.93%) ⬇️
support/controlplane-component/status.go 72.61% <100.00%> (+0.32%) ⬆️
...ontrollers/hostedcontrolplane/v2/etcd/component.go 10.00% <0.00%> (-0.21%) ⬇️
etcd-defrag/main.go 0.00% <0.00%> (ø)
...or/controllers/hostedcontrolplane/v2/kas/config.go 88.94% <0.00%> (-0.73%) ⬇️
...or/controllers/hostedcontrolplane/manifests/pki.go 0.00% <0.00%> (ø)
...t/controlplane-component/controlplane-component.go 44.31% <58.33%> (+0.53%) ⬆️
... and 11 more
Flag Coverage Δ
cmd-support 37.55% <60.75%> (+0.09%) ⬆️
cpo-hostedcontrolplane 46.43% <73.71%> (+0.52%) ⬆️
cpo-other 45.13% <ø> (ø)
hypershift-operator 54.07% <100.00%> (+<0.01%) ⬆️
other 32.11% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with 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.

Inline comments:
In @.gitignore:
- Around line 62-64: The .gitignore entry "*.egg_build-amd64/" mismatches the
actual build directory pattern used by the Dockerfile (which uses
"_build-${TARGETARCH}/" -> "_build-amd64/"); update the ignore list so amd64
artifacts are ignored consistently by replacing or adding the pattern
"_build-amd64/" (alongside the existing "_build-arm64/" and "_build/") so all
architecture-specific build dirs match the Dockerfile copy source.

In `@Dockerfile.local`:
- Around line 1-18: The Dockerfile currently leaves the container running as
root (ENTRYPOINT ["/usr/bin/hypershift"]); add a non-root user and switch to it
with a USER instruction before ENTRYPOINT. Create/ensure a runtime user (e.g.,
adduser or groupadd/useradd or use a fixed UID like 1000), chown or adjust
permissions on the copied binaries in /usr/bin (hypershift, hcp,
hypershift-operator, karpenter-operator, control-plane-operator,
control-plane-pki-operator) so the non-root user can execute them, and then add
USER <non-root-user-or-uid> immediately before the ENTRYPOINT to comply with the
non-root requirement.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 40924115-0d68-416c-9094-7fc72f13c8ed

📥 Commits

Reviewing files that changed from the base of the PR and between 832b848 and 7db3f5e.

⛔ Files ignored due to path filters (22)
  • api/hypershift/v1beta1/zz_generated.deepcopy.go is excluded by !**/zz_generated*.go, !**/zz_generated*
  • api/hypershift/v1beta1/zz_generated.featuregated-crd-manifests.yaml is excluded by !**/zz_generated*
  • api/hypershift/v1beta1/zz_generated.featuregated-crd-manifests/hostedclusters.hypershift.openshift.io/EtcdSharding.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • api/hypershift/v1beta1/zz_generated.featuregated-crd-manifests/hostedcontrolplanes.hypershift.openshift.io/EtcdSharding.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • client/applyconfiguration/hypershift/v1beta1/etcdshardresource.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/etcdshardschedulingspec.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/managedetcdshardpersistentvolumespec.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/managedetcdshardspec.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/managedetcdshardstoragespec.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/managedetcdspec.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/unmanagedetcdshardspec.go is excluded by !client/**
  • client/applyconfiguration/hypershift/v1beta1/unmanagedetcdspec.go is excluded by !client/**
  • client/applyconfiguration/utils.go is excluded by !client/**
  • cmd/install/assets/crds/hypershift-operator/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml is excluded by !cmd/install/assets/**/*.yaml
  • cmd/install/assets/crds/hypershift-operator/zz_generated.crd-manifests/hostedclusters-Hypershift-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/**, !cmd/install/assets/**/*.yaml
  • cmd/install/assets/crds/hypershift-operator/zz_generated.crd-manifests/hostedclusters-Hypershift-TechPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/**, !cmd/install/assets/**/*.yaml
  • cmd/install/assets/crds/hypershift-operator/zz_generated.crd-manifests/hostedcontrolplanes-Hypershift-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/**, !cmd/install/assets/**/*.yaml
  • cmd/install/assets/crds/hypershift-operator/zz_generated.crd-manifests/hostedcontrolplanes-Hypershift-TechPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/**, !cmd/install/assets/**/*.yaml
  • docs/content/reference/aggregated-docs.md is excluded by !docs/content/reference/aggregated-docs.md
  • docs/content/reference/api.md is excluded by !docs/content/reference/api.md
  • vendor/github.com/openshift/hypershift/api/hypershift/v1beta1/hostedcluster_types.go is excluded by !vendor/**, !**/vendor/**
  • vendor/github.com/openshift/hypershift/api/hypershift/v1beta1/zz_generated.deepcopy.go is excluded by !vendor/**, !**/vendor/**, !**/zz_generated*.go, !**/zz_generated*
📒 Files selected for processing (16)
  • .gitignore
  • Dockerfile.local
  • api/hypershift/v1beta1/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
  • api/hypershift/v1beta1/hostedcluster_types.go
  • control-plane-operator/controllers/hostedcontrolplane/hostedcontrolplane_controller.go
  • control-plane-operator/controllers/hostedcontrolplane/pki/etcd.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/assets/kube-apiserver/prometheus-recording-rules.yaml
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/shard.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/kas/config.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/kas/deployment.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/kas/params.go
  • support/controlplane-component/builder.go
  • support/controlplane-component/controlplane-component.go
  • support/controlplane-component/defaults.go
  • support/controlplane-component/status.go
  • support/etcd/shards.go

Comment thread .gitignore Outdated
Comment thread Dockerfile.local Outdated
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 19:26 Inactive

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
control-plane-operator/controllers/hostedcontrolplane/hostedcontrolplane_controller.go (1)

245-250: ⚠️ Potential issue | 🟠 Major | 🏗️ Heavy lift

Shard component registration is static and misses runtime shard spec updates.

registerComponents is only called during setup, so r.components is frozen from startup shard config. If spec.etcd.managed.shards changes later, new shard components won’t reconcile (and removed shards may continue) until CPO restarts.

🤖 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
`@control-plane-operator/controllers/hostedcontrolplane/hostedcontrolplane_controller.go`
around lines 245 - 250, registerComponents currently builds r.components once at
setup using hcp.Spec.Etcd.Managed.Shards, so runtime changes to
spec.etcd.managed.shards are ignored; instead, rebuild or extend the component
list at reconcile time. Update the logic so Reconcile (or the reconcile loop
that iterates r.components) computes the etcd shard components from the current
hcp.Spec.Etcd.Managed.Shards by calling etcdv2.NewShardComponent(shard) for each
shard and merging those into the component list used for that reconciliation
(rather than relying on the startup-populated r.components from
registerComponents); ensure you only mutate a local slice or replace
r.components atomically so removed shards stop being reconciled.
🤖 Prompt for all review comments with 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.

Outside diff comments:
In
`@control-plane-operator/controllers/hostedcontrolplane/hostedcontrolplane_controller.go`:
- Around line 245-250: registerComponents currently builds r.components once at
setup using hcp.Spec.Etcd.Managed.Shards, so runtime changes to
spec.etcd.managed.shards are ignored; instead, rebuild or extend the component
list at reconcile time. Update the logic so Reconcile (or the reconcile loop
that iterates r.components) computes the etcd shard components from the current
hcp.Spec.Etcd.Managed.Shards by calling etcdv2.NewShardComponent(shard) for each
shard and merging those into the component list used for that reconciliation
(rather than relying on the startup-populated r.components from
registerComponents); ensure you only mutate a local slice or replace
r.components atomically so removed shards stop being reconciled.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: df4ec306-22e9-43bd-8a0c-4914e8ed2cf6

📥 Commits

Reviewing files that changed from the base of the PR and between 7db3f5e and e0b7962.

⛔ Files ignored due to path filters (3)
  • api/hypershift/v1beta1/zz_generated.deepcopy.go is excluded by !**/zz_generated*.go, !**/zz_generated*
  • client/applyconfiguration/hypershift/v1beta1/unmanagedetcdshardspec.go is excluded by !client/**
  • cmd/install/assets/crds/hypershift-operator/tests/hostedclusters.hypershift.openshift.io/featuregated.hostedclusters.etcdsharding.testsuite.yaml is excluded by !cmd/install/assets/**/*.yaml
📒 Files selected for processing (12)
  • .gitignore
  • Dockerfile.local
  • api/hypershift/v1beta1/hostedcluster_types.go
  • control-plane-operator/controllers/hostedcontrolplane/hostedcontrolplane_controller.go
  • control-plane-operator/controllers/hostedcontrolplane/manifests/pki.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/shard.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/statefulset.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/kas/params.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/kas/params_test.go
  • hypershift-operator/featuregate/feature.go
  • support/etcd/shards.go
  • support/etcd/shards_test.go
💤 Files with no reviewable changes (1)
  • support/etcd/shards.go
✅ Files skipped from review due to trivial changes (1)
  • .gitignore
🚧 Files skipped from review as they are similar to previous changes (3)
  • Dockerfile.local
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/shard.go
  • api/hypershift/v1beta1/hostedcluster_types.go

@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 20:04 Inactive
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 20:27 Inactive
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 20:49 Inactive

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
control-plane-operator/controllers/hostedcontrolplane/v2/etcd/etcd_test.go (1)

76-136: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add test coverage for non-empty leaderElectionID.

The test only covers the empty leaderElectionID case. The new conditional logic at lines 169-171 in statefulset.go that appends --leader-election-id when non-empty is untested.

💚 Suggested additional test case
{
	name:      "When called with a leaderElectionID, it should pass the leader-election-id as an arg",
	namespace: "test-namespace",
	leaderElectionID: "etcd-shard-foo-defrag",
	validate: func(g Gomega, c corev1.Container) {
		g.Expect(c.Args).To(Equal([]string{
			"etcd-defrag-controller",
			"--namespace",
			"test-namespace",
			"--leader-election-id",
			"etcd-shard-foo-defrag",
		}))
	},
},

This requires adding leaderElectionID string to the test case struct and updating the call:

-			c := buildEtcdDefragControllerContainer(tc.namespace, "")
+			c := buildEtcdDefragControllerContainer(tc.namespace, tc.leaderElectionID)
🤖 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 `@control-plane-operator/controllers/hostedcontrolplane/v2/etcd/etcd_test.go`
around lines 76 - 136, The test TestBuildEtcdDefragControllerContainer only
validates the empty leaderElectionID path; add a test case that supplies a
non-empty leaderElectionID and asserts the container args include
"--leader-election-id" and the provided ID. Update the test case struct in
TestBuildEtcdDefragControllerContainer to include leaderElectionID string, pass
that value into the call to buildEtcdDefragControllerContainer(namespace,
leaderElectionID), and add the suggested case (name: "...leaderElectionID...",
leaderElectionID: "etcd-shard-foo-defrag") that expects Args to equal
["etcd-defrag-controller","--namespace","test-namespace","--leader-election-id","etcd-shard-foo-defrag"]
so the conditional branch in statefulset.go is covered.
🧹 Nitpick comments (1)
control-plane-operator/controllers/hostedcontrolplane/v2/etcd/statefulset.go (1)

102-114: ⚡ Quick win

Extract duplicate scheduling logic into a shared helper.

This code duplicates adaptShardScheduling in shard.go:329-341 (from the relevant code snippets). Both apply NodeSelector and Tolerations identically to a StatefulSet pod template. Extract a shared helper to avoid divergence.

♻️ Suggested refactor

Create a shared helper (e.g., in this file or a common location):

func applySchedulingToStatefulSet(sts *appsv1.StatefulSet, nodeSelector map[string]string, tolerations []corev1.Toleration) {
	if len(nodeSelector) > 0 {
		if sts.Spec.Template.Spec.NodeSelector == nil {
			sts.Spec.Template.Spec.NodeSelector = map[string]string{}
		}
		for k, v := range nodeSelector {
			sts.Spec.Template.Spec.NodeSelector[k] = v
		}
	}
	if len(tolerations) > 0 {
		sts.Spec.Template.Spec.Tolerations = append(sts.Spec.Template.Spec.Tolerations, tolerations...)
	}
}

Then use it in both places:

-	if managedEtcdSpec != nil {
-		if len(managedEtcdSpec.Scheduling.NodeSelector) > 0 {
-			if sts.Spec.Template.Spec.NodeSelector == nil {
-				sts.Spec.Template.Spec.NodeSelector = map[string]string{}
-			}
-			for k, v := range managedEtcdSpec.Scheduling.NodeSelector {
-				sts.Spec.Template.Spec.NodeSelector[k] = v
-			}
-		}
-		if len(managedEtcdSpec.Scheduling.Tolerations) > 0 {
-			sts.Spec.Template.Spec.Tolerations = append(sts.Spec.Template.Spec.Tolerations, managedEtcdSpec.Scheduling.Tolerations...)
-		}
-	}
+	if managedEtcdSpec != nil {
+		applySchedulingToStatefulSet(sts, managedEtcdSpec.Scheduling.NodeSelector, managedEtcdSpec.Scheduling.Tolerations)
+	}
🤖 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 `@control-plane-operator/controllers/hostedcontrolplane/v2/etcd/statefulset.go`
around lines 102 - 114, The scheduling merge logic duplicated between the
StatefulSet block and adaptShardScheduling should be factored into a single
helper; add a function named applySchedulingToStatefulSet that accepts
(*appsv1.StatefulSet, nodeSelector map[string]string, tolerations
[]corev1.Toleration) and moves the NodeSelector merge and Tolerations append
logic into it, then replace the inline block in the StatefulSet creation (the
code handling managedEtcdSpec.Scheduling.NodeSelector/Tolerations) and the calls
in adaptShardScheduling to call applySchedulingToStatefulSet(sts,
managedEtcdSpec.Scheduling.NodeSelector, managedEtcdSpec.Scheduling.Tolerations)
so both sites reuse the same implementation.
🤖 Prompt for all review comments with 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.

Outside diff comments:
In `@control-plane-operator/controllers/hostedcontrolplane/v2/etcd/etcd_test.go`:
- Around line 76-136: The test TestBuildEtcdDefragControllerContainer only
validates the empty leaderElectionID path; add a test case that supplies a
non-empty leaderElectionID and asserts the container args include
"--leader-election-id" and the provided ID. Update the test case struct in
TestBuildEtcdDefragControllerContainer to include leaderElectionID string, pass
that value into the call to buildEtcdDefragControllerContainer(namespace,
leaderElectionID), and add the suggested case (name: "...leaderElectionID...",
leaderElectionID: "etcd-shard-foo-defrag") that expects Args to equal
["etcd-defrag-controller","--namespace","test-namespace","--leader-election-id","etcd-shard-foo-defrag"]
so the conditional branch in statefulset.go is covered.

---

Nitpick comments:
In
`@control-plane-operator/controllers/hostedcontrolplane/v2/etcd/statefulset.go`:
- Around line 102-114: The scheduling merge logic duplicated between the
StatefulSet block and adaptShardScheduling should be factored into a single
helper; add a function named applySchedulingToStatefulSet that accepts
(*appsv1.StatefulSet, nodeSelector map[string]string, tolerations
[]corev1.Toleration) and moves the NodeSelector merge and Tolerations append
logic into it, then replace the inline block in the StatefulSet creation (the
code handling managedEtcdSpec.Scheduling.NodeSelector/Tolerations) and the calls
in adaptShardScheduling to call applySchedulingToStatefulSet(sts,
managedEtcdSpec.Scheduling.NodeSelector, managedEtcdSpec.Scheduling.Tolerations)
so both sites reuse the same implementation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: b94f399c-88b4-420f-8838-81a9b6394891

📥 Commits

Reviewing files that changed from the base of the PR and between e27c482 and 7b4aaf1.

📒 Files selected for processing (4)
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/etcd_test.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/shard.go
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/statefulset.go
  • etcd-defrag/main.go
🚧 Files skipped from review as they are similar to previous changes (1)
  • control-plane-operator/controllers/hostedcontrolplane/v2/etcd/shard.go

@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 21:01 Inactive
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 21:49 Inactive
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 9, 2026 21:54 Inactive
@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8705 June 10, 2026 00:03 Inactive
@jhjaggars jhjaggars changed the title NO-JIRA: Add etcd sharding by resource kind support OCPSTRAT-3150: Add etcd sharding by resource kind support Jun 10, 2026
// particular, resources backed by CustomResourceDefinitions and resources
// served by aggregated API servers (such as the openshift.io groups served
// by openshift-apiserver and oauth-apiserver) are NOT routed: entries for
// such resources are accepted but have no effect, and their data remains in

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I presume it's more complicated than it's worth to be able to validate this at admission time?

Scheduling EtcdShardSchedulingSpec `json:"scheduling,omitzero"`
}

// ManagedEtcdShardStorageType defines the type of storage for an etcd shard.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I know we chatted about creating "types" of etcd shard, maybe like a EphemeralEtcd that then drove settings like in-memory storage etc.

I think what you have here gives us the toggles to design that as we see fit from a service provider perspective though 👍 and keeps HyperShift API from needing to have a strong opinion right now.

@joshbranham joshbranham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left a few previous comments for clarification, but overall, this approach should allow us to protect clusters from event abuse, which is a very common pattern.

We will need to adopt this config down the road in ROSA, and decide, for example, if we care about some loss of events if we added an event shard to all clusters. I don't think that needs to block this design implementation, however.

@JoelSpeed JoelSpeed left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/lgtm
/approve

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 9, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aks-4-22
/test e2e-aws-4-22
/test e2e-aks
/test e2e-aws
/test e2e-aws-upgrade-hypershift-operator
/test e2e-azure-v2-self-managed
/test e2e-kubevirt-aws-ovn-reduced
/test e2e-v2-aws
/test e2e-v2-gke

@openshift-ci

openshift-ci Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jhjaggars, JoelSpeed
Once this PR has been reviewed and has the lgtm label, please assign sjenning for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added area/ci-tooling Indicates the PR includes changes for CI or tooling and removed lgtm Indicates that a PR is ready to be merged. labels Jul 9, 2026
jhjaggars and others added 10 commits July 14, 2026 07:25
- Add EtcdSharding feature gate (TechPreviewNoUpgrade)
- Add EtcdShardResource, ManagedEtcdShardSpec, ManagedEtcdShardStorageSpec,
  EtcdShardSchedulingSpec, and UnmanagedEtcdShardSpec types
- Add Shards field to ManagedEtcdSpec and UnmanagedEtcdSpec
- Add CEL validation for shard resource routing (built-in types only)
- Regenerate deepcopy and featuregated CRD manifests

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ndor

- Regenerate apply configurations for new etcd shard types
- Update CRD manifests for CustomNoUpgrade and TechPreviewNoUpgrade
- Add envtest suite for EtcdSharding feature gate validation
- Vendor updated API types

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…POv2 framework

- Register EtcdSharding feature gate
- Add WithAssetDir() to component builder for shared asset directories
- Support etcd-prefixed components in priorityClass, DefaultReplicas,
  FSGroup, and checkDependencies
- Add EffectiveShards() helper to compute shard list from HCP spec

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add NewShardComponent() for shard etcd StatefulSet instances
- Add per-shard TLS certificate generation in PKI controller
- Add --etcd-servers-overrides KAS flag for shard routing
- Update wait-for-etcd to check all shard DNS entries
- Update prometheus recording rules to match all etcd shards
- Isolate etcd-defrag to skip shard members
- Register shard components conditionally in HCP reconciler

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Document EtcdShardResource, ManagedEtcdShardSpec, and related types
- Document built-in-only routing limitation for shard resources

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Expand godocs for ManagedEtcdShardStorageSpec.Type and
  persistentVolume fields with valid values, behavior per value,
  and inheritance semantics
- Skip PDB for single-replica shards via predicate instead of
  deploying a no-op PDB (replicas is immutable so no lifecycle concern)
- Remove unused intstr import from shard.go
- Simplify PDB test to only cover multi-replica case
- Regenerate deepcopy, CRDs, clients, and vendor after rebase onto main
- Remove WithIdentityAdaptFunction calls removed upstream
- Update vendored deepcopy for SecretEncryptionStatus
Replace per-manifest adapt functions (adaptServiceForShard,
adaptDiscoveryServiceForShard, adaptPDBForShard) with Go template
rendering in asset YAMLs via WithTemplateData builder method.

- Add LoadManifestTemplated to assets package with missingkey=error
- Add WithTemplateData builder method to component framework
- Templatize etcd YAML assets with {{ .Name }}, {{ .ClientServiceName }},
  {{ .DiscoveryServiceName }}
- Wire template data through all manifest loading paths (update, delete,
  status)
- Remove imperative rename adapt functions from shard.go
- Keep adaptStatefulSetForShard for runtime domain logic
- Add comprehensive template rendering tests
Match the openshift/api policy for crdify's unhandled enforcement.
crdify doesn't have comparators for all schema fields yet (e.g.
XValidations/CEL rules), so unhandled diffs produce warnings rather
than hard errors. API reviewers catch actual breaking changes during
review.
Shard components share the etcd asset directory via WithAssetDir and
suppress shared SA/RBAC manifests with false predicates. However, the
framework's predicate-false path deletes existing HCP-owned resources,
creating a race where the default etcd component creates the etcd
ServiceAccount and shard reconciliations delete it.

Add a SkipManifest() adapter option that neither creates nor deletes the
manifest, and use it for the 7 shared SA/RBAC manifests in shard
components.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci

openshift-ci Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

@jhjaggars: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@jhjaggars

Copy link
Copy Markdown
Contributor Author

/test e2e-aks-4-22
/test e2e-aws-4-22
/test e2e-aks
/test e2e-aws
/test e2e-aws-upgrade-hypershift-operator
/test e2e-azure-v2-self-managed
/test e2e-kubevirt-aws-ovn-reduced
/test e2e-v2-aws
/test e2e-v2-gke

@hypershift-jira-solve-ci

hypershift-jira-solve-ci Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Now I have all the evidence needed to produce the final report. Here it is:


Test Failure Analysis: ci/prow/e2e-kubevirt-aws-ovn-reduced

PR: #8705OCPSTRAT-3150: Add etcd sharding by resource kind support
Prow Job: pull-ci-openshift-hypershift-main-e2e-kubevirt-aws-ovn-reduced
Build ID: 2077002677002178560
Result: failure — Cluster installation timed out during bootstrap


💥 Failure Summary

The IPI management cluster installation failed because the Cluster Etcd Operator (CEO) entered a permanent resource-version conflict loop, preventing the observedConfig from persisting on the etcds.operator.openshift.io/cluster CR. This deadlocked the entire CEO controller chain: without a persisted observedConfig, the EnvVarController couldn't read cipherSuites, which blocked TargetConfigController and ScriptController from generating configmap/etcd-pod, which blocked the InstallerController from deploying etcd static pods on control plane nodes. The EtcdRunningInCluster condition was never set to True, so bootkube waited indefinitely until the 55m50s bootstrap timeout.

This is a base CI payload bug, not caused by PR #8705. The cluster-etcd-operator image comes from the OCP 5.0.0 CI payload (5.0.0-0.ci-2026-07-14-134847), not from the hypershift PR. The PR only replaces the hypershift-operator image.


🔍 Root Cause

Root cause: CEO observedConfig write contention causing permanent deadlock

The Cluster Etcd Operator has ~10 internal controllers that concurrently read/write the etcds.operator.openshift.io/cluster CR. During bootstrap, these controllers create a thundering-herd problem:

  1. ConfigObserver detects observedConfig is {} and attempts to write {controlPlane: {replicas: 3}, servingInfo: {cipherSuites: [...], minTLSVersion: "VersionTLS12"}}
  2. Simultaneously, StatusController, DefragController, BootstrapTeardownController, EtcdMembersController, and EtcdEndpointsController all write their status updates to the same CR
  3. Result: 441 out of 442 ObservedConfigChanged writes failed with "Operation cannot be fulfilled on etcds.operator.openshift.io 'cluster': the object has been modified" — the diff is always {} → {full config}, proving the config never persisted
  4. Cascading deadlock:
    • EnvVarController reads observedConfig → finds {} → error: "no supported cipherSuites not found in observedConfig" (3,702 occurrences)
    • TargetConfigController depends on env vars → error: "TargetConfigController missing env var values"
    • ScriptController depends on etcd-pod configmap → error: "configmap/etcd-pod: missing env var values"
    • RevisionController depends on etcd-pod configmap → error: "configmap 'etcd-pod' not found"
    • InstallerController depends on revision resources → error: "missing required resources: [configmaps: etcd-all-bundles-0, etcd-endpoints-0, etcd-pod-0, secrets: etcd-all-certs-0]"
    • Result: 0 out of 3 master nodes got etcd static pods deployed; all remained at revision 0
  5. Bootstrap etcd on 10.0.104.103 was healthy and serving clients — the failure was exclusively in the CEO's inability to transition from bootstrap etcd to production etcd on control plane nodes
  6. API throttling compounded the issue: 2,216 client-side throttling events on PUT to the etcd CR, with delays up to 1.4 seconds

Timeline:

  • 14:00:53 — Bootstrap etcd starts, becomes leader
  • 14:06:08 — CEO instance 1 starts on master, immediately fails (certs missing — expected during bootstrap)
  • 14:06:09 — CEO instance 1 loses leader election
  • 14:06:19 — CEO instance 2 starts, begins reconciliation loop
  • 14:06:20 — First observedConfig write attempt: {} → {cipherSuites, replicas}fails with version conflict
  • 14:06:2014:47:2941 minutes of continuous write failures (441 total), cipherSuites not found errors (3,702 total), and API throttling (2,216 events)
  • 14:14:51 — bootkube begins waiting for EtcdRunningInCluster=True
  • 14:47:09 — bootkube timeout (55m50s total install budget exhausted)
  • 14:47:37 — Installer reports exit code 5 (bootstrap failure)
📋 Recommendations
  1. Retry the job — This is likely a timing-dependent race condition in the cluster-etcd-operator during bootstrap. The write contention between ~10 CEO controllers fighting over one CR may resolve on a less loaded API server or with different timing.

  2. File a bug against openshift/cluster-etcd-operator — The observedConfig write path lacks adequate retry-with-backoff logic. When multiple controllers compete for the same CR, the ConfigObserver should use optimistic concurrency with exponential backoff or a dedicated update channel that serializes writes. The fact that 441/442 writes failed over 41 minutes indicates no effective backoff is in place.

  3. Check CI payload health — Verify if other jobs on the same 5.0.0-0.ci-2026-07-14-134847 payload also experience bootstrap timeouts. This could be a regression in the cluster-etcd-operator image in the latest 5.0 nightly.

  4. This PR (#8705) is NOT the cause — The openshift/hypershift PR only replaces the hypershift-operator image in the CI payload. The cluster-etcd-operator comes from the base OCP 5.0.0 CI payload. The failure occurs during IPI cluster installation (pre phase), before any HyperShift components are involved.

📄 Evidence

Failed JUnit test cases (junit_operator.xml):

Step Phase Exit Code Error
ipi-install-install pre 5 Bootstrap timeout after 55m50s
hypershift-k8sgpt test 1 Server doesn't have resource type "hostedcluster" (consequence of install failure)
Run multi-stage test pre phase pre Phase-level failure
Run multi-stage test post phase post Phase-level failure

CEO observedConfig write failure loop (ceo-2.log):

442 ObservedConfigChanged events (attempts to write config)
441 ObservedConfigWriteError events (failed with "object has been modified")
  1 successful write (immediately overwritten by conflicting controller)

CEO error counts (14:06:20 – 14:47:29, 41 minutes):

3,702 × "no supported cipherSuites not found in observedConfig" (EnvVarController)
2,216 × client-side throttling on PUT to etcd CR
  441 × ConfigObserver write failure
  441 × DefragController conflict
  441 × BootstrapTeardownController conflict
  110 × EtcdMembersController conflict

Cluster operator status (persisted throughout the 41-minute loop):

ScriptControllerDegraded: "configmap/etcd-pod": missing env var values
EnvVarControllerDegraded: no supported cipherSuites not found in observedConfig
InstallerControllerDegraded: missing required resources: [configmaps: etcd-all-bundles-0, etcd-endpoints-0, etcd-pod-0, secrets: etcd-all-certs-0]
RevisionControllerDegraded: configmap "etcd-pod" not found
ConfigObservationDegraded: error writing updated observed config: Operation cannot be fulfilled
StaticPodsAvailable: 0 nodes are active; 3 nodes are at revision 0

Bootstrap etcd health (confirmed NOT the cause):

etcd 3.6.11 on bootstrap node 10.0.104.103
Leader at term 2, serving clients normally
Processing snapshots and compactions through 14:43

Bootkube stuck (wait-for-ceo.log):

14:14:51 → 14:47:09 (32+ minutes): "waiting on condition EtcdRunningInCluster in etcd CR /cluster to be True"
Condition never set — CEO controllers never deployed etcd static pods

Payload: 5.0.0-0.ci-2026-07-14-134847-test-ci-op-305by355-latest

Artifacts: .work/prow-job-analyze-test-failure/2077002677002178560/logs/


@JoelSpeed

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 14, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Tests from second stage were triggered manually. Pipeline can be controlled only manually, until HEAD changes. Use command to trigger second stage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/api Indicates the PR includes changes for the API area/ci-tooling Indicates the PR includes changes for CI or tooling area/cli Indicates the PR includes changes for CLI area/control-plane-operator Indicates the PR includes changes for the control plane operator - in an OCP release area/documentation Indicates the PR includes changes for documentation area/hypershift-operator Indicates the PR includes changes for the hypershift operator and API - outside an OCP release jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants