Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

⚠ rename Operator API to ClusterExtension API #568

Conversation

joelanford
Copy link
Member

Description

This PR updates the Operator API to be renamed to ClusterExtension, and updates docs terminology, variable names, etc. to align with the more generic "extension" term. This helps in a variety of ways:

  1. It signals that OLMv1 is about more than operators. (Yes, there's still the overall Operator Framework and Operator Lifecycle Manager branding to deal with)
  2. It gets us out of the conundrum of having Operator APIs in both OLMv0 and OLMv1 in different groups, which causes UX problems with the kubectl <verb> operators.
  3. The Cluster prefix paves the way to introducing a namespace-scoped equivalent Extension API.

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@joelanford joelanford requested a review from a team as a code owner December 14, 2023 16:28
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

Attention: 22 lines in your changes are missing coverage. Please review.

Comparison is base (8d428a5) 83.60% compared to head (cd8b3b6) 83.60%.

Files Patch % Lines
...nternal/controllers/clusterextension_controller.go 76.62% 17 Missing and 1 partial ⚠️
api/v1alpha1/zz_generated.deepcopy.go 40.00% 3 Missing ⚠️
cmd/manager/main.go 66.66% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #568   +/-   ##
=======================================
  Coverage   83.60%   83.60%           
=======================================
  Files          20       20           
  Lines         811      811           
=======================================
  Hits          678      678           
  Misses         92       92           
  Partials       41       41           
Flag Coverage Δ
e2e 63.50% <62.13%> (ø)
unit 78.72% <69.00%> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@joelanford joelanford force-pushed the rename-operator-to-clusterextension branch 2 times, most recently from 676c73e to e3be862 Compare December 14, 2023 16:43
everettraven
everettraven previously approved these changes Dec 14, 2023
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

Looks good to me. Left a couple comments on more nitpicky things, so feel free to address them or ignore them - totally up to you.

everettraven
everettraven previously approved these changes Dec 14, 2023
Makefile Outdated Show resolved Hide resolved
Signed-off-by: Joe Lanford <joe.lanford@gmail.com>
@joelanford joelanford force-pushed the rename-operator-to-clusterextension branch from 603cab5 to cd8b3b6 Compare December 14, 2023 20:08
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

LGTM

@joelanford joelanford added this pull request to the merge queue Dec 14, 2023
Merged via the queue into operator-framework:main with commit 9316012 Dec 14, 2023
14 of 16 checks passed
@joelanford joelanford deleted the rename-operator-to-clusterextension branch December 14, 2023 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants