diff --git a/.github/workflows/buildtest.yaml b/.github/workflows/buildtest.yaml index a31e0e50f..ea79ee222 100644 --- a/.github/workflows/buildtest.yaml +++ b/.github/workflows/buildtest.yaml @@ -50,7 +50,7 @@ jobs: - name: Setup dotnet SDK uses: actions/setup-dotnet@v4 with: - dotnet-version: '8.0.x' + dotnet-version: '9.0.x' - name: Restore nugets (msbuild) run: msbuild .\src\KubernetesClient\ -t:restore -p:RestorePackagesConfig=true - name: Build (msbuild) diff --git a/.github/workflows/docfx.yaml b/.github/workflows/docfx.yaml index b437c1b5f..c10c7e1e9 100644 --- a/.github/workflows/docfx.yaml +++ b/.github/workflows/docfx.yaml @@ -39,7 +39,7 @@ jobs: - name: Build run: dotnet build -c Release - - uses: nunit/docfx-action@v4.0.0 + - uses: nunit/docfx-action@v4.1.0 name: Build Documentation with: args: doc/docfx.json diff --git a/Directory.Build.props b/Directory.Build.props index 10ec5bf39..3d3e1cfce 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -26,7 +26,7 @@ snupkg true $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 11.0 + 13.0 diff --git a/Directory.Packages.props b/Directory.Packages.props index f083f5a48..2e1b01456 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -1,53 +1,53 @@ - - - true - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/README.md b/README.md index 58bfe650b..f92d95e61 100644 --- a/README.md +++ b/README.md @@ -154,6 +154,7 @@ ${GEN_DIR}/openapi/csharp.sh ${REPO_DIR}/src/KubernetesClient ${REPO_DIR}/csharp | SDK Version | Kubernetes Version | .NET Targeting | |-------------|--------------------|-----------------------------------------------------| +| 17.0 | 1.33 | net8.0;net9.0;net48*;netstandard2.0* | | 16.0 | 1.32 | net8.0;net9.0;net48*;netstandard2.0* | | 15.0 | 1.31 | net6.0;net8.0;net48*;netstandard2.0* | | 14.0 | 1.30 | net6.0;net8.0;net48*;netstandard2.0* | diff --git a/csharp.settings b/csharp.settings index 5bf31f681..1cc92da6d 100644 --- a/csharp.settings +++ b/csharp.settings @@ -1,3 +1,3 @@ -export KUBERNETES_BRANCH=v1.32.0 +export KUBERNETES_BRANCH=v1.33.0 export CLIENT_VERSION=0.0.1 export PACKAGE_NAME=k8s diff --git a/examples/Directory.Build.props b/examples/Directory.Build.props index edc5738f1..b87fe6aaa 100644 --- a/examples/Directory.Build.props +++ b/examples/Directory.Build.props @@ -1,6 +1,7 @@ + - net8.0 + net9.0 diff --git a/examples/Directory.Build.targets b/examples/Directory.Build.targets index 65c630b6d..bf5f5ee49 100644 --- a/examples/Directory.Build.targets +++ b/examples/Directory.Build.targets @@ -1,4 +1,5 @@ + diff --git a/examples/attach/Attach.cs b/examples/attach/Attach.cs index a53b5da56..cfdce7d8e 100755 --- a/examples/attach/Attach.cs +++ b/examples/attach/Attach.cs @@ -3,38 +3,29 @@ using System; using System.Threading.Tasks; -namespace attach -{ - internal class Attach - { - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting Request!"); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting Request!"); - var list = client.CoreV1.ListNamespacedPod("default"); - var pod = list.Items[0]; - await AttachToPod(client, pod).ConfigureAwait(false); - } +var list = client.CoreV1.ListNamespacedPod("default"); +var pod = list.Items[0]; +await AttachToPod(client, pod).ConfigureAwait(false); - private static async Task AttachToPod(IKubernetes client, V1Pod pod) - { - var webSocket = - await client.WebSocketNamespacedPodAttachAsync(pod.Metadata.Name, "default", - pod.Spec.Containers[0].Name).ConfigureAwait(false); +async Task AttachToPod(IKubernetes client, V1Pod pod) +{ + var webSocket = + await client.WebSocketNamespacedPodAttachAsync(pod.Metadata.Name, "default", + pod.Spec.Containers[0].Name).ConfigureAwait(false); - var demux = new StreamDemuxer(webSocket); - demux.Start(); + var demux = new StreamDemuxer(webSocket); + demux.Start(); - var buff = new byte[4096]; - var stream = demux.GetStream(1, 1); - while (true) - { - var read = stream.Read(buff, 0, 4096); - var str = System.Text.Encoding.Default.GetString(buff); - Console.WriteLine(str); - } - } + var buff = new byte[4096]; + var stream = demux.GetStream(1, 1); + while (true) + { + var read = stream.Read(buff, 0, 4096); + var str = System.Text.Encoding.Default.GetString(buff); + Console.WriteLine(str); } } diff --git a/examples/clientset/Program.cs b/examples/clientset/Program.cs new file mode 100644 index 000000000..9c2cac461 --- /dev/null +++ b/examples/clientset/Program.cs @@ -0,0 +1,26 @@ +// See https://aka.ms/new-console-template for more information +using k8s; +using k8s.ClientSets; +using System.Threading.Tasks; + +namespace clientset +{ + internal class Program + { + private static async Task Main(string[] args) + { + var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); + var client = new Kubernetes(config); + + ClientSet clientSet = new ClientSet(client); + var list = await clientSet.CoreV1.Pod.ListAsync("default").ConfigureAwait(false); + foreach (var item in list) + { + System.Console.WriteLine(item.Metadata.Name); + } + + var pod = await clientSet.CoreV1.Pod.GetAsync("test","default").ConfigureAwait(false); + System.Console.WriteLine(pod?.Metadata?.Name); + } + } +} diff --git a/examples/clientset/clientset.csproj b/examples/clientset/clientset.csproj new file mode 100644 index 000000000..4274ceb02 --- /dev/null +++ b/examples/clientset/clientset.csproj @@ -0,0 +1,6 @@ + + + Exe + + + diff --git a/examples/cp/Cp.cs b/examples/cp/Cp.cs index b7dd5b207..43e769490 100644 --- a/examples/cp/Cp.cs +++ b/examples/cp/Cp.cs @@ -1,4 +1,4 @@ -using ICSharpCode.SharpZipLib.Tar; +using ICSharpCode.SharpZipLib.Tar; using k8s; using System; using System.IO; @@ -7,110 +7,104 @@ using System.Threading; using System.Threading.Tasks; -namespace cp -{ - internal class Cp - { - private static IKubernetes client; +namespace cp; - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - client = new Kubernetes(config); +internal class Cp +{ + private static IKubernetes client; + private static async Task Main(string[] args) + { + var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); + client = new Kubernetes(config); - var pods = client.CoreV1.ListNamespacedPod("default", null, null, null, $"job-name=upload-demo"); - var pod = pods.Items.First(); - await CopyFileToPodAsync(pod.Metadata.Name, "default", "upload-demo", args[0], $"home/{args[1]}"); + var pods = client.CoreV1.ListNamespacedPod("default", null, null, null, $"job-name=upload-demo"); + var pod = pods.Items.First(); - } + await CopyFileToPodAsync(pod.Metadata.Name, "default", "upload-demo", args[0], $"home/{args[1]}").ConfigureAwait(false); + } - private static void ValidatePathParameters(string sourcePath, string destinationPath) + private static void ValidatePathParameters(string sourcePath, string destinationPath) + { + if (string.IsNullOrWhiteSpace(sourcePath)) { - if (string.IsNullOrWhiteSpace(sourcePath)) - { - throw new ArgumentException($"{nameof(sourcePath)} cannot be null or whitespace"); - } - - if (string.IsNullOrWhiteSpace(destinationPath)) - { - throw new ArgumentException($"{nameof(destinationPath)} cannot be null or whitespace"); - } - + throw new ArgumentException($"{nameof(sourcePath)} cannot be null or whitespace"); } - public static async Task CopyFileToPodAsync(string name, string @namespace, string container, string sourceFilePath, string destinationFilePath, CancellationToken cancellationToken = default(CancellationToken)) + if (string.IsNullOrWhiteSpace(destinationPath)) { - // All other parameters are being validated by MuxedStreamNamespacedPodExecAsync called by NamespacedPodExecAsync - ValidatePathParameters(sourceFilePath, destinationFilePath); + throw new ArgumentException($"{nameof(destinationPath)} cannot be null or whitespace"); + } + } + + public static async Task CopyFileToPodAsync(string name, string @namespace, string container, string sourceFilePath, string destinationFilePath, CancellationToken cancellationToken = default(CancellationToken)) + { + // All other parameters are being validated by MuxedStreamNamespacedPodExecAsync called by NamespacedPodExecAsync + ValidatePathParameters(sourceFilePath, destinationFilePath); - // The callback which processes the standard input, standard output and standard error of exec method - var handler = new ExecAsyncCallback(async (stdIn, stdOut, stdError) => + // The callback which processes the standard input, standard output and standard error of exec method + var handler = new ExecAsyncCallback(async (stdIn, stdOut, stdError) => + { + var fileInfo = new FileInfo(destinationFilePath); + try { - var fileInfo = new FileInfo(destinationFilePath); - try + using (var memoryStream = new MemoryStream()) { - using (var memoryStream = new MemoryStream()) + using (var inputFileStream = File.OpenRead(sourceFilePath)) + using (var tarOutputStream = new TarOutputStream(memoryStream, Encoding.Default)) { - using (var inputFileStream = File.OpenRead(sourceFilePath)) - using (var tarOutputStream = new TarOutputStream(memoryStream, Encoding.Default)) - { - tarOutputStream.IsStreamOwner = false; - - var fileSize = inputFileStream.Length; - var entry = TarEntry.CreateTarEntry(fileInfo.Name); - - entry.Size = fileSize; + tarOutputStream.IsStreamOwner = false; - tarOutputStream.PutNextEntry(entry); - await inputFileStream.CopyToAsync(tarOutputStream); - tarOutputStream.CloseEntry(); - } + var fileSize = inputFileStream.Length; + var entry = TarEntry.CreateTarEntry(fileInfo.Name); - memoryStream.Position = 0; + entry.Size = fileSize; - await memoryStream.CopyToAsync(stdIn); - await stdIn.FlushAsync(); + tarOutputStream.PutNextEntry(entry); + await inputFileStream.CopyToAsync(tarOutputStream).ConfigureAwait(false); + tarOutputStream.CloseEntry(); } - } - catch (Exception ex) - { - throw new IOException($"Copy command failed: {ex.Message}"); - } + memoryStream.Position = 0; - using StreamReader streamReader = new StreamReader(stdError); - while (streamReader.EndOfStream == false) - { - string error = await streamReader.ReadToEndAsync(); - throw new IOException($"Copy command failed: {error}"); + await memoryStream.CopyToAsync(stdIn).ConfigureAwait(false); + await stdIn.FlushAsync().ConfigureAwait(false); } - }); - - string destinationFolder = GetFolderName(destinationFilePath); - - return await client.NamespacedPodExecAsync( - name, - @namespace, - container, - new string[] { "sh", "-c", $"tar xmf - -C {destinationFolder}" }, - false, - handler, - cancellationToken); - } - + } + catch (Exception ex) + { + throw new IOException($"Copy command failed: {ex.Message}"); + } - private static string GetFolderName(string filePath) - { - var folderName = Path.GetDirectoryName(filePath); + using StreamReader streamReader = new StreamReader(stdError); + while (streamReader.EndOfStream == false) + { + string error = await streamReader.ReadToEndAsync().ConfigureAwait(false); + throw new IOException($"Copy command failed: {error}"); + } + }); + + string destinationFolder = GetFolderName(destinationFilePath); + + return await client.NamespacedPodExecAsync( + name, + @namespace, + container, + new string[] { "sh", "-c", $"tar xmf - -C {destinationFolder}" }, + false, + handler, + cancellationToken).ConfigureAwait(false); + } - return string.IsNullOrEmpty(folderName) ? "." : folderName; - } + private static string GetFolderName(string filePath) + { + var folderName = Path.GetDirectoryName(filePath); + return string.IsNullOrEmpty(folderName) ? "." : folderName; } } diff --git a/examples/csrApproval/Program.cs b/examples/csrApproval/Program.cs index b4f154864..fc94ae9a8 100644 --- a/examples/csrApproval/Program.cs +++ b/examples/csrApproval/Program.cs @@ -1,4 +1,4 @@ -using Json.Patch; +using Json.Patch; using k8s; using k8s.Models; using System.Net; @@ -21,7 +21,7 @@ string GenerateCertificate(string name) var request = new CertificateRequest(distinguishedName, rsa, HashAlgorithmName.SHA256, RSASignaturePadding.Pkcs1); request.CertificateExtensions.Add(new X509KeyUsageExtension(X509KeyUsageFlags.DataEncipherment | X509KeyUsageFlags.KeyEncipherment | X509KeyUsageFlags.DigitalSignature, false)); - request.CertificateExtensions.Add(new X509EnhancedKeyUsageExtension(new OidCollection { new("1.3.6.1.5.5.7.3.1") }, false)); + request.CertificateExtensions.Add(new X509EnhancedKeyUsageExtension([new ("1.3.6.1.5.5.7.3.1")], false)); request.CertificateExtensions.Add(sanBuilder.Build()); var csr = request.CreateSigningRequest(); var pemKey = "-----BEGIN CERTIFICATE REQUEST-----\r\n" + @@ -44,34 +44,34 @@ string GenerateCertificate(string name) Kind = "CertificateSigningRequest", Metadata = new V1ObjectMeta { - Name = name + Name = name, }, Spec = new V1CertificateSigningRequestSpec { Request = encodedCsr, SignerName = "kubernetes.io/kube-apiserver-client", Usages = new List { "client auth" }, - ExpirationSeconds = 600 // minimum should be 10 minutes - } + ExpirationSeconds = 600, // minimum should be 10 minutes + }, }; -await client.CertificatesV1.CreateCertificateSigningRequestAsync(request); +await client.CertificatesV1.CreateCertificateSigningRequestAsync(request).ConfigureAwait(false); var serializeOptions = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, - WriteIndented = true + WriteIndented = true, }; -var readCert = await client.CertificatesV1.ReadCertificateSigningRequestAsync(name); +var readCert = await client.CertificatesV1.ReadCertificateSigningRequestAsync(name).ConfigureAwait(false); var old = JsonSerializer.SerializeToDocument(readCert, serializeOptions); var replace = new List { - new("True", "Approved", DateTime.UtcNow, DateTime.UtcNow, "This certificate was approved by k8s client", "Approve") + new ("True", "Approved", DateTime.UtcNow, DateTime.UtcNow, "This certificate was approved by k8s client", "Approve"), }; readCert.Status.Conditions = replace; var expected = JsonSerializer.SerializeToDocument(readCert, serializeOptions); var patch = old.CreatePatch(expected); -await client.CertificatesV1.PatchCertificateSigningRequestApprovalAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name); +await client.CertificatesV1.PatchCertificateSigningRequestApprovalAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name).ConfigureAwait(false); diff --git a/examples/exec/Exec.cs b/examples/exec/Exec.cs index 9fdfc73b0..20bbd2125 100755 --- a/examples/exec/Exec.cs +++ b/examples/exec/Exec.cs @@ -3,35 +3,26 @@ using System; using System.Threading.Tasks; -namespace exec -{ - internal class Exec - { - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting Request!"); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting Request!"); - var list = client.CoreV1.ListNamespacedPod("default"); - var pod = list.Items[0]; - await ExecInPod(client, pod).ConfigureAwait(false); - } +var list = client.CoreV1.ListNamespacedPod("default"); +var pod = list.Items[0]; +await ExecInPod(client, pod).ConfigureAwait(false); - private static async Task ExecInPod(IKubernetes client, V1Pod pod) - { - var webSocket = - await client.WebSocketNamespacedPodExecAsync(pod.Metadata.Name, "default", "ls", - pod.Spec.Containers[0].Name).ConfigureAwait(false); +async Task ExecInPod(IKubernetes client, V1Pod pod) +{ + var webSocket = + await client.WebSocketNamespacedPodExecAsync(pod.Metadata.Name, "default", "ls", + pod.Spec.Containers[0].Name).ConfigureAwait(false); - var demux = new StreamDemuxer(webSocket); - demux.Start(); + var demux = new StreamDemuxer(webSocket); + demux.Start(); - var buff = new byte[4096]; - var stream = demux.GetStream(1, 1); - var read = stream.Read(buff, 0, 4096); - var str = System.Text.Encoding.Default.GetString(buff); - Console.WriteLine(str); - } - } + var buff = new byte[4096]; + var stream = demux.GetStream(1, 1); + var read = stream.Read(buff, 0, 4096); + var str = System.Text.Encoding.Default.GetString(buff); + Console.WriteLine(str); } diff --git a/examples/generic/Generic.cs b/examples/generic/Generic.cs index 41f91b39f..f65fb944d 100644 --- a/examples/generic/Generic.cs +++ b/examples/generic/Generic.cs @@ -1,26 +1,16 @@ using k8s; using k8s.Models; using System; -using System.Threading.Tasks; -namespace exec -{ - internal class Generic - { - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - var generic = new GenericClient(client, "", "v1", "nodes"); - var node = await generic.ReadAsync("kube0").ConfigureAwait(false); - Console.WriteLine(node.Metadata.Name); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +var generic = new GenericClient(client, "", "v1", "nodes"); +var node = await generic.ReadAsync("kube0").ConfigureAwait(false); +Console.WriteLine(node.Metadata.Name); - var genericPods = new GenericClient(client, "", "v1", "pods"); - var pods = await genericPods.ListNamespacedAsync("default").ConfigureAwait(false); - foreach (var pod in pods.Items) - { - Console.WriteLine(pod.Metadata.Name); - } - } - } +var genericPods = new GenericClient(client, "", "v1", "pods"); +var pods = await genericPods.ListNamespacedAsync("default").ConfigureAwait(false); +foreach (var pod in pods.Items) +{ + Console.WriteLine(pod.Metadata.Name); } diff --git a/examples/labels/PodList.cs b/examples/labels/PodList.cs index 2d59e9026..0c5df001d 100755 --- a/examples/labels/PodList.cs +++ b/examples/labels/PodList.cs @@ -2,47 +2,38 @@ using System; using System.Collections.Generic; -namespace simple +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting Request!"); + +var list = client.CoreV1.ListNamespacedService("default"); +foreach (var item in list.Items) { - internal class PodList + Console.WriteLine("Pods for service: " + item.Metadata.Name); + Console.WriteLine("=-=-=-=-=-=-=-=-=-=-="); + if (item.Spec == null || item.Spec.Selector == null) { - private static void Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting Request!"); - - var list = client.CoreV1.ListNamespacedService("default"); - foreach (var item in list.Items) - { - Console.WriteLine("Pods for service: " + item.Metadata.Name); - Console.WriteLine("=-=-=-=-=-=-=-=-=-=-="); - if (item.Spec == null || item.Spec.Selector == null) - { - continue; - } - - var labels = new List(); - foreach (var key in item.Spec.Selector) - { - labels.Add(key.Key + "=" + key.Value); - } + continue; + } - var labelStr = string.Join(",", labels.ToArray()); - Console.WriteLine(labelStr); - var podList = client.CoreV1.ListNamespacedPod("default", labelSelector: labelStr); - foreach (var pod in podList.Items) - { - Console.WriteLine(pod.Metadata.Name); - } + var labels = new List(); + foreach (var key in item.Spec.Selector) + { + labels.Add(key.Key + "=" + key.Value); + } - if (podList.Items.Count == 0) - { - Console.WriteLine("Empty!"); - } + var labelStr = string.Join(",", labels.ToArray()); + Console.WriteLine(labelStr); + var podList = client.CoreV1.ListNamespacedPod("default", labelSelector: labelStr); + foreach (var pod in podList.Items) + { + Console.WriteLine(pod.Metadata.Name); + } - Console.WriteLine(); - } - } + if (podList.Items.Count == 0) + { + Console.WriteLine("Empty!"); } + + Console.WriteLine(); } diff --git a/examples/logs/Logs.cs b/examples/logs/Logs.cs index ea23fa05f..5293de579 100755 --- a/examples/logs/Logs.cs +++ b/examples/logs/Logs.cs @@ -1,31 +1,21 @@ using k8s; using System; -using System.Threading.Tasks; -namespace logs -{ - internal class Logs - { - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting Request!"); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting Request!"); - var list = client.CoreV1.ListNamespacedPod("default"); - if (list.Items.Count == 0) - { - Console.WriteLine("No pods!"); - return; - } +var list = client.CoreV1.ListNamespacedPod("default"); +if (list.Items.Count == 0) +{ + Console.WriteLine("No pods!"); + return; +} - var pod = list.Items[0]; +var pod = list.Items[0]; - var response = await client.CoreV1.ReadNamespacedPodLogWithHttpMessagesAsync( - pod.Metadata.Name, - pod.Metadata.NamespaceProperty, container: pod.Spec.Containers[0].Name, follow: true).ConfigureAwait(false); - var stream = response.Body; - stream.CopyTo(Console.OpenStandardOutput()); - } - } -} +var response = await client.CoreV1.ReadNamespacedPodLogWithHttpMessagesAsync( + pod.Metadata.Name, + pod.Metadata.NamespaceProperty, container: pod.Spec.Containers[0].Name, follow: true).ConfigureAwait(false); +var stream = response.Body; +stream.CopyTo(Console.OpenStandardOutput()); diff --git a/examples/metrics/Program.cs b/examples/metrics/Program.cs index 33a779f09..f823bf54d 100644 --- a/examples/metrics/Program.cs +++ b/examples/metrics/Program.cs @@ -3,58 +3,49 @@ using System.Linq; using System.Threading.Tasks; -namespace metrics +async Task NodesMetrics(IKubernetes client) { - internal class Program + var nodesMetrics = await client.GetKubernetesNodesMetricsAsync().ConfigureAwait(false); + + foreach (var item in nodesMetrics.Items) { - private static async Task NodesMetrics(IKubernetes client) + Console.WriteLine(item.Metadata.Name); + + foreach (var metric in item.Usage) { - var nodesMetrics = await client.GetKubernetesNodesMetricsAsync().ConfigureAwait(false); + Console.WriteLine($"{metric.Key}: {metric.Value}"); + } + } +} - foreach (var item in nodesMetrics.Items) - { - Console.WriteLine(item.Metadata.Name); +async Task PodsMetrics(IKubernetes client) +{ + var podsMetrics = await client.GetKubernetesPodsMetricsAsync().ConfigureAwait(false); - foreach (var metric in item.Usage) - { - Console.WriteLine($"{metric.Key}: {metric.Value}"); - } - } - } + if (!podsMetrics.Items.Any()) + { + Console.WriteLine("Empty"); + } - private static async Task PodsMetrics(IKubernetes client) + foreach (var item in podsMetrics.Items) + { + foreach (var container in item.Containers) { - var podsMetrics = await client.GetKubernetesPodsMetricsAsync().ConfigureAwait(false); - - if (!podsMetrics.Items.Any()) - { - Console.WriteLine("Empty"); - } + Console.WriteLine(container.Name); - foreach (var item in podsMetrics.Items) + foreach (var metric in container.Usage) { - foreach (var container in item.Containers) - { - Console.WriteLine(container.Name); - - foreach (var metric in container.Usage) - { - Console.WriteLine($"{metric.Key}: {metric.Value}"); - } - } - - Console.Write(Environment.NewLine); + Console.WriteLine($"{metric.Key}: {metric.Value}"); } } - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - var client = new Kubernetes(config); - - await NodesMetrics(client).ConfigureAwait(false); - Console.WriteLine(Environment.NewLine); - await PodsMetrics(client).ConfigureAwait(false); - } + Console.Write(Environment.NewLine); } } + +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +var client = new Kubernetes(config); + +await NodesMetrics(client).ConfigureAwait(false); +Console.WriteLine(Environment.NewLine); +await PodsMetrics(client).ConfigureAwait(false); diff --git a/examples/namespace/NamespaceExample.cs b/examples/namespace/NamespaceExample.cs index 22ad06cde..06e8757a4 100644 --- a/examples/namespace/NamespaceExample.cs +++ b/examples/namespace/NamespaceExample.cs @@ -4,52 +4,37 @@ using System.Net; using System.Threading.Tasks; -namespace @namespace +void ListNamespaces(IKubernetes client) { - internal class NamespaceExample + var list = client.CoreV1.ListNamespace(); + foreach (var item in list.Items) { - private static void ListNamespaces(IKubernetes client) - { - var list = client.CoreV1.ListNamespace(); - foreach (var item in list.Items) - { - Console.WriteLine(item.Metadata.Name); - } + Console.WriteLine(item.Metadata.Name); + } - if (list.Items.Count == 0) - { - Console.WriteLine("Empty!"); - } - } + if (list.Items.Count == 0) + { + Console.WriteLine("Empty!"); + } +} - private static async Task DeleteAsync(IKubernetes client, string name, int delayMillis) +async Task DeleteAsync(IKubernetes client, string name, int delayMillis) +{ + while (true) + { + await Task.Delay(delayMillis).ConfigureAwait(false); + try { - while (true) + await client.CoreV1.ReadNamespaceAsync(name).ConfigureAwait(false); + } + catch (AggregateException ex) + { + foreach (var innerEx in ex.InnerExceptions) { - await Task.Delay(delayMillis).ConfigureAwait(false); - try - { - await client.CoreV1.ReadNamespaceAsync(name).ConfigureAwait(false); - } - catch (AggregateException ex) - { - foreach (var innerEx in ex.InnerExceptions) - { - if (innerEx is k8s.Autorest.HttpOperationException exception) - { - var code = exception.Response.StatusCode; - if (code == HttpStatusCode.NotFound) - { - return; - } - - throw; - } - } - } - catch (k8s.Autorest.HttpOperationException ex) + if (innerEx is k8s.Autorest.HttpOperationException exception) { - if (ex.Response.StatusCode == HttpStatusCode.NotFound) + var code = exception.Response.StatusCode; + if (code == HttpStatusCode.NotFound) { return; } @@ -58,41 +43,47 @@ private static async Task DeleteAsync(IKubernetes client, string name, int delay } } } - - private static void Delete(IKubernetes client, string name, int delayMillis) + catch (k8s.Autorest.HttpOperationException ex) { - DeleteAsync(client, name, delayMillis).Wait(); + if (ex.Response.StatusCode == HttpStatusCode.NotFound) + { + return; + } + + throw; } + } +} - private static void Main(string[] args) - { - var k8SClientConfig = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(k8SClientConfig); +void Delete(IKubernetes client, string name, int delayMillis) +{ + DeleteAsync(client, name, delayMillis).Wait(); +} - ListNamespaces(client); +var k8SClientConfig = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(k8SClientConfig); - var ns = new V1Namespace { Metadata = new V1ObjectMeta { Name = "test" } }; +ListNamespaces(client); - var result = client.CoreV1.CreateNamespace(ns); - Console.WriteLine(result); +var ns = new V1Namespace { Metadata = new V1ObjectMeta { Name = "test" } }; - ListNamespaces(client); +var result = client.CoreV1.CreateNamespace(ns); +Console.WriteLine(result); - var status = client.CoreV1.DeleteNamespace(ns.Metadata.Name, new V1DeleteOptions()); +ListNamespaces(client); - if (status.HasObject) - { - var obj = status.ObjectView(); - Console.WriteLine(obj.Status.Phase); +var status = client.CoreV1.DeleteNamespace(ns.Metadata.Name, new V1DeleteOptions()); - Delete(client, ns.Metadata.Name, 3 * 1000); - } - else - { - Console.WriteLine(status.Message); - } +if (status.HasObject) +{ + var obj = status.ObjectView(); + Console.WriteLine(obj.Status.Phase); - ListNamespaces(client); - } - } + Delete(client, ns.Metadata.Name, 3 * 1000); } +else +{ + Console.WriteLine(status.Message); +} + +ListNamespaces(client); diff --git a/examples/openTelemetryConsole/Program.cs b/examples/openTelemetryConsole/Program.cs index 9a5460dcb..4b7406be3 100644 --- a/examples/openTelemetryConsole/Program.cs +++ b/examples/openTelemetryConsole/Program.cs @@ -24,11 +24,12 @@ // Read the list of pods contained in default namespace var list = client.CoreV1.ListNamespacedPod("default"); -// Print the name of pods +// Print the name of pods foreach (var item in list.Items) { Console.WriteLine(item.Metadata.Name); } + // Or empty if there are no pods if (list.Items.Count == 0) { diff --git a/examples/patch-aot/Program.cs b/examples/patch-aot/Program.cs index 06a693dde..e72f6a4d2 100644 --- a/examples/patch-aot/Program.cs +++ b/examples/patch-aot/Program.cs @@ -28,5 +28,6 @@ static void PrintLabels(V1Pod pod) { Console.WriteLine($"{k} : {v}"); } + Console.WriteLine("=-=-=-=-=-=-=-=-=-=-="); } diff --git a/examples/patch/Program.cs b/examples/patch/Program.cs index 7958fcc35..f8cefa67c 100644 --- a/examples/patch/Program.cs +++ b/examples/patch/Program.cs @@ -3,21 +3,15 @@ using System; using System.Linq; -namespace patch -{ - internal class Program - { - private static void Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting Request!"); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting Request!"); - var pod = client.CoreV1.ListNamespacedPod("default").Items.First(); - var name = pod.Metadata.Name; - PrintLabels(pod); +var pod = client.CoreV1.ListNamespacedPod("default").Items.First(); +var name = pod.Metadata.Name; +PrintLabels(pod); - var patchStr = @" +var patchStr = @" { ""metadata"": { ""labels"": { @@ -26,19 +20,16 @@ private static void Main(string[] args) } }"; - client.CoreV1.PatchNamespacedPod(new V1Patch(patchStr, V1Patch.PatchType.MergePatch), name, "default"); - PrintLabels(client.CoreV1.ReadNamespacedPod(name, "default")); - } - - private static void PrintLabels(V1Pod pod) - { - Console.WriteLine($"Labels: for {pod.Metadata.Name}"); - foreach (var (k, v) in pod.Metadata.Labels) - { - Console.WriteLine($"{k} : {v}"); - } +client.CoreV1.PatchNamespacedPod(new V1Patch(patchStr, V1Patch.PatchType.MergePatch), name, "default"); +PrintLabels(client.CoreV1.ReadNamespacedPod(name, "default")); - Console.WriteLine("=-=-=-=-=-=-=-=-=-=-="); - } +void PrintLabels(V1Pod pod) +{ + Console.WriteLine($"Labels: for {pod.Metadata.Name}"); + foreach (var (k, v) in pod.Metadata.Labels) + { + Console.WriteLine($"{k} : {v}"); } + + Console.WriteLine("=-=-=-=-=-=-=-=-=-=-="); } diff --git a/examples/portforward/PortForward.cs b/examples/portforward/PortForward.cs index fe9485d86..ee095e073 100644 --- a/examples/portforward/PortForward.cs +++ b/examples/portforward/PortForward.cs @@ -6,74 +6,66 @@ using System.Text; using System.Threading.Tasks; -namespace portforward -{ - internal class Portforward - { - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting port forward!"); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting port forward!"); - var list = client.CoreV1.ListNamespacedPod("default"); - var pod = list.Items[0]; - await Forward(client, pod); - } - - private static async Task Forward(IKubernetes client, V1Pod pod) - { - // Note this is single-threaded, it won't handle concurrent requests well... - var webSocket = await client.WebSocketNamespacedPodPortForwardAsync(pod.Metadata.Name, "default", new int[] { 80 }, "v4.channel.k8s.io"); - var demux = new StreamDemuxer(webSocket, StreamType.PortForward); - demux.Start(); +var list = client.CoreV1.ListNamespacedPod("default"); +var pod = list.Items[0]; +await Forward(client, pod).ConfigureAwait(false); - var stream = demux.GetStream((byte?)0, (byte?)0); +async Task Forward(IKubernetes client, V1Pod pod) +{ + // Note this is single-threaded, it won't handle concurrent requests well... + var webSocket = await client.WebSocketNamespacedPodPortForwardAsync(pod.Metadata.Name, "default", new int[] { 80 }, "v4.channel.k8s.io").ConfigureAwait(false); + var demux = new StreamDemuxer(webSocket, StreamType.PortForward); + demux.Start(); - IPAddress ipAddress = IPAddress.Loopback; - IPEndPoint localEndPoint = new IPEndPoint(ipAddress, 8080); - Socket listener = new Socket(ipAddress.AddressFamily, SocketType.Stream, ProtocolType.Tcp); - listener.Bind(localEndPoint); - listener.Listen(100); + var stream = demux.GetStream((byte?)0, (byte?)0); - Socket handler = null; + IPAddress ipAddress = IPAddress.Loopback; + IPEndPoint localEndPoint = new IPEndPoint(ipAddress, 8080); + Socket listener = new Socket(ipAddress.AddressFamily, SocketType.Stream, ProtocolType.Tcp); + listener.Bind(localEndPoint); + listener.Listen(100); - // Note this will only accept a single connection - var accept = Task.Run(() => - { - while (true) - { - handler = listener.Accept(); - var bytes = new byte[4096]; - while (true) - { - int bytesRec = handler.Receive(bytes); - stream.Write(bytes, 0, bytesRec); - if (bytesRec == 0 || Encoding.ASCII.GetString(bytes, 0, bytesRec).IndexOf("") > -1) - { - break; - } - } - } - }); + Socket handler = null; - var copy = Task.Run(() => + // Note this will only accept a single connection + var accept = Task.Run(() => + { + while (true) + { + handler = listener.Accept(); + var bytes = new byte[4096]; + while (true) { - var buff = new byte[4096]; - while (true) + int bytesRec = handler.Receive(bytes); + stream.Write(bytes, 0, bytesRec); + if (bytesRec == 0 || Encoding.ASCII.GetString(bytes, 0, bytesRec).IndexOf("") > -1) { - var read = stream.Read(buff, 0, 4096); - handler.Send(buff, read, 0); + break; } - }); - - await accept; - await copy; - if (handler != null) - { - handler.Close(); } - listener.Close(); } + }); + + var copy = Task.Run(() => + { + var buff = new byte[4096]; + while (true) + { + var read = stream.Read(buff, 0, 4096); + handler.Send(buff, read, 0); + } + }); + + await accept.ConfigureAwait(false); + await copy.ConfigureAwait(false); + if (handler != null) + { + handler.Close(); } + + listener.Close(); } diff --git a/examples/restart/Program.cs b/examples/restart/Program.cs index b6e7a6f22..894e305a6 100644 --- a/examples/restart/Program.cs +++ b/examples/restart/Program.cs @@ -1,17 +1,17 @@ -using Json.Patch; +using Json.Patch; using k8s; using k8s.Models; using System.Text.Json; async Task RestartDaemonSetAsync(string name, string @namespace, IKubernetes client) { - var daemonSet = await client.AppsV1.ReadNamespacedDaemonSetAsync(name, @namespace); + var daemonSet = await client.AppsV1.ReadNamespacedDaemonSetAsync(name, @namespace).ConfigureAwait(false); var options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true }; var old = JsonSerializer.SerializeToDocument(daemonSet, options); var now = DateTimeOffset.Now.ToUnixTimeSeconds(); var restart = new Dictionary { - ["date"] = now.ToString() + ["date"] = now.ToString(), }; daemonSet.Spec.Template.Metadata.Annotations = restart; @@ -19,18 +19,18 @@ async Task RestartDaemonSetAsync(string name, string @namespace, IKubernetes cli var expected = JsonSerializer.SerializeToDocument(daemonSet); var patch = old.CreatePatch(expected); - await client.AppsV1.PatchNamespacedDaemonSetAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name, @namespace); + await client.AppsV1.PatchNamespacedDaemonSetAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name, @namespace).ConfigureAwait(false); } async Task RestartDeploymentAsync(string name, string @namespace, IKubernetes client) { - var deployment = await client.AppsV1.ReadNamespacedDeploymentAsync(name, @namespace); + var deployment = await client.AppsV1.ReadNamespacedDeploymentAsync(name, @namespace).ConfigureAwait(false); var options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true }; var old = JsonSerializer.SerializeToDocument(deployment, options); var now = DateTimeOffset.Now.ToUnixTimeSeconds(); var restart = new Dictionary { - ["date"] = now.ToString() + ["date"] = now.ToString(), }; deployment.Spec.Template.Metadata.Annotations = restart; @@ -38,18 +38,18 @@ async Task RestartDeploymentAsync(string name, string @namespace, IKubernetes cl var expected = JsonSerializer.SerializeToDocument(deployment); var patch = old.CreatePatch(expected); - await client.AppsV1.PatchNamespacedDeploymentAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name, @namespace); + await client.AppsV1.PatchNamespacedDeploymentAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name, @namespace).ConfigureAwait(false); } async Task RestartStatefulSetAsync(string name, string @namespace, IKubernetes client) { - var deployment = await client.AppsV1.ReadNamespacedStatefulSetAsync(name, @namespace); + var deployment = await client.AppsV1.ReadNamespacedStatefulSetAsync(name, @namespace).ConfigureAwait(false); var options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true }; var old = JsonSerializer.SerializeToDocument(deployment, options); var now = DateTimeOffset.Now.ToUnixTimeSeconds(); var restart = new Dictionary { - ["date"] = now.ToString() + ["date"] = now.ToString(), }; deployment.Spec.Template.Metadata.Annotations = restart; @@ -57,12 +57,12 @@ async Task RestartStatefulSetAsync(string name, string @namespace, IKubernetes c var expected = JsonSerializer.SerializeToDocument(deployment); var patch = old.CreatePatch(expected); - await client.AppsV1.PatchNamespacedStatefulSetAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name, @namespace); + await client.AppsV1.PatchNamespacedStatefulSetAsync(new V1Patch(patch, V1Patch.PatchType.JsonPatch), name, @namespace).ConfigureAwait(false); } var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); IKubernetes client = new Kubernetes(config); -await RestartDeploymentAsync("event-exporter", "monitoring", client); -await RestartDaemonSetAsync("prometheus-exporter", "monitoring", client); -await RestartStatefulSetAsync("argocd-application-controlle", "argocd", client); +await RestartDeploymentAsync("event-exporter", "monitoring", client).ConfigureAwait(false); +await RestartDaemonSetAsync("prometheus-exporter", "monitoring", client).ConfigureAwait(false); +await RestartStatefulSetAsync("argocd-application-controlle", "argocd", client).ConfigureAwait(false); diff --git a/examples/simple/PodList.cs b/examples/simple/PodList.cs index b9eb3cdcf..751622c16 100755 --- a/examples/simple/PodList.cs +++ b/examples/simple/PodList.cs @@ -1,26 +1,17 @@ using k8s; using System; -namespace simple -{ - internal class PodList - { - private static void Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildDefaultConfig(); - IKubernetes client = new Kubernetes(config); - Console.WriteLine("Starting Request!"); +var config = KubernetesClientConfiguration.BuildDefaultConfig(); +IKubernetes client = new Kubernetes(config); +Console.WriteLine("Starting Request!"); - var list = client.CoreV1.ListNamespacedPod("default"); - foreach (var item in list.Items) - { - Console.WriteLine(item.Metadata.Name); - } +var list = client.CoreV1.ListNamespacedPod("default"); +foreach (var item in list.Items) +{ + Console.WriteLine(item.Metadata.Name); +} - if (list.Items.Count == 0) - { - Console.WriteLine("Empty!"); - } - } - } +if (list.Items.Count == 0) +{ + Console.WriteLine("Empty!"); } diff --git a/examples/watch/Program.cs b/examples/watch/Program.cs index 525cbec5c..f21f8f88c 100644 --- a/examples/watch/Program.cs +++ b/examples/watch/Program.cs @@ -4,47 +4,37 @@ using System.Threading; using System.Threading.Tasks; -namespace watch -{ - internal class Program - { - private static async Task Main(string[] args) - { - var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); +var config = KubernetesClientConfiguration.BuildConfigFromConfigFile(); - IKubernetes client = new Kubernetes(config); +IKubernetes client = new Kubernetes(config); - var podlistResp = client.CoreV1.ListNamespacedPodWithHttpMessagesAsync("default", watch: true); - // C# 8 required https://docs.microsoft.com/en-us/archive/msdn-magazine/2019/november/csharp-iterating-with-async-enumerables-in-csharp-8 - await foreach (var (type, item) in podlistResp.WatchAsync()) - { - Console.WriteLine("==on watch event=="); - Console.WriteLine(type); - Console.WriteLine(item.Metadata.Name); - Console.WriteLine("==on watch event=="); - } - - // uncomment if you prefer callback api - // WatchUsingCallback(client); - } +var podlistResp = client.CoreV1.ListNamespacedPodWithHttpMessagesAsync("default", watch: true); +// C# 8 required https://docs.microsoft.com/en-us/archive/msdn-magazine/2019/november/csharp-iterating-with-async-enumerables-in-csharp-8 +await foreach (var (type, item) in podlistResp.WatchAsync().ConfigureAwait(false)) +{ + Console.WriteLine("==on watch event=="); + Console.WriteLine(type); + Console.WriteLine(item.Metadata.Name); + Console.WriteLine("==on watch event=="); +} - private static void WatchUsingCallback(IKubernetes client) - { - var podlistResp = client.CoreV1.ListNamespacedPodWithHttpMessagesAsync("default", watch: true); - using (podlistResp.Watch((type, item) => - { - Console.WriteLine("==on watch event=="); - Console.WriteLine(type); - Console.WriteLine(item.Metadata.Name); - Console.WriteLine("==on watch event=="); - })) - { - Console.WriteLine("press ctrl + c to stop watching"); +#pragma warning disable CS8321 // Remove unused private members +void WatchUsingCallback(IKubernetes client) +#pragma warning restore CS8321 // Remove unused private members +{ + var podlistResp = client.CoreV1.ListNamespacedPodWithHttpMessagesAsync("default", watch: true); + using (podlistResp.Watch((type, item) => + { + Console.WriteLine("==on watch event=="); + Console.WriteLine(type); + Console.WriteLine(item.Metadata.Name); + Console.WriteLine("==on watch event=="); + })) + { + Console.WriteLine("press ctrl + c to stop watching"); - var ctrlc = new ManualResetEventSlim(false); - Console.CancelKeyPress += (sender, eventArgs) => ctrlc.Set(); - ctrlc.Wait(); - } - } + var ctrlc = new ManualResetEventSlim(false); + Console.CancelKeyPress += (sender, eventArgs) => ctrlc.Set(); + ctrlc.Wait(); } } diff --git a/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnConstructorController.cs b/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnConstructorController.cs index 30fd2656c..6bff6df0d 100644 --- a/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnConstructorController.cs +++ b/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnConstructorController.cs @@ -10,22 +10,23 @@ public class ExampleDependencyInjectionOnConstructorController : ControllerBase private readonly IKubernetes kubernetesClient; /// - /// Inject the kubernets class in the constructor. + /// Initializes a new instance of the class. + /// Injects the Kubernetes client into the controller. /// - /// + /// The Kubernetes client to interact with the Kubernetes API. public ExampleDependencyInjectionOnConstructorController(IKubernetes kubernetesClient) { this.kubernetesClient = kubernetesClient; } /// - /// Example using the kubernetes client obtained from the constructor (this.kubernetesClient). + /// Retrieves the names of all pods in the default namespace using the injected Kubernetes client. /// - /// - [HttpGet()] + /// A collection of pod names in the default namespace. + [HttpGet] public IEnumerable GetPods() { - // Read the list of pods contained in default namespace + // Read the list of pods contained in the default namespace var podList = this.kubernetesClient.CoreV1.ListNamespacedPod("default"); // Return names of pods diff --git a/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnMethodController.cs b/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnMethodController.cs index 0a831befb..84427f5e2 100644 --- a/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnMethodController.cs +++ b/examples/webApiDependencyInjection/Controllers/ExampleDependencyInjectionOnMethodController.cs @@ -10,11 +10,13 @@ public class ExampleDependencyInjectionOnMethodController : ControllerBase /// /// Example using the kubernetes client injected directly into the method ([FromServices] IKubernetes kubernetesClient). /// - /// - /// - [HttpGet()] + /// The Kubernetes client instance injected via dependency injection. + /// A collection of pod names in the default namespace. + [HttpGet] public IEnumerable GetPods([FromServices] IKubernetes kubernetesClient) { + ArgumentNullException.ThrowIfNull(kubernetesClient); + // Read the list of pods contained in default namespace var podList = kubernetesClient.CoreV1.ListNamespacedPod("default"); diff --git a/examples/workerServiceDependencyInjection/Program.cs b/examples/workerServiceDependencyInjection/Program.cs index 59bf3cf25..a894a33fe 100644 --- a/examples/workerServiceDependencyInjection/Program.cs +++ b/examples/workerServiceDependencyInjection/Program.cs @@ -14,4 +14,4 @@ }) .Build(); -await host.RunAsync(); +await host.RunAsync().ConfigureAwait(false); diff --git a/examples/workerServiceDependencyInjection/Worker.cs b/examples/workerServiceDependencyInjection/Worker.cs index 87d2ecfe2..cb2f82386 100644 --- a/examples/workerServiceDependencyInjection/Worker.cs +++ b/examples/workerServiceDependencyInjection/Worker.cs @@ -8,10 +8,11 @@ public class Worker : BackgroundService private readonly IKubernetes kubernetesClient; /// + /// Initializes a new instance of the class. /// Inject in the constructor the IKubernetes interface. /// - /// - /// + /// The logger instance used for logging information. + /// The Kubernetes client used to interact with the Kubernetes API. public Worker(ILogger logger, IKubernetes kubernetesClient) { this.logger = logger; @@ -33,7 +34,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken) Console.WriteLine(pod.Metadata.Name); } - await Task.Delay(1000, stoppingToken); + await Task.Delay(1000, stoppingToken).ConfigureAwait(false); } } } diff --git a/examples/yaml/Program.cs b/examples/yaml/Program.cs index 04676b16f..47b70bdfe 100644 --- a/examples/yaml/Program.cs +++ b/examples/yaml/Program.cs @@ -2,27 +2,17 @@ using k8s.Models; using System; using System.Collections.Generic; -using System.Threading.Tasks; -namespace yaml +var typeMap = new Dictionary { - internal class Program - { - private static async Task Main(string[] args) - { - var typeMap = new Dictionary - { - { "v1/Pod", typeof(V1Pod) }, - { "v1/Service", typeof(V1Service) }, - { "apps/v1/Deployment", typeof(V1Deployment) } - }; + { "v1/Pod", typeof(V1Pod) }, + { "v1/Service", typeof(V1Service) }, + { "apps/v1/Deployment", typeof(V1Deployment) }, +}; - var objects = await KubernetesYaml.LoadAllFromFileAsync(args[0], typeMap); +var objects = await KubernetesYaml.LoadAllFromFileAsync(args[0], typeMap).ConfigureAwait(false); - foreach (var obj in objects) - { - Console.WriteLine(obj); - } - } - } +foreach (var obj in objects) +{ + Console.WriteLine(obj); } diff --git a/src/KubernetesClient.Aot/KubernetesClient.Aot.csproj b/src/KubernetesClient.Aot/KubernetesClient.Aot.csproj index 226f818e6..88fe09488 100644 --- a/src/KubernetesClient.Aot/KubernetesClient.Aot.csproj +++ b/src/KubernetesClient.Aot/KubernetesClient.Aot.csproj @@ -46,6 +46,10 @@ + + + + @@ -107,4 +111,4 @@ - \ No newline at end of file + diff --git a/src/KubernetesClient.Classic/KubernetesClient.Classic.csproj b/src/KubernetesClient.Classic/KubernetesClient.Classic.csproj index bc8ad033a..254e745f3 100644 --- a/src/KubernetesClient.Classic/KubernetesClient.Classic.csproj +++ b/src/KubernetesClient.Classic/KubernetesClient.Classic.csproj @@ -75,7 +75,10 @@ - + + + + diff --git a/src/KubernetesClient.ModelConverter/AutoMapper/AutoMapperModelVersionConverter.cs b/src/KubernetesClient.ModelConverter/AutoMapper/AutoMapperModelVersionConverter.cs deleted file mode 100644 index c44190a46..000000000 --- a/src/KubernetesClient.ModelConverter/AutoMapper/AutoMapperModelVersionConverter.cs +++ /dev/null @@ -1,17 +0,0 @@ -using static k8s.Models.ModelVersionConverter; - -namespace k8s.ModelConverter.AutoMapper; - -public class AutoMapperModelVersionConverter : IModelVersionConverter -{ - public static IModelVersionConverter Instance { get; } = new AutoMapperModelVersionConverter(); - - private AutoMapperModelVersionConverter() - { - } - - public TTo Convert(TFrom from) - { - return VersionConverter.Mapper.Map(from); - } -} diff --git a/src/KubernetesClient.ModelConverter/AutoMapper/KubernetesVersionComparer.cs b/src/KubernetesClient.ModelConverter/AutoMapper/KubernetesVersionComparer.cs deleted file mode 100644 index de22d25e1..000000000 --- a/src/KubernetesClient.ModelConverter/AutoMapper/KubernetesVersionComparer.cs +++ /dev/null @@ -1,58 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Text.RegularExpressions; - -namespace k8s.ModelConverter.AutoMapper; - -internal class KubernetesVersionComparer : IComparer -{ - public static KubernetesVersionComparer Instance { get; } = new KubernetesVersionComparer(); - private static readonly Regex KubernetesVersionRegex = new Regex(@"^v(?[0-9]+)((?alpha|beta)(?[0-9]+))?$", RegexOptions.Compiled); - - internal KubernetesVersionComparer() - { - } - - public int Compare(string x, string y) - { - if (x == null || y == null) - { - return StringComparer.CurrentCulture.Compare(x, y); - } - - var matchX = KubernetesVersionRegex.Match(x); - if (!matchX.Success) - { - return StringComparer.CurrentCulture.Compare(x, y); - } - - var matchY = KubernetesVersionRegex.Match(y); - if (!matchY.Success) - { - return StringComparer.CurrentCulture.Compare(x, y); - } - - var versionX = ExtractVersion(matchX); - var versionY = ExtractVersion(matchY); - return versionX.CompareTo(versionY); - } - - private Version ExtractVersion(Match match) - { - var major = int.Parse(match.Groups["major"].Value); - if (!Enum.TryParse(match.Groups["stream"].Value, true, out var stream)) - { - stream = Stream.Final; - } - - _ = int.TryParse(match.Groups["minor"].Value, out var minor); - return new Version(major, (int)stream, minor); - } - - private enum Stream - { - Alpha = 1, - Beta = 2, - Final = 3, - } -} diff --git a/src/KubernetesClient.ModelConverter/AutoMapper/VersionConverter.cs b/src/KubernetesClient.ModelConverter/AutoMapper/VersionConverter.cs deleted file mode 100644 index ebc1b214e..000000000 --- a/src/KubernetesClient.ModelConverter/AutoMapper/VersionConverter.cs +++ /dev/null @@ -1,176 +0,0 @@ -// WARNING: DO NOT LEAVE COMMENTED CODE IN THIS FILE. IT GETS SCANNED BY GEN PROJECT SO IT CAN EXCLUDE ANY MANUALLY DEFINED MAPS - -using AutoMapper; -#if NET6_0_OR_GREATER -using AutoMapper.Internal; -#endif -using k8s.Models; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Reflection; - -namespace k8s.ModelConverter.AutoMapper; - -/// -/// Provides mappers that converts Kubernetes models between different versions -/// -internal static partial class VersionConverter -{ - static VersionConverter() - { - UpdateMappingConfiguration(expression => { }); - } - - public static IMapper Mapper { get; private set; } - internal static MapperConfiguration MapperConfiguration { get; private set; } - - /// - /// Two level lookup of model types by Kind and then Version - /// - internal static Dictionary> KindVersionsMap { get; private set; } - - public static Type GetTypeForVersion(string version) - { - return GetTypeForVersion(typeof(T), version); - } - - public static Type GetTypeForVersion(Type type, string version) - { - return KindVersionsMap[type.GetKubernetesTypeMetadata().Kind][version]; - } - - public static void UpdateMappingConfiguration(Action configuration) - { - MapperConfiguration = new MapperConfiguration(cfg => - { - GetConfigurations(cfg); - configuration(cfg); - }); - Mapper = MapperConfiguration -#if NET6_0_OR_GREATER - .Internal() -#endif - .CreateMapper(); - KindVersionsMap = MapperConfiguration -#if NET6_0_OR_GREATER - .Internal() -#endif - .GetAllTypeMaps() - .SelectMany(x => new[] { x.Types.SourceType, x.Types.DestinationType }) - .Where(x => x.GetCustomAttribute() != null) - .Select(x => - { - var attr = GetKubernetesEntityAttribute(x); - return new { attr.Kind, attr.ApiVersion, Type = x }; - }) - .GroupBy(x => x.Kind) - .ToDictionary(x => x.Key, kindGroup => kindGroup - .GroupBy(x => x.ApiVersion) - .ToDictionary( - x => x.Key, - versionGroup => versionGroup.Select(x => x.Type).Distinct().Single())); // should only be one type for each Kind/Version combination - } - - public static object ConvertToVersion(object source, string apiVersion) - { - if (source == null) - { - throw new ArgumentNullException(nameof(source)); - } - - var type = source.GetType(); - var attr = GetKubernetesEntityAttribute(type); - if (attr.ApiVersion == apiVersion) - { - return source; - } - - if (!KindVersionsMap.TryGetValue(attr.Kind, out var kindVersions)) - { - throw new InvalidOperationException($"Version converter does not have any registered types for Kind `{attr.Kind}`"); - } - - if (!kindVersions.TryGetValue(apiVersion, out var targetType) || !kindVersions.TryGetValue(attr.ApiVersion, out var sourceType) || - MapperConfiguration -#if NET6_0_OR_GREATER - .Internal() -#endif - .FindTypeMapFor(sourceType, targetType) == null) - { - throw new InvalidOperationException($"There is no conversion mapping registered for Kind `{attr.Kind}` from ApiVersion {attr.ApiVersion} to {apiVersion}"); - } - - return Mapper.Map(source, sourceType, targetType); - } - - private static KubernetesEntityAttribute GetKubernetesEntityAttribute(Type type) - { - if (type == null) - { - throw new ArgumentNullException(nameof(type)); - } - - var attr = type.GetCustomAttribute(); - if (attr == null) - { - throw new InvalidOperationException($"Type {type} does not have {nameof(KubernetesEntityAttribute)}"); - } - - return attr; - } - - internal static void GetConfigurations(IMapperConfigurationExpression cfg) - { - AutoConfigurations(cfg); - ManualConfigurations(cfg); - } - - private static void ManualConfigurations(IMapperConfigurationExpression cfg) - { - cfg.AllowNullCollections = true; - cfg.DisableConstructorMapping(); - cfg -#if NET6_0_OR_GREATER - .Internal() -#endif - .ForAllMaps((typeMap, opt) => - { - if (!typeof(IKubernetesObject).IsAssignableFrom(typeMap.Types.DestinationType)) - { - return; - } - - var metadata = typeMap.Types.DestinationType.GetKubernetesTypeMetadata(); - opt.ForMember(nameof(IKubernetesObject.ApiVersion), x => x.Ignore()); - opt.ForMember(nameof(IKubernetesObject.Kind), x => x.Ignore()); - opt.AfterMap((from, to) => - { - var obj = (IKubernetesObject)to; - obj.ApiVersion = !string.IsNullOrEmpty(metadata.Group) ? $"{metadata.Group}/{metadata.ApiVersion}" : metadata.ApiVersion; - obj.Kind = metadata.Kind; - }); - }); - - cfg.CreateMap() - .ForMember(dest => dest.Metrics, opt => opt.Ignore()) - .ForMember(dest => dest.Behavior, opt => opt.Ignore()) - .ReverseMap(); - - - cfg.CreateMap() - .ForMember(dest => dest.Conditions, opt => opt.Ignore()) - .ForMember(dest => dest.CurrentMetrics, opt => opt.Ignore()) - .ReverseMap(); - - cfg.CreateMap() - .ForMember(dest => dest.Name, opt => opt.Ignore()) - .ForMember(dest => dest.Request, opt => opt.Ignore()) - .ReverseMap(); - - cfg.CreateMap() - .ForMember(dest => dest.Name, opt => opt.Ignore()) - .ForMember(dest => dest.Request, opt => opt.Ignore()) - .ReverseMap(); - } -} diff --git a/src/KubernetesClient.ModelConverter/KubernetesClient.ModelConverter.csproj b/src/KubernetesClient.ModelConverter/KubernetesClient.ModelConverter.csproj deleted file mode 100644 index cbd90f79d..000000000 --- a/src/KubernetesClient.ModelConverter/KubernetesClient.ModelConverter.csproj +++ /dev/null @@ -1,20 +0,0 @@ - - - net8.0;net9.0 - k8s.ModelConverter - - - - - - - - - - - - - - - - diff --git a/src/KubernetesClient/ClientSets/ClientSet.cs b/src/KubernetesClient/ClientSets/ClientSet.cs new file mode 100644 index 000000000..53aa37df9 --- /dev/null +++ b/src/KubernetesClient/ClientSets/ClientSet.cs @@ -0,0 +1,16 @@ +namespace k8s.ClientSets +{ + /// + /// Represents a base class for clients that interact with Kubernetes resources. + /// Provides shared functionality for derived resource-specific clients. + /// + public partial class ClientSet + { + private readonly Kubernetes _kubernetes; + + public ClientSet(Kubernetes kubernetes) + { + _kubernetes = kubernetes; + } + } +} diff --git a/src/KubernetesClient/ClientSets/ResourceClient.cs b/src/KubernetesClient/ClientSets/ResourceClient.cs new file mode 100644 index 000000000..bbf1c43e8 --- /dev/null +++ b/src/KubernetesClient/ClientSets/ResourceClient.cs @@ -0,0 +1,16 @@ +namespace k8s.ClientSets +{ + /// + /// Represents a set of Kubernetes clients for interacting with the Kubernetes API. + /// This class provides access to various client implementations for managing Kubernetes resources. + /// + public abstract class ResourceClient + { + protected Kubernetes Client { get; } + + public ResourceClient(Kubernetes kubernetes) + { + Client = kubernetes; + } + } +} diff --git a/src/KubernetesClient/Kubernetes.WebSocket.cs b/src/KubernetesClient/Kubernetes.WebSocket.cs index a3a5bc908..aeca29708 100644 --- a/src/KubernetesClient/Kubernetes.WebSocket.cs +++ b/src/KubernetesClient/Kubernetes.WebSocket.cs @@ -18,11 +18,11 @@ public partial class Kubernetes /// public Task WebSocketNamespacedPodExecAsync(string name, string @namespace = "default", string command = null, string container = null, bool stderr = true, bool stdin = true, bool stdout = true, - bool tty = true, string webSocketSubProtol = null, Dictionary> customHeaders = null, + bool tty = true, string webSocketSubProtocol = null, Dictionary> customHeaders = null, CancellationToken cancellationToken = default) { return WebSocketNamespacedPodExecAsync(name, @namespace, new string[] { command }, container, stderr, stdin, - stdout, tty, webSocketSubProtol, customHeaders, cancellationToken); + stdout, tty, webSocketSubProtocol, customHeaders, cancellationToken); } /// @@ -30,7 +30,7 @@ public virtual async Task MuxedStreamNamespacedPodExecAsync( string name, string @namespace = "default", IEnumerable command = null, string container = null, bool stderr = true, bool stdin = true, bool stdout = true, bool tty = true, - string webSocketSubProtol = WebSocketProtocol.V4BinaryWebsocketProtocol, + string webSocketSubProtocol = WebSocketProtocol.V4BinaryWebsocketProtocol, Dictionary> customHeaders = null, CancellationToken cancellationToken = default) { @@ -45,7 +45,7 @@ public virtual async Task MuxedStreamNamespacedPodExecAsync( public virtual Task WebSocketNamespacedPodExecAsync(string name, string @namespace = "default", IEnumerable command = null, string container = null, bool stderr = true, bool stdin = true, bool stdout = true, bool tty = true, - string webSocketSubProtol = WebSocketProtocol.V4BinaryWebsocketProtocol, + string webSocketSubProtocol = WebSocketProtocol.V4BinaryWebsocketProtocol, Dictionary> customHeaders = null, CancellationToken cancellationToken = default) { @@ -114,7 +114,7 @@ public virtual Task WebSocketNamespacedPodExecAsync(string name, stri uriBuilder.Query = query.ToString(1, query.Length - 1); // UriBuilder.Query doesn't like leading '?' chars, so trim it - return StreamConnectAsync(uriBuilder.Uri, webSocketSubProtol, customHeaders, + return StreamConnectAsync(uriBuilder.Uri, webSocketSubProtocol, customHeaders, cancellationToken); } @@ -173,7 +173,7 @@ public Task WebSocketNamespacedPodPortForwardAsync(string name, strin /// public Task WebSocketNamespacedPodAttachAsync(string name, string @namespace, string container = default, bool stderr = true, bool stdin = false, bool stdout = true, - bool tty = false, string webSocketSubProtol = null, Dictionary> customHeaders = null, + bool tty = false, string webSocketSubProtocol = null, Dictionary> customHeaders = null, CancellationToken cancellationToken = default) { if (name == null) @@ -208,7 +208,7 @@ public Task WebSocketNamespacedPodAttachAsync(string name, string @na uriBuilder.Query = query.ToString(1, query.Length - 1); // UriBuilder.Query doesn't like leading '?' chars, so trim it - return StreamConnectAsync(uriBuilder.Uri, webSocketSubProtol, customHeaders, + return StreamConnectAsync(uriBuilder.Uri, webSocketSubProtocol, customHeaders, cancellationToken); } diff --git a/src/LibKubernetesGenerator/ClientSetGenerator.cs b/src/LibKubernetesGenerator/ClientSetGenerator.cs new file mode 100644 index 000000000..a0b392d8b --- /dev/null +++ b/src/LibKubernetesGenerator/ClientSetGenerator.cs @@ -0,0 +1,103 @@ +using CaseExtensions; +using Microsoft.CodeAnalysis; +using NSwag; +using System.Collections.Generic; +using System.Linq; + +namespace LibKubernetesGenerator +{ + internal class ClientSetGenerator + { + private readonly ScriptObjectFactory _scriptObjectFactory; + + public ClientSetGenerator(ScriptObjectFactory scriptObjectFactory) + { + _scriptObjectFactory = scriptObjectFactory; + } + + public void Generate(OpenApiDocument swagger, IncrementalGeneratorPostInitializationContext context) + { + var data = swagger.Operations + .Where(o => o.Method != OpenApiOperationMethod.Options) + .Select(o => + { + var ps = o.Operation.ActualParameters.OrderBy(p => !p.IsRequired).ToArray(); + + o.Operation.Parameters.Clear(); + + var name = new HashSet(); + + var i = 1; + foreach (var p in ps) + { + if (name.Contains(p.Name)) + { + p.Name += i++; + } + + o.Operation.Parameters.Add(p); + name.Add(p.Name); + } + + return o; + }) + .Select(o => + { + o.Path = o.Path.TrimStart('/'); + o.Method = char.ToUpper(o.Method[0]) + o.Method.Substring(1); + return o; + }) + .ToArray(); + + var sc = _scriptObjectFactory.CreateScriptObject(); + + var groups = new List(); + var apiGroups = new Dictionary(); + + foreach (var grouped in data.Where(d => HasKubernetesAction(d.Operation?.ExtensionData)) + .GroupBy(d => d.Operation.Tags.First())) + { + var clients = new List(); + var name = grouped.Key.ToPascalCase(); + groups.Add(name); + var apis = grouped.Select(x => + { + var groupVersionKindElements = x.Operation?.ExtensionData?["x-kubernetes-group-version-kind"]; + var groupVersionKind = (Dictionary)groupVersionKindElements; + + return new { Kind = groupVersionKind?["kind"] as string, Api = x }; + }); + + foreach (var item in apis.GroupBy(x => x.Kind)) + { + var kind = item.Key; + apiGroups[kind] = item.Select(x => x.Api).ToArray(); + clients.Add(kind); + } + + sc.SetValue("clients", clients, true); + sc.SetValue("name", name, true); + context.RenderToContext("GroupClient.cs.template", sc, $"{name}GroupClient.g.cs"); + } + + foreach (var apiGroup in apiGroups) + { + var name = apiGroup.Key; + var apis = apiGroup.Value.ToArray(); + var group = apis.Select(x => x.Operation.Tags[0]).First(); + sc.SetValue("apis", apis, true); + sc.SetValue("name", name, true); + sc.SetValue("group", group.ToPascalCase(), true); + context.RenderToContext("Client.cs.template", sc, $"{name}Client.g.cs"); + } + + sc = _scriptObjectFactory.CreateScriptObject(); + sc.SetValue("groups", groups, true); + + context.RenderToContext("ClientSet.cs.template", sc, $"ClientSet.g.cs"); + } + + private bool HasKubernetesAction(IDictionary extensionData) => + extensionData?.ContainsKey("x-kubernetes-action") ?? false; + } +} diff --git a/src/LibKubernetesGenerator/GeneralNameHelper.cs b/src/LibKubernetesGenerator/GeneralNameHelper.cs index c9b5cf5af..15194bb90 100644 --- a/src/LibKubernetesGenerator/GeneralNameHelper.cs +++ b/src/LibKubernetesGenerator/GeneralNameHelper.cs @@ -21,7 +21,8 @@ public GeneralNameHelper(ClassNameHelper classNameHelper) public void RegisterHelper(ScriptObject scriptObject) { scriptObject.Import(nameof(GetInterfaceName), new Func(GetInterfaceName)); - scriptObject.Import(nameof(GetMethodName), new Func(GetMethodName)); + scriptObject.Import(nameof(GetOperationId), new Func(GetOperationId)); + scriptObject.Import(nameof(GetActionName), new Func(GetActionName)); scriptObject.Import(nameof(GetDotNetName), new Func(GetDotNetName)); scriptObject.Import(nameof(GetDotNetNameOpenApiParameter), new Func(GetDotNetNameOpenApiParameter)); } @@ -138,7 +139,7 @@ public string GetDotNetName(string jsonName, string style = "parameter") return jsonName.ToCamelCase(); } - public static string GetMethodName(OpenApiOperation watchOperation, string suffix) + public static string GetOperationId(OpenApiOperation watchOperation, string suffix) { var tag = watchOperation.Tags[0]; tag = tag.Replace("_", string.Empty); @@ -162,5 +163,28 @@ public static string GetMethodName(OpenApiOperation watchOperation, string suffi return methodName; } + + public static string GetActionName(OpenApiOperation apiOperation, string resource, string suffix) + { + var operationId = apiOperation.OperationId.ToPascalCase(); + var replacements = new Dictionary(StringComparer.OrdinalIgnoreCase) + { + { "Replace", "Update" }, + { "Read", "Get" }, + }; + + foreach (var replacement in replacements) + { + operationId = Regex.Replace(operationId, replacement.Key, replacement.Value, RegexOptions.IgnoreCase); + } + + var resources = new[] { resource, "ForAllNamespaces", "Namespaced" }; + var pattern = string.Join("|", Array.ConvertAll(resources, Regex.Escape)); + var actionName = pattern.Length > 0 + ? Regex.Replace(operationId, pattern, string.Empty, RegexOptions.IgnoreCase) + : operationId; + + return $"{actionName}{suffix}"; + } } } diff --git a/src/LibKubernetesGenerator/KubernetesClientSourceGenerator.cs b/src/LibKubernetesGenerator/KubernetesClientSourceGenerator.cs index 8dd368e03..6ea216f28 100644 --- a/src/LibKubernetesGenerator/KubernetesClientSourceGenerator.cs +++ b/src/LibKubernetesGenerator/KubernetesClientSourceGenerator.cs @@ -1,12 +1,6 @@ using Autofac; using Microsoft.CodeAnalysis; using NSwag; -#if GENERATE_AUTOMAPPER -using System.Collections.Generic; -using System; -using System.IO; -using System.Linq; -#endif namespace LibKubernetesGenerator { @@ -67,8 +61,8 @@ private static IContainer BuildContainer(OpenApiDocument swagger) builder.RegisterType(); builder.RegisterType(); builder.RegisterType(); + builder.RegisterType(); builder.RegisterType(); - builder.RegisterType(); builder.RegisterType(); return builder.Build(); @@ -87,36 +81,10 @@ public void Initialize(IncrementalGeneratorInitializationContext generatorContex container.Resolve().Generate(swagger, ctx); container.Resolve().Generate(swagger, ctx); container.Resolve().Generate(swagger, ctx); + container.Resolve().Generate(swagger, ctx); }); #endif -#if GENERATE_AUTOMAPPER - var automappersrc = generatorContext.CompilationProvider.Select((c, _) => c.SyntaxTrees.First(s => PathSuffixMath(s.FilePath, "AutoMapper/VersionConverter.cs"))); - generatorContext.RegisterSourceOutput(automappersrc, (ctx, srctree) => - { - var (swagger, container) = BuildContainer(); - container.Resolve().Generate(swagger, ctx, srctree); - }); -#endif - } - -#if GENERATE_AUTOMAPPER - private IEnumerable PathSplit(string path) - { - var p = path; - - while (!string.IsNullOrEmpty(p)) - { - yield return Path.GetFileName(p); - p = Path.GetDirectoryName(p); - } } - - private bool PathSuffixMath(string path, string suffix) - { - var s = PathSplit(suffix).ToList(); - return PathSplit(path).Take(s.Count).SequenceEqual(s); - } -#endif } } diff --git a/src/LibKubernetesGenerator/LibKubernetesGenerator.target b/src/LibKubernetesGenerator/LibKubernetesGenerator.target index ee9aeb083..916c1dd19 100644 --- a/src/LibKubernetesGenerator/LibKubernetesGenerator.target +++ b/src/LibKubernetesGenerator/LibKubernetesGenerator.target @@ -12,10 +12,11 @@ - + + @@ -30,8 +31,10 @@ + + @@ -48,8 +51,10 @@ + + diff --git a/src/LibKubernetesGenerator/VersionConverterAutoMapperGenerator.cs b/src/LibKubernetesGenerator/VersionConverterAutoMapperGenerator.cs deleted file mode 100644 index 9a2c95cbc..000000000 --- a/src/LibKubernetesGenerator/VersionConverterAutoMapperGenerator.cs +++ /dev/null @@ -1,82 +0,0 @@ -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.Text; -using NSwag; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Text.RegularExpressions; - -namespace LibKubernetesGenerator -{ - internal class VersionConverterAutoMapperGenerator - { - private readonly ClassNameHelper classNameHelper; - - public VersionConverterAutoMapperGenerator(ClassNameHelper classNameHelper) - { - this.classNameHelper = classNameHelper; - } - - public void Generate(OpenApiDocument swagger, SourceProductionContext context, SyntaxTree manualconverter) - { - var allGeneratedModelClassNames = new List(); - - foreach (var kv in swagger.Definitions) - { - var def = kv.Value; - var clz = classNameHelper.GetClassNameForSchemaDefinition(def); - allGeneratedModelClassNames.Add(clz); - } - - var manualMaps = new List<(string, string)>(); - - manualMaps = Regex.Matches(manualconverter.GetText().ToString(), @"\.CreateMap<(?.+?),\s?(?.+?)>") - .OfType() - .Select(x => (x.Groups["T1"].Value, x.Groups["T2"].Value)) - .ToList(); - - var versionRegex = @"(^V|v)[0-9]+((alpha|beta)[0-9]+)?"; - var typePairs = allGeneratedModelClassNames - .OrderBy(x => x) - .Select(x => new - { - Version = Regex.Match(x, versionRegex).Value?.ToLower(), - Kinda = Regex.Replace(x, versionRegex, string.Empty), - Type = x, - }) - .Where(x => !string.IsNullOrEmpty(x.Version)) - .GroupBy(x => x.Kinda) - .Where(x => x.Count() > 1) - .SelectMany(x => - x.SelectMany((value, index) => x.Skip(index + 1), (first, second) => new { first, second })) - .OrderBy(x => x.first.Kinda) - .ThenBy(x => x.first.Version) - .Select(x => (x.first.Type, x.second.Type)) - .ToList(); - - var versionConverterPairs = typePairs.Except(manualMaps).ToList(); - - var sbversion = new StringBuilder(@"// -using AutoMapper; -using k8s.Models; - -namespace k8s.ModelConverter.AutoMapper; - -internal static partial class VersionConverter - { - private static void AutoConfigurations(IMapperConfigurationExpression cfg) - { - -"); - - foreach (var (t0, t1) in versionConverterPairs) - { - sbversion.AppendLine($@"cfg.CreateMap<{t0}, {t1}>().ReverseMap();"); - } - - sbversion.AppendLine("}}"); - - context.AddSource($"VersionConverter.g.cs", SourceText.From(sbversion.ToString(), Encoding.UTF8)); - } - } -} diff --git a/src/LibKubernetesGenerator/generators/LibKubernetesGenerator.Automapper/LibKubernetesGenerator.Automapper.csproj b/src/LibKubernetesGenerator/generators/LibKubernetesGenerator.Automapper/LibKubernetesGenerator.Automapper.csproj deleted file mode 100644 index 1cf7ecd42..000000000 --- a/src/LibKubernetesGenerator/generators/LibKubernetesGenerator.Automapper/LibKubernetesGenerator.Automapper.csproj +++ /dev/null @@ -1,8 +0,0 @@ - - - $(DefineConstants);GENERATE_AUTOMAPPER; - - - - - diff --git a/src/LibKubernetesGenerator/templates/Client.cs.template b/src/LibKubernetesGenerator/templates/Client.cs.template new file mode 100644 index 000000000..02c55d7b1 --- /dev/null +++ b/src/LibKubernetesGenerator/templates/Client.cs.template @@ -0,0 +1,100 @@ +// +// Code generated by https://github.com/kubernetes-client/csharp/tree/master/src/LibKubernetesGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// +using System.Net.Http; +using System.Net.Http.Headers; + +namespace k8s.ClientSets; + +/// +/// +public partial class {{name}}Client : ResourceClient +{ + public {{name}}Client(Kubernetes kubernetes) : base(kubernetes) + { + } + + {{for api in apis }} + /// + /// {{ToXmlDoc api.operation.description}} + /// + {{ for parameter in api.operation.parameters}} + /// + /// {{ToXmlDoc parameter.description}} + /// + {{end}} + /// + /// A which can be used to cancel the asynchronous operation. + /// + public async Task{{GetReturnType api.operation "<>"}} {{GetActionName api.operation name "Async"}}( + {{ for parameter in api.operation.parameters}} + {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}}, + {{ end }} + CancellationToken cancellationToken = default(CancellationToken)) + { + {{if IfReturnType api.operation "stream"}} + var _result = await Client.{{group}}.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( + {{ for parameter in api.operation.parameters}} + {{GetDotNetNameOpenApiParameter parameter "false"}}, + {{end}} + null, + cancellationToken); + _result.Request.Dispose(); + {{GetReturnType api.operation "_result.Body"}}; + {{end}} + {{if IfReturnType api.operation "obj"}} + using (var _result = await Client.{{group}}.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( + {{ for parameter in api.operation.parameters}} + {{GetDotNetNameOpenApiParameter parameter "false"}}, + {{end}} + null, + cancellationToken).ConfigureAwait(false)) + { + {{GetReturnType api.operation "_result.Body"}}; + } + {{end}} + {{if IfReturnType api.operation "void"}} + using (var _result = await Client.{{group}}.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( + {{ for parameter in api.operation.parameters}} + {{GetDotNetNameOpenApiParameter parameter "false"}}, + {{end}} + null, + cancellationToken).ConfigureAwait(false)) + { + } + {{end}} + } + + {{if IfReturnType api.operation "object"}} + /// + /// {{ToXmlDoc api.operation.description}} + /// + {{ for parameter in api.operation.parameters}} + /// + /// {{ToXmlDoc parameter.description}} + /// + {{end}} + /// + /// A which can be used to cancel the asynchronous operation. + /// + public async Task {{GetActionName api.operation name "Async"}}( + {{ for parameter in api.operation.parameters}} + {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "false"}}, + {{ end }} + CancellationToken cancellationToken = default(CancellationToken)) + { + using (var _result = await Client.{{group}}.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( + {{ for parameter in api.operation.parameters}} + {{GetDotNetNameOpenApiParameter parameter "false"}}, + {{end}} + null, + cancellationToken).ConfigureAwait(false)) + { + return _result.Body; + } + } + {{end}} + {{end}} +} diff --git a/src/LibKubernetesGenerator/templates/ClientSet.cs.template b/src/LibKubernetesGenerator/templates/ClientSet.cs.template new file mode 100644 index 000000000..c358b2b3c --- /dev/null +++ b/src/LibKubernetesGenerator/templates/ClientSet.cs.template @@ -0,0 +1,16 @@ +// +// Code generated by https://github.com/kubernetes-client/csharp/tree/master/src/LibKubernetesGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace k8s.ClientSets; + +/// +/// +public partial class ClientSet +{ + {{for group in groups}} + public {{group}}GroupClient {{group}} => new {{group}}GroupClient(_kubernetes); + {{end}} +} diff --git a/src/LibKubernetesGenerator/templates/GroupClient.cs.template b/src/LibKubernetesGenerator/templates/GroupClient.cs.template new file mode 100644 index 000000000..45f219e55 --- /dev/null +++ b/src/LibKubernetesGenerator/templates/GroupClient.cs.template @@ -0,0 +1,24 @@ +// +// Code generated by https://github.com/kubernetes-client/csharp/tree/master/src/LibKubernetesGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace k8s.ClientSets; + + +/// +/// +public partial class {{name}}GroupClient +{ + private readonly Kubernetes _kubernetes; + + {{for client in clients}} + public {{client}}Client {{client}} => new {{client}}Client(_kubernetes); + {{end}} + + public {{name}}GroupClient(Kubernetes kubernetes) + { + _kubernetes = kubernetes; + } +} diff --git a/src/LibKubernetesGenerator/templates/IOperations.cs.template b/src/LibKubernetesGenerator/templates/IOperations.cs.template index c310acf9f..6904b8b91 100644 --- a/src/LibKubernetesGenerator/templates/IOperations.cs.template +++ b/src/LibKubernetesGenerator/templates/IOperations.cs.template @@ -25,7 +25,7 @@ public partial interface I{{name}}Operations /// /// A which can be used to cancel the asynchronous operation. /// - Task"}}> {{GetMethodName api.operation "WithHttpMessagesAsync"}}( + Task"}}> {{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}}, {{ end }} @@ -47,7 +47,7 @@ public partial interface I{{name}}Operations /// /// A which can be used to cancel the asynchronous operation. /// - Task> {{GetMethodName api.operation "WithHttpMessagesAsync"}}( + Task> {{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}}, {{ end }} diff --git a/src/LibKubernetesGenerator/templates/Operations.cs.template b/src/LibKubernetesGenerator/templates/Operations.cs.template index 876ed8a16..d98337ada 100644 --- a/src/LibKubernetesGenerator/templates/Operations.cs.template +++ b/src/LibKubernetesGenerator/templates/Operations.cs.template @@ -10,13 +10,13 @@ public partial class AbstractKubernetes : I{{name}}Operations { {{for api in apis }} {{if IfReturnType api.operation "void"}} - private async Task I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + private async Task I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{end}} {{if IfReturnType api.operation "obj"}} - private async Task> I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + private async Task> I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{end}} {{if IfReturnType api.operation "stream"}} - private async Task> I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + private async Task> I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{end}} {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "false"}}, @@ -90,7 +90,7 @@ public partial class AbstractKubernetes : I{{name}}Operations } /// - async Task"}}> I{{name}}Operations.{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + async Task"}}> I{{name}}Operations.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -98,7 +98,7 @@ public partial class AbstractKubernetes : I{{name}}Operations CancellationToken cancellationToken) { {{if IfReturnType api.operation "void"}} - return await I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + return await I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -106,7 +106,7 @@ public partial class AbstractKubernetes : I{{name}}Operations cancellationToken).ConfigureAwait(false); {{end}} {{if IfReturnType api.operation "obj"}} - return await I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}{{GetReturnType api.operation "<>"}}( + return await I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}{{GetReturnType api.operation "<>"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -114,7 +114,7 @@ public partial class AbstractKubernetes : I{{name}}Operations cancellationToken).ConfigureAwait(false); {{end}} {{if IfReturnType api.operation "stream"}} - return await I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + return await I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -125,14 +125,14 @@ public partial class AbstractKubernetes : I{{name}}Operations {{if IfReturnType api.operation "object"}} /// - async Task> I{{name}}Operations.{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + async Task> I{{name}}Operations.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} IReadOnlyDictionary> customHeaders, CancellationToken cancellationToken) { - return await I{{name}}Operations_{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + return await I{{name}}Operations_{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} diff --git a/src/LibKubernetesGenerator/templates/OperationsExtensions.cs.template b/src/LibKubernetesGenerator/templates/OperationsExtensions.cs.template index 98c304ede..b05f0e243 100644 --- a/src/LibKubernetesGenerator/templates/OperationsExtensions.cs.template +++ b/src/LibKubernetesGenerator/templates/OperationsExtensions.cs.template @@ -23,14 +23,14 @@ public static partial class {{name}}OperationsExtensions /// {{ToXmlDoc api.description}} /// {{ end }} - public static {{GetReturnType api.operation "void"}} {{GetMethodName api.operation ""}}( + public static {{GetReturnType api.operation "void"}} {{GetOperationId api.operation ""}}( this I{{name}}Operations operations {{ for parameter in api.operation.parameters}} ,{{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}} {{end}} ) { - {{GetReturnType api.operation "return"}} operations.{{GetMethodName api.operation "Async"}}( + {{GetReturnType api.operation "return"}} operations.{{GetOperationId api.operation "Async"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -50,14 +50,14 @@ public static partial class {{name}}OperationsExtensions /// {{ToXmlDoc parameter.description}} /// {{end}} - public static T {{GetMethodName api.operation ""}}( + public static T {{GetOperationId api.operation ""}}( this I{{name}}Operations operations {{ for parameter in api.operation.parameters}} ,{{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}} {{end}} ) { - return operations.{{GetMethodName api.operation "Async"}}( + return operations.{{GetOperationId api.operation "Async"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -80,7 +80,7 @@ public static partial class {{name}}OperationsExtensions /// /// A which can be used to cancel the asynchronous operation. /// - public static async Task{{GetReturnType api.operation "<>"}} {{GetMethodName api.operation "Async"}}( + public static async Task{{GetReturnType api.operation "<>"}} {{GetOperationId api.operation "Async"}}( this I{{name}}Operations operations, {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}}, @@ -88,7 +88,7 @@ public static partial class {{name}}OperationsExtensions CancellationToken cancellationToken = default(CancellationToken)) { {{if IfReturnType api.operation "stream"}} - var _result = await operations.{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + var _result = await operations.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -98,7 +98,7 @@ public static partial class {{name}}OperationsExtensions {{GetReturnType api.operation "_result.Body"}}; {{end}} {{if IfReturnType api.operation "obj"}} - using (var _result = await operations.{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + using (var _result = await operations.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -109,7 +109,7 @@ public static partial class {{name}}OperationsExtensions } {{end}} {{if IfReturnType api.operation "void"}} - using (var _result = await operations.{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + using (var _result = await operations.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} @@ -135,14 +135,14 @@ public static partial class {{name}}OperationsExtensions /// /// A which can be used to cancel the asynchronous operation. /// - public static async Task {{GetMethodName api.operation "Async"}}( + public static async Task {{GetOperationId api.operation "Async"}}( this I{{name}}Operations operations, {{ for parameter in api.operation.parameters}} {{GetDotNetTypeOpenApiParameter parameter}} {{GetDotNetNameOpenApiParameter parameter "true"}}, {{ end }} CancellationToken cancellationToken = default(CancellationToken)) { - using (var _result = await operations.{{GetMethodName api.operation "WithHttpMessagesAsync"}}( + using (var _result = await operations.{{GetOperationId api.operation "WithHttpMessagesAsync"}}( {{ for parameter in api.operation.parameters}} {{GetDotNetNameOpenApiParameter parameter "false"}}, {{end}} diff --git a/src/nuget.proj b/src/nuget.proj index feec6cda8..1f4213256 100644 --- a/src/nuget.proj +++ b/src/nuget.proj @@ -3,6 +3,5 @@ - diff --git a/swagger.json b/swagger.json index c933c42b2..7bb0ceeee 100644 --- a/swagger.json +++ b/swagger.json @@ -907,7 +907,7 @@ "description": "MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)", "properties": { "excludeResourceRules": { - "description": "ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)", + "description": "ExcludeResourceRules describes what operations on what resources/subresources the policy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)", "items": { "$ref": "#/definitions/v1alpha1.NamedRuleWithOperations" }, @@ -915,7 +915,7 @@ "x-kubernetes-list-type": "atomic" }, "matchPolicy": { - "description": "matchPolicy defines how the \"MatchResources\" list is used to match incoming requests. Allowed values are \"Exact\" or \"Equivalent\".\n\n- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy.\n\n- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy.\n\nDefaults to \"Equivalent\"", + "description": "matchPolicy defines how the \"MatchResources\" list is used to match incoming requests. Allowed values are \"Exact\" or \"Equivalent\".\n\n- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`, the admission policy does not consider requests to apps/v1beta1 or extensions/v1beta1 API groups.\n\n- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`, the admission policy **does** consider requests made to apps/v1beta1 or extensions/v1beta1 API groups. The API server translates the request to a matched resource API if necessary.\n\nDefaults to \"Equivalent\"", "type": "string" }, "namespaceSelector": { @@ -924,10 +924,10 @@ }, "objectSelector": { "$ref": "#/definitions/v1.LabelSelector", - "description": "ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything." + "description": "ObjectSelector decides whether to run the policy based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the policy's expression (CEL), and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything." }, "resourceRules": { - "description": "ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule.", + "description": "ResourceRules describes what operations on what resources/subresources the admission policy matches. The policy cares about an operation if it matches _any_ Rule.", "items": { "$ref": "#/definitions/v1alpha1.NamedRuleWithOperations" }, @@ -2357,7 +2357,7 @@ "description": "DeploymentStatus is the most recently observed status of the Deployment.", "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.", + "description": "Total number of available non-terminating pods (ready for at least minReadySeconds) targeted by this deployment.", "format": "int32", "type": "integer" }, @@ -2385,12 +2385,17 @@ "type": "integer" }, "readyReplicas": { - "description": "readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.", + "description": "Total number of non-terminating pods targeted by this Deployment with a Ready Condition.", "format": "int32", "type": "integer" }, "replicas": { - "description": "Total number of non-terminated pods targeted by this deployment (their labels match the selector).", + "description": "Total number of non-terminating pods targeted by this deployment (their labels match the selector).", + "format": "int32", + "type": "integer" + }, + "terminatingReplicas": { + "description": "Total number of terminating pods targeted by this deployment. Terminating pods have a non-null .metadata.deletionTimestamp and have not yet reached the Failed or Succeeded .status.phase.\n\nThis is an alpha field. Enable DeploymentReplicaSetTerminatingReplicas to be able to use this field.", "format": "int32", "type": "integer" }, @@ -2400,7 +2405,7 @@ "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this deployment that have the desired template spec.", + "description": "Total number of non-terminating pods targeted by this deployment that have the desired template spec.", "format": "int32", "type": "integer" } @@ -2493,7 +2498,7 @@ "type": "string" }, "items": { - "description": "List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller", + "description": "List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset", "items": { "$ref": "#/definitions/v1.ReplicaSet" }, @@ -2529,7 +2534,7 @@ "type": "integer" }, "replicas": { - "description": "Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller", + "description": "Replicas is the number of desired pods. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset", "format": "int32", "type": "integer" }, @@ -2539,7 +2544,7 @@ }, "template": { "$ref": "#/definitions/v1.PodTemplateSpec", - "description": "Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template" + "description": "Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/#pod-template" } }, "required": [ @@ -2551,7 +2556,7 @@ "description": "ReplicaSetStatus represents the current status of a ReplicaSet.", "properties": { "availableReplicas": { - "description": "The number of available replicas (ready for at least minReadySeconds) for this replica set.", + "description": "The number of available non-terminating pods (ready for at least minReadySeconds) for this replica set.", "format": "int32", "type": "integer" }, @@ -2569,7 +2574,7 @@ "x-kubernetes-patch-strategy": "merge" }, "fullyLabeledReplicas": { - "description": "The number of pods that have labels matching the labels of the pod template of the replicaset.", + "description": "The number of non-terminating pods that have labels matching the labels of the pod template of the replicaset.", "format": "int32", "type": "integer" }, @@ -2579,12 +2584,17 @@ "type": "integer" }, "readyReplicas": { - "description": "readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.", + "description": "The number of non-terminating pods targeted by this ReplicaSet with a Ready Condition.", "format": "int32", "type": "integer" }, "replicas": { - "description": "Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller", + "description": "Replicas is the most recently observed number of non-terminating pods. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset", + "format": "int32", + "type": "integer" + }, + "terminatingReplicas": { + "description": "The number of terminating pods for this replica set. Terminating pods have a non-null .metadata.deletionTimestamp and have not yet reached the Failed or Succeeded .status.phase.\n\nThis is an alpha field. Enable DeploymentReplicaSetTerminatingReplicas to be able to use this field.", "format": "int32", "type": "integer" } @@ -2818,8 +2828,7 @@ }, "required": [ "selector", - "template", - "serviceName" + "template" ], "type": "object" }, @@ -3156,45 +3165,6 @@ }, "type": "object" }, - "v1beta1.SelfSubjectReview": { - "description": "SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.", - "properties": { - "apiVersion": { - "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", - "type": "string" - }, - "kind": { - "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", - "type": "string" - }, - "metadata": { - "$ref": "#/definitions/v1.ObjectMeta", - "description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" - }, - "status": { - "$ref": "#/definitions/v1beta1.SelfSubjectReviewStatus", - "description": "Status is filled in by the server with the user attributes." - } - }, - "type": "object", - "x-kubernetes-group-version-kind": [ - { - "group": "authentication.k8s.io", - "kind": "SelfSubjectReview", - "version": "v1beta1" - } - ] - }, - "v1beta1.SelfSubjectReviewStatus": { - "description": "SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user.", - "properties": { - "userInfo": { - "$ref": "#/definitions/v1.UserInfo", - "description": "User attributes of the user making this request." - } - }, - "type": "object" - }, "v1.FieldSelectorAttributes": { "description": "FieldSelectorAttributes indicates a field limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.", "properties": { @@ -3968,10 +3938,10 @@ "type": "object" }, "v2.HPAScalingRules": { - "description": "HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.", + "description": "HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.\n\nScaling Policy Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.\n\nThe tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires enabling the alpha HPAConfigurableTolerance feature gate.)", "properties": { "policies": { - "description": "policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid", + "description": "policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.", "items": { "$ref": "#/definitions/v2.HPAScalingPolicy" }, @@ -3986,6 +3956,10 @@ "description": "stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).", "format": "int32", "type": "integer" + }, + "tolerance": { + "$ref": "#/definitions/resource.Quantity", + "description": "tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%).\n\nFor example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi.\n\nThis is an alpha field and requires enabling the HPAConfigurableTolerance feature gate." } }, "type": "object" @@ -4690,7 +4664,7 @@ "type": "integer" }, "backoffLimitPerIndex": { - "description": "Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).", + "description": "Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable.", "format": "int32", "type": "integer" }, @@ -4712,7 +4686,7 @@ "type": "boolean" }, "maxFailedIndexes": { - "description": "Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).", + "description": "Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5.", "format": "int32", "type": "integer" }, @@ -4735,7 +4709,7 @@ }, "successPolicy": { "$ref": "#/definitions/v1.SuccessPolicy", - "description": "successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated.\n\nThis field is beta-level. To use this field, you must enable the `JobSuccessPolicy` feature gate (enabled by default)." + "description": "successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated." }, "suspend": { "description": "suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.", @@ -4789,7 +4763,7 @@ "type": "integer" }, "failedIndexes": { - "description": "FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as \"1,3-5,7\". The set of failed indexes cannot overlap with the set of completed indexes.\n\nThis field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).", + "description": "FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as \"1,3-5,7\". The set of failed indexes cannot overlap with the set of completed indexes.", "type": "string" }, "ready": { @@ -4899,7 +4873,7 @@ "description": "PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.", "properties": { "action": { - "description": "Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:\n\n- FailJob: indicates that the pod's job is marked as Failed and all\n running pods are terminated.\n- FailIndex: indicates that the pod's index is marked as Failed and will\n not be restarted.\n This value is beta-level. It can be used when the\n `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).\n- Ignore: indicates that the counter towards the .backoffLimit is not\n incremented and a replacement pod is created.\n- Count: indicates that the pod is handled in the default way - the\n counter towards the .backoffLimit is incremented.\nAdditional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.", + "description": "Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:\n\n- FailJob: indicates that the pod's job is marked as Failed and all\n running pods are terminated.\n- FailIndex: indicates that the pod's index is marked as Failed and will\n not be restarted.\n- Ignore: indicates that the counter towards the .backoffLimit is not\n incremented and a replacement pod is created.\n- Count: indicates that the pod is handled in the default way - the\n counter towards the .backoffLimit is incremented.\nAdditional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.", "type": "string" }, "onExitCodes": { @@ -5245,6 +5219,90 @@ ], "type": "object" }, + "v1beta1.ClusterTrustBundle": { + "description": "ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).\n\nClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the `clusterTrustBundle` projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.\n\nIt can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ObjectMeta", + "description": "metadata contains the object metadata." + }, + "spec": { + "$ref": "#/definitions/v1beta1.ClusterTrustBundleSpec", + "description": "spec contains the signer (if any) and trust anchors." + } + }, + "required": [ + "spec" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "certificates.k8s.io", + "kind": "ClusterTrustBundle", + "version": "v1beta1" + } + ] + }, + "v1beta1.ClusterTrustBundleList": { + "description": "ClusterTrustBundleList is a collection of ClusterTrustBundle objects", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "items": { + "description": "items is a collection of ClusterTrustBundle objects", + "items": { + "$ref": "#/definitions/v1beta1.ClusterTrustBundle" + }, + "type": "array" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ListMeta", + "description": "metadata contains the list metadata." + } + }, + "required": [ + "items" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "certificates.k8s.io", + "kind": "ClusterTrustBundleList", + "version": "v1beta1" + } + ] + }, + "v1beta1.ClusterTrustBundleSpec": { + "description": "ClusterTrustBundleSpec contains the signer and trust anchors.", + "properties": { + "signerName": { + "description": "signerName indicates the associated signer, if any.\n\nIn order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission: group=certificates.k8s.io resource=signers resourceName= verb=attest.\n\nIf signerName is not empty, then the ClusterTrustBundle object must be named with the signer name as a prefix (translating slashes to colons). For example, for the signer name `example.com/foo`, valid ClusterTrustBundle object names include `example.com:foo:abc` and `example.com:foo:v1`.\n\nIf signerName is empty, then the ClusterTrustBundle object's name must not have such a prefix.\n\nList/watch requests for ClusterTrustBundles can filter on this field using a `spec.signerName=NAME` field selector.", + "type": "string" + }, + "trustBundle": { + "description": "trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates.\n\nThe data must consist only of PEM certificate blocks that parse as valid X.509 certificates. Each certificate must include a basic constraints extension with the CA bit set. The API server will reject objects that contain duplicate certificates, or that use PEM block headers.\n\nUsers of ClusterTrustBundles, including Kubelet, are free to reorder and deduplicate certificate blocks in this file according to their own logic, as well as to drop PEM block headers and inter-block data.", + "type": "string" + } + }, + "required": [ + "trustBundle" + ], + "type": "object" + }, "v1.Lease": { "description": "Lease defines a lease concept.", "properties": { @@ -5437,7 +5495,108 @@ "type": "string" }, "strategy": { - "description": "Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.", + "description": "Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved.", + "type": "string" + } + }, + "required": [ + "leaseName", + "binaryVersion", + "strategy" + ], + "type": "object" + }, + "v1beta1.LeaseCandidate": { + "description": "LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ObjectMeta", + "description": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" + }, + "spec": { + "$ref": "#/definitions/v1beta1.LeaseCandidateSpec", + "description": "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + } + }, + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "coordination.k8s.io", + "kind": "LeaseCandidate", + "version": "v1beta1" + } + ] + }, + "v1beta1.LeaseCandidateList": { + "description": "LeaseCandidateList is a list of Lease objects.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "items": { + "description": "items is a list of schema objects.", + "items": { + "$ref": "#/definitions/v1beta1.LeaseCandidate" + }, + "type": "array" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ListMeta", + "description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" + } + }, + "required": [ + "items" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "coordination.k8s.io", + "kind": "LeaseCandidateList", + "version": "v1beta1" + } + ] + }, + "v1beta1.LeaseCandidateSpec": { + "description": "LeaseCandidateSpec is a specification of a Lease.", + "properties": { + "binaryVersion": { + "description": "BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required.", + "type": "string" + }, + "emulationVersion": { + "description": "EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is \"OldestEmulationVersion\"", + "type": "string" + }, + "leaseName": { + "description": "LeaseName is the name of the lease for which this candidate is contending. The limits on this field are the same as on Lease.name. Multiple lease candidates may reference the same Lease.name. This field is immutable.", + "type": "string" + }, + "pingTime": { + "description": "PingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime.", + "format": "date-time", + "type": "string" + }, + "renewTime": { + "description": "RenewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates.", + "format": "date-time", + "type": "string" + }, + "strategy": { + "description": "Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved.", "type": "string" } }, @@ -6588,6 +6747,10 @@ "$ref": "#/definitions/v1.ContainerState", "description": "State holds details about the container's current condition." }, + "stopSignal": { + "description": "StopSignal reports the effective stop signal for this container", + "type": "string" + }, "user": { "$ref": "#/definitions/v1.ContainerUser", "description": "User represents user identity information initially attached to the first process of the container" @@ -6713,7 +6876,7 @@ "type": "object" }, "v1.EndpointAddress": { - "description": "EndpointAddress is a tuple that describes single IP address.", + "description": "EndpointAddress is a tuple that describes single IP address. Deprecated: This API is deprecated in v1.33+.", "properties": { "hostname": { "description": "The Hostname of this endpoint", @@ -6739,7 +6902,7 @@ "x-kubernetes-map-type": "atomic" }, "core.v1.EndpointPort": { - "description": "EndpointPort is a tuple that describes a single port.", + "description": "EndpointPort is a tuple that describes a single port. Deprecated: This API is deprecated in v1.33+.", "properties": { "appProtocol": { "description": "The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:\n\n* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).\n\n* Kubernetes-defined prefixed names:\n * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-\n * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455\n * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455\n\n* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.", @@ -6766,7 +6929,7 @@ "x-kubernetes-map-type": "atomic" }, "v1.EndpointSubset": { - "description": "EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:\n\n\t{\n\t Addresses: [{\"ip\": \"10.10.1.1\"}, {\"ip\": \"10.10.2.2\"}],\n\t Ports: [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n\t}\n\nThe resulting set of endpoints can be viewed as:\n\n\ta: [ 10.10.1.1:8675, 10.10.2.2:8675 ],\n\tb: [ 10.10.1.1:309, 10.10.2.2:309 ]", + "description": "EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:\n\n\t{\n\t Addresses: [{\"ip\": \"10.10.1.1\"}, {\"ip\": \"10.10.2.2\"}],\n\t Ports: [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n\t}\n\nThe resulting set of endpoints can be viewed as:\n\n\ta: [ 10.10.1.1:8675, 10.10.2.2:8675 ],\n\tb: [ 10.10.1.1:309, 10.10.2.2:309 ]\n\nDeprecated: This API is deprecated in v1.33+.", "properties": { "addresses": { "description": "IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.", @@ -6796,7 +6959,7 @@ "type": "object" }, "v1.Endpoints": { - "description": "Endpoints is a collection of endpoints that implement the actual service. Example:\n\n\t Name: \"mysvc\",\n\t Subsets: [\n\t {\n\t Addresses: [{\"ip\": \"10.10.1.1\"}, {\"ip\": \"10.10.2.2\"}],\n\t Ports: [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n\t },\n\t {\n\t Addresses: [{\"ip\": \"10.10.3.3\"}],\n\t Ports: [{\"name\": \"a\", \"port\": 93}, {\"name\": \"b\", \"port\": 76}]\n\t },\n\t]", + "description": "Endpoints is a collection of endpoints that implement the actual service. Example:\n\n\t Name: \"mysvc\",\n\t Subsets: [\n\t {\n\t Addresses: [{\"ip\": \"10.10.1.1\"}, {\"ip\": \"10.10.2.2\"}],\n\t Ports: [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n\t },\n\t {\n\t Addresses: [{\"ip\": \"10.10.3.3\"}],\n\t Ports: [{\"name\": \"a\", \"port\": 93}, {\"name\": \"b\", \"port\": 76}]\n\t },\n\t]\n\nEndpoints is a legacy API and does not contain information about all Service features. Use discoveryv1.EndpointSlice for complete information about Service endpoints.\n\nDeprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -6829,7 +6992,7 @@ ] }, "v1.EndpointsList": { - "description": "EndpointsList is a list of endpoints.", + "description": "EndpointsList is a list of endpoints. Deprecated: This API is deprecated in v1.33+.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -6864,14 +7027,14 @@ ] }, "v1.EnvFromSource": { - "description": "EnvFromSource represents the source of a set of ConfigMaps", + "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets", "properties": { "configMapRef": { "$ref": "#/definitions/v1.ConfigMapEnvSource", "description": "The ConfigMap to select from" }, "prefix": { - "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", + "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.", "type": "string" }, "secretRef": { @@ -7759,6 +7922,10 @@ "preStop": { "$ref": "#/definitions/v1.LifecycleHandler", "description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + }, + "stopSignal": { + "description": "StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name", + "type": "string" } }, "type": "object" @@ -8614,6 +8781,17 @@ }, "type": "object" }, + "v1.NodeSwapStatus": { + "description": "NodeSwapStatus represents swap memory information.", + "properties": { + "capacity": { + "description": "Total amount of swap memory in bytes.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, "v1.NodeSystemInfo": { "description": "NodeSystemInfo is a set of ids/uuids to uniquely identify the node.", "properties": { @@ -8653,6 +8831,10 @@ "description": "OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).", "type": "string" }, + "swap": { + "$ref": "#/definitions/v1.NodeSwapStatus", + "description": "Swap Info reported by the node." + }, "systemUUID": { "description": "SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid", "type": "string" @@ -9283,7 +9465,7 @@ "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods." }, "matchLabelKeys": { - "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).", + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, @@ -9291,7 +9473,7 @@ "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { - "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).", + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, @@ -9359,6 +9541,11 @@ "description": "Human-readable message indicating details about last transition.", "type": "string" }, + "observedGeneration": { + "description": "If set, this represents the .metadata.generation that the pod condition was set based upon. This is an alpha field. Enable PodObservedGenerationTracking to be able to use this field.", + "format": "int64", + "type": "integer" + }, "reason": { "description": "Unique, one-word, CamelCase reason for the condition's last transition.", "type": "string" @@ -9718,7 +9905,7 @@ "x-kubernetes-patch-strategy": "merge" }, "initContainers": { - "description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/", + "description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/", "items": { "$ref": "#/definitions/v1.Container" }, @@ -9948,6 +10135,11 @@ "description": "nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.", "type": "string" }, + "observedGeneration": { + "description": "If set, this represents the .metadata.generation that the pod status was set based upon. This is an alpha field. Enable PodObservedGenerationTracking to be able to use this field.", + "format": "int64", + "type": "integer" + }, "phase": { "description": "The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:\n\nPending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase", "type": "string" @@ -9978,7 +10170,7 @@ "type": "string" }, "resize": { - "description": "Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to \"Proposed\"", + "description": "Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to \"Proposed\" Deprecated: Resize status is moved to two pod conditions PodResizePending and PodResizeInProgress. PodResizePending will track states where the spec has been resized, but the Kubelet has not yet allocated the resources. PodResizeInProgress will track in-progress resizes, and should be present whenever allocated resources != acknowledged resources.", "type": "string" }, "resourceClaimStatuses": { @@ -11484,7 +11676,7 @@ "description": "sessionAffinityConfig contains the configurations of session affinity." }, "trafficDistribution": { - "description": "TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to \"PreferClose\", implementations should prioritize endpoints that are topologically close (e.g., same zone). This is a beta field and requires enabling ServiceTrafficDistribution feature.", + "description": "TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to \"PreferClose\", implementations should prioritize endpoints that are in the same zone.", "type": "string" }, "type": { @@ -11745,11 +11937,11 @@ "type": "integer" }, "nodeAffinityPolicy": { - "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.", + "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy.", "type": "string" }, "nodeTaintsPolicy": { - "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.", + "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.", "type": "string" }, "topologyKey": { @@ -11890,7 +12082,7 @@ }, "image": { "$ref": "#/definitions/v1.ImageVolumeSource", - "description": "image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:\n\n- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\n\nThe volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type." + "description": "image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:\n\n- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\n\nThe volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type." }, "iscsi": { "$ref": "#/definitions/v1.ISCSIVolumeSource", @@ -12158,7 +12350,7 @@ "description": "Endpoint represents a single logical \"backend\" implementing a service.", "properties": { "addresses": { - "description": "addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267", + "description": "addresses of this endpoint. For EndpointSlices of addressType \"IPv4\" or \"IPv6\", the values are IP addresses in canonical form. The syntax and semantics of other addressType values are not defined. This must contain at least one address but no more than 100. EndpointSlices generated by the EndpointSlice controller will always have exactly 1 address. No semantics are defined for additional addresses beyond the first, and kube-proxy does not look at them.", "items": { "type": "string" }, @@ -12206,15 +12398,15 @@ "description": "EndpointConditions represents the current condition of an endpoint.", "properties": { "ready": { - "description": "ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be \"true\" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag.", + "description": "ready indicates that this endpoint is ready to receive traffic, according to whatever system is managing the endpoint. A nil value should be interpreted as \"true\". In general, an endpoint should be marked ready if it is serving and not terminating, though this can be overridden in some cases, such as when the associated Service has set the publishNotReadyAddresses flag.", "type": "boolean" }, "serving": { - "description": "serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition.", + "description": "serving indicates that this endpoint is able to receive traffic, according to whatever system is managing the endpoint. For endpoints backed by pods, the EndpointSlice controller will mark the endpoint as serving if the pod's Ready condition is True. A nil value should be interpreted as \"true\".", "type": "boolean" }, "terminating": { - "description": "terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating.", + "description": "terminating indicates that this endpoint is terminating. A nil value should be interpreted as \"false\".", "type": "boolean" } }, @@ -12223,8 +12415,16 @@ "v1.EndpointHints": { "description": "EndpointHints provides hints describing how an endpoint should be consumed.", "properties": { + "forNodes": { + "description": "forNodes indicates the node(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries. This is an Alpha feature and is only used when the PreferSameTrafficDistribution feature gate is enabled.", + "items": { + "$ref": "#/definitions/v1.ForNode" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "forZones": { - "description": "forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.", + "description": "forZones indicates the zone(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.", "items": { "$ref": "#/definitions/v1.ForZone" }, @@ -12246,7 +12446,7 @@ "type": "string" }, "port": { - "description": "port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.", + "description": "port represents the port number of the endpoint. If the EndpointSlice is derived from a Kubernetes service, this must be set to the service's target port. EndpointSlices used for other purposes may have a nil port.", "format": "int32", "type": "integer" }, @@ -12259,10 +12459,10 @@ "x-kubernetes-map-type": "atomic" }, "v1.EndpointSlice": { - "description": "EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.", + "description": "EndpointSlice represents a set of service endpoints. Most EndpointSlices are created by the EndpointSlice controller to represent the Pods selected by Service objects. For a given service there may be multiple EndpointSlice objects which must be joined to produce the full set of endpoints; you can find all of the slices for a given service by listing EndpointSlices in the service's namespace whose `kubernetes.io/service-name` label contains the service's name.", "properties": { "addressType": { - "description": "addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.", + "description": "addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. (Deprecated) The EndpointSlice controller only generates, and kube-proxy only processes, slices of addressType \"IPv4\" and \"IPv6\". No semantics are defined for the \"FQDN\" type.", "type": "string" }, "apiVersion": { @@ -12286,7 +12486,7 @@ "description": "Standard object's metadata." }, "ports": { - "description": "ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates \"all ports\". Each slice may include a maximum of 100 ports.", + "description": "ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. Each slice may include a maximum of 100 ports. Services always have at least 1 port, so EndpointSlices generated by the EndpointSlice controller will likewise always have at least 1 port. EndpointSlices used for other purposes may have an empty ports list.", "items": { "$ref": "#/definitions/discovery.v1.EndpointPort" }, @@ -12342,6 +12542,19 @@ } ] }, + "v1.ForNode": { + "description": "ForNode provides information about which nodes should consume this endpoint.", + "properties": { + "name": { + "description": "name represents the name of the node.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "v1.ForZone": { "description": "ForZone provides information about which zones should consume this endpoint.", "properties": { @@ -13123,6 +13336,83 @@ ], "type": "object" }, + "v1.IPAddress": { + "description": "IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ObjectMeta", + "description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" + }, + "spec": { + "$ref": "#/definitions/v1.IPAddressSpec", + "description": "spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + } + }, + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "networking.k8s.io", + "kind": "IPAddress", + "version": "v1" + } + ] + }, + "v1.IPAddressList": { + "description": "IPAddressList contains a list of IPAddress.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "items": { + "description": "items is the list of IPAddresses.", + "items": { + "$ref": "#/definitions/v1.IPAddress" + }, + "type": "array" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ListMeta", + "description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" + } + }, + "required": [ + "items" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "networking.k8s.io", + "kind": "IPAddressList", + "version": "v1" + } + ] + }, + "v1.IPAddressSpec": { + "description": "IPAddressSpec describe the attributes in an IP Address.", + "properties": { + "parentRef": { + "$ref": "#/definitions/v1.ParentReference", + "description": "ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object." + } + }, + "required": [ + "parentRef" + ], + "type": "object" + }, "v1.IPBlock": { "description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.", "properties": { @@ -13663,6 +13953,32 @@ ], "type": "object" }, + "v1.ParentReference": { + "description": "ParentReference describes a reference to a parent object.", + "properties": { + "group": { + "description": "Group is the group of the object being referenced.", + "type": "string" + }, + "name": { + "description": "Name is the name of the object being referenced.", + "type": "string" + }, + "namespace": { + "description": "Namespace is the namespace of the object being referenced.", + "type": "string" + }, + "resource": { + "description": "Resource is the resource of the object being referenced.", + "type": "string" + } + }, + "required": [ + "resource", + "name" + ], + "type": "object" + }, "v1.ServiceBackendPort": { "description": "ServiceBackendPort is the service port being referenced.", "properties": { @@ -13679,6 +13995,107 @@ "type": "object", "x-kubernetes-map-type": "atomic" }, + "v1.ServiceCIDR": { + "description": "ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ObjectMeta", + "description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" + }, + "spec": { + "$ref": "#/definitions/v1.ServiceCIDRSpec", + "description": "spec is the desired state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + }, + "status": { + "$ref": "#/definitions/v1.ServiceCIDRStatus", + "description": "status represents the current state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + } + }, + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "networking.k8s.io", + "kind": "ServiceCIDR", + "version": "v1" + } + ] + }, + "v1.ServiceCIDRList": { + "description": "ServiceCIDRList contains a list of ServiceCIDR objects.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "items": { + "description": "items is the list of ServiceCIDRs.", + "items": { + "$ref": "#/definitions/v1.ServiceCIDR" + }, + "type": "array" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ListMeta", + "description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" + } + }, + "required": [ + "items" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "networking.k8s.io", + "kind": "ServiceCIDRList", + "version": "v1" + } + ] + }, + "v1.ServiceCIDRSpec": { + "description": "ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.", + "properties": { + "cidrs": { + "description": "CIDRs defines the IP blocks in CIDR notation (e.g. \"192.168.0.0/24\" or \"2001:db8::/64\") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is immutable.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + } + }, + "type": "object" + }, + "v1.ServiceCIDRStatus": { + "description": "ServiceCIDRStatus describes the current state of the ServiceCIDR.", + "properties": { + "conditions": { + "description": "conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR. Current service state", + "items": { + "$ref": "#/definitions/v1.Condition" + }, + "type": "array", + "x-kubernetes-list-map-keys": [ + "type" + ], + "x-kubernetes-list-type": "map", + "x-kubernetes-patch-merge-key": "type", + "x-kubernetes-patch-strategy": "merge" + } + }, + "type": "object" + }, "v1beta1.IPAddress": { "description": "IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1", "properties": { @@ -14107,7 +14524,7 @@ "x-kubernetes-patch-strategy": "replace" }, "unhealthyPodEvictionPolicy": { - "description": "UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type=\"Ready\",status=\"True\".\n\nValid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy.\n\nIfHealthyBudget policy means that running pods (status.phase=\"Running\"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction.\n\nAlwaysAllow policy means that all running pods (status.phase=\"Running\"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction.\n\nAdditional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.\n\nThis field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).", + "description": "UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type=\"Ready\",status=\"True\".\n\nValid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy.\n\nIfHealthyBudget policy means that running pods (status.phase=\"Running\"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction.\n\nAlwaysAllow policy means that all running pods (status.phase=\"Running\"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction.\n\nAdditional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.", "type": "string" } }, @@ -14580,7 +14997,7 @@ "description": "AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it. This may include driver-specific information.", "properties": { "conditions": { - "description": "Conditions contains the latest observation of the device's state. If the device has been configured according to the class and claim config references, the `Ready` condition should be True.", + "description": "Conditions contains the latest observation of the device's state. If the device has been configured according to the class and claim config references, the `Ready` condition should be True.\n\nMust not contain more than 8 entries.", "items": { "$ref": "#/definitions/v1.Condition" }, @@ -14635,6 +15052,10 @@ "v1alpha3.BasicDevice": { "description": "BasicDevice defines one device instance.", "properties": { + "allNodes": { + "description": "AllNodes indicates that all nodes have access to the device.\n\nMust only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.", + "type": "boolean" + }, "attributes": { "additionalProperties": { "$ref": "#/definitions/v1alpha3.DeviceAttribute" @@ -14648,6 +15069,30 @@ }, "description": "Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set.\n\nThe maximum number of attributes and capacities combined is 32.", "type": "object" + }, + "consumesCounters": { + "description": "ConsumesCounters defines a list of references to sharedCounters and the set of counters that the device will consume from those counter sets.\n\nThere can only be a single entry per counterSet.\n\nThe total number of device counter consumption entries must be <= 32. In addition, the total number in the entire ResourceSlice must be <= 1024 (for example, 64 devices with 16 counters each).", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceCounterConsumption" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "nodeName": { + "description": "NodeName identifies the node where the device is available.\n\nMust only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.", + "type": "string" + }, + "nodeSelector": { + "$ref": "#/definitions/v1.NodeSelector", + "description": "NodeSelector defines the nodes where the device is available.\n\nMust only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set." + }, + "taints": { + "description": "If specified, these are the driver-defined taints.\n\nThe maximum number of taints is 4.\n\nThis is an alpha field and requires enabling the DRADeviceTaints feature gate.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceTaint" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" } }, "type": "object" @@ -14665,6 +15110,40 @@ ], "type": "object" }, + "v1alpha3.Counter": { + "description": "Counter describes a quantity associated with a device.", + "properties": { + "value": { + "$ref": "#/definitions/resource.Quantity", + "description": "Value defines how much of a certain device counter is available." + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "v1alpha3.CounterSet": { + "description": "CounterSet defines a named set of counters that are available to be used by devices defined in the ResourceSlice.\n\nThe counters are not allocatable by themselves, but can be referenced by devices. When a device is allocated, the portion of counters it uses will no longer be available for use by other devices.", + "properties": { + "counters": { + "additionalProperties": { + "$ref": "#/definitions/v1alpha3.Counter" + }, + "description": "Counters defines the counters that will be consumed by the device. The name of each counter must be unique in that set and must be a DNS label.\n\nTo ensure this uniqueness, capacities defined by the vendor must be listed without the driver name as domain prefix in their name. All others must be listed with their domain prefix.\n\nThe maximum number of counters is 32.", + "type": "object" + }, + "name": { + "description": "CounterSet is the name of the set from which the counters defined will be consumed.", + "type": "string" + } + }, + "required": [ + "name", + "counters" + ], + "type": "object" + }, "v1alpha3.Device": { "description": "Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.", "properties": { @@ -14690,7 +15169,7 @@ "description": "Opaque provides driver-specific configuration parameters." }, "requests": { - "description": "Requests lists the names of requests where the configuration applies. If empty, its applies to all requests.", + "description": "Requests lists the names of requests where the configuration applies. If empty, its applies to all requests.\n\nReferences to subrequests must include the name of the main request and may include the subrequest using the format
[/]. If just the main request is given, the configuration applies to all subrequests.", "items": { "type": "string" }, @@ -14790,7 +15269,7 @@ "description": "Opaque provides driver-specific configuration parameters." }, "requests": { - "description": "Requests lists the names of requests where the configuration applies. If empty, it applies to all requests.", + "description": "Requests lists the names of requests where the configuration applies. If empty, it applies to all requests.\n\nReferences to subrequests must include the name of the main request and may include the subrequest using the format
[/]. If just the main request is given, the configuration applies to all subrequests.", "items": { "type": "string" }, @@ -14907,7 +15386,7 @@ "type": "string" }, "requests": { - "description": "Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim.", + "description": "Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim.\n\nReferences to subrequests must include the name of the main request and may include the subrequest using the format
[/]. If just the main request is given, the constraint applies to all subrequests.", "items": { "type": "string" }, @@ -14917,42 +15396,78 @@ }, "type": "object" }, + "v1alpha3.DeviceCounterConsumption": { + "description": "DeviceCounterConsumption defines a set of counters that a device will consume from a CounterSet.", + "properties": { + "counterSet": { + "description": "CounterSet defines the set from which the counters defined will be consumed.", + "type": "string" + }, + "counters": { + "additionalProperties": { + "$ref": "#/definitions/v1alpha3.Counter" + }, + "description": "Counters defines the Counter that will be consumed by the device.\n\nThe maximum number counters in a device is 32. In addition, the maximum number of all counters in all devices is 1024 (for example, 64 devices with 16 counters each).", + "type": "object" + } + }, + "required": [ + "counterSet", + "counters" + ], + "type": "object" + }, "v1alpha3.DeviceRequest": { - "description": "DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.\n\nA DeviceClassName is currently required. Clients must check that it is indeed set. It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request.", + "description": "DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.", "properties": { "adminAccess": { - "description": "AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations.\n\nThis is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.", + "description": "AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations.\n\nThis field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.\n\nThis is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.", "type": "boolean" }, "allocationMode": { - "description": "AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:\n\n- ExactCount: This request is for a specific number of devices.\n This is the default. The exact number is provided in the\n count field.\n\n- All: This request is for all of the matching devices in a pool.\n Allocation will fail if some devices are already allocated,\n unless adminAccess is requested.\n\nIf AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.\n\nMore modes may get added in the future. Clients must refuse to handle requests with unknown modes.", + "description": "AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:\n\n- ExactCount: This request is for a specific number of devices.\n This is the default. The exact number is provided in the\n count field.\n\n- All: This request is for all of the matching devices in a pool.\n At least one device must exist on the node for the allocation to succeed.\n Allocation will fail if some devices are already allocated,\n unless adminAccess is requested.\n\nIf AllocationMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.\n\nThis field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.\n\nMore modes may get added in the future. Clients must refuse to handle requests with unknown modes.", "type": "string" }, "count": { - "description": "Count is used only when the count mode is \"ExactCount\". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.", + "description": "Count is used only when the count mode is \"ExactCount\". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.\n\nThis field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.", "format": "int64", "type": "integer" }, "deviceClassName": { - "description": "DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.\n\nA class is required. Which classes are available depends on the cluster.\n\nAdministrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.", + "description": "DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.\n\nA class is required if no subrequests are specified in the firstAvailable list and no class can be set if subrequests are specified in the firstAvailable list. Which classes are available depends on the cluster.\n\nAdministrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.", "type": "string" }, + "firstAvailable": { + "description": "FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request. It tries to satisfy them in the order in which they are listed here. So if there are two entries in the list, the scheduler will only check the second one if it determines that the first one cannot be used.\n\nThis field may only be set in the entries of DeviceClaim.Requests.\n\nDRA does not yet implement scoring, so the scheduler will select the first set of devices that satisfies all the requests in the claim. And if the requirements can be satisfied on more than one node, other scheduling features will determine which node is chosen. This means that the set of devices allocated to a claim might not be the optimal set available to the cluster. Scoring will be implemented later.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceSubRequest" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "name": { "description": "Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.\n\nMust be a DNS label.", "type": "string" }, "selectors": { - "description": "Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.", + "description": "Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.\n\nThis field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.", "items": { "$ref": "#/definitions/v1alpha3.DeviceSelector" }, "type": "array", "x-kubernetes-list-type": "atomic" + }, + "tolerations": { + "description": "If specified, the request's tolerations.\n\nTolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute.\n\nIn addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated.\n\nThe maximum number of tolerations is 16.\n\nThis field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.\n\nThis is an alpha field and requires enabling the DRADeviceTaints feature gate.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceToleration" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" } }, "required": [ - "name", - "deviceClassName" + "name" ], "type": "object" }, @@ -14976,8 +15491,16 @@ "type": "string" }, "request": { - "description": "Request is the name of the request in the claim which caused this device to be allocated. Multiple devices may have been allocated per request.", + "description": "Request is the name of the request in the claim which caused this device to be allocated. If it references a subrequest in the firstAvailable list on a DeviceRequest, this field must include both the name of the main request and the subrequest using the format
/.\n\nMultiple devices may have been allocated per request.", "type": "string" + }, + "tolerations": { + "description": "A copy of all tolerations specified in the request at the time when the device got allocated.\n\nThe maximum number of tolerations is 16.\n\nThis is an alpha field and requires enabling the DRADeviceTaints feature gate.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceToleration" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" } }, "required": [ @@ -14998,6 +15521,217 @@ }, "type": "object" }, + "v1alpha3.DeviceSubRequest": { + "description": "DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices.\n\nDeviceSubRequest is similar to Request, but doesn't expose the AdminAccess or FirstAvailable fields, as those can only be set on the top-level request. AdminAccess is not supported for requests with a prioritized list, and recursive FirstAvailable fields are not supported.", + "properties": { + "allocationMode": { + "description": "AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:\n\n- ExactCount: This request is for a specific number of devices.\n This is the default. The exact number is provided in the\n count field.\n\n- All: This request is for all of the matching devices in a pool.\n Allocation will fail if some devices are already allocated,\n unless adminAccess is requested.\n\nIf AllocationMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.\n\nMore modes may get added in the future. Clients must refuse to handle requests with unknown modes.", + "type": "string" + }, + "count": { + "description": "Count is used only when the count mode is \"ExactCount\". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.", + "format": "int64", + "type": "integer" + }, + "deviceClassName": { + "description": "DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest.\n\nA class is required. Which classes are available depends on the cluster.\n\nAdministrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.", + "type": "string" + }, + "name": { + "description": "Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format
/.\n\nMust be a DNS label.", + "type": "string" + }, + "selectors": { + "description": "Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceSelector" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "tolerations": { + "description": "If specified, the request's tolerations.\n\nTolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute.\n\nIn addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated.\n\nThe maximum number of tolerations is 16.\n\nThis is an alpha field and requires enabling the DRADeviceTaints feature gate.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceToleration" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + } + }, + "required": [ + "name", + "deviceClassName" + ], + "type": "object" + }, + "v1alpha3.DeviceTaint": { + "description": "The device this taint is attached to has the \"effect\" on any claim which does not tolerate the taint and, through the claim, to pods using the claim.", + "properties": { + "effect": { + "description": "The effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them. Valid effects are NoSchedule and NoExecute. PreferNoSchedule as used for nodes is not valid here.", + "type": "string" + }, + "key": { + "description": "The taint key to be applied to a device. Must be a label name.", + "type": "string" + }, + "timeAdded": { + "description": "TimeAdded represents the time at which the taint was added. Added automatically during create or update if not set.", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The taint value corresponding to the taint key. Must be a label value.", + "type": "string" + } + }, + "required": [ + "key", + "effect" + ], + "type": "object" + }, + "v1alpha3.DeviceTaintRule": { + "description": "DeviceTaintRule adds one taint to all devices which match the selector. This has the same effect as if the taint was specified directly in the ResourceSlice by the DRA driver.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ObjectMeta", + "description": "Standard object metadata" + }, + "spec": { + "$ref": "#/definitions/v1alpha3.DeviceTaintRuleSpec", + "description": "Spec specifies the selector and one taint.\n\nChanging the spec automatically increments the metadata.generation number." + } + }, + "required": [ + "spec" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "resource.k8s.io", + "kind": "DeviceTaintRule", + "version": "v1alpha3" + } + ] + }, + "v1alpha3.DeviceTaintRuleList": { + "description": "DeviceTaintRuleList is a collection of DeviceTaintRules.", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "items": { + "description": "Items is the list of DeviceTaintRules.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceTaintRule" + }, + "type": "array" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/v1.ListMeta", + "description": "Standard list metadata" + } + }, + "required": [ + "items" + ], + "type": "object", + "x-kubernetes-group-version-kind": [ + { + "group": "resource.k8s.io", + "kind": "DeviceTaintRuleList", + "version": "v1alpha3" + } + ] + }, + "v1alpha3.DeviceTaintRuleSpec": { + "description": "DeviceTaintRuleSpec specifies the selector and one taint.", + "properties": { + "deviceSelector": { + "$ref": "#/definitions/v1alpha3.DeviceTaintSelector", + "description": "DeviceSelector defines which device(s) the taint is applied to. All selector criteria must be satified for a device to match. The empty selector matches all devices. Without a selector, no devices are matches." + }, + "taint": { + "$ref": "#/definitions/v1alpha3.DeviceTaint", + "description": "The taint that gets applied to matching devices." + } + }, + "required": [ + "taint" + ], + "type": "object" + }, + "v1alpha3.DeviceTaintSelector": { + "description": "DeviceTaintSelector defines which device(s) a DeviceTaintRule applies to. The empty selector matches all devices. Without a selector, no devices are matched.", + "properties": { + "device": { + "description": "If device is set, only devices with that name are selected. This field corresponds to slice.spec.devices[].name.\n\nSetting also driver and pool may be required to avoid ambiguity, but is not required.", + "type": "string" + }, + "deviceClassName": { + "description": "If DeviceClassName is set, the selectors defined there must be satisfied by a device to be selected. This field corresponds to class.metadata.name.", + "type": "string" + }, + "driver": { + "description": "If driver is set, only devices from that driver are selected. This fields corresponds to slice.spec.driver.", + "type": "string" + }, + "pool": { + "description": "If pool is set, only devices in that pool are selected.\n\nAlso setting the driver name may be useful to avoid ambiguity when different drivers use the same pool name, but this is not required because selecting pools from different drivers may also be useful, for example when drivers with node-local devices use the node name as their pool name.", + "type": "string" + }, + "selectors": { + "description": "Selectors contains the same selection criteria as a ResourceClaim. Currently, CEL expressions are supported. All of these selectors must be satisfied.", + "items": { + "$ref": "#/definitions/v1alpha3.DeviceSelector" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + } + }, + "type": "object" + }, + "v1alpha3.DeviceToleration": { + "description": "The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple using the matching operator .", + "properties": { + "effect": { + "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.", + "type": "string" + }, + "key": { + "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. Must be a label name.", + "type": "string" + }, + "operator": { + "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a ResourceClaim can tolerate all taints of a particular category.", + "type": "string" + }, + "tolerationSeconds": { + "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. If larger than zero, the time when the pod needs to be evicted is calculated as