Référence API

secretNamespace chaîne

SecretNamespace est l’espace de noms du Secret.

secretRef chaîne

SecretRef est le nom du Secret.

name chaîne

name est le nom de la VirtualClusterPolicy actuellement appliquée à ce cluster.

MinLength: 1

priorityClass chaîne

priorityClass est la classe de priorité appliquée par la VirtualClusterPolicy active.

nodeSelector objet (clés:string, valeurs:string)

nodeSelector est un sélecteur de nœuds appliqué par la VirtualClusterPolicy active.

serverAffinity Affinity

serverAffinity correspond aux règles d’affinité pour les pods serveur appliquées par la VirtualClusterPolicy active.
Cela inclut à la fois les règles d’affinité de nœud et les règles d’affinité/anti-affinité de pod.

agentAffinity Affinity

agentAffinity correspond aux règles d’affinité pour les pods agent appliquées par la VirtualClusterPolicy active.
Cela inclut à la fois les règles d’affinité de nœud et les règles d’affinité/anti-affinité de pod.

sync SyncConfig

sync est la SyncConfig appliquée par la VirtualClusterPolicy active.

runtimeClassName chaîne

RuntimeClassName spécifie une classe d’exécution alternative pour les
pods agent et serveur du cluster en mode virtual ou shared.

podSecurityContext PodSecurityContext

PodSecurityContext spécifie un SecurityContext personnalisé à ajouter aux
pods agent et serveur du cluster en mode virtual ou shared.

securityContext SecurityContext

SecurityContext spécifie un SecurityContext de conteneur personnalisé à ajouter aux
conteneurs agent et serveur du cluster en mode virtual ou shared.

hostUsers booléen

HostUsers définit l’espace de noms utilisateur pour les pods serveur et agent.
S’il est défini sur true ou absent, le pod s’exécute dans l’espace de noms utilisateur de l’hôte.
S’il est défini sur false, un nouveau userns est créé pour le pod.
Ce champ est de niveau alpha et n’est pris en compte que par les serveurs qui activent la fonctionnalité UserNamespacesSupport.

apiVersion chaîne

k3k.io/v1beta1

kind chaîne

Cluster

metadata ObjectMeta

Consultez la documentation de l’API Kubernetes pour les champs de metadata.

spec ClusterSpec

La spécification définit l’état souhaité du Cluster.

{ }

status ClusterStatus

Status reflète l’état observé du Cluster.

{ }

apiVersion chaîne

k3k.io/v1beta1

kind chaîne

ClusterList

metadata ListMeta

Consultez la documentation de l’API Kubernetes pour les champs de metadata.

items Cluster tableau

version chaîne

La version est la version K3s à utiliser pour les nœuds virtuels.
Elle doit suivre la convention de versionnement K3s (par exemple, v1.28.2-k3s1).
Si non spécifié, la version Kubernetes du nœud hôte sera utilisée.

mode ClusterMode

Mode spécifie le mode de provisionnement du cluster. Ce champ est immuable.

shared

Enum: [shared virtual hcp]

servers entier

Les serveurs spécifient le nombre de pods K3s à exécuter en mode serveur (plan de contrôle).
Doit être d’au moins 1. La valeur par défaut est 1.

1

agents entier

Les agents spécifient le nombre de pods K3s à exécuter en mode agent (travailleur).
Doit être 0 ou plus. La valeur par défaut est 0.
Ce champ est ignoré en mode "shared".

0

clusterCIDR chaîne

ClusterCIDR est la plage CIDR pour les adresses IP des pods.
La valeur par défaut est 10.42.0.0/16 en mode shared et 10.52.0.0/16 en mode virtual.
Ce champ est immuable.

serviceCIDR chaîne

ServiceCIDR est la plage CIDR pour les adresses IP des services.
La valeur par défaut est 10.43.0.0/16 en mode shared et 10.53.0.0/16 en mode virtual.
Ce champ est immuable.

clusterDNS chaîne

ClusterDNS est l’adresse IP du service CoreDNS.
Doit être dans la plage ServiceCIDR. La valeur par défaut est 10.43.0.10.
Ce champ est immuable.

persistence PersistenceConfig

La persistance spécifie les options pour la persistance des données etcd.
La valeur par défaut est la persistance dynamique, qui utilise un PersistentVolumeClaim pour fournir la persistance des données.
Une StorageClass par défaut est requise pour la persistance dynamique.

expose ExposeConfig

Expose spécifie les options pour exposer le serveur API.
Par défaut, il n’est exposé qu’en tant que ClusterIP.

nodeSelector objet (clés:string, valeurs:string)

NodeSelector spécifie les étiquettes de nœud pour contraindre où les pods serveur/agent sont planifiés.
En mode "shared", cela s’applique également aux charges de travail.

priorityClass chaîne

PriorityClass spécifie le priorityClassName pour les pods serveur/agent.
En mode "shared", cela s’applique également aux charges de travail.

tokenSecretRef SecretReference

TokenSecretRef est une référence Secret contenant le token utilisé par les nœuds de travail pour rejoindre le cluster.
Le Secret doit avoir un champ "token" dans ses données.

tlsSANs tableau de chaînes

TLSSANs spécifie les noms alternatifs de sujet pour le certificat du serveur K3s.

serverArgs tableau de chaînes

ServerArgs spécifie des paires clé-valeur ordonnées pour les pods serveur K3s.
Exemple : ["--tls-san=example.com"]

agentArgs tableau de chaînes

AgentArgs spécifie des paires clé-valeur ordonnées pour les pods agent K3s.
Exemple : ["--node-name=my-agent-node"]

serverEnvs EnvVar tableau

ServerEnvs spécifie la liste des variables d’environnement à définir dans le pod serveur.

agentEnvs EnvVar tableau

AgentEnvs spécifie la liste des variables d’environnement à définir dans le pod agent.

addons Addon tableau

Addons spécifie des secrets contenant du YAML brut à déployer au démarrage du cluster.

serverLimit ResourceList

ServerLimit spécifie les limites de ressources pour les nœuds serveur.

workerLimit ResourceList

WorkerLimit spécifie les limites de ressources pour les nœuds agents.

serverResources ResourceRequirements

ServerResources spécifie les limites et les demandes de ressources pour les nœuds serveur.

workerResources ResourceRequirements

WorkerResources spécifie les limites et les demandes de ressources pour les nœuds de travail.

serverAffinity Affinity

ServerAffinity spécifie les règles d’affinité pour les pods serveur.
Cela inclut à la fois les règles d’affinité de nœud et les règles d’affinité/anti-affinité de pod.

agentAffinity Affinity

AgentAffinity spécifie les règles d’affinité pour les pods agent.
Cela inclut à la fois les règles d’affinité de nœud et les règles d’affinité/anti-affinité de pod.

mirrorHostNodes booléen

MirrorHostNodes contrôle si les objets de nœud du cluster hôte
sont reflétés dans le cluster virtuel.

customCAs CustomCAs

CustomCAs spécifie les paires de certificats/clés pour les certificats CA personnalisés.

sync SyncConfig

Sync spécifie les types de ressources qui seront synchronisés du cluster virtuel vers le cluster hôte.

{ }

secretMounts SecretMount tableau

SecretMounts spécifie une liste de secrets à monter dans les pods du serveur et de l’agent.
Chaque entrée définit un secret et son chemin de montage dans les pods.

podSecurityContext PodSecurityContext

PodSecurityContext spécifie un PodSecurityContext personnalisé à ajouter aux
pods agent et serveur du cluster en mode virtual ou shared.

securityContext SecurityContext

SecurityContext spécifie un SecurityContext de conteneur personnalisé à ajouter aux
conteneurs agent et serveur du cluster en mode virtual ou shared.
Cette option remplace le SecurityContext défini par défaut pour le mode virtual.

runtimeClassName chaîne

RuntimeClassName spécifie une classe d’exécution alternative pour les
pods agent et serveur du cluster en mode virtual ou shared.

hostUsers booléen

HostUsers définit l’espace de noms utilisateur pour les pods serveur et agent.
S’il est défini sur true ou absent, le pod s’exécute dans l’espace de noms utilisateur de l’hôte.
S’il est défini sur false, un nouveau userns est créé pour le pod.
Ce champ est de niveau alpha et n’est pris en compte que par les serveurs qui activent la fonctionnalité UserNamespacesSupport.

hostVersion chaîne

HostVersion est la version de Kubernetes du nœud hôte.

clusterCIDR chaîne

ClusterCIDR est la plage CIDR pour les adresses IP des pods.

serviceCIDR chaîne

ServiceCIDR est la plage CIDR pour les adresses IP des services.

clusterDNS chaîne

ClusterDNS est l’adresse IP du service CoreDNS.

tlsSANs tableau de chaînes

TLSSANs spécifie les noms alternatifs de sujet pour le certificat du serveur K3s.

policyName chaîne

PolicyName spécifie le nom de la politique de cluster virtuel liée au cluster virtuel.

policy AppliedPolicy

policy représente l’état de la politique appliquée à ce cluster.
Ce champ est défini par le contrôleur VirtualClusterPolicy.

kubeletPort entier

KubeletPort spécifie le port utilisé par k3k-kubelet en mode shared.

conditions Condition tableau

Conditions correspond aux conditions individuelles définies pour le cluster.

phase ClusterPhase

Phase est un résumé de haut niveau de l’état actuel du cycle de vie du cluster.

Unknown

Enum: [Pending Provisioning Ready Failed Terminating Unknown]

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

true

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

secretName chaîne

Le secret doit contenir des clés spécifiques en fonction du type d’identifiant :
- Pour les paires de certificats TLS (par exemple, ServerCA) : tls.crt et tls.key.
- Pour la clé de signature ServiceAccountToken : tls.key.

serverCA CredentialSource

ServerCA spécifie la paire de certificats/clés server-ca.

clientCA CredentialSource

ClientCA spécifie la paire de certificats/clés client-ca.

requestHeaderCA CredentialSource

RequestHeaderCA spécifie la paire de certificats/clés request-header-ca.

etcdServerCA CredentialSource

ETCDServerCA spécifie la paire de certificats/clés etcd-server-ca.

etcdPeerCA CredentialSource

ETCDPeerCA spécifie la paire de certificats/clés etcd-peer-ca.

serviceAccountToken CredentialSource

ServiceAccountToken spécifie la clé du service-account-token.

enabled booléen

Enabled active ou désactive cette fonctionnalité.

true

sources CredentialSources

Sources définit les sources pour tous les certificats CA personnalisés requis.

ingress IngressConfig

Ingress spécifie les options pour exposer le serveur API via un Ingress.

loadBalancer LoadBalancerConfig

LoadBalancer spécifie les options pour exposer le serveur API via un service LoadBalancer.

nodePort NodePortConfig

NodePort spécifie les options pour exposer le serveur API via NodePort.

annotations objet (clés:string, valeurs:string)

Annotations spécifie les annotations à ajouter au Service généré.

annotations objet (clés:string, valeurs:string)

Annotations spécifie les annotations à ajouter à l’Ingress.

ingressClassName chaîne

IngressClassName spécifie la classe d’Ingress à utiliser pour l’Ingress.

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

false

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

disableTLSSecretTranslation booléen

DisableTLSSecretTranslation est un interrupteur marche/arrêt pour la traduction des secrets TLS
du cluster virtuel vers le cluster hôte

false

serverPort entier

ServerPort est le port sur lequel le serveur K3s est exposé lorsque le type est LoadBalancer.
Si non spécifié, le port https par défaut 443 sera alloué.
Si 0 ou négatif, le port ne sera pas exposé.

etcdPort entier

ETCDPort est le port sur lequel le service ETCD est exposé lorsque le type est LoadBalancer.
Si non spécifié, le port etcd par défaut 2379 sera alloué.
Si 0 ou négatif, le port ne sera pas exposé.

