VMware VKS

Autor: Wei Zhou, VMware by Broadcom — wei-wz.zhou@broadcom.com Este es un proyecto impulsado por la comunidad por un ingeniero de VMware, no es un producto oficial de VMware. Para herramientas oficiales de desarrollador de VMware, consulte developer.broadcom.com.

Inglés | 中文

MCP Skill + CLI para la gestión de VMware vSphere Kubernetes Service (VKS): clústeres Supervisor, vSphere Namespaces y ciclo de vida de clústeres VKS. 20 herramientas MCP.

👁 License: MIT

Skills complementarias

Parte de la familia de VMware MCP Skills. Cada skill maneja un dominio distinto: instale solo lo que necesite.

Related MCP server: vmware-nsx

Requisitos previos

• vSphere 8.0+ — Las APIs de Workload Management (Supervisor) requieren vSphere 8.x

• Workload Management habilitado — WCP debe estar habilitado en al menos un clúster de computación

• Licencia — vSphere Kubernetes Service (Enterprise Plus o VMware Cloud Foundation)

Ejecute vmware-vks check después de la configuración para verificar que se cumplen todos los requisitos.

Inicio rápido

# Install
uv tool install vmware-vks

# Configure
mkdir -p ~/.vmware-vks
cp config.example.yaml ~/.vmware-vks/config.yaml
# Edit config.yaml with your vCenter host and username

echo "VMWARE_MY_VCENTER_PASSWORD=your_password" > ~/.vmware-vks/.env
chmod 600 ~/.vmware-vks/.env

# Verify
vmware-vks check

# Common operations
vmware-vks supervisor status domain-c1
vmware-vks namespace list
vmware-vks tkc list
vmware-vks tkc create my-cluster -n dev --version v1.28.4+vmware.1 --vm-class best-effort-large
vmware-vks tkc create my-cluster -n dev --apply

Flujos de trabajo comunes

Desplegar un nuevo clúster TKC

1. Comprobar compatibilidad → vmware-vks check

2. Listar versiones de K8s disponibles → vmware-vks tkc versions -n dev

3. Crear namespace (si es necesario) → vmware-vks namespace create dev --cluster domain-c1 --storage-policy vSAN --cpu 16000 --memory 32768 --apply

4. Crear clúster TKC → vmware-vks tkc create dev-cluster -n dev --version v1.28.4+vmware.1 --control-plane 1 --workers 3 --vm-class best-effort-large --apply

5. Obtener kubeconfig → vmware-vks kubeconfig get dev-cluster -n dev

Escalar workers para pruebas de carga

1. Comprobar estado actual → vmware-vks tkc get dev-cluster -n dev

2. Escalar hacia arriba → vmware-vks tkc scale dev-cluster -n dev --workers 6

3. Monitorizar progreso → vmware-vks tkc get dev-cluster -n dev (observar fase)

4. Escalar hacia abajo después de la prueba

Gestión de recursos de Namespace

1. Listar namespaces → vmware-vks namespace list

2. Comprobar uso → vmware-vks storage -n dev

3. Actualizar cuota → vmware-vks namespace update dev --cpu 32000 --memory 65536

Referencia de herramientas (20 herramientas)

Supervisor

Namespace

TKC

Acceso

Arquitectura

User (Natural Language)
 ↓
AI Agent (Claude Code / Goose / Cursor)
 ↓ reads SKILL.md
 ↓
vmware-vks CLI ─── or ─── vmware-vks MCP Server (stdio)
 │
 ├─ Layer 1: pyVmomi → vCenter REST API
 │ Supervisor status, storage policies, Namespace CRUD, VM classes, Harbor
 │
 └─ Layer 2: kubernetes client → Supervisor K8s API endpoint
 TKC CR apply / get / delete (cluster.x-k8s.io/v1beta1)
 Kubeconfig built from Layer 1 session token
 ↓
vCenter Server 8.x+ (Workload Management enabled)
 ↓
Supervisor Cluster → vSphere Namespaces → TanzuKubernetesCluster

Referencia de CLI

# Pre-flight diagnostics
vmware-vks check

# Supervisor
vmware-vks supervisor status <cluster-id>
vmware-vks supervisor storage-policies

# Namespace
vmware-vks namespace list
vmware-vks namespace get <name>
vmware-vks namespace create <name> --cluster <id> --storage-policy <policy>
vmware-vks namespace create <name> --cluster <id> --storage-policy <policy> --apply
vmware-vks namespace update <name> [--cpu <mhz>] [--memory <mib>]
vmware-vks namespace delete <name>
vmware-vks namespace vm-classes

# VKS Cluster
vmware-vks tkc list [-n <namespace>]
vmware-vks tkc get <name> -n <namespace>
vmware-vks tkc versions -n <namespace>
vmware-vks tkc create <name> -n <namespace> [--version <v>] [--vm-class <c>]
vmware-vks tkc create <name> -n <namespace> --apply
vmware-vks tkc scale <name> -n <namespace> --workers <n>
vmware-vks tkc upgrade <name> -n <namespace> --version <v>
vmware-vks tkc delete <name> -n <namespace>

# Kubeconfig
vmware-vks kubeconfig supervisor -n <namespace>
vmware-vks kubeconfig get <cluster-name> -n <namespace> [-o <path>]

# Harbor & Storage
vmware-vks harbor
vmware-vks storage -n <namespace>

Servidor MCP

Después de uv tool install vmware-vks, inicie el servidor MCP con un comando (v1.5.15+):

# Recommended — single command, no network re-resolve
vmware-vks mcp

# With a custom config path
VMWARE_VKS_CONFIG=/path/to/config.yaml vmware-vks mcp

Configuración del agente

Añada a la configuración MCP de su agente de IA:

{
 "mcpServers": {
 "vmware-vks": {
 "command": "vmware-vks",
 "args": ["mcp"],
 "env": {
 "VMWARE_VKS_CONFIG": "~/.vmware-vks/config.yaml"
 }
 }
 }
}

# Run without installing (requires PyPI access each launch)
uvx --from vmware-vks vmware-vks mcp

# Legacy entry point (still works, kept for backward compatibility)
vmware-vks-mcp

¿Detrás de un proxy TLS corporativo? uvx puede fallar con invalid peer certificate: UnknownIssuer. Utilice la forma recomendada vmware-vks mcp anterior (no se necesita red), o establezca UV_NATIVE_TLS=true.

Seguridad

Solución de problemas

Error "VKS not compatible"

Workload Management debe estar habilitado en vCenter. Compruebe: vCenter UI -> Workload Management. Requiere vSphere 8.x+ con licencia Enterprise Plus o VCF.

La creación de Namespace falla con "storage policy not found"

Liste primero las políticas disponibles: vmware-vks supervisor storage-policies. Los nombres de las políticas distinguen entre mayúsculas y minúsculas.

Clúster TKC atascado en fase "Creating"

Compruebe los eventos del Supervisor en vCenter. Causas comunes: recursos insuficientes en hosts ESXi, problemas de red con NSX-T, o política de almacenamiento no disponible en el datastore de destino.

La recuperación de Kubeconfig falla

El endpoint de la API del Supervisor debe ser accesible desde la máquina que ejecuta vmware-vks. Compruebe las reglas de firewall para el puerto 6443.

La operación de escala no tiene efecto

Verifique que el clúster esté en fase "Running" antes de escalar. Los clústeres en fase "Creating" o "Updating" rechazan las operaciones de escala.

Eliminación de namespace rechazada inesperadamente

La protección de eliminación de namespace evita la eliminación cuando existen clústeres TKC dentro. Elimine primero todos los clústeres TKC en el namespace y luego vuelva a intentarlo.

Compatibilidad de versiones

Proyectos relacionados

Licencia

MIT

Maintenance

Resources

• GitHub Repository
Need Help?Related Servers

Tools

• check_vks_compatibilityA
• create_namespaceA
• create_tkc_clusterA
• delete_namespaceA
• delete_tkc_clusterA
• get_harbor_infoA
• get_namespaceA
• get_supervisor_kubeconfigA