Referencia de la API

secretNamespace cadena

SecretNamespace es el espacio de nombres del Secreto.

secretRef cadena

SecretRef es el nombre del Secreto.

name cadena

name es el nombre de la VirtualClusterPolicy aplicada actualmente a este clúster.

MinLength: 1

priorityClass cadena

priorityClass es la clase de prioridad aplicada por la VirtualClusterPolicy activa.

nodeSelector object (keys:string, values:string)

nodeSelector es un selector de nodos aplicado por la VirtualClusterPolicy activa.

serverAffinity Affinity

serverAffinity son las reglas de afinidad para los pods de servidor aplicadas por la VirtualClusterPolicy activa.
Esto incluye tanto reglas de afinidad de nodo como reglas de afinidad/antiafinidad de pod.

agentAffinity Affinity

agentAffinity son las reglas de afinidad para los pods de agente aplicadas por la VirtualClusterPolicy activa.
Esto incluye tanto reglas de afinidad de nodo como reglas de afinidad/antiafinidad de pod.

sync SyncConfig

sync es la SyncConfig aplicada por la VirtualClusterPolicy activa.

runtimeClassName cadena

RuntimeClassName especifica una clase de runtime alternativa para los
pods de agente y servidor del clúster en modo virtual o shared.

podSecurityContext PodSecurityContext

PodSecurityContext especifica un SecurityContext personalizado que se añade a los
pods de agente y servidor del clúster en modo virtual o shared.

securityContext SecurityContext

SecurityContext especifica un SecurityContext de contenedor personalizado que se añade a los
contenedores de agente y servidor del clúster en modo virtual o shared.

hostUsers boolean

HostUsers establece el espacio de nombres de usuario para los pods de servidor y agente.
Si se establece en true o no está presente, el pod se ejecutará en el espacio de nombres de usuario del host.
Si se establece en false, se crea un nuevo userns para el pod.
Este campo es de nivel alfa y solo lo respetan los servidores que habilitan la característica UserNamespacesSupport.

apiVersion cadena

k3k.io/v1beta1

kind cadena

Cluster

metadata ObjectMeta

Consulta la documentación de la API de Kubernetes para los campos de metadata.

spec ClusterSpec

Spec define el estado deseado del Clúster.

{ }

status ClusterStatus

Status refleja el estado observado del clúster.

{ }

apiVersion cadena

k3k.io/v1beta1

kind cadena

ClusterList

metadata ListMeta

Consulta la documentación de la API de Kubernetes para los campos de metadata.

items Cluster array

version cadena

La versión es la versión de K3s que se utilizará para los nodos virtuales.
Debería seguir la convención de versionado de K3s (por ejemplo, v1.28.2-k3s1).
Si no se especifica, se utilizará la versión de Kubernetes del nodo host.

mode ClusterMode

Mode especifica el modo de aprovisionamiento del clúster. Este campo es inmutable.

shared

Enum: [shared virtual hcp]

servers entero

Servers especifica el número de pods de K3s que se ejecutarán en modo servidor (plano de control).
Debe ser al menos 1. El valor predeterminado es 1.

1

agents entero

Los agentes especifican el número de pods de K3s que se ejecutarán en modo agente (trabajador).
Debe ser 0 o mayor. El valor predeterminado es 0.
Este campo se ignora en modo "shared".

0

clusterCIDR cadena

ClusterCIDR es el rango CIDR para las IPs de los pods.
El valor predeterminado es 10.42.0.0/16 en modo shared y 10.52.0.0/16 en modo virtual.
Este campo es inmutable.

serviceCIDR cadena

ServiceCIDR es el rango CIDR para las IPs de los servicios.
El valor predeterminado es 10.43.0.0/16 en modo shared y 10.53.0.0/16 en modo virtual.
Este campo es inmutable.

clusterDNS cadena