serverPort entier

ServerPort est le port sur chaque nœud sur lequel le serveur K3s est exposé lorsque le type est NodePort.
Si non spécifié, un port aléatoire entre 30000-32767 sera alloué.
Si hors de la plage, le port ne sera pas exposé.

etcdPort entier

ETCDPort est le port sur chaque nœud sur lequel le service ETCD est exposé lorsque le type est NodePort.
Si non spécifié, un port aléatoire entre 30000-32767 sera alloué.
Si hors de la plage, le port ne sera pas exposé.

type PersistenceMode

Le type spécifie le mode de persistance.

dynamic

storageClassName chaîne

StorageClassName est le nom de la classe de stockage à utiliser pour le PVC.
Ce champ n’est pertinent qu’en mode "dynamique".

storageRequestSize Quantity

StorageRequestSize est la taille demandée pour le PVC.
Ce champ n’est pertinent qu’en mode "dynamique".

2G

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

true

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

false

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

secretName chaîne

secretName est le nom du secret dans l’espace de noms du pod à utiliser.
Pour en savoir plus : https://kubernetes.io/docs/concepts/storage/volumes#secret

items KeyToPath tableau

éléments Si non spécifié, chaque paire clé-valeur dans le champ Données du
Secret sera projeté dans le volume sous forme de fichier dont le nom est le
la clé et le contenu sont la valeur. Si spécifié, les clés listées seront
projetées dans les chemins spécifiés, et les clés non listées ne le seront pas
présent. Si une clé est spécifiée qui n’est pas présente dans le Secret,
la configuration du volume générera une erreur à moins qu’elle ne soit marquée comme optionnelle. Les chemins doivent être
relatifs et ne peuvent pas contenir le chemin '..' ou commencer par '..'.

defaultMode entier

defaultMode est optionnel : bits de mode utilisés pour définir les permissions sur les fichiers créés par défaut.
Doit être une valeur octale entre 0000 et 0777 ou une valeur décimale entre 0 et 511.
YAML accepte à la fois des valeurs octales et décimales, JSON nécessite des valeurs décimales
pour les bits de mode. La valeur par défaut est 0644.
Les répertoires dans le chemin ne sont pas affectés par ce paramètre.
Cela pourrait entrer en conflit avec d’autres options qui affectent le fichier
mode, comme fsGroup, et le résultat peut être d’autres bits de mode définis.

optional booléen

le champ optionnel spécifie si le Secret ou ses clés doivent être définis

name chaîne

Name est le nom du volume de montage du secret qui sera utilisé
comme nom du volume et du montage de volume pour le pod serveur ou agent.
S’il est vide, le nom du secret est utilisé à la place.

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

mountPath chaîne

MountPath est le chemin dans les pods du serveur et de l’agent où le
contenu du secret sera monté.

subPath chaîne

SubPath est un chemin optionnel dans le secret à monter au lieu de la racine.
Lorsque spécifié, seule la clé spécifiée du secret sera montée en tant que fichier
à MountPath, en gardant le répertoire parent modifiable.

role chaîne

Role est le type de pod k3k qui sera utilisé pour monter le secret.

Enum: [server agent all]

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

true

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

true

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

enabled booléen

Enabled est un interrupteur marche/arrêt pour la synchronisation des ressources.

false

selector objet (clés:string, valeurs:string)

Selector spécifie un ensemble d’étiquettes des ressources qui seront synchronisées, si vide
alors toutes les ressources du type donné seront synchronisées.

services ServiceSyncConfig

Configuration de synchronisation des ressources de services.

{ enabled:true }

configMaps ConfigMapSyncConfig

Configuration de synchronisation des ressources de ConfigMaps.

{ enabled:true }

secrets SecretSyncConfig

Configuration de synchronisation des ressources de secrets.

{ enabled:true }

ingresses IngressSyncConfig

Configuration de synchronisation des ressources d’Ingresses.

{ enabled:false }

persistentVolumeClaims PersistentVolumeClaimSyncConfig

