Go Operator Tutorial Page: Incorrect Link(s) and some file path corrections

[harshvijaythakkar]

What is the URL of the document?

Go Operator Tutorial

Which section(s) is the issue in?

Implement the Controller

What needs fixing?

The latest operator-sdk version: "v1.34.0" is pointing to wrong link for memcached_controller.go file.

Additional context

First Issue

When I click on memcached_controller.go it is giving 404 not found error. On the "latest" branch of operator-sdk repository under testdata path I don't see go/v3 folder.

The correct file location of memcached_controller.go file is under testdata/go/v4/memcached-operator/internal/controller/memcached_controller.go

On documentation I see following text

For this example replace the generated controller file controllers/memcached_controller.go with the example memcached_controller.go implementation.

I think it needs to be changed to

For this example replace the generated controller file internal/controller/memcached_controller.go with the example memcached_controller.go implementation.

Second Issue

On documentation I see following text

The SetupWithManager() function in controllers/memcached_controller.go specifies how the controller is built to watch a CR and other resources that are owned and managed by that controller.

I think it needs to be changed to

The SetupWithManager() function in internal/controllers/memcached_controller.go specifies how the controller is built to watch a CR and other resources that are owned and managed by that controller.

If my understanding is correct I think I can also make changes but just want to confirm that my understanding is correct before raising PR for changes.

[caspereijkens]

Also, the tutorial is incompatible with go v1.22: #6681
I think a warning would save time for many of us.

[caspereijkens]

And the namespace scoping as described in the tutorial also doesn't work anymore. Please update to follow https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/manager#example-New-LimitToNamespaces

[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.

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-sigs/prow repository.