vcluster_create
Create a virtual cluster with specified name, namespace, and Helm values, with options to pin chart version, expose via load balancer, or upgrade an existing cluster.
Instructions
Create a new vcluster.
Creates a vcluster with the specified name. Configuration can come from values files, inline helm values, or both. The caller's kube context is never switched by this operation.
Args: name: The name for the new vcluster. values: Optional path to a values file, or a list of paths. Later files override earlier ones. upgrade: Optional flag to upgrade the cluster if it was created before. namespace: Optional namespace to create the vcluster in. If not provided, the vcluster CLI picks the default. set_values: Optional inline helm values, e.g. {"sync.toHost.ingresses.enabled": "true"}. Avoids writing a temporary values file for a single setting. chart_version: Optional vcluster chart version to pin, e.g. "0.36.0". chart_repo: Optional chart repository URL override. chart_name: Optional chart name override. expose: If True, create a load balancer service to expose the vcluster endpoint outside the host cluster. create_namespace: If False, do not create the namespace. Defaults to the CLI behaviour, which creates it when missing. kube_config_context_name: Optional override for the generated kube context name. kubeconfig_path: Optional path to a kubeconfig file. If not provided, the default kubeconfig from the environment will be used.
Returns: Union[CommandResult, str]: CommandResult on success, or error object if failed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| expose | No | ||
| values | No | ||
| upgrade | No | ||
| namespace | No | ||
| chart_name | No | ||
| chart_repo | No | ||
| set_values | No | ||
| chart_version | No | ||
| kubeconfig_path | No | ||
| create_namespace | No | ||
| kube_config_context_name | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |