Referência da API

secretNamespace string

SecretNamespace é o namespace do Secret.

secretRef string

SecretRef é o nome do Secret.

name string

name é o nome da VirtualClusterPolicy atualmente aplicada a este cluster.

MinLength: 1

priorityClass string

priorityClass é a classe de prioridade aplicada pela VirtualClusterPolicy ativa.

nodeSelector object (keys:string, values:string)

nodeSelector é um seletor de nós aplicado pela VirtualClusterPolicy ativa.

serverAffinity Affinity

serverAffinity são as regras de afinidade para os pods de servidor aplicadas pela VirtualClusterPolicy ativa.
Isso inclui tanto regras de afinidade de nó quanto regras de afinidade/antiafinidade de pod.

agentAffinity Affinity

agentAffinity são as regras de afinidade para os pods de agente aplicadas pela VirtualClusterPolicy ativa.
Isso inclui tanto regras de afinidade de nó quanto regras de afinidade/antiafinidade de pod.

sync SyncConfig

sync é a SyncConfig aplicada pela VirtualClusterPolicy ativa.

runtimeClassName string

RuntimeClassName especifica uma classe de runtime alternativa para os
pods de agente e servidor do cluster no modo virtual ou shared.

podSecurityContext PodSecurityContext

PodSecurityContext especifica um SecurityContext personalizado a ser adicionado aos
pods de agente e servidor do cluster no modo virtual ou shared.

securityContext SecurityContext

SecurityContext especifica um SecurityContext de contêiner personalizado a ser adicionado aos
contêineres de agente e servidor do cluster no modo virtual ou shared.

hostUsers booleano

HostUsers define o namespace de usuário para os pods de servidor e agente.
Se definido como true ou ausente, o pod será executado no namespace de usuário do host.
Se definido como false, um novo userns é criado para o pod.
Este campo é de nível alfa e só é respeitado por servidores que habilitam o recurso UserNamespacesSupport.

apiVersion string

k3k.io/v1beta1

kind string

Cluster

metadata ObjectMeta

Consulte a documentação da API do Kubernetes para os campos de metadata.

spec ClusterSpec

Spec define o estado desejado do Cluster.

{ }

status ClusterStatus

Status reflete o estado observado do cluster.

{ }

apiVersion string

k3k.io/v1beta1

kind string

ClusterList

metadata ListMeta

Consulte a documentação da API do Kubernetes para os campos de metadata.

items Cluster array

version string

Versão é a versão do K3s a ser usada para os nós virtuais.
Deve seguir a convenção de versionamento do K3s (por exemplo, v1.28.2-k3s1).
Se não especificado, a versão do Kubernetes do nó host será usada.

mode ClusterMode

Mode especifica o modo de provisionamento do cluster. Este campo é imutável.

shared

Enum: [shared virtual hcp]

servers integer

Servidores especifica o número de pods K3s a serem executados em modo servidor (plano de controle).
Deve ser pelo menos 1. Padrão: 1.

1

agents integer

Agentes especifica o número de pods K3s a serem executados no modo agente (trabalhador).
Deve ser 0 ou maior. Padrão: 0.
Este campo é ignorado no modo "shared".

0

clusterCIDR string

ClusterCIDR é o intervalo CIDR para IPs de pods.
Padrão: 10.42.0.0/16 no modo shared e 10.52.0.0/16 no modo virtual.
Este campo é imutável.

serviceCIDR string

ServiceCIDR é o intervalo CIDR para IPs de serviços.
Padrão: 10.43.0.0/16 no modo shared e 10.53.0.0/16 no modo virtual.
Este campo é imutável.

clusterDNS string

ClusterDNS é o endereço IP para o serviço CoreDNS.
Deve estar dentro do intervalo ServiceCIDR. Padrão: 10.43.0.10.
Este campo é imutável.

persistence PersistenceConfig

Persistência especifica opções para persistir dados do etcd.
Padrão: persistência dinâmica, que usa um PersistentVolumeClaim para fornecer persistência de dados.
Uma StorageClass padrão é necessária para persistência dinâmica.

expose ExposeConfig

Expose especifica opções para expor o servidor da API.
Por padrão, ele é exposto apenas como um ClusterIP.

nodeSelector object (keys:string, values:string)

NodeSelector especifica rótulos de nó para restringir onde os pods do servidor/agente são agendados.
No modo "shared", isso também se aplica a cargas de trabalho.

priorityClass string

PriorityClass especifica o priorityClassName para pods de servidor/agente.
No modo "shared", isso também se aplica a cargas de trabalho.

tokenSecretRef SecretReference

TokenSecretRef é uma referência de Secret contendo o token usado pelos nós trabalhadores para ingressar no cluster.
O Secret deve ter um campo "token" em seus dados.

tlsSANs array de string

TLSSANs especifica nomes alternativos de assunto para o certificado do servidor K3s.

serverArgs array de string

ServerArgs especifica pares de chave-valor ordenados para pods de servidor K3s.
Exemplo: ["--tls-san=example.com"]

agentArgs array de string

AgentArgs especifica pares de chave-valor ordenados para pods de agente K3s.
Exemplo: ["--node-name=my-agent-node"]

serverEnvs EnvVar array

ServerEnvs especifica uma lista de variáveis de ambiente a serem definidas no pod do servidor.

agentEnvs EnvVar array

AgentEnvs especifica uma lista de variáveis de ambiente a serem definidas no pod do agente.

addons Addon array

Addons especifica Secrets contendo YAML bruto para implantar na inicialização do cluster.

serverLimit ResourceList

ServerLimit especifica limites de recursos para nós de servidor.

workerLimit ResourceList

WorkerLimit especifica limites de recursos para nós de agente.

serverResources ResourceRequirements

ServerResources especifica os limites e as solicitações de recursos para os nós de servidor.

workerResources ResourceRequirements

WorkerResources especifica os limites e as solicitações de recursos para os nós de trabalho.

serverAffinity Affinity

ServerAffinity especifica as regras de afinidade para os pods de servidor.
Isso inclui tanto regras de afinidade de nó quanto regras de afinidade/antiafinidade de pod.

agentAffinity Affinity

AgentAffinity especifica as regras de afinidade para os pods de agente.
Isso inclui tanto regras de afinidade de nó quanto regras de afinidade/antiafinidade de pod.

mirrorHostNodes booleano

MirrorHostNodes controla se os objetos de nó do cluster host
são espelhados no cluster virtual.

customCAs CustomCAs

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

sync SyncConfig

Sync especifica os tipos de recursos que serão sincronizados do cluster virtual para o cluster host.

{ }

secretMounts SecretMount array

SecretMounts especifica uma lista de Secrets a serem montados nos pods do servidor e do agente.
Cada entrada define um Secret e seu caminho de montagem dentro dos pods.

podSecurityContext PodSecurityContext

PodSecurityContext especifica um PodSecurityContext personalizado a ser adicionado aos
pods de agente e servidor do cluster no modo virtual ou shared.

securityContext SecurityContext

SecurityContext especifica um SecurityContext de contêiner personalizado a ser adicionado aos
contêineres de agente e servidor do cluster no modo virtual ou shared.
Esta opção substitui o SecurityContext definido por padrão para o modo virtual.

runtimeClassName string

RuntimeClassName especifica uma classe de runtime alternativa para os
pods de agente e servidor do cluster no modo virtual ou shared.

hostUsers booleano

HostUsers define o namespace de usuário para os pods de servidor e agente.
Se definido como true ou ausente, o pod será executado no namespace de usuário do host.
Se definido como false, um novo userns é criado para o pod.
Este campo é de nível alfa e só é respeitado por servidores que habilitam o recurso UserNamespacesSupport.

hostVersion string

HostVersion é a versão do Kubernetes do nó host.

clusterCIDR string

ClusterCIDR é o intervalo CIDR para IPs de pods.

serviceCIDR string

ServiceCIDR é o intervalo CIDR para IPs de serviços.

clusterDNS string

ClusterDNS é o endereço IP para o serviço CoreDNS.

tlsSANs array de string

TLSSANs especifica nomes alternativos de assunto para o certificado do servidor K3s.

policyName string

PolicyName especifica o nome da política de cluster virtual vinculada ao cluster virtual.

policy AppliedPolicy

policy representa o status da política aplicada a este cluster.
Este campo é definido pelo controlador VirtualClusterPolicy.

kubeletPort integer

KubeletPort especifica a porta usada pelo k3k-kubelet no modo shared.

conditions Condition array

Conditions são as condições individuais definidas para o cluster.

phase ClusterPhase

Phase é um resumo de alto nível do estado atual do ciclo de vida do cluster.

Unknown

Enum: [Pending Provisioning Ready Failed Terminating Unknown]

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

secretName string

O Secret deve conter chaves específicas com base no tipo de credencial:
- Para pares de certificados TLS (por exemplo, ServerCA): tls.crt e tls.key.
- Para a chave de assinatura do ServiceAccountToken: tls.key.

serverCA CredentialSource

ServerCA especifica o par de cert/key do servidor-ca.

clientCA CredentialSource

ClientCA especifica o par de cert/key do client-ca.

