You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ch...@apache.org on 2023/04/13 01:48:18 UTC

[kyuubi] branch master updated: [KYUUBI #4697] [K8S][HELM] Add template rendering info to README

This is an automated email from the ASF dual-hosted git repository.

chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git


The following commit(s) were added to refs/heads/master by this push:
     new 72c2b601d [KYUUBI #4697] [K8S][HELM] Add template rendering info to README
72c2b601d is described below

commit 72c2b601da0bd5dda21b48040c69511ede97fb00
Author: pengqli <pe...@cisco.com>
AuthorDate: Thu Apr 13 09:48:06 2023 +0800

    [KYUUBI #4697] [K8S][HELM] Add template rendering info to README
    
    ### _Why are the changes needed?_
    
    The user wants to test the template rendering so they can see the output. Debugging templates provide a quick way of viewing the generated content without YAML parse errors blocking.
    There are two ways to render templates.
    locally with `helm template --debug ../kyuubi`
    on the server side with `helm install --dry-run --debug --generate-name ../kyuubi`
    
    ### _How was this patch tested?_
    - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
    
    - [ ] Add screenshots for manual tests if appropriate
    
    - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #4697 from dev-lpq/helm_rendering.
    
    Closes #4697
    
    d83693df1 [Cheng Pan] Update charts/kyuubi/README.md
    709d0b0a3 [pengqli] helm add template rendering
    bce8ad9c6 [pengqli] helm add template rendering
    
    Lead-authored-by: pengqli <pe...@cisco.com>
    Co-authored-by: Cheng Pan <pa...@gmail.com>
    Signed-off-by: Cheng Pan <ch...@apache.org>
---
 charts/kyuubi/README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/charts/kyuubi/README.md b/charts/kyuubi/README.md
index ef54c3226..a01fafde1 100644
--- a/charts/kyuubi/README.md
+++ b/charts/kyuubi/README.md
@@ -32,6 +32,20 @@ cluster using the [Helm](https://helm.sh) package manager.
 - Kubernetes cluster
 - Helm 3.0+
 
+## Template rendering
+
+When you want to test the template rendering, but not actually install anything. [Debugging templates](https://helm.sh/docs/chart_template_guide/debugging/) provide a quick way of viewing the generated content without YAML parse errors blocking.
+
+There are two ways to render templates. It will return the rendered template to you so you can see the output.
+
+- Local rendering chart templates
+```shell
+helm template --debug ../kyuubi
+```
+- Server side rendering chart templates
+```shell
+helm install --dry-run --debug --generate-name ../kyuubi
+```
 <!-- ## Features -->
 
 ## Documentation