Fix #3756-added CI user guide in docs #4369
Conversation
Signed-off-by: Jaisheesh-2006 <[email protected]>
…dex of book Signed-off-by: Jaisheesh-2006 <[email protected]>
Signed-off-by: Jaisheesh-2006 <[email protected]>
Jaisheesh-2006
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
CsatariGergely
left a comment
CsatariGergely
left a comment
There was a problem hiding this comment.
Thanks for this massive documentation pr, looks very good for me.
I would like to get a review from someone who has a better understanding of kpt architecture and philosophy than myself.
| weight: 90 | ||
| --- | ||
|
|
||
| <!-- |
There was a problem hiding this comment.
We do not need a manual ToC. I would recommend to delete this even if this is only a comment. It will be dated and non maintained with time.
There was a problem hiding this comment.
Hi @CsatariGergely , i have just made the required changes and commited them
| 4. Observe results and fail fast if any checks fail. | ||
| 5. Optionally apply the rendered resources when explicit deployment gates are satisfied. | ||
|
|
||
|  |
There was a problem hiding this comment.
Can you share the source of this figure? Add the editable version to the same /images/ folder using the same name, but proper extension, like ci-kpt-workflow.svg.
There was a problem hiding this comment.
just made the required changes and commited them
|
|
||
| ### Prerequisites | ||
|
|
||
| Since kpt functions run as containers, your CI environment must have access to a container runtime (for example, |
There was a problem hiding this comment.
I would rather promote a container runtime which does not need elevation, like Podman.
There was a problem hiding this comment.
Added a short note on why Podman is preferred as well
Signed-off-by: Jaisheesh-2006 <[email protected]>
There was a problem hiding this comment.
This file should not take up almost 6 MB and I can't find a reference to it, is this unused?
There was a problem hiding this comment.
Hi @mozesl-nokia , in the latest commit, i deleted that image and pushed its svg version, so at the end it will be squashed and merged right. The png version is unused
| ```shell | ||
| $ export API_TOKEN=$(vault read -field=token secret/my-api) | ||
| ``` | ||
|
|
||
| ```shell | ||
| $ kpt fn render | ||
| ``` |
There was a problem hiding this comment.
Maybe these two can be in the same code block?
There was a problem hiding this comment.
I will update them and push the new commit
There was a problem hiding this comment.
Hi @mozesl-nokia I was just reviewing the kpt docs style guide, and I noticed it mentions that shell commands should ideally be in shell code blocks with a single command prefixed by $
There was a problem hiding this comment.
There was a problem hiding this comment.
Is this a common convention? I'm not a fan tbh as it means you can't just copy and past the cmd to a terminal without stripping the $
Or am I wrong??
There was a problem hiding this comment.
I agree with @efiacor , whether the convention says it or not, I prefer the $ character not to be there because then if you copy/paste a command into the terminal (especially if its a long one), you end up having to tab back to the beginning of the command to delete the $
There was a problem hiding this comment.
Hi @efiacor, you are absolutely right from a usability perspective. As far as I know, the $ is a standard convention for Unix documentation, which is why I stuck to the current style guide for this PR. I am happy to change it if we decide to go that route, though we would likely need to update the style guide as well to maintain consistency
| ```shell | ||
| $ echo "$KUBECONFIG_CONTENT" > /tmp/kubeconfig | ||
| ``` | ||
|
|
||
| ```shell | ||
| $ KUBECONFIG=/tmp/kubeconfig kpt live apply | ||
| ``` |
There was a problem hiding this comment.
Maybe these two can be in the same code block?
There was a problem hiding this comment.
I will update them and push the new commit
There was a problem hiding this comment.
Hi @mozesl-nokia I was just reviewing the kpt docs style guide, and I noticed it mentions that shell commands should ideally be in shell code blocks with a single command prefixed by $
| ```shell | ||
| $ export API_TOKEN=$(vault read -field=token secret/my-api) | ||
| ``` | ||
|
|
||
| ```shell | ||
| $ kpt fn render | ||
| ``` |
There was a problem hiding this comment.
5 participants
Description
This PR adds a new guide to the kpt book detailing how to use
kptin CI/CD workflows. The guide covers:render+validateworkflow.live applysteps.Motivation
kptis frequently used in CI environments, but there was no dedicated documentation explaining the recommended patterns. This guide aims to clarify best practices, specifically regarding the "Configuration as Data" philosophy, and to help users avoid common mistakes like mutating packages during CI runs.Fixes
Fixes #3756