docs(contributing): Add section for building custom image #7250
Conversation
There didn't exist any documentation on how to build images with changes made in https://github.com/kubernetes-sigs/karpenter. This adds explicit documentation on how to update the `go.mod` file and produce an image with changes made to the karpenter project.
✅ Deploy Preview for karpenter-docs-prod ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| *Note: that this will produce a build with the latest version of https://github.com/kubernetes-sigs/karpenter. | ||
|
|
||
| ```bash | ||
| export $ |
There was a problem hiding this comment.
Did you mean to leave something here? Or does this do something I'm not aware of
There was a problem hiding this comment.
Ah yeah, I was debating if I wanted to explicitly add setting $KO_DOCKER_REPO but that's already called out earlier. Let me update it and remove
|
|
||
| ```bash | ||
| export $ | ||
| make image # build and push the karpenter images |
There was a problem hiding this comment.
This is automatically done by make apply. Was there a reason you wanted to specifically include this as a separate step ?
There was a problem hiding this comment.
Same as my comment below. My company is a heavy GitOps shop and I don't deploy karpenter via helm. make apply is not relevant to my experience and would actually cause more problems.
| go mod edit -replace sign.k8s.io/karpenter=$PATH_TO_KUBERNETES_SIGS_KARPENTER | ||
| ``` | ||
|
|
||
| *Note: you need to commit the go.mod changes before running `make image` |
There was a problem hiding this comment.
you shouldn't need to git commit it. If you run make apply, it runs the verify target, which should run go mod tidy for you
There was a problem hiding this comment.
Got it. I didn't use make apply when building the images and deploying. I deploy my changes via flux and so that entire part of the process didn't apply to me. Do you prefer I remove this bit, or make a call out that you need to do this only if you're trying to build the images?
| ```bash | ||
| make image # build and push the karpenter images | ||
| ``` |
There was a problem hiding this comment.
I think you can probably remove these lines now that you've added more detail above
Co-authored-by: Nick Tran <[email protected]>
Co-authored-by: Nick Tran <[email protected]>
Co-authored-by: Nick Tran <[email protected]>
|
This PR has been inactive for 14 days. StaleBot will close this stale PR after 14 more days of inactivity. |
|
This PR has been inactive for 14 days. StaleBot will close this stale PR after 14 more days of inactivity. |
|
This PR has been inactive for 14 days. StaleBot will close this stale PR after 14 more days of inactivity. |
Fixes #N/A
Description
There didn't exist any documentation on how to build images with changes made in https://github.com/kubernetes-sigs/karpenter.
This adds explicit documentation on how to update the
go.modfile and produce an image with changes made to the karpenter project.How was this change tested?
By viewing the generated documenation.
Does this change impact docs?
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.