vcluster_delete
Delete a virtual cluster and its resources permanently. Optionally remove the associated namespace.
Instructions
Delete a vcluster.
This function deletes a vcluster and optionally its namespace. This action is irreversible - the cluster and all its resources will be permanently removed.
Args: name: The name of the vcluster to delete. namespace: Optional namespace where the vcluster is located. If not provided, defaults to the vcluster 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 | ||
| namespace | No | ||
| kubeconfig_path | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |