Add `crd print` subcommand to output embedded CRDs by Arpit529Srivastava · Pull Request #8251 · prometheus-operator/prometheus-operator

Arpit529Srivastava · 2026-01-07T19:40:45Z

Description

adds a crd subcommand to the prom-operator binary to print and list CRDs directly from the operator. CRDs are embedded at build time using //go:embed.

Closes: #7270

If you're contributing for the first-time, check our contribution guidelines.

Type of change

What type of changes does your code introduce to the Prometheus operator? Put an x in the box that apply.

CHANGE (fix or feature that would cause existing functionality to not work as expected)
FEATURE (non-breaking change which adds functionality)
BUGFIX (non-breaking change which fixes an issue)
ENHANCEMENT (non-breaking change which improves existing functionality)
NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Verification

added unit tests in example/prometheus-operator-crd/crd_test.go

TestPrintAll: verifies all 10 CRDs are embedded and output correctly
TestListNames : verifies CRD listing functionality
TestPrintByName : verifies individual CRD retrieval

Please check the Prometheus-Operator testing guidelines for recommendations about automated tests.

Changelog entry

Please put a one-line changelog entry below. This will be copied to the changelog file during the release process.

Add `crd print` subcommand to output embedded CRDs to stdout for automated installation.

Arpit529Srivastava · 2026-01-07T19:54:35Z

/cc @heliapb @simonpasquier please review once you get a chance.
thanks.

simonpasquier · 2026-01-08T08:28:52Z

copied from the original issue:

the size increase of the binary but if we're talking about a few percents, it would be fine.

what's the binary size's increase?

About the integration with the flag std library, I suggest that we use https://pkg.go.dev/flag#FlagSet.NArg to check for remaining CLI args:

./operator crds

For completeness, we should probably implement a start argument:

./operator --web.cert-file /etc/tls/server.crt --web.key-file /etc/tls.server.key [...] start

The flag library is a bit limited compared to other alternatives like github.com/spf13/viper but a migration would be expensive.

Arpit529Srivastava · 2026-01-08T08:46:44Z

what's the binary size's increase?

@simonpasquier
the embedded CRD files add approximately 4.3 MB to the binary (uncompressed). based on the current operator binary size (~90MB),this represents about a ~ 5% increase.

Arpit529Srivastava · 2026-01-08T09:24:27Z

@simonpasquier PTAL
updated the implementation to align with your suggestions.

cmd are getting checked after flag parsing, as suggested.

supported commands

./operator crds : prints all CRDs to stdout (for pipelined installs).

./operator start: explicitly starts the operator.

./operator: remains backward compatible and starts the operator by default.

Arpit529Srivastava · 2026-01-12T06:56:52Z

@simonpasquier gentle ping, whenever you get a chance.

simonpasquier

Not sure about the CI failures. Have you tried to rebase on top of the main branch?

Also ideally --help should print information about the new command

Usage of ./operator:

operator [arguments] [<command>]

Commands:
  start  Run the operator (default)
  crds   Print the Custom Resource Definitions (CRDs) in YAML format to standard output

Arguments:
...

example/crds.go

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

Arpit529Srivastava · 2026-01-12T17:04:33Z

the crd files are duplicated under cmd/crds/crds/ because //go:embed can’t reference files from example/prometheus-operator-crd/. which is making this pr large diff (~74k lines).
options:
keep the go files in example/prometheus-operator-crd/ (avoid duplication), gzip the embedded files to reduce size or
accept the duplication

what should be the correct approach @simonpasquier? please review
thanks

simonpasquier · 2026-01-13T09:01:33Z

what should be the correct approach @simonpasquier? please review

In that case I would vote to have crds.go located in the example/ directory. At least the Go code won't be mixed with yaml files.

simonpasquier · 2026-01-13T09:08:59Z

cmd/operator/main.go

 	}