requestHeaderCA CredentialSource

RequestHeaderCA especifica o par de cert/key do request-header-ca.

etcdServerCA CredentialSource

ETCDServerCA especifica o par de cert/key do etcd-server-ca.

etcdPeerCA CredentialSource

ETCDPeerCA especifica o par de cert/key do etcd-peer-ca.

serviceAccountToken CredentialSource

ServiceAccountToken especifica a chave do service-account-token.

enabled booleano

Habilitado ativa ou desativa este recurso.

true

sources CredentialSources

Fontes define as fontes para todos os certificados CA personalizados necessários.

ingress IngressConfig

Ingress especifica opções para expor o servidor da API através de um Ingress.

loadBalancer LoadBalancerConfig

LoadBalancer especifica opções para expor o servidor da API através de um serviço LoadBalancer.

nodePort NodePortConfig

NodePort especifica opções para expor o servidor da API através de NodePort.

annotations object (keys:string, values:string)

Annotations especifica anotações a serem adicionadas ao Service gerado.

annotations object (keys:string, values:string)

Anotações especifica anotações a serem adicionadas ao Ingress.

ingressClassName string

IngressClassName especifica a IngressClass a ser utilizada para o Ingress.

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

false

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

disableTLSSecretTranslation booleano

DisableTLSSecretTranslation é um interruptor de ligar/desligar para traduzir os secrets TLS
do cluster virtual para o cluster host

false

serverPort integer

ServerPort é a porta na qual o servidor K3s é exposto quando o tipo é LoadBalancer.
Se não especificado, a porta padrão https 443 será alocada.
Se 0 ou negativo, a porta não será exposta.

etcdPort integer

ETCDPort é a porta na qual o serviço ETCD é exposto quando o tipo é LoadBalancer.
Se não especificado, a porta padrão etcd 2379 será alocada.
Se 0 ou negativo, a porta não será exposta.

serverPort integer

ServerPort é a porta em cada nó na qual o servidor K3s é exposto quando o tipo é NodePort.
Se não especificado, uma porta aleatória entre 30000-32767 será alocada.
Se estiver fora do intervalo, a porta não será exposta.

etcdPort integer

ETCDPort é a porta em cada nó na qual o serviço ETCD é exposto quando o tipo é NodePort.
Se não especificado, uma porta aleatória entre 30000-32767 será alocada.
Se estiver fora do intervalo, a porta não será exposta.

type PersistenceMode

O tipo especifica o modo de persistência.

dynamic

storageClassName string

StorageClassName é o nome da StorageClass a ser usada para o PVC.
Este campo é relevante apenas no modo "dinâmico".

storageRequestSize Quantity

StorageRequestSize é o tamanho solicitado para o PVC.
Este campo é relevante apenas no modo "dinâmico".

2G

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

false

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

secretName string

secretName é o nome do segredo no namespace do pod a ser utilizado.
Mais informações: https://kubernetes.io/docs/concepts/storage/volumes#secret

items KeyToPath array

itens: Se não especificado, cada par chave-valor no campo Data do Secret referenciado
O Secret será projetado no volume como um arquivo cujo nome é a
chave e o conteúdo é o valor. Se especificado, as chaves listadas serão
projetadas nos caminhos especificados, e as chaves não listadas não estarão
presentes. Se uma chave for especificada que não está presente no Secret,
a configuração do volume apresentará erro, a menos que seja marcada como opcional. Os caminhos devem ser
relativos e não podem conter o caminho '..' ou começar com '..'.

defaultMode integer

defaultMode é Opcional: bits de modo usados para definir permissões em arquivos criados por padrão.
Deve ser um valor octal entre 0000 e 0777 ou um valor decimal entre 0 e 511.
YAML aceita tanto valores octais quanto decimais, JSON requer valores decimais
para bits de modo. Padrão: 0644.
Diretórios dentro do caminho não são afetados por esta configuração.
Isso pode estar em conflito com outras opções que afetam o arquivo
modo, como fsGroup, e o resultado pode ser outros bits de modo definidos.

optional booleano

campo opcional especifica se o segredo ou suas chaves devem ser definidos

name string

Name é o nome do volume de montagem do secret que será usado
como nome do volume e da montagem de volume para o pod de servidor ou de agente.
Se estiver vazio, o nome do secret será usado no lugar.

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

mountPath string

MountPath é o caminho dentro dos pods do servidor e do agente onde o
conteúdo do segredo será montado.

subPath string

SubPath é um caminho opcional dentro do segredo para montar em vez da raiz.
Quando especificado, apenas a chave especificada do segredo será montada como um arquivo
em MountPath, mantendo o diretório pai gravável.

