APIリファレンス

secretNamespace string

SecretNamespaceはシークレットのネームスペースです。

secretRef string

SecretRefはシークレットの名前です。

name string

name は、このクラスターに現在適用されている VirtualClusterPolicy の名前です。

MinLength: 1

priorityClass string

priorityClass は、アクティブな VirtualClusterPolicy によって適用される優先度クラスです。

nodeSelector object (keys:string, values:string)

nodeSelector は、アクティブな VirtualClusterPolicy によって適用されるノードセレクターです。

serverAffinity Affinity

serverAffinity は、アクティブな VirtualClusterPolicy によって適用されるサーバーポッドのアフィニティルールです。
これには、ノードアフィニティルールとポッドアフィニティ/アンチアフィニティルールの両方が含まれます。

agentAffinity Affinity

agentAffinity は、アクティブな VirtualClusterPolicy によって適用されるエージェントポッドのアフィニティルールです。
これには、ノードアフィニティルールとポッドアフィニティ/アンチアフィニティルールの両方が含まれます。

sync SyncConfig

sync は、アクティブな VirtualClusterPolicy によって適用される SyncConfig です。

runtimeClassName string

RuntimeClassName は、virtual または shared モードのクラスターのエージェントおよび
サーバーポッドに対する代替のランタイムクラスを指定します。

podSecurityContext PodSecurityContext

PodSecurityContext は、virtual または shared モードのクラスターのエージェントおよび
サーバーポッドに追加するカスタム SecurityContext を指定します。

securityContext SecurityContext

SecurityContext は、virtual または shared モードのクラスターのエージェントおよび
サーバーコンテナーに追加するカスタムコンテナー SecurityContext を指定します。

hostUsers ブール値

HostUsers は、サーバーポッドおよびエージェントポッドのユーザー名前空間を設定します。
true に設定されている場合、または指定されていない場合、ポッドはホストのユーザー名前空間で実行されます。
false に設定されている場合、ポッド用に新しい userns が作成されます。
このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にしたサーバーでのみ有効です。

apiVersion string

k3k.io/v1beta1

kind string

Cluster

metadata ObjectMeta

`metadata`のフィールドについてはKubernetes APIドキュメントを参照してください。

spec ClusterSpec

Specはクラスターの望ましい状態を定義します。

{ }

status ClusterStatus

Statusは、クラスターの観測された状態を反映します。

{ }

apiVersion string

k3k.io/v1beta1

kind string

ClusterList

metadata ListMeta

`metadata`のフィールドについてはKubernetes APIドキュメントを参照してください。

items Cluster array

version string

バージョンは、仮想ノードに使用するK3sのバージョンです。
K3sのバージョン管理規則に従う必要があります（例：v1.28.2-k3s1）。
指定されていない場合、ホストノードのKubernetesバージョンが使用されます。

mode ClusterMode

Modeは、クラスターのプロビジョニングモードを指定します。このフィールドは不変です。

shared

Enum: [shared virtual hcp]

servers 整数

サーバーは、サーバー（コントロールプレーン）モードで実行するK3sポッドの数を指定します。
少なくとも1でなければなりません。デフォルトは1です。

1

agents 整数

エージェントは、エージェント（ワーカー）モードで実行するK3sポッドの数を指定します。
0以上でなければなりません。デフォルトは0です。
このフィールドは"shared"モードでは無視されます。

0

clusterCIDR string

ClusterCIDRは、ポッドIPのCIDR範囲です。
"shared"モードでは10.42.0.0/16、"virtual"モードでは10.52.0.0/16がデフォルトです。
このフィールドは不変です。

serviceCIDR string

ServiceCIDRはサービスIPのCIDR範囲です。
"shared"モードでは10.43.0.0/16、"virtual"モードでは10.53.0.0/16がデフォルトです。
このフィールドは不変です。

clusterDNS string

ClusterDNSはCoreDNSサービスのIPアドレスです。
ServiceCIDR範囲内である必要があります。デフォルトは10.43.0.10です。
このフィールドは不変です。

persistence PersistenceConfig