Configuration de synchronisation des ressources de PersistentVolumeClaims.

{ enabled:true }

priorityClasses PriorityClassSyncConfig

Configuration de synchronisation des ressources de PriorityClasses.

{ enabled:false }

storageClasses StorageClassSyncConfig

Configuration de synchronisation des ressources StorageClasses.

{ enabled:false }

apiVersion chaîne

k3k.io/v1beta1

kind chaîne

VirtualClusterPolicy

metadata ObjectMeta

Consultez la documentation de l’API Kubernetes pour les champs de metadata.

spec VirtualClusterPolicySpec

Spec définit l’état souhaité de la VirtualClusterPolicy.

{ }

status VirtualClusterPolicyStatus

Status reflète l’état observé de la VirtualClusterPolicy.

apiVersion chaîne

k3k.io/v1beta1

kind chaîne

VirtualClusterPolicyList

metadata ListMeta

Consultez la documentation de l’API Kubernetes pour les champs de metadata.

items VirtualClusterPolicy tableau

quota ResourceQuotaSpec

Quota spécifie les limites de ressources pour les clusters au sein d’une clusterpolicy.

limit LimitRangeSpec

Limit spécifie le LimitRange qui sera appliqué à tous les pods au sein de la VirtualClusterPolicy
pour définir des valeurs par défaut et des contraintes (min/max)

defaultNodeSelector objet (clés:string, valeurs:string)

DefaultNodeSelector spécifie le sélecteur de nœuds qui s’applique à tous les clusters (serveur + agent) dans l’espace de noms cible.

defaultPriorityClass chaîne

DefaultPriorityClass spécifie le priorityClassName appliqué à tous les pods de tous les clusters dans l’espace de noms cible.

defaultServerAffinity Affinity

DefaultServerAffinity spécifie les règles d’affinité appliquées aux pods serveur de tous les clusters de l’espace de noms cible.
Cela inclut à la fois les règles d’affinité de nœud et les règles d’affinité/anti-affinité de pod.

defaultAgentAffinity Affinity

DefaultAgentAffinity spécifie les règles d’affinité appliquées aux pods agent de tous les clusters de l’espace de noms cible.
Cela inclut à la fois les règles d’affinité de nœud et les règles d’affinité/anti-affinité de pod.

allowedMode ClusterMode

AllowedMode spécifie le mode de provisionnement de cluster autorisé.

shared

Enum: [shared virtual hcp]

disableNetworkPolicy booléen

DisableNetworkPolicy indique s’il faut désactiver la création d’une stratégie réseau par défaut pour l’isolation des clusters.

podSecurityAdmissionLevel PodSecurityAdmissionLevel

PodSecurityAdmissionLevel spécifie le niveau d’admission de sécurité des pods appliqué aux pods dans l’espace de noms.

Enum: [privileged baseline restricted]

sync SyncConfig

Sync spécifie les types de ressources qui seront synchronisés du cluster virtuel vers le cluster hôte.

{ }

runtimeClassName chaîne

SecurityContext spécifie un SecurityContext personnalisé à ajouter aux
pods agent et serveur du cluster en mode virtual ou shared.

securityContext SecurityContext

RuntimeClassName spécifie une classe d’exécution alternative pour les
pods agent et serveur du cluster en mode virtual ou shared.

hostUsers booléen

HostUsers définit l’espace de noms utilisateur pour les pods serveur et agent.
S’il est défini sur true ou absent, le pod s’exécute dans l’espace de noms utilisateur de l’hôte.
S’il est défini sur false, un nouveau userns est créé pour le pod.
Ce champ est de niveau alpha et n’est pris en compte que par les serveurs qui activent la fonctionnalité UserNamespacesSupport.

observedGeneration entier

ObservedGeneration correspond à la génération au moment de la mise à jour de l’état.

lastUpdateTime chaîne

LastUpdate est l’horodatage de la dernière mise à jour de l’état.

summary chaîne

Summary est un résumé de l’état.

conditions Condition tableau

Conditions correspond aux conditions individuelles définies pour le cluster.