+	// Handle CLI commands (crds, start, etc.)
+	if exitCode, handled := handleCommand(fs); handled {


I would

create start() and crds() functions which would handle each command.

repurpose run() to parse the arguments + validate the command (default to start if nothing is specificed) + call either start(), crds() or exit with error.

made the requested changes.

simonpasquier

#8251 (comment)

Is it possible to move the crds*.go file to example/

simonpasquier · 2026-01-13T13:42:07Z

cmd/operator/main.go


 func parseFlags(fs *flag.FlagSet) {
+	// Customize Usage to show available commands
+	fs.Usage = func() {


(nit) Rather than modifying the default flagset, can we create our own instance in main()?

Arpit529Srivastava · 2026-01-13T15:00:08Z

#8251 (comment)

Is it possible to move the crds*.go file to example/

my bad, poor overlooking.

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

simonpasquier

One last nuance is that we have 2 sets of CRDs: example/prometheus-operator-crd/ and example/prometheus-operator-crd-full/. Can we have also have a full-crds command which would read from example/prometheus-operator-crd-full/?

simonpasquier · 2026-01-13T15:40:27Z

example/crds_test.go

+	if err != nil {
+		t.Fatalf("PrintAll() error = %v", err)
+	}


Suggested change

if err != nil {

t.Fatalf("PrintAll() error = %v", err)

}

require.NoError(t, err)

simonpasquier · 2026-01-13T15:41:36Z

example/crds_test.go

+	// Check that output is not empty
+	if len(output) == 0 {
+		t.Error("PrintAll() returned empty output")
+	}
+
+	// Check for expected CRD content markers
+	expectedMarkers := []string{
+		"apiVersion: apiextensions.k8s.io/v1",
+		"kind: CustomResourceDefinition",
+		"monitoring.coreos.com",
+	}
+
+	for _, marker := range expectedMarkers {
+		if !strings.Contains(output, marker) {
+			t.Errorf("PrintAll() output missing expected marker: %q", marker)
+		}
+	}
+
+	// Check that we have multiple CRDs (separated by ---)
+	crdCount := strings.Count(output, "kind: CustomResourceDefinition")
+	if crdCount < 10 {
+		t.Errorf("PrintAll() expected at least 10 CRDs, got %d", crdCount)
+	}


To be honest, I would just check that the output is a valid YAML and can be deserialized to []CustomResourceDefinition.

simonpasquier · 2026-01-13T15:41:59Z

Makefile

 operator:
 	$(GO_BUILD_RECIPE) -o $@ ./cmd/operator/

+


not needed?

Yes, my bad

Arpit529Srivastava · 2026-01-13T15:53:39Z

on it!

Arpit529Srivastava · 2026-01-13T15:59:27Z

One last nuance is that we have 2 sets of CRDs: example/prometheus-operator-crd/ and example/prometheus-operator-crd-full/. Can we have also have a full-crds command which would read from example/prometheus-operator-crd-full/?

going with this
./operator full-crds

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

Arpit529Srivastava · 2026-01-13T16:50:36Z

@simonpasquier thanks for the revie, PTAL

simonpasquier

Thanks!

…r to v0.89.0 (#3775) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [prometheus-operator/prometheus-operator](https://github.com/prometheus-operator/prometheus-operator) | minor | `v0.88.1` → `v0.89.0` | --- ### Release Notes <details> <summary>prometheus-operator/prometheus-operator (prometheus-operator/prometheus-operator)</summary> ### [`v0.89.0`](https://github.com/prometheus-operator/prometheus-operator/releases/tag/v0.89.0): 0.89.0 / 2026-02-05 [Compare Source](prometheus-operator/prometheus-operator@v0.88.1...v0.89.0) - \[ENHANCEMENT] Add `hostNetwork` field to the `Alertmanager` CRD. [#8281](prometheus-operator/prometheus-operator#8281) - \[ENHANCEMENT] Add the `crds` and `full-crds` commands to the operator's binary. [#8251](prometheus-operator/prometheus-operator#8251) - \[ENHANCEMENT] Report deprecated field usage in the `Reconciled` condition type. [#8236](prometheus-operator/prometheus-operator#8236) - \[ENHANCEMENT] Avoid unnecessary reconciliation upon creation of the `ThanosRuler` StatefulSet. [#8347](prometheus-operator/prometheus-operator#8347) - \[ENHANCEMENT] Add `bodySizeLimit` to the ScrapeConfig CRD. [#8348](prometheus-operator/prometheus-operator#8348) - \[ENHANCEMENT] Support `http_headers` field in the Alertmanager Secret. [#8357](prometheus-operator/prometheus-operator#8357) - \[ENHANCEMENT] Add the `-kubelet-http-metrics` flag to enable/disable the HTTP metrics port in the Kubelet endpoint (default=enabled). [#8350](prometheus-operator/prometheus-operator#8350) - \[ENHANCEMENT] Include `operator.prometheus.io/version` annotation in the full version of CRDs. [#8279](prometheus-operator/prometheus-operator#8279) - \[BUGFIX] Validate VictorOps global configuration in the `Alertmanager` CRD. [#8020](prometheus-operator/prometheus-operator#8020) - \[BUGFIX] Validate Jira global configuration in the `Alertmanager` CRD. [#8265](prometheus-operator/prometheus-operator#8265) - \[BUGFIX] Validate VictorOps receiver's URL in the `AlertmanagerConfig` CRD. [#8258](prometheus-operator/prometheus-operator#8258) - \[BUGFIX] Validate Webex receiver's URL in the `AlertmanagerConfig` CRD. [#8255](prometheus-operator/prometheus-operator#8255) - \[BUGFIX] Validate Jira receiver's URL configuration in the `AlertmanagerConfig` CRD. [#8230](prometheus-operator/prometheus-operator#8230) - \[BUGFIX] Validate OpsGenie receiver configuration in the `AlertmanagerConfig` CRD. [#8267](prometheus-operator/prometheus-operator#8267) - \[BUGFIX] Validate WeChat receiver configuration in the `AlertmanagerConfig` CRD. [#8271](prometheus-operator/prometheus-operator#8271) - \[BUGFIX] Validate SNS receiver configuration in the `AlertmanagerConfig` CRD. [#8217](prometheus-operator/prometheus-operator#8217) - \[BUGFIX] Validate Webex global configuration in the `Alertmanager` CRD. [#7979](prometheus-operator/prometheus-operator#7979) - \[BUGFIX] Validate Telegram global configuration in the `Alertmanager` CRD. [#8268](prometheus-operator/prometheus-operator#8268) - \[BUGFIX] Restore statefulset's labels if the creation fails with AlreadyExists. [#8343](prometheus-operator/prometheus-operator#8343) - \[BUGFIX] Fix potential panic due to informer cache races. [#8310](prometheus-operator/prometheus-operator#8310) - \[BUGFIX] Support probers defined with IPv6 addresses in the `Probe` CRD. [#8354](prometheus-operator/prometheus-operator#8354) - \[BUGFIX] Prevent group and repeat intervals with zero duration from breaking Alertmanager. [#8126](prometheus-operator/prometheus-operator#8126) - \[BUGFIX] Propagate all supported RocketChat attributes for `AlertmanagerConfig` CRD. [#8016](prometheus-operator/prometheus-operator#8016) - \[BUGFIX] Add URL validation for WeChat receiver. [#8256](prometheus-operator/prometheus-operator#8256) - \[BUGFIX] Add URL validation for SNS receiver. [#8259](prometheus-operator/prometheus-operator#8259) - \[BUGFIX] Fix GCE service discovery for the `ScrapeConfig` CRD. [#8284](prometheus-operator/prometheus-operator#8284) - \[BUGFIX] Avoid stale conditions in `Alertmanager`, `ThanosRuler`, `Prometheus` and `PrometheusAgent` resources. [#8304](prometheus-operator/prometheus-operator#8304) - \[BUGFIX] Fix race condition when updating rule ConfigMaps. [#8290](prometheus-operator/prometheus-operator#8290) - \[BUGFIX] Fix race condition when patching finalizers. [#8323](prometheus-operator/prometheus-operator#8323) - \[BUGFIX] Reconcile `ScrapeConfig` resources when namespace selection changes. [#8334](prometheus-operator/prometheus-operator#8334) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.alexlebens.dev/alexlebens/infrastructure/pulls/3775 Co-authored-by: Renovate Bot <renovate-bot@alexlebens.net> Co-committed-by: Renovate Bot <renovate-bot@alexlebens.net>

…r to v0.89.0 ##### [\`v0.89.0\`](https://github.com/prometheus-operator/prometheus-operator/releases/tag/v0.89.0) - \[ENHANCEMENT] Add `hostNetwork` field to the `Alertmanager` CRD. [#8281](prometheus-operator/prometheus-operator#8281) - \[ENHANCEMENT] Add the `crds` and `full-crds` commands to the operator's binary. [#8251](prometheus-operator/prometheus-operator#8251) - \[ENHANCEMENT] Report deprecated field usage in the `Reconciled` condition type. [#8236](prometheus-operator/prometheus-operator#8236) - \[ENHANCEMENT] Avoid unnecessary reconciliation upon creation of the `ThanosRuler` StatefulSet. [#8347](prometheus-operator/prometheus-operator#8347) - \[ENHANCEMENT] Add `bodySizeLimit` to the ScrapeConfig CRD. [#8348](prometheus-operator/prometheus-operator#8348) - \[ENHANCEMENT] Support `http_headers` field in the Alertmanager Secret. [#8357](prometheus-operator/prometheus-operator#8357) - \[ENHANCEMENT] Add the `-kubelet-http-metrics` flag to enable/disable the HTTP metrics port in the Kubelet endpoint (default=enabled). [#8350](prometheus-operator/prometheus-operator#8350) - \[ENHANCEMENT] Include `operator.prometheus.io/version` annotation in the full version of CRDs. [#8279](prometheus-operator/prometheus-operator#8279) - \[BUGFIX] Validate VictorOps global configuration in the `Alertmanager` CRD. [#8020](prometheus-operator/prometheus-operator#8020) - \[BUGFIX] Validate Jira global configuration in the `Alertmanager` CRD. [#8265](prometheus-operator/prometheus-operator#8265) - \[BUGFIX] Validate VictorOps receiver's URL in the `AlertmanagerConfig` CRD. [#8258](prometheus-operator/prometheus-operator#8258) - \[BUGFIX] Validate Webex receiver's URL in the `AlertmanagerConfig` CRD. [#8255](prometheus-operator/prometheus-operator#8255) - \[BUGFIX] Validate Jira receiver's URL configuration in the `AlertmanagerConfig` CRD. [#8230](prometheus-operator/prometheus-operator#8230) - \[BUGFIX] Validate OpsGenie receiver configuration in the `AlertmanagerConfig` CRD. [#8267](prometheus-operator/prometheus-operator#8267) - \[BUGFIX] Validate WeChat receiver configuration in the `AlertmanagerConfig` CRD. [#8271](prometheus-operator/prometheus-operator#8271) - \[BUGFIX] Validate SNS receiver configuration in the `AlertmanagerConfig` CRD. [#8217](prometheus-operator/prometheus-operator#8217) - \[BUGFIX] Validate Webex global configuration in the `Alertmanager` CRD. [#7979](prometheus-operator/prometheus-operator#7979) - \[BUGFIX] Validate Telegram global configuration in the `Alertmanager` CRD. [#8268](prometheus-operator/prometheus-operator#8268) - \[BUGFIX] Restore statefulset's labels if the creation fails with AlreadyExists. [#8343](prometheus-operator/prometheus-operator#8343) - \[BUGFIX] Fix potential panic due to informer cache races. [#8310](prometheus-operator/prometheus-operator#8310) - \[BUGFIX] Support probers defined with IPv6 addresses in the `Probe` CRD. [#8354](prometheus-operator/prometheus-operator#8354) - \[BUGFIX] Prevent group and repeat intervals with zero duration from breaking Alertmanager. [#8126](prometheus-operator/prometheus-operator#8126) - \[BUGFIX] Propagate all supported RocketChat attributes for `AlertmanagerConfig` CRD. [#8016](prometheus-operator/prometheus-operator#8016) - \[BUGFIX] Add URL validation for WeChat receiver. [#8256](prometheus-operator/prometheus-operator#8256) - \[BUGFIX] Add URL validation for SNS receiver. [#8259](prometheus-operator/prometheus-operator#8259) - \[BUGFIX] Fix GCE service discovery for the `ScrapeConfig` CRD. [#8284](prometheus-operator/prometheus-operator#8284) - \[BUGFIX] Avoid stale conditions in `Alertmanager`, `ThanosRuler`, `Prometheus` and `PrometheusAgent` resources. [#8304](prometheus-operator/prometheus-operator#8304) - \[BUGFIX] Fix race condition when updating rule ConfigMaps. [#8290](prometheus-operator/prometheus-operator#8290) - \[BUGFIX] Fix race condition when patching finalizers. [#8323](prometheus-operator/prometheus-operator#8323) - \[BUGFIX] Reconcile `ScrapeConfig` resources when namespace selection changes. [#8334](prometheus-operator/prometheus-operator#8334) --- ##### [\`v0.88.1\`](https://github.com/prometheus-operator/prometheus-operator/releases/tag/v0.88.1) - \[BUGFIX] Validate `webhookURL` secret for `MSTeams` receiver in `AlertmanagerConfig` CRD. [#8294](prometheus-operator/prometheus-operator#8294) - \[BUGFIX] Revert maximum version check for `EC2/Lightsail` SD in `ScrapeConfig` CRD. [#8308](prometheus-operator/prometheus-operator#8308) - \[BUGFIX] Relax URL validation in `Slack` receiver in AlertmanagerConfig CRD to support Go templates. [#8299](prometheus-operator/prometheus-operator#8299) [#8331](prometheus-operator/prometheus-operator#8331) - \[BUGFIX] Relax URL validation in `PagerDuty` in AlertmanagerConfig CRD to support Go templates. [#8319](prometheus-operator/prometheus-operator#8319) - \[BUGFIX] Relax URL validation in `WebhookConfig` in AlertmanagerConfig CRD to support Go templates. [#8307](prometheus-operator/prometheus-operator#8307) [#8317](prometheus-operator/prometheus-operator#8317) - \[BUGFIX] Relax URL validation in `RocketChat` receiver in AlertmanagerConfig CRD to support Go templates. [#8318](prometheus-operator/prometheus-operator#8318) - \[BUGFIX] Relax URL validation in `Pushover` receiver in AlertmanagerConfig CRD to support Go templates. [#8307](prometheus-operator/prometheus-operator#8307) [#8316](prometheus-operator/prometheus-operator#8316)

Arpit529Srivastava requested a review from a team as a code owner January 7, 2026 19:40

pull-request-size bot added the size/M label Jan 7, 2026

Arpit529Srivastava force-pushed the feat-issue7270 branch from 696c1ed to 95ded11 Compare January 7, 2026 20:00

simonpasquier reviewed Jan 12, 2026

View reviewed changes

example/crds.go Show resolved Hide resolved

Arpit529Srivastava added 3 commits January 12, 2026 21:58

feat: embed CRD manifests in operator

b827a66

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

replace sort with slices package

1656a8a

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

refactor: use flag.NArg() for crds and start commands

f1ce919

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

Arpit529Srivastava force-pushed the feat-issue7270 branch from de5c618 to 81c1b1b Compare January 12, 2026 16:48

pull-request-size bot added size/L and removed size/M labels Jan 12, 2026

Arpit529Srivastava force-pushed the feat-issue7270 branch from 81c1b1b to 1950b8e Compare January 12, 2026 16:55

pull-request-size bot added size/XXL and removed size/L labels Jan 12, 2026

Arpit529Srivastava force-pushed the feat-issue7270 branch from 1950b8e to 77ea78a Compare January 12, 2026 17:07

Arpit529Srivastava requested a review from simonpasquier January 12, 2026 17:47

simonpasquier reviewed Jan 13, 2026

View reviewed changes

Arpit529Srivastava force-pushed the feat-issue7270 branch from 77ea78a to a432f49 Compare January 13, 2026 10:58

pull-request-size bot added size/M and removed size/XXL labels Jan 13, 2026

Arpit529Srivastava requested a review from simonpasquier January 13, 2026 11:38

simonpasquier reviewed Jan 13, 2026

View reviewed changes

refactor: move crds to cmd/crds and add --help info

1fa9670

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

Arpit529Srivastava force-pushed the feat-issue7270 branch from a432f49 to 1fa9670 Compare January 13, 2026 15:02

pull-request-size bot added size/L and removed size/M labels Jan 13, 2026

Arpit529Srivastava requested a review from simonpasquier January 13, 2026 15:41

simonpasquier reviewed Jan 13, 2026

View reviewed changes

feat: add full-crds command

610194e

Signed-off-by: arpit529srivastava <arpitsrivastava529@gmail.com>

Arpit529Srivastava requested a review from simonpasquier January 13, 2026 16:50

simonpasquier approved these changes Jan 13, 2026

View reviewed changes

simonpasquier merged commit b877445 into prometheus-operator:main Jan 13, 2026
22 checks passed

Arpit529Srivastava deleted the feat-issue7270 branch January 13, 2026 19:53

Conversation

Arpit529Srivastava commented Jan 7, 2026

Description

Type of change

Verification

Changelog entry

Uh oh!

Arpit529Srivastava commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simonpasquier commented Jan 8, 2026

Uh oh!

Arpit529Srivastava commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Arpit529Srivastava commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Arpit529Srivastava commented Jan 12, 2026

Uh oh!

simonpasquier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Arpit529Srivastava commented Jan 12, 2026

Uh oh!

simonpasquier commented Jan 13, 2026

Uh oh!

simonpasquier Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Arpit529Srivastava Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

simonpasquier left a comment

Choose a reason for hiding this comment

Uh oh!

simonpasquier Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Arpit529Srivastava Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Arpit529Srivastava commented Jan 13, 2026

Uh oh!

simonpasquier left a comment

Choose a reason for hiding this comment

Uh oh!

simonpasquier Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

simonpasquier Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

simonpasquier Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Arpit529Srivastava Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Arpit529Srivastava commented Jan 13, 2026

Uh oh!

Arpit529Srivastava commented Jan 13, 2026

Uh oh!

Arpit529Srivastava commented Jan 13, 2026

Uh oh!

simonpasquier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Arpit529Srivastava commented Jan 7, 2026 •

edited

Loading

Arpit529Srivastava commented Jan 8, 2026 •

edited

Loading

Arpit529Srivastava commented Jan 8, 2026 •

edited

Loading

Arpit529Srivastava Jan 13, 2026 •

edited

Loading