CNTRLPLANE-2270: Update README with operator responsibilities

[YamunadeviShanmugam]

Update ReadMe file with correct information(README contained outdated information that could mislead contributors and users about the operator's actual scope and responsibilities.)

Summary

Update the README to accurately reflect the cluster-config-operator's current responsibilities and remove outdated information.

Changes

• Remove outdated claim about being the source of CRD manifests for config.openshift.io (CRDs were moved to the api)
• Clarify that the operator has a minimal set of controllers but is not accepting new ones
• Document the actual controllers running in the operator:
  • Feature Gates Controller
  • Kube Cloud Config Controller
  • AWS Platform Service Location Controller
  • Platform Status Migration Controller
  • Feature Upgradeable Controller
  • Latency Sensitive Removal Controller (temporary migration)
  • OKD Feature Set Migration Controller (temporary migration)
• Add accurate descriptions of controllers

Summary by CodeRabbit

• Documentation
  • Reworked the README to provide a clearer, operator-focused overview.
  • Added a more complete description of the operator’s runtime controllers and what they manage.
  • Improved the testing section with clearer guidance for building, running, and listing tests.
  • Added a new dependencies section with key project references.
  • Expanded security guidance and updated the license notice to Apache 2.0.

[openshift-ci-robot]

@YamunadeviShanmugam: This pull request references CNTRLPLANE-2270 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Update ReadMe file with correct information(README contained outdated information that could mislead contributors and users about the operator's actual scope and responsibilities.)

Summary

Update the README to accurately reflect the cluster-config-operator's current responsibilities and remove outdated information.

Changes

• Remove outdated claim about being the source of CRD manifests for config.openshift.io (CRDs were moved to the api)
• Clarify that the operator has a minimal set of controllers but is not accepting new ones
• Document the actual controllers running in the operator:
  • Feature Gates Controller
  • Kube Cloud Config Controller
  • AWS Platform Service Location Controller
  • Platform Status Migration Controller
  • Feature Upgradeable Controller
  • Latency Sensitive Removal Controller (temporary migration)
  • OKD Feature Set Migration Controller (temporary migration)
• Add accurate descriptions of controllers

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]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: b4b8c2a4-67ad-4bd9-ae2c-089ac5d79ba1

📥 Commits

Reviewing files that changed from the base of the PR and between a346b39 and 354f90c.

📒 Files selected for processing (1)

• README.md

---

Walkthrough

README.md is rewritten to describe the operator's purpose and enumerated controllers, reorganize the Testing section into build/run/list subsections, and add new Dependencies, Security, and License sections, replacing the prior CRD-manifest-focused description.

Changes

README Documentation Update

Layer / File(s)	Summary
Rewrite README structure and content README.md	Replaces CRD-manifest-focused content with an operator/controller overview, restructured Testing subsections (build, run-suite, run-test, JUnit output, listing), a new Dependencies section with a key dependencies table, a Security section with disclosure guidance, and an updated Apache 2.0 License section.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit hopped through docs anew,
Swapped old CRD talk for controllers true,
Testing steps now clear and neat,
Security and license, tidy and complete,
Hop, hop, README — freshly renewed!

---

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name	Status	Explanation	Resolution
Ote Binary Stdout Contract	❌ Error	cmd/cluster-config-operator-tests-ext/main.go calls cmd.Help() from the main path and no SetOut/SetErr redirection exists, so help text can hit stdout.	Send help/usage to stderr (e.g. cmd.SetOut(os.Stderr); cmd.SetErr(os.Stderr)) or avoid calling cmd.Help() in the tests-ext root Run path.

✅ Passed checks (14 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: a README update focused on the operator’s responsibilities.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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	No new or modified Ginkgo test titles were introduced; the only test file in the diff was deleted, and changed source files contain no It/Describe/Context/When calls.
Test Structure And Quality	✅ Passed	PASS: This PR only rewrites README/docs; no Ginkgo test code or test logic is changed, so the test-quality check is not applicable.
Microshift Test Compatibility	✅ Passed	Docs-only PR: no new Ginkgo e2e specs were added, and the only test-file change is deletion of an existing suite, so no MicroShift issues were introduced.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	Only README.md changed; no Ginkgo e2e tests or SNO-relevant assumptions were added.
Topology-Aware Scheduling Compatibility	✅ Passed	Only README.md changed in HEAD vs parent; no manifests or operator code/controllers were modified.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	No new Ginkgo e2e tests were added; the changed tests are plain testing.T unit tests, and no IPv4/external connectivity assumptions were found.
No-Weak-Crypto	✅ Passed	PASS: The PR only updates README/docs; no non-vendor code adds weak crypto, custom crypto, or secret/token comparisons.
Container-Privileges	✅ Passed	No privileged settings found; the deployment uses runAsNonRoot:true and allowPrivilegeEscalation:false, with no hostPID/hostNetwork/hostIPC/SYS_ADMIN or runAsUser:0 matches.
No-Sensitive-Data-In-Logs	✅ Passed	No new sensitive logging was added; README is docs-only and the code change only uses klog.Fatal on errors.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[gangwgr]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gangwgr, YamunadeviShanmugam
Once this PR has been reviewed and has the lgtm label, please assign joelspeed 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:

• OWNERS

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

[openshift-ci]

@YamunadeviShanmugam: 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.