Skip to content

Make pkg/util/k8sutil functions private or internal #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ericchiang opened this issue Apr 3, 2018 · 9 comments
Closed

Make pkg/util/k8sutil functions private or internal #160

ericchiang opened this issue Apr 3, 2018 · 9 comments
Labels
blocked release-blocker This issue blocks the parent release milestone
Milestone

Comments

@ericchiang
Copy link

If this isn't intended to be used by consumers we probably shouldn't allow them to use it. It's just extra API that needs to be maintained.

@ericchiang
Copy link
Author

cc @hasbro17

@ericchiang ericchiang changed the title Make pkg/util/k8suti functions private or internal Make pkg/util/k8sutil functions private or internal Apr 3, 2018
@ericchiang
Copy link
Author

pkg/generator and pkg/k8sclient should also be made private.

@hasbro17
Copy link
Contributor

hasbro17 commented Apr 3, 2018

Agreed, we're planning to do an overall revamp of the the SDK APIs and objects and move away from maintaining global state and functions.
And making all of the internal utils private would be part of that.

@ericchiang ericchiang added release-blocker This issue blocks the parent release milestone area/api labels Apr 3, 2018
@ericchiang
Copy link
Author

cc @Verolop

@spahl spahl added this to the 0.0.6 milestone Jun 5, 2018
@hasbro17
Copy link
Contributor

hasbro17 commented Jun 5, 2018

Blocked by #169

@pawelprazak
Copy link

IMHO most important functions in pkg/k8sclient should be "configurable", as in an interface that can have a custom implementation, something like a "kubeclient factory", that would allow an SDK user to implement features like #351

@hasbro17
Copy link
Contributor

After #382 we've removed the k8sutil and k8sclient helper functions that weren't supposed to be exposed as an API to users.

@pawelprazak I've addressed how the custom client functionality needed by #351 can be added on the PR.

pkg/generator is now pkg/scaffold whose utils are mostly internal now.
But there is something to be said for making pkg/scaffold completely internal since that's not something the SDK users need to see as a potential API(not that anyone has done so far). It's only needed by the SDK CLI in cmd/....
@estroz WDYT? We can follow that up in a separate issue though since this one was mostly related to the unnecessary client helpers we exposed initially.

@estroz
Copy link
Member

estroz commented Nov 16, 2018

@hasbro17 good point. There are no use cases for exposed pkg/scaffold code apparent to me. Every package in pkg should be exposed to users, so I think it would be worth moving pkg/scaffold -> internal/scaffold.

@hasbro17
Copy link
Contributor

@estroz Can you please open a new issue for that. I don't think it's urgent but it'll be a big change, so it's worth discussing any potential issues with making all the scaffolding internal.

m1kola pushed a commit to m1kola/operator-sdk that referenced this issue Jun 7, 2024
…istency-openshift-4.10-openshift-enterprise-operator-sdk

Updating openshift-enterprise-operator-sdk images to be consistent with ART
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked release-blocker This issue blocks the parent release milestone
Projects
None yet
Development

No branches or pull requests

5 participants