operator-framework / operator-sdk

SDK for building Kubernetes applications. Provides high level APIs, useful abstractions, and project scaffolding.
https://sdk.operatorframework.io
Apache License 2.0
7.25k stars 1.75k forks source link

Docs: Have an operator scope doc per type #3447

Open camilamacedo86 opened 4 years ago

camilamacedo86 commented 4 years ago

Feature Request

Is your feature request related to a problem? Please describe. Currently, we have just one doc that explains the operator scope and how to change it which is very specific for Go. However, it has been linked in the Ansible/Helm doc and then, its user may might harder to understand.

Describe the solution you'd like

camilamacedo86 commented 4 years ago

For Helm/Ansible operators the steps are quite the same as Go one. The only diff is that users will not change the main.go file which is not provided to them. However, they can do the same setup by using the WATCH_NAMESPACE as it was in the legacy layout in the config/manager/manager.yaml which allows them to inform 1 namespace or a set of them (N/Many) ( multi-namespace scenario that you can see in the Operator Scope doc for Go).

camilamacedo86 commented 4 years ago

I just would like to track here that more than one issue came from OCP users since by the default shows that they have not admin permissions and we might need to provide in this docs a tutorial. For example, for Helm use the Nginx example to describe it.

openshift-bot commented 3 years ago

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

camilamacedo86 commented 3 years ago

/lifecycle frozen