github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli_builder_template.md (about)

     1  ---
     2  title: kbcli builder template
     3  ---
     4  
     5  tpl - a developer tool integrated with KubeBlocks that can help developers quickly generate rendered configurations or scripts based on Helm templates, and discover errors in the template before creating the database cluster.
     6  
     7  ```
     8  kbcli builder template [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # builder template: Provides a mechanism to rendered template for ComponentConfigSpec and ComponentScriptSpec in the ClusterComponentDefinition.
    15    # builder template --helm deploy/redis --memory=64Gi --cpu=16 --replicas=3 --component-name=redis --config-spec=redis-replication-config
    16    
    17    # build all configspec
    18    kbcli builder template --helm deploy/redis -a
    19  ```
    20  
    21  ### Options
    22  
    23  ```
    24        --clean                       specify whether to clear the output dir
    25        --cluster string              the cluster yaml file
    26        --cluster-definition string   specify the cluster definition name
    27        --cluster-version string      specify the cluster version name
    28        --component-name string       specify the component name of the clusterdefinition
    29        --config-spec string          specify the config spec to be rendered
    30        --cpu string                  specify the cpu of the component
    31        --helm string                 specify the helm template dir
    32        --helm-output string          specify the helm template output dir
    33    -h, --help                        help for template
    34        --memory string               specify the memory of the component
    35    -o, --output-dir string           specify the output directory
    36    -r, --replicas int32              specify the replicas of the component (default 1)
    37        --volume-name string          specify the data volume name of the component
    38  ```
    39  
    40  ### Options inherited from parent commands
    41  
    42  ```
    43        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    44        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    45        --as-uid string                  UID to impersonate for the operation.
    46        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    47        --certificate-authority string   Path to a cert file for the certificate authority
    48        --client-certificate string      Path to a client certificate file for TLS
    49        --client-key string              Path to a client key file for TLS
    50        --context string                 The name of the kubeconfig context to use
    51        --disable-compression            If true, opt-out of response compression for all requests to the server
    52        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    53        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    54        --match-server-version           Require server version to match client version
    55    -n, --namespace string               If present, the namespace scope for this CLI request
    56        --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
    57    -s, --server string                  The address and port of the Kubernetes API server
    58        --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
    59        --token string                   Bearer token for authentication to the API server
    60        --user string                    The name of the kubeconfig user to use
    61  ```
    62  
    63  ### SEE ALSO
    64  
    65  * [kbcli builder](kbcli_builder.md)	 - builder command.
    66  
    67  #### Go Back to [CLI Overview](cli.md) Homepage.
    68