Persistenceはetcdデータを永続化するためのオプションを指定します。
デフォルトは動的永続化で、PersistentVolumeClaimを使用してデータの永続化を提供します。
動的永続化にはデフォルトのStorageClassが必要です。

expose ExposeConfig

ExposeはAPIサーバーを公開するためのオプションを指定します。
デフォルトでは、ClusterIPとしてのみ公開されます。

nodeSelector object (keys:string, values:string)

NodeSelectorはサーバー/エージェントポッドがスケジュールされるノードラベルを指定します。
"shared"モードでは、これもワークロードに適用されます。

priorityClass string

PriorityClassはサーバー/エージェントポッドのpriorityClassNameを指定します。
"shared"モードでは、これもワークロードに適用されます。

tokenSecretRef SecretReference

TokenSecretRefは、ワーカーノードがクラスターに参加するために使用するトークンを含むSecret参照です。
Secretにはデータに「token」フィールドが必要です。

tlsSANs string array

TLSSANsはK3sサーバー証明書のサブジェクト代替名を指定します。

serverArgs string array

ServerArgsはK3sサーバーポッドのための順序付きキー-バリューペアを指定します。
例: ["--tls-san=example.com"]

agentArgs string array

AgentArgsはK3sエージェントポッドのための順序付きキー-バリューペアを指定します。
Example: ["--node-name=my-agent-node"]

serverEnvs EnvVar array

ServerEnvsはサーバーポッドに設定する環境変数のリストを指定します。

agentEnvs EnvVar array

AgentEnvsはエージェントポッドに設定する環境変数のリストを指定します。

addons Addon array

Addonsはクラスター起動時にデプロイする生のYAMLを含むシークレットを指定します。

serverLimit ResourceList

ServerLimitはサーバーノードのリソース制限を指定します。

workerLimit ResourceList

WorkerLimitはエージェントノードのリソース制限を指定します。

serverResources ResourceRequirements

ServerResourcesは、サーバーノードのリソース制限とリクエストを指定します。

workerResources ResourceRequirements

WorkerResourcesは、ワーカーノードのリソース制限とリクエストを指定します。

serverAffinity Affinity

ServerAffinityは、サーバーポッドのアフィニティルールを指定します。
これには、ノードアフィニティルールとポッドアフィニティ/アンチアフィニティルールの両方が含まれます。

agentAffinity Affinity

AgentAffinityは、エージェントポッドのアフィニティルールを指定します。
これには、ノードアフィニティルールとポッドアフィニティ/アンチアフィニティルールの両方が含まれます。

mirrorHostNodes ブール値

MirrorHostNodesはホストクラスターからのノードオブジェクトが
仮想クラスターにミラーリングされるかどうかを制御します。

customCAs CustomCAs

CustomCAsはカスタムCA証明書のための証明書/鍵ペアを指定します。

sync SyncConfig

Syncは仮想クラスターからホストクラスターに同期されるリソースタイプを指定します。

{ }

secretMounts SecretMount array

SecretMountsはサーバーおよびエージェントポッドにマウントするシークレットのリストを指定します。
各エントリは、シークレットとそのポッド内のマウントパスを定義します。

podSecurityContext PodSecurityContext

PodSecurityContext は、virtual または shared モードのクラスターのエージェントおよび
サーバーポッドに追加するカスタム PodSecurityContext を指定します。

securityContext SecurityContext

SecurityContext は、virtual または shared モードのクラスターのエージェントおよび
サーバーコンテナーに追加するカスタムコンテナー SecurityContext を指定します。
このオプションは、virtual モードでデフォルトに設定されている SecurityContext を上書きします。

runtimeClassName string

RuntimeClassName は、virtual または shared モードのクラスターのエージェントおよび
サーバーポッドに対する代替のランタイムクラスを指定します。

hostUsers ブール値

HostUsers は、サーバーポッドおよびエージェントポッドのユーザー名前空間を設定します。
true に設定されている場合、または指定されていない場合、ポッドはホストのユーザー名前空間で実行されます。
false に設定されている場合、ポッド用に新しい userns が作成されます。
このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にしたサーバーでのみ有効です。

hostVersion string

