SDK generated components named `controller-manager` should be named `controller` or `operator`

[bwoolf1]

Bug Report

The SDK generates a Deployment named "controller-manager". This name is misleading. The controller manager is a component in the control plane that runs controllers. That's not what's being deployed.

The image for this Deployment is called "operator." That would be a better name for this Deployment. Or "controller" would be better than "controller-manager".

What did you do?

Generated a Go operator and deployed it.

What did you expect to see?

Since the image is named <my_service>-operator, I expect its deployment to have the same name.

What did you see instead? Under which circumstances?

The deployment is named <my_service>-operator-controller-manager. The pods have the same name, plus the UID. The control-plane label is literally controller-manager (no prefix). Interestingly, the container doesn't have this name, it's just <my_service>-operator.

Environment

Operator type:

/language go

Kubernetes cluster type:

$ operator-sdk version

operator-sdk version: "v1.6.1", commit: "e6981d812a759442a583d8ee2fae269507c408d4", kubernetes version: "v1.19.4", go version: "go1.16.3", GOOS: "darwin", GOARCH: "amd64"

$ go version (if language is Go)

go version go1.15.8 darwin/amd64

$ kubectl version

Client Version: version.Info{Major:"1", Minor:"19", GitVersion:"v1.19.0", GitCommit:"18d7461aca47e77cefb355339252a8d4c149188f", GitTreeState:"clean", BuildDate:"2021-01-30T16:44:37Z", GoVersion:"go1.15.5", Compiler:"gc", Platform:"darwin/amd64"}

Possible Solution

The names in the /config/manager/manager.yaml template should be "operator", not "controller-manager". The kustomize code should add the "<my_service>-" prefix to "operator" or simply replace "operator" with "<my_service>-operator". Likewise, the filename shouldn't be manager, nor should the directory name; they should be operator, same as the deployment in the template.

Additional context

[estroz]

The name "controller-manager" name/suffix comes from controller-runtime's Manager being the operator-sdk's (and kubebuilder's) default controller manager. Additionally you are able to write just a controller, and not a full operator, using operator-sdk (operator-sdk init && operator-sdk create api --resource=false --controller=true). The "operator" name/suffix would be fine, and you are more than welcome to find config/ -name *.yaml -exec sed -i 's/controller-manager/operator/g' {} \;. Unless you are seeing a technical issue with this naming scheme, I do not see a reason to change its default value.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

[openshift-bot]

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

[openshift-ci]

@openshift-bot: Closing this issue.

Details

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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/test-infra repository.