role string

Role é o tipo do pod k3k que será usado para montar o secret.

Enum: [server agent all]

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

true

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

enabled booleano

Enabled é um interruptor de ligar/desligar para sincronizar recursos.

false

selector object (keys:string, values:string)

Selector especifica um conjunto de rótulos dos recursos que serão sincronizados; se estiver vazio
então todos os recursos do tipo dado serão sincronizados.

services ServiceSyncConfig

Configuração de sincronização de recursos de serviços.

{ enabled:true }

configMaps ConfigMapSyncConfig

Configuração de sincronização de recursos de ConfigMaps.

{ enabled:true }

secrets SecretSyncConfig

Configuração de sincronização de recursos de segredos.

{ enabled:true }

ingresses IngressSyncConfig

Configuração de sincronização de recursos de Ingresses.

{ enabled:false }

persistentVolumeClaims PersistentVolumeClaimSyncConfig

Configuração de sincronização de recursos de PersistentVolumeClaims.

{ enabled:true }

priorityClasses PriorityClassSyncConfig

Configuração de sincronização de recursos de PriorityClasses.

{ enabled:false }

storageClasses StorageClassSyncConfig

Configuração de sincronização dos recursos StorageClasses.

{ enabled:false }

apiVersion string

k3k.io/v1beta1

kind string

VirtualClusterPolicy

metadata ObjectMeta

Consulte a documentação da API do Kubernetes para os campos de metadata.

spec VirtualClusterPolicySpec

Spec define o estado desejado da VirtualClusterPolicy.

{ }

status VirtualClusterPolicyStatus

Status reflete o estado observado da VirtualClusterPolicy.

apiVersion string

k3k.io/v1beta1

kind string

VirtualClusterPolicyList

metadata ListMeta

Consulte a documentação da API do Kubernetes para os campos de metadata.

items VirtualClusterPolicy array

quota ResourceQuotaSpec

Quota especifica os limites de recursos para clusters dentro de uma política de cluster.

limit LimitRangeSpec

Limit especifica o LimitRange que será aplicado a todos os pods dentro da VirtualClusterPolicy
para definir padrões e restrições (min/max)

defaultNodeSelector object (keys:string, values:string)

DefaultNodeSelector especifica o seletor de nós que se aplica a todos os clusters (servidor + agente) no Namespace de destino.

defaultPriorityClass string

DefaultPriorityClass especifica o priorityClassName aplicado a todos os pods de todos os clusters no Namespace de destino.

defaultServerAffinity Affinity

DefaultServerAffinity especifica as regras de afinidade aplicadas aos pods de servidor de todos os clusters no namespace de destino.
Isso inclui tanto regras de afinidade de nó quanto regras de afinidade/antiafinidade de pod.

defaultAgentAffinity Affinity

DefaultAgentAffinity especifica as regras de afinidade aplicadas aos pods de agente de todos os clusters no namespace de destino.
Isso inclui tanto regras de afinidade de nó quanto regras de afinidade/antiafinidade de pod.

allowedMode ClusterMode

AllowedMode especifica o modo de provisionamento de cluster permitido.

shared

Enum: [shared virtual hcp]

disableNetworkPolicy booleano

DisableNetworkPolicy indica se deve desabilitar a criação de uma política de rede padrão para isolamento de cluster.

podSecurityAdmissionLevel PodSecurityAdmissionLevel

PodSecurityAdmissionLevel especifica o nível de admissão de segurança de pod aplicado aos pods no namespace.

Enum: [privileged baseline restricted]

sync SyncConfig

Sync especifica os tipos de recursos que serão sincronizados do cluster virtual para o cluster host.

{ }

runtimeClassName string

SecurityContext especifica um SecurityContext personalizado a ser adicionado aos
pods de agente e servidor do cluster no modo virtual ou shared.

securityContext SecurityContext

RuntimeClassName especifica uma classe de runtime alternativa para os
pods de agente e servidor do cluster no modo virtual ou shared.

hostUsers booleano

HostUsers define o namespace de usuário para os pods de servidor e agente.
Se definido como true ou ausente, o pod será executado no namespace de usuário do host.
Se definido como false, um novo userns é criado para o pod.
Este campo é de nível alfa e só é respeitado por servidores que habilitam o recurso UserNamespacesSupport.

observedGeneration integer

ObservedGeneration era a geração no momento em que o status foi atualizado.

lastUpdateTime string

LastUpdate é o carimbo de data/hora da última atualização do status.

summary string

Summary é um resumo do status.

conditions Condition array

Conditions são as condições individuais definidas para o cluster.