HostVersionは、ホストノードのKubernetesバージョンです。

clusterCIDR string

ClusterCIDRは、ポッドIPのCIDR範囲です。

serviceCIDR string

ServiceCIDRはサービスIPのCIDR範囲です。

clusterDNS string

ClusterDNSはCoreDNSサービスのIPアドレスです。

tlsSANs string array

TLSSANsはK3sサーバー証明書のサブジェクト代替名を指定します。

policyName string

PolicyNameは、仮想クラスターにバインドされた仮想クラスターポリシー名を指定します。

policy AppliedPolicy

policy は、このクラスターに適用されたポリシーのステータスを表します。
このフィールドは VirtualClusterPolicy コントローラーによって設定されます。

kubeletPort 整数

KubeletPortは、shared モードで k3k-kubelet が使用するポートを指定します。

conditions Condition array

Conditionsは、クラスターに設定された個々の条件です。

phase ClusterPhase

Phaseは、クラスターの現在のライフサイクル状態の概要です。

Unknown

Enum: [Pending Provisioning Ready Failed Terminating Unknown]

enabled ブール値

Enabledは、リソースの同期のオン/オフスイッチです。

true

selector object (keys:string, values:string)

Selectorは、同期されるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースが同期されます。

secretName string

秘密は、資格情報のタイプに基づいて特定のキーを含む必要があります：
- TLS証明書ペアの場合（例：ServerCA）：tls.crt`および`tls.key。
- ServiceAccountToken署名キーの場合：tls.key.

serverCA CredentialSource

ServerCAは、server-ca証明書/鍵ペアを指定します。

clientCA CredentialSource

ClientCAは、client-ca証明書/鍵ペアを指定します。

requestHeaderCA CredentialSource

RequestHeaderCAは、request-header-ca証明書/鍵ペアを指定します。

etcdServerCA CredentialSource

ETCDServerCAは、etcd-server-ca証明書/鍵ペアを指定します。

etcdPeerCA CredentialSource

ETCDPeerCAは、etcd-peer-ca証明書/鍵ペアを指定します。

serviceAccountToken CredentialSource

ServiceAccountTokenは、service-account-tokenキーを指定します。

enabled ブール値

有効にすると、この機能がオンまたはオフになります。

true

sources CredentialSources

ソースは、すべての必要なカスタムCA証明書のソースを定義します。

ingress IngressConfig

Ingressは、Ingressを通じてAPIサーバーを公開するためのオプションを指定します。

loadBalancer LoadBalancerConfig

LoadBalancerは、LoadBalancerサービスを通じてAPIサーバーを公開するためのオプションを指定します。

nodePort NodePortConfig

NodePortは、NodePortを通じてAPIサーバーを公開するためのオプションを指定します。

annotations object (keys:string, values:string)

Annotationsは、生成されるServiceに追加するアノテーションを指定します。

annotations object (keys:string, values:string)

Annotationsは、Ingressに追加するアノテーションを指定します。

ingressClassName string

IngressClassNameは、Ingressに使用するIngressClassを指定します。

enabled ブール値

Enabledは、リソースのsyncのオン/オフスイッチです。

false

selector object (keys:string, values:string)

Selectorは、syncされるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースがsyncされます。

disableTLSSecretTranslation ブール値

DisableTLSSecretTranslationは、仮想クラスターからホストクラスターへの
TLSシークレットの変換のオン/オフスイッチです

false

serverPort 整数

ServerPortは、タイプがLoadBalancerのときにK3sサーバーが公開されるポートです。
指定されていない場合、デフォルトのhttps 443ポートが割り当てられます。
0または負の値の場合、ポートは公開されません。

etcdPort 整数

ETCDPortは、タイプがLoadBalancerのときにETCDサービスが公開されるポートです。
指定されていない場合、デフォルトのetcd 2379ポートが割り当てられます。
0または負の値の場合、ポートは公開されません。

serverPort 整数

ServerPortは、NodePortタイプのときにK3sサーバーが公開される各ノードのポートです。
指定されていない場合、30000から32767の間のランダムなポートが割り当てられます。
範囲外の場合、ポートは公開されません。

etcdPort 整数