ClusterDNS es la dirección IP para el servicio CoreDNS.
Debe estar dentro del rango ServiceCIDR. El valor predeterminado es 10.43.0.10.
Este campo es inmutable.

persistence PersistenceConfig

Persistence especifica opciones para persistir los datos de etcd.
El valor predeterminado es persistencia dinámica, que utiliza un PersistentVolumeClaim para proporcionar persistencia de datos.
Se requiere una StorageClass predeterminada para la persistencia dinámica.

expose ExposeConfig

Expose especifica opciones para exponer el servidor API.
Por defecto, solo se expone como un ClusterIP.

nodeSelector object (keys:string, values:string)

NodeSelector especifica etiquetas de nodo para restringir dónde se programan los pods del servidor/agente.
En modo "shared", esto también se aplica a las cargas de trabajo.

priorityClass cadena

PriorityClass especifica el priorityClassName para los pods del servidor/agente.
En modo "shared", esto también se aplica a las cargas de trabajo.

tokenSecretRef SecretReference

TokenSecretRef es una referencia de secreto que contiene el token utilizado por los nodos trabajadores para unirse al clúster.
El secreto debe tener un campo "token" en sus datos.

tlsSANs matriz de cadenas

TLSSANs especifica nombres alternativos de sujeto para el certificado del servidor K3s.

serverArgs matriz de cadenas

ServerArgs especifica pares clave-valor ordenados para los pods del servidor K3s.
Ejemplo: ["--tls-san=example.com"]

agentArgs matriz de cadenas

AgentArgs especifica pares clave-valor ordenados para los pods del agente K3s.
Ejemplo: ["--node-name=my-agent-node"]

serverEnvs EnvVar array

ServerEnvs especifica una lista de variables de entorno para establecer en el pod del servidor.

agentEnvs EnvVar array

AgentEnvs especifica una lista de variables de entorno para establecer en el pod del agente.

addons Addon array

Addons especifica secretos que contienen YAML en bruto para desplegar al iniciar el clúster.

serverLimit ResourceList

ServerLimit especifica límites de recursos para los nodos del servidor.

workerLimit ResourceList

WorkerLimit especifica límites de recursos para los nodos del agente.

serverResources ResourceRequirements

ServerResources especifica los límites y las solicitudes de recursos para los nodos de servidor.

workerResources ResourceRequirements

WorkerResources especifica los límites y las solicitudes de recursos para los nodos de trabajo.

serverAffinity Affinity

ServerAffinity especifica las reglas de afinidad para los pods de servidor.
Esto incluye tanto reglas de afinidad de nodo como reglas de afinidad/antiafinidad de pod.

agentAffinity Affinity

AgentAffinity especifica las reglas de afinidad para los pods de agente.
Esto incluye tanto reglas de afinidad de nodo como reglas de afinidad/antiafinidad de pod.

mirrorHostNodes boolean

MirrorHostNodes controla si los objetos de nodo del clúster anfitrión
se reflejan en el clúster virtual.

customCAs CustomCAs

CustomCAs especifica los pares de cert/key para certificados CA personalizados.

sync SyncConfig

Sync especifica los tipos de recursos que se sincronizarán del clúster virtual al clúster anfitrión.

{ }

secretMounts SecretMount array

SecretMounts especifica una lista de secretos que se montarán en los pods del servidor y del agente.
Cada entrada define un secreto y su ruta de montaje dentro de los pods.

podSecurityContext PodSecurityContext

PodSecurityContext especifica un PodSecurityContext personalizado que se añade a los
pods de agente y servidor del clúster en modo virtual o shared.

securityContext SecurityContext

SecurityContext especifica un SecurityContext de contenedor personalizado que se añade a los
contenedores de agente y servidor del clúster en modo virtual o shared.
Esta opción anula el SecurityContext establecido de forma predeterminada para el modo virtual.

runtimeClassName cadena

RuntimeClassName especifica una clase de runtime alternativa para los
pods de agente y servidor del clúster en modo virtual o shared.

hostUsers boolean

HostUsers establece el espacio de nombres de usuario para los pods de servidor y agente.
Si se establece en true o no está presente, el pod se ejecutará en el espacio de nombres de usuario del host.
Si se establece en false, se crea un nuevo userns para el pod.
Este campo es de nivel alfa y solo lo respetan los servidores que habilitan la característica UserNamespacesSupport.

hostVersion cadena

HostVersion es la versión de Kubernetes del nodo anfitrión.

clusterCIDR cadena

ClusterCIDR es el rango CIDR para las IPs de los pods.

serviceCIDR cadena

ServiceCIDR es el rango CIDR para las IPs de los servicios.

clusterDNS cadena

ClusterDNS es la dirección IP para el servicio CoreDNS.

tlsSANs matriz de cadenas

TLSSANs especifica nombres alternativos de sujeto para el certificado del servidor K3s.

policyName cadena

PolicyName especifica el nombre de la directiva de clúster virtual vinculada al clúster virtual.

policy AppliedPolicy

policy representa el estado de la directiva aplicada a este clúster.
Este campo lo establece el controlador de VirtualClusterPolicy.

kubeletPort entero

KubeletPort especifica el puerto utilizado por k3k-kubelet en modo shared.

conditions Condition array

Conditions son las condiciones individuales establecidas para el clúster.

phase ClusterPhase

Phase es un resumen de alto nivel del estado actual del ciclo de vida del clúster.

Unknown

Enum: [Pending Provisioning Ready Failed Terminating Unknown]

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

secretName cadena

El secreto debe contener claves específicas según el tipo de credencial:
- Para pares de certificados TLS (por ejemplo, ServerCA): tls.crt y tls.key.
- Para la clave de firma del ServiceAccountToken: tls.key.

serverCA CredentialSource

ServerCA especifica el par de certificados y claves de server-ca.

clientCA CredentialSource

ClientCA especifica el par de certificados/claves client-ca.

requestHeaderCA CredentialSource

RequestHeaderCA especifica el par de certificados/claves request-header-ca.

etcdServerCA CredentialSource

ETCDServerCA especifica el par de certificados/claves etcd-server-ca.

etcdPeerCA CredentialSource

ETCDPeerCA especifica el par de certificados/claves etcd-peer-ca.

serviceAccountToken CredentialSource

ServiceAccountToken especifica la clave del service-account-token.

enabled boolean

Enabled activa o desactiva esta función.

true

sources CredentialSources

Sources define las fuentes para todos los certificados CA personalizados requeridos.

ingress IngressConfig

Ingress especifica las opciones para exponer el servidor API a través de un Ingress.

loadBalancer LoadBalancerConfig

LoadBalancer especifica las opciones para exponer el servidor API a través de un servicio LoadBalancer.

nodePort NodePortConfig

NodePort especifica las opciones para exponer el servidor API a través de NodePort.

annotations object (keys:string, values:string)

Annotations especifica las anotaciones que se añadirán al Service generado.

annotations object (keys:string, values:string)

Annotations especifica las anotaciones que se añadirán al Ingress.

ingressClassName cadena

IngressClassName especifica la IngressClass que se debe utilizar para el Ingress.

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

false

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

disableTLSSecretTranslation boolean

DisableTLSSecretTranslation es un interruptor de encendido/apagado para traducir los secretos TLS
del clúster virtual al clúster anfitrión

false

serverPort entero

ServerPort es el puerto en el que se expone el servidor K3s cuando el tipo es LoadBalancer.
Si no se especifica, se asignará el puerto https 443 por defecto.
Si es 0 o negativo, el puerto no será expuesto.

etcdPort entero

ETCDPort es el puerto en el que se expone el servicio ETCD cuando el tipo es LoadBalancer.
Si no se especifica, se asignará el puerto etcd 2379 por defecto.
Si es 0 o negativo, el puerto no será expuesto.

serverPort entero

ServerPort es el puerto en cada nodo en el que se expone el servidor K3s cuando el tipo es NodePort.
Si no se especifica, se asignará un puerto aleatorio entre 30000-32767.
Si está fuera de rango, el puerto no será expuesto.

etcdPort entero

ETCDPort es el puerto en cada nodo en el que se expone el servicio ETCD cuando el tipo es NodePort.
Si no se especifica, se asignará un puerto aleatorio entre 30000-32767.
Si está fuera de rango, el puerto no será expuesto.

type PersistenceMode

Type especifica el modo de persistencia.

dynamic

storageClassName cadena

StorageClassName es el nombre de la StorageClass que se utilizará para el PVC.
Este campo solo es relevante en modo "dinámico".

storageRequestSize Quantity

StorageRequestSize es el tamaño solicitado para el PVC.
Este campo solo es relevante en modo "dinámico".

2G

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

false

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

secretName cadena

secretName es el nombre del secreto en el espacio de nombres del pod que se utilizará.
Más información: https://kubernetes.io/docs/concepts/storage/volumes#secret

items KeyToPath array

items Si no se especifica, cada par clave-valor en el campo Data del
Secret se proyectará en el volumen como un archivo cuyo nombre es el
clave y el contenido es el valor. Si se especifica, las claves enumeradas serán
proyectado en las rutas especificadas, y las claves no listadas no estarán
presente. Si se especifica una clave que no está presente en el Secret,
la configuración del volumen dará error a menos que esté marcada como opcional. Las rutas deben ser
relativas y no pueden contener la ruta '..' ni comenzar con '..'.

defaultMode entero

defaultMode es Opcional: bits de modo utilizados para establecer permisos en los archivos creados por defecto.
Debe ser un valor octal entre 0000 y 0777 o un valor decimal entre 0 y 511.
YAML acepta tanto valores octales como decimales, JSON requiere valores decimales
para los bits de modo. Predeterminado a 0644.
Los directorios dentro de la ruta no se ven afectados por esta configuración.
Esto podría estar en conflicto con otras opciones que afectan el archivo
modo, como fsGroup, y el resultado puede ser otros bits de modo establecidos.

optional boolean

el campo opcional especifica si el Secret o sus claves deben estar definidos

name cadena

Name es el nombre del volumen de montaje del secreto que se utilizará
como nombre del volumen y del montaje de volumen para el pod de servidor o de agente.
Si está vacío, se utilizará en su lugar el nombre del secreto.

MaxLength: 63
MinLength: 1
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

mountPath cadena

MountPath es la vía dentro de los pods del servidor y del agente donde se
montarán los contenidos del secreto.

subPath cadena

SubPath es una vía opcional dentro del secreto para montar en lugar de la raíz.
Cuando se especifica, solo la clave especificada del secreto se montará como un archivo
en MountPath, manteniendo el directorio padre escribible.

role cadena

Role es el tipo de pod de k3k que se utilizará para montar el secreto.

Enum: [server agent all]

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

enabled boolean

Enabled es un interruptor de encendido/apagado para sincronizar recursos.

false

selector object (keys:string, values:string)

Selector especifica un conjunto de etiquetas de los recursos que se sincronizarán, si está vacío
entonces todos los recursos del tipo dado se sincronizarán.

services ServiceSyncConfig

Configuración de sincronización de recursos de servicios.

{ enabled:true }

configMaps ConfigMapSyncConfig

Configuración de sincronización de recursos de ConfigMaps.

{ enabled:true }

secrets SecretSyncConfig

Configuración de sincronización de recursos de secretos.

{ enabled:true }

ingresses IngressSyncConfig

Configuración de sincronización de recursos de Ingresses.

{ enabled:false }

persistentVolumeClaims PersistentVolumeClaimSyncConfig

Configuración de sincronización de recursos de PersistentVolumeClaims.

{ enabled:true }

priorityClasses PriorityClassSyncConfig

Configuración de sincronización de recursos de PriorityClasses.

{ enabled:false }

storageClasses StorageClassSyncConfig

Configuración de sincronización de los recursos StorageClasses.

{ enabled:false }

apiVersion cadena

k3k.io/v1beta1

kind cadena

VirtualClusterPolicy

metadata ObjectMeta

Consulta la documentación de la API de Kubernetes para los campos de metadata.

spec VirtualClusterPolicySpec

Spec define el estado deseado de la VirtualClusterPolicy.

{ }

status VirtualClusterPolicyStatus

Status refleja el estado observado de la VirtualClusterPolicy.

apiVersion cadena

k3k.io/v1beta1

kind cadena

VirtualClusterPolicyList

metadata ListMeta

Consulta la documentación de la API de Kubernetes para los campos de metadata.

items VirtualClusterPolicy array

quota ResourceQuotaSpec

La cuota especifica los límites de recursos para los clústeres dentro de una política de clúster.

limit LimitRangeSpec

El límite especifica el LimitRange que se aplicará a todos los pods dentro de la VirtualClusterPolicy
para establecer valores predeterminados y restricciones (mín./máx.)

defaultNodeSelector object (keys:string, values:string)

DefaultNodeSelector especifica el selector de nodo que se aplica a todos los clústeres (servidor + agente) en el espacio de nombres de destino.

defaultPriorityClass cadena

DefaultPriorityClass especifica el priorityClassName aplicado a todos los pods de todos los clústeres en el espacio de nombres de destino.

defaultServerAffinity Affinity

DefaultServerAffinity especifica las reglas de afinidad aplicadas a los pods de servidor de todos los clústeres en el espacio de nombres de destino.
Esto incluye tanto reglas de afinidad de nodo como reglas de afinidad/antiafinidad de pod.

defaultAgentAffinity Affinity

DefaultAgentAffinity especifica las reglas de afinidad aplicadas a los pods de agente de todos los clústeres en el espacio de nombres de destino.
Esto incluye tanto reglas de afinidad de nodo como reglas de afinidad/antiafinidad de pod.

allowedMode ClusterMode

AllowedMode especifica el modo de aprovisionamiento de clúster permitido.

shared

Enum: [shared virtual hcp]

disableNetworkPolicy boolean

DisableNetworkPolicy indica si se debe desactivar la creación de una directiva de red predeterminada para el aislamiento del clúster.

podSecurityAdmissionLevel PodSecurityAdmissionLevel

PodSecurityAdmissionLevel especifica el nivel de admisión de seguridad de pods aplicado a los pods en el espacio de nombres.

Enum: [privileged baseline restricted]

sync SyncConfig

Sync especifica los tipos de recursos que se sincronizarán del clúster virtual al clúster anfitrión.

{ }

runtimeClassName cadena

SecurityContext especifica un SecurityContext personalizado que se añade a los
pods de agente y servidor del clúster en modo virtual o shared.

securityContext SecurityContext

RuntimeClassName especifica una clase de runtime alternativa para los
pods de agente y servidor del clúster en modo virtual o shared.

hostUsers boolean

HostUsers establece el espacio de nombres de usuario para los pods de servidor y agente.
Si se establece en true o no está presente, el pod se ejecutará en el espacio de nombres de usuario del host.
Si se establece en false, se crea un nuevo userns para el pod.
Este campo es de nivel alfa y solo lo respetan los servidores que habilitan la característica UserNamespacesSupport.

observedGeneration entero

ObservedGeneration era la generación en el momento en que se actualizó el estado.

lastUpdateTime cadena

LastUpdate es la marca de tiempo de la última actualización del estado.

summary cadena

Summary es un resumen del estado.

conditions Condition array

Conditions son las condiciones individuales establecidas para el clúster.