Simple example with detailed instructions

[kubernetes]

Simple example with detailed instructions

[sttts]

@devdattakulkarni would you mind to contribute the figure from your blog to the controller sample README?

[devdattakulkarni]

@vncntvandriessche Good writeup.

I have recently written an article that explains under-the-hood details of the client-go machinery.
Check it out here:
https://medium.com/@cloudark/kubernetes-custom-controllers-b6c7d0668fdf

Hopefully it helps!

@nikhita: Would be interested in your thoughts about the article as well.

[nikhita]

We can probably mention something like this in the README. 👍

/cc @sttts @munnerz

[vncntvandriessche]

@nikhita Is there any resource/channel/... you'd suggest gathering information to continue from the point where I stopped in the above document? This is where it gets very hard for me. At least, it is if I want to follow the examples provided.

[devdattakulkarni]

@sttts I would be happy to contribute the figure. And if required the write-up too. Let me know the process. Should I just open a PR with modifications to the README? Also, is there any specific directory to put the figure and then link its path in the README?

[sttts]

@devdattakulkarni 👍, just create a PR against the README in the main kubernetes repo.

[devdattakulkarni]

@sttts Cool. Will do that.

One more question -- when you say README in main kubernetes repo, do you mean:
https://github.com/kubernetes/kubernetes

or you mean:
https://github.com/kubernetes/sample-controller

[nikhita]

@devdattakulkarni This one: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/sample-controller/README.md. :)

[vncntvandriessche]

@devdattakulkarni Thanks for sharing the article. I read it and it provides a lot of insights I was still missing.
I'll start hacking soon thanks to your help!

[devdattakulkarni]

@nikhita Thanks :)

@sttts kubernetes/kubernetes#62563

@vncntvandriessche :)

[devdattakulkarni]

@sttts @nikhita The PR kubernetes/kubernetes#62563 has passed all the tests. Let me know if anything else is required.

[barry8schneider]

I am confused by this section. would you please clarify?

k8s.io/sample-controller/pkg/client k8s.io/sample-controller/pkg/apis
Should be swapped by your projects' "apis"-folder location.

samplecontroller:v1alpha1 should be edited into yoursamplecontroller.com:youversion

[vncntvandriessche]

@barry-schneider Those lines just ensure no one forgets to change yoursamplecontroller.com and the version set in your custom resource is what you've set it to be.

These are parameters you can choose for yourself and should be changed everywhere once customised.

[esnunes]

Do you know why we need to manually create the pkg/apis/samplecontroller/v1alpha1/register.go file. The generator depends on Resource func, looks like this code could be generate automatically too. Is there a reason not to automatically generate it?

[vncntvandriessche]

@esnunes If it's generated automatically I've been mistaken. I think it would be better to let the generator handle everything it can, to prevent manual errors...

[esnunes]

@vncntvandriessche sorry, it is manually created. I was just wondering what is the reason why it is not generated automatically.

[vncntvandriessche]

@esnunes Ah, I understand. To me it sounds like a good point. I think it actually could be generated, as all info that's required seems to be available from the custom resource?

[nikhita]

https://github.com/kubernetes/sample-controller/blob/master/docs/controller-client-go.md explains the reasoning but I guess we still need documentation in a "steps form". Step 1,.. Step 2,...

[nikhita]

I think it actually could be generated, as all info that's required seems to be available from the custom resource?

@sttts Wdyt about generating register.go too?

[sttts]

We probably could. We might need some more tags (which are the runtime.Object types to register in the scheme?). Also, aren't there small differences depending on whether you have custom conversions or defaulters?

[devdattakulkarni]

@nikhita: Recently I had created a list of steps to serve as a quick reference of all the things that need to be done to create a custom controller. There are available here:

cloud-ark/kubeplus#14

Were you thinking something along these lines?

Currently the explanation on the steps is sparse but that can be fixed. If you think this might be useful, I will be happy to contribute the steps.

[cmoulliard]

This is how far I've gotten

Have you created a github repo containing your code + instructions ? @vncntvandriessche

[vncntvandriessche]

@cmoulliard I'm afraid not, if I get around to it, I'll give a nudge here!

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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/test-infra repository.