ETCDPortは、NodePortタイプのときにETCDサービスが公開される各ノードのポートです。
指定されていない場合、30000から32767の間のランダムなポートが割り当てられます。
範囲外の場合、ポートは公開されません。

type PersistenceMode

Typeは、永続化モードを指定します。

dynamic

storageClassName string

StorageClassNameは、PVCに使用するStorageClassの名前です。
このフィールドは「動的」モードでのみ関連します。

storageRequestSize Quantity

StorageRequestSizeは、PVCの要求サイズです。
このフィールドは「動的」モードでのみ関連します。

2G

enabled ブール値

Enabledは、リソースのsyncのオン/オフスイッチです。

true

selector object (keys:string, values:string)

Selectorは、syncされるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースがsyncされます。

enabled ブール値

Enabledは、リソースの同期のオン/オフスイッチです。

false

selector object (keys:string, values:string)

Selectorは、syncされるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースがsyncされます。

secretName string

secretNameは、ポッドのネームスペースで使用するシークレットの名前です。
その他の情報: https://kubernetes.io/docs/concepts/storage/volumes#secret

items KeyToPath array

items: 未指定の場合、参照されたデータフィールド内の各キーと値のペアが
Secretは、名前がキーで内容が値のファイルとしてボリュームに投影されます。
キーがファイル名、内容が値となります。指定された場合、リストされたキーは
指定されたパスに投影され、リストされていないキーは投影されません。
存在しません。Secretに存在しないキーが指定された場合、
Secretに存在しないキーが指定された場合、ボリュームのセットアップは、オプションとしてマークされていない場合にエラーとなります。相対的でなければならず、'..'パスを含むことや'..'で始まることはできません。
相対的でなければならず、「..」パスを含むことや「..」で始まることはできません。

defaultMode 整数

defaultModeは任意のフィールドで、作成されたファイルのパーミッションを設定するためのモードビットを指定します。
値は、0000から0777の間の8進数値、または0から511の間の10進数値でなければなりません。
YAMLでは8進数値と10進数値の両方が受け入れられますが、JSONでは10進数値が要求されます。
これはモードビットのための指定です。デフォルトは0644です。
パス内のディレクトリはこの設定の影響を受けません。
これは、ファイルに影響を与える他のオプションと競合する可能性があります。
モードはfsGroupなどの他のファイルモード設定と競合する場合があり、その結果、他のモードビットが設定されることもあります。

optional ブール値

オプションのフィールドは、Secretまたはそのキーが定義される必要があるかどうかを指定します。

name string

Name は、サーバーポッドまたはエージェントポッドのボリュームおよび
ボリュームマウントの名前として使用される Secret マウントボリュームの名前です。
空の場合は、代わりに Secret の名前が使用されます。

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

mountPath string

MountPathは、サーバーおよびエージェントポッド内のパスです。
シークレットの内容がマウントされます。

subPath string

SubPathは、ルートの代わりにマウントするためのシークレット内のオプションのパスです。
指定された場合、シークレットから指定されたキーのみがファイルとしてマウントされます。
MountPathで、親ディレクトリは書き込み可能のままです。

role string

Roleは、Secretのマウントに使用されるk3kポッドのタイプです。

Enum: [server agent all]

enabled ブール値

Enabledは、リソースの同期のオン/オフスイッチです。

true

selector object (keys:string, values:string)

Selectorは、同期されるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースが同期されます。

enabled ブール値

Enabledは、リソースの同期のオン/オフスイッチです。

true

selector object (keys:string, values:string)

Selectorは、同期されるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースが同期されます。

enabled ブール値

Enabledは、リソースの同期のオン/オフスイッチです。

false

selector object (keys:string, values:string)

Selectorは、同期されるリソースのラベルのセットを指定します。空の場合、
指定されたタイプのすべてのリソースが同期されます。

services ServiceSyncConfig

サービスリソースの同期設定。

{ enabled:true }

configMaps ConfigMapSyncConfig

ConfigMapsリソースの同期設定。

{ enabled:true }

secrets SecretSyncConfig

Secretsリソースの同期設定。

{ enabled:true }

ingresses IngressSyncConfig

Ingressesリソースの同期設定。

{ enabled:false }

persistentVolumeClaims PersistentVolumeClaimSyncConfig

PersistentVolumeClaimsリソースの同期設定。

{ enabled:true }

priorityClasses PriorityClassSyncConfig

PriorityClassesリソースの同期設定。

{ enabled:false }

storageClasses StorageClassSyncConfig

StorageClassesリソースの同期設定。

{ enabled:false }

apiVersion string

k3k.io/v1beta1

kind string

VirtualClusterPolicy

metadata ObjectMeta

`metadata`のフィールドについてはKubernetes APIドキュメントを参照してください。

spec VirtualClusterPolicySpec

Specは、VirtualClusterPolicyの望ましい状態を定義します。

{ }

status VirtualClusterPolicyStatus

Statusは、VirtualClusterPolicyの観測された状態を反映します。

apiVersion string

k3k.io/v1beta1

kind string

VirtualClusterPolicyList

metadata ListMeta

`metadata`のフィールドについてはKubernetes APIドキュメントを参照してください。

items VirtualClusterPolicy array

quota ResourceQuotaSpec

Quotaは、クラスター・ポリシー内のクラスターに対するリソース制限を指定します。

limit LimitRangeSpec

Limitは、VirtualClusterPolicy内のすべてのポッドに適用されるLimitRangeを指定します。
デフォルト値と制約（最小値/最大値）を設定するためのものです。

defaultNodeSelector object (keys:string, values:string)

DefaultNodeSelectorは、ターゲットネームスペース内のすべてのクラスター（サーバー + エージェント）に適用されるノードセレクターを指定します。

defaultPriorityClass string

DefaultPriorityClassは、ターゲットネームスペース内のすべてのクラスターのすべてのポッドに適用されるpriorityClassNameを指定します。

defaultServerAffinity Affinity

DefaultServerAffinityは、対象の名前空間内のすべてのクラスターのサーバーポッドに適用されるアフィニティルールを指定します。
これには、ノードアフィニティルールとポッドアフィニティ/アンチアフィニティルールの両方が含まれます。

defaultAgentAffinity Affinity

DefaultAgentAffinityは、対象の名前空間内のすべてのクラスターのエージェントポッドに適用されるアフィニティルールを指定します。
これには、ノードアフィニティルールとポッドアフィニティ/アンチアフィニティルールの両方が含まれます。

allowedMode ClusterMode

AllowedModeは、許可されるクラスターのプロビジョニングモードを指定します。

shared

Enum: [shared virtual hcp]

disableNetworkPolicy ブール値

DisableNetworkPolicyは、クラスターの分離のためにデフォルトのネットワークポリシーの作成を無効にするかどうかを示します。

podSecurityAdmissionLevel PodSecurityAdmissionLevel

PodSecurityAdmissionLevelは、ネームスペース内のポッドに適用されるポッドセキュリティの入場レベルを指定します。

Enum: [privileged baseline restricted]

sync SyncConfig

Syncは仮想クラスターからホストクラスターに同期されるリソースタイプを指定します。

{ }

runtimeClassName string

SecurityContext は、virtual または shared モードのクラスターのエージェントおよび
サーバーポッドに追加するカスタム SecurityContext を指定します。

securityContext SecurityContext

RuntimeClassName は、virtual または shared モードのクラスターのエージェントおよび
サーバーポッドに対する代替のランタイムクラスを指定します。

hostUsers ブール値

HostUsers は、サーバーポッドおよびエージェントポッドのユーザー名前空間を設定します。
true に設定されている場合、または指定されていない場合、ポッドはホストのユーザー名前空間で実行されます。
false に設定されている場合、ポッド用に新しい userns が作成されます。
このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にしたサーバーでのみ有効です。

observedGeneration 整数

ObservedGenerationは、ステータスが更新された時点のジェネレーションです。

lastUpdateTime string

LastUpdateは、ステータスが最後に更新されたタイムスタンプです。

summary string

Summaryは、ステータスの概要です。

conditions Condition array

Conditionsは、クラスターに設定された個々の条件です。