Operator SDK 1.0 Meta-issue

[joelanford]

The Operator SDK maintainers and community members have been hard at work adding new features to improve integration with the Operator Lifecycle Manager and to unify project structures with Kubebuilder.

Many of these features are already on master, but some are still outstanding. The purpose of this issue is to communicate with the community about what the proposed 1.0 feature set is, and to document what's in, what's out, and what major changes we plan to make for existing projects.

Support for legacy project layouts (scaffolded with the new subcommand) will be removed for 1.0. The latest pre-1.0 release will receive patch updates to give users time to migrate to the new project structure. No new features will be backported from 1.0 to the latest pre-1.0 release.

1.0.0 GA

• Should display the commit info - https://bugzilla.redhat.com/show_bug.cgi?id=1865808 (Bug 1865808: Version informations populating error fix #3643) NOTE: @jmrodri to add a note in release for this tomorrow
• Simplify operator-sdk cleanup command (operator-sdk cleanup: remove packagemanifests, add generic command #3644)
• Fix molecule scaffolding error (Fix undefined var in scaffolded molecule tests #3654)
• Docs: reference to old boilerplate code Issue Docs: reference to old boilerplate code  #3460 - PR doc: Fix/Update the migration guide for Go projects #3543
• Migration guide for Ansible : doc: migration guide for Ansible and quickstart fixes #3571
• Molecule scaffolding fixes: Various molecule scaffolding tweaks #3661

1.0.0-alpha.2

• remove --operator-name flag from generate subcommands (generate: remove --operator-name #3530)
• switch to controller runtime log flags for helm and ansible and remove internal/log (cmd/helm|ansible-operator: add cobra subcommands #3596)
• helm/ansible subcommands (cmd/helm|ansible-operator: add cobra subcommands #3596)
• move scorecard APIs to operator-framework/api and remove pkg/apis (pkg/apis: add scorecard v1alpha3 API api#55) (scorecard: use api repo v1alpha3 API, remove existing #3622)
• Remove default channel validation from bundle lib (from operator-registry PR #408) (deps: bump operator-registry to v1.13.4 #3602)
• Update run packagemanifests flags
  • Remove --include and --olm-namespace flags (<run|cleanup> packagemanifests: remove --include-paths, change --operator-version to --version #3599, <run|cleanup> packagemanifests: remove --olm-namespace, change --operator-namespace to --namespace #3601)
  • Rename --operator-version to --version (<run|cleanup> packagemanifests: remove --include-paths, change --operator-version to --version #3599)
  • Rename --operator-namespace to --namespace (<run|cleanup> packagemanifests: remove --olm-namespace, change --operator-namespace to --namespace #3601)
• Fix CSV generation related to roles, role bindings, service accounts. (generate: consider service accounts when generating a CSV #3610)

What's added in v1.0.0

• operator-sdk generate kustomize manifests
• operator-sdk generate bundle
• operator-sdk generate packagemanifests
• operator-sdk <run|cleanup> packagemanifests
• Go project scaffolding using the Kubebuilder project layout
• Helm project scaffolding using the Kubebuilder project layout (feat: add helm plugin scaffolding new layout #3421)
• operator-sdk scorecard will be updated with the new scorecard implementation, currently under operator-sdk alpha scorecard (Scorecard move alpha #3444)
• operator-sdk scorecard will support both sequential and parallel stages (internal/scorecard/alpha: add parallelism support #3434)
• New controller-runtime handler that generates kube-state-metrics metrics (and incorporate into helm and ansible operators). ( Add new handler for metrics #3436)
• Rewrite e2e tests to handle new helm operator scaffolding (feat: add helm plugin scaffolding new layout #3421)
• Use controller-runtime leader election in helm-operator (Helm: add leader election flags, use lease-based election #3446)
• Helm/ansible operators: rename --max-workers to --max-concurrent-reconciles (ansible/helm: Rename max-workers to max-concurrent-reconciles #3452, fix: remove max-workers flag for ansible #3456)
• Ansible: rename WORKER_%s_%s envvar to MAX_CONCURRENT_RECONCILES_%s_%s (ansible: rename cmd line flag and add global variable #3435)
• Split importable SDK library components into a separate (non 1.0) repository. (Remove leader and status which have moved to operator-lib. #3503)
• Move pkg/log/zap to internal/log/zap (move zap flags internally #3525)
• Support custom scorecard config.yaml path in metadata/annotations.yaml (scorecard: add bundle metadata #3474)
• Use controller-runtime leader election in ansible-operator (Ansible: add leader election flags, use lease-based election #3457)
• remove runlocal stuff from leader.Become in operator-lib (Leader remove runlocal operator-lib#7)
• update handler/enqueue_annotation.go with changes from ✨ add EnqueueRequestForAnnotation enqueues Requests based on the presence of an annotation to watch resources kubernetes-sigs/controller-runtime#892 (Update hander/enqueue_annotation.go operator-lib#2)
• update operator-sdk to point to https://operator-framework/operator-lib for ansible/helm
• delete pkg/handler/enqueue_annotation.go from operator-sdk; have ansible to use operator-framework/operator-lib/handler instead (Remove EnqueueRequestForAnnotation handler from SDK #3506)
• delete pkg/handler/instrumented from operator-sdk; have ansible/helm use operator-framework/operator-lib/handler instead (replace instrumented handler with the one from operator-lib #3523)
• switch ansible-operator to use operator-lib/predicate (Switch ansible/helm to use operator-lib predicate. #3481)
• switch helm-operator to use operator-lib/predicate (Switch ansible/helm to use operator-lib predicate. #3481)
• Remove GenerationChangedPredicate from predicate. Moved pkg/predicate to pkg/ansible/predicate (Move pkg/predicate closer to where it is used. #3491 pkg/predicate: move predicates elsewhere and remove #3532)
• move jmrodri/operator-lib to operator-framework/operator-lib
• setup github actions on operator-framework/operator-lib (actions tab)
• update go docs of code in operator-lib (NICE TO HAVE) (Format source code in go doc. operator-lib#16)
• Fix CVE-2020-14040 from golang.org/x/text Bug 1855608 (Update golang.org/x/text to v0.3.3 #3458)
• Allow .yml changelog fragments (allow fragments to end in either .yml or .yaml #3493)
• Move InstrumentedEnqueueRequestForObject to operator-lib (Added new handler for metrics operator-lib#8)
• add license check to operator-lib (Add check-license target operator-lib#14)
• Move existing quickstarts to "tutorial" or "user guide" (name TBD), and author actual quickstart docs for Go, Ansible, and Helm operators. (PR done for Go doc: quickstart for Go projects #3551 - Helm doc: quickstart for Helm projects and more details for the migration guide #3552 - Ansible doc: quickstart for Ansible projects  #3555
• Increase test coverage for operator-lib (Add test for InstrumentedEnqueueRequestForObject operator-lib#15)
• Update go.mod requires to use tagged versions of operator-lib and controller-runtime (bump operator-lib to v0.1.0 #3616)
• Bump controller-runtime to v0.6.2 (pkg/plugin/{v2,v3}: controller-runtime v0.6.2 kubernetes-sigs/kubebuilder#1625, go.mod: controller-runtime v0.6.2 #3653)
• Add scorecard e2e test (Scorecard e2e Testing #3507)
• Ensure operator-sdk repository has no exported public Go APIs.
• tag operator-framework/operator-lib (https://github.com/operator-framework/operator-lib/releases/tag/v0.1.0)

What's removed in v1.0.0

• operator-sdk exec-entrypoint ([ansible/helm] remove operator-sdk binary from ansible/helm base images #3331)
• operator-sdk build (cmd/operator-sdk: remove build subcommand #3566)
• operator-sdk add api for Go operators (Remove legacy CLI, code, and scaffold templates #3385)
• operator-sdk add controller (Remove legacy CLI, code, and scaffold templates #3385)
• operator-sdk add crd for Go operators (*: remove the add crd subcommand and related utilities #3547)
• operator-sdk migrate (Remove legacy CLI, code, and scaffold templates #3385)
• operator-sdk print-deps (Remove legacy CLI, code, and scaffold templates #3385)
• operator-sdk generate k8s (Remove legacy CLI, code, and scaffold templates #3385)
• operator-sdk generate crds (Remove legacy CLI, code, and scaffold templates #3385)
• The legacy scorecard implementation is being removed (replaced by new scorecard implementation). (Remove legacy CLI, code, and scaffold templates #3385)
• The operator-sdk test subcommand and e2e framework are being removed. Users should migrate to envtest. (*: remove test subcommand, pkg/test, and internal e2e tests for legacy projects #3409)
• operator-sdk run local. To continue supporting running helm and ansible operators locally, we will release these binaries so that upcoming make run targets for those operator types can download and run the operator binaries locally. (cmd/operator-sdk/run: remove legacy run subcommand #3406)
• operator-sdk cleanup for legacy projects. (cmd/operator-sdk/run: remove legacy run subcommand #3406)
• Legacy run packagemanifests support (cmd/operator-sdk/run: remove legacy run subcommand #3406)
• Legacy generate csv (Remove legacy generate and bundle commands #3414)
• Legacy generate bundle (Remove legacy generate and bundle commands #3414)
• Legacy generate packagemanifests(Remove legacy generate and bundle commands #3414)
• Legacy operator-sdk bundle <create/validate> is removed. (Remove legacy generate and bundle commands #3414)
• Remove test/test-framework sample project that is used for legacy tests (test/test-framework: remove, and update/remove references and dependent tests #3424)
• Remove legacy docs and examples (website,example: remove legacy docs and fixup links #3432)
• Remove scaffolding for legacy helm operators (removal: helm legacy scaffold #3343)
• operator-sdk [new|add api] CLI for Helm operators (removal: helm legacy scaffold #3343)
• Remove creation of service, service monitor, and kube-state-metrics server from Helm operator (Remove metrics logic from cmd/helm-operator/main.go #3451)
• Remove creation of service, service monitor, and kube-state-metrics server from Ansible operator (Remove metrics logic from cmd/anisble-operator/main.go #3466)
• pkg/metrics and pkg/kube-metrics
• Ansible operator remove unused WATCH_NAMESPACE and POD_NAME environment variables from manager template (internal/plugins/ansible: manager scaffolding updates for --metrics-addr and envvars #3570)

Checklist for 1.0.0-alpha1 release

• New CSV marker format for Go APIs (generate: parse CSV annotations with controller-tools/pkg/markers #2792)
• Ansible project scaffolding using the Kubebuilder project layout (Port Ansible scaffolding to Kubebuilder plugin #3488)
• Rewrite e2e tests to handle new ansible operator scaffolding (Port Ansible scaffolding to Kubebuilder plugin #3488)
• Remove operator-sdk [new|add api] CLI for Ansible operators (Remove operator-sdk new|add api commands and ansible scaffolding. #3531)
• Remove scaffolding for legacy ansible operators (Remove operator-sdk new|add api commands and ansible scaffolding. #3531)
• operator-sdk scorecard config file is a componentconfig (scorecard: make config a componentconfig, scaffold config kustomization on init #3490)
• Scaffold a scorecard config.yaml file (scorecard: make config a componentconfig, scaffold config kustomization on init #3490)
• Bump kubebuilder version in Operator SDK repo (internal/plugins/helm: add --project-name and use Config.ProjectName in scaffold #3438)
• Move pkg/helm to internal/helm (Move pkg/helm to internal/helm #3537)
• Move pkg/ansible to internal/ansible (*: move pkg/ansible to internal/ansible #3560)
• Use consistent domain everywhere (*.sdk.operatorframework.io) (*: consistently use *.sdk.operatorframework.io wherever we use domains #3527)
• Ansible operator should use default metrics addr in manager.yaml (internal/plugins/ansible: manager scaffolding updates for --metrics-addr and envvars #3570)
• Helm and Ansible operators should support OLM manifest generation (Allows OLM subcommands work for Helm/Ansible new layout #3341)
• Wordsmith release notes for alpha1 release. Generated CHANGELOG.md & migration guide ( Reword the changelog fragments to better generate the CHANGELOG.md when we release 1.0. #3544)

[estroz]

For anyone interested, this PR adds a migration tool to migrate a legacy project to a new one: #2851.