operator-sdk icon indicating copy to clipboard operation
operator-sdk copied to clipboard

Published 20 hours ago • verified publisher icon operator-framework

Go tutorials are referencing old project layout

Open maxcao13 opened this issue 1 year ago • 3 comments

What is the URL of the document?

https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/ https://sdk.operatorframework.io/docs/building-operators/golang/migration/ ...etc

Which section(s) is the issue in?

Create a new API and Controller (tutorial) What was changed (migration)

What needs fixing?

I think the documentation that references controllers and main.go is old. Seems like when I do operator-sdk init and operator-sdk create api, it generates cmd/main.go and internal/..._controller.go. Not sure which one is wrong, the docs or the init, but I'm guessing it's the docs.

Additional context

I think there's more cases of the wrong project layout being referenced in the docs. Operator-sdk version:

operator-sdk version: "v1.36.1", commit: "37d2f2872bfecd6927469f384be4951805aa4caa", kubernetes version: "1.29.0", go version: "go1.21.12", GOOS: "linux", GOARCH: "amd64"

maxcao13 avatar Aug 28 '24 07:08 maxcao13