Merge branch 'master' into style_fix0

Author: tg123

examples/metrics/Program.cs

@@ -0,0 +1,60 @@
+using k8s;
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace metrics
+{
+    internal class Program
+    {
+        private static async Task NodesMetrics(IKubernetes client)
+        {
+            var nodesMetrics = await client.GetKubernetesNodesMetricsAsync().ConfigureAwait(false);
+
+            foreach (var item in nodesMetrics.Items)
+            {
+                Console.WriteLine(item.Metadata.Name);
+
+                foreach (var metric in item.Usage)
+                {
+                    Console.WriteLine($"{metric.Key}: {metric.Value}");
+                }
+            }
+        }
+
+        private static async Task PodsMetrics(IKubernetes client)
+        {
+            var podsMetrics = await client.GetKubernetesPodsMetricsAsync().ConfigureAwait(false);
+
+            if (!podsMetrics.Items.Any())
+            {
+                Console.WriteLine("Empty");
+            }
+
+            foreach (var item in podsMetrics.Items)
+            {
+                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);
+            }
+        }
+
+        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);
+        }
+    }
+}

examples/metrics/metrics.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\KubernetesClient\KubernetesClient.csproj" />
+  </ItemGroup>
+
+
+</Project>

kubernetes-client.sln

@@ -35,6 +35,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "patch", "examples\patch\pat
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "httpClientFactory", "examples\httpClientFactory\httpClientFactory.csproj", "{A07314A0-02E8-4F36-B233-726D59D28F08}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "metrics", "examples\metrics\metrics.csproj", "{B9647AD4-F6B0-406F-8B79-6781E31600EC}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -189,6 +191,18 @@ Global
 		{A07314A0-02E8-4F36-B233-726D59D28F08}.Release|x64.Build.0 = Release|Any CPU
 		{A07314A0-02E8-4F36-B233-726D59D28F08}.Release|x86.ActiveCfg = Release|Any CPU
 		{A07314A0-02E8-4F36-B233-726D59D28F08}.Release|x86.Build.0 = Release|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Debug|x64.Build.0 = Debug|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Debug|x86.Build.0 = Debug|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Release|x64.ActiveCfg = Release|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Release|x64.Build.0 = Release|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Release|x86.ActiveCfg = Release|Any CPU
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -206,6 +220,7 @@ Global
 		{542DC30E-FDF7-4A35-B026-6C21F435E8B1} = {879F8787-C3BB-43F3-A92D-6D4C7D3A5285}
 		{04DE2C84-117D-4E21-8B45-B7AE627697BD} = {B70AFB57-57C9-46DC-84BE-11B7DDD34B40}
 		{A07314A0-02E8-4F36-B233-726D59D28F08} = {B70AFB57-57C9-46DC-84BE-11B7DDD34B40}
+		{B9647AD4-F6B0-406F-8B79-6781E31600EC} = {B70AFB57-57C9-46DC-84BE-11B7DDD34B40}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {049A763A-C891-4E8D-80CF-89DD3E22ADC7}

src/KubernetesClient/ContainerMetrics.cs

@@ -0,0 +1,23 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace k8s.Models
+{
+    /// <summary>
+    /// Describes the resource usage metrics of a container pull from metrics server API.
+    /// </summary>
+    public class ContainerMetrics
+    {
+        /// <summary>
+        /// Defines container name corresponding to the one from pod.spec.containers.
+        /// </summary>
+        [JsonProperty(PropertyName = "name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The resource usage.
+        /// </summary>
+        [JsonProperty(PropertyName = "usage")]
+        public IDictionary<string, ResourceQuantity> Usage { get; set; }
+    }
+}

src/KubernetesClient/KubeConfigModels/ExternalExecution.cs

@@ -17,7 +17,7 @@ public class ExternalExecution
         /// Environment variables to set when executing the plugin. Optional.
         /// </summary>
         [YamlMember(Alias = "env")]
-        public IDictionary<string, string> EnvironmentVariables { get; set; }
+        public IList<Dictionary<string, string>> EnvironmentVariables { get; set; }
 
         /// <summary>
         /// Arguments to pass when executing the plugin. Optional.

src/KubernetesClient/KubernetesClientConfiguration.ConfigFile.cs

@@ -1,9 +1,7 @@
 using System;
 using System.Collections.Generic;
-#if NETSTANDARD2_0
 using Newtonsoft.Json;
 using System.Diagnostics;
-#endif
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
@@ -378,7 +376,6 @@ private void SetUserDetails(K8SConfiguration k8SConfig, Context activeContext)
                 }
             }
 
-#if NETSTANDARD2_0
             if (userDetails.UserCredentials.ExternalExecution != null)
             {
                 if (string.IsNullOrWhiteSpace(userDetails.UserCredentials.ExternalExecution.Command))
@@ -392,12 +389,16 @@ private void SetUserDetails(K8SConfiguration k8SConfig, Context activeContext)
                     throw new KubeConfigException("External command execution missing ApiVersion key");
                 }
 
-                var token = ExecuteExternalCommand(userDetails.UserCredentials.ExternalExecution);
-                AccessToken = token;
+                var (accessToken, clientCertificateData, clientCertificateKeyData) = ExecuteExternalCommand(userDetails.UserCredentials.ExternalExecution);
+                AccessToken = accessToken;
+                // When reading ClientCertificateData from a config file it will be base64 encoded, and code later in the system (see CertUtils.GeneratePfx)
+                // expects ClientCertificateData and ClientCertificateKeyData to be base64 encoded because of this. However the string returned by external
+                // auth providers is the raw certificate and key PEM text, so we need to take that and base64 encoded it here so it can be decoded later.
+                ClientCertificateData = clientCertificateData == null ? null : Convert.ToBase64String(System.Text.Encoding.ASCII.GetBytes(clientCertificateData));
+                ClientCertificateKeyData = clientCertificateKeyData == null ? null : Convert.ToBase64String(System.Text.Encoding.ASCII.GetBytes(clientCertificateKeyData));
 
                 userCredentialsFound = true;
             }
-#endif
 
             if (!userCredentialsFound)
             {
@@ -411,17 +412,7 @@ public static string RenewAzureToken(string tenantId, string clientId, string ap
             throw new KubeConfigException("Refresh not supported.");
         }
 
-#if NETSTANDARD2_0
-        /// <summary>
-        /// Implementation of the proposal for out-of-tree client
-        /// authentication providers as described here --
-        /// https://github.com/kubernetes/community/blob/master/contributors/design-proposals/auth/kubectl-exec-plugins.md
-        /// Took inspiration from python exec_provider.py --
-        /// https://github.com/kubernetes-client/python-base/blob/master/config/exec_provider.py
-        /// </summary>
-        /// <param name="config">The external command execution configuration</param>
-        /// <returns>The token received from the external command execution</returns>
-        public static string ExecuteExternalCommand(ExternalExecution config)
+        public static Process CreateRunnableExternalProcess(ExternalExecution config)
         {
             var execInfo = new Dictionary<string, dynamic>
             {
@@ -432,15 +423,22 @@ public static string ExecuteExternalCommand(ExternalExecution config)
 
             var process = new Process();
 
-            process.StartInfo.Environment.Add("KUBERNETES_EXEC_INFO",
-                JsonConvert.SerializeObject(execInfo));
-
+            process.StartInfo.EnvironmentVariables.Add("KUBERNETES_EXEC_INFO", JsonConvert.SerializeObject(execInfo));
             if (config.EnvironmentVariables != null)
             {
-                foreach (var configEnvironmentVariableKey in config.EnvironmentVariables.Keys)
+                foreach (var configEnvironmentVariable in config.EnvironmentVariables)
                 {
-                    process.StartInfo.Environment.Add(key: configEnvironmentVariableKey,
-                        value: config.EnvironmentVariables[configEnvironmentVariableKey]);
+                    if (configEnvironmentVariable.ContainsKey("name") && configEnvironmentVariable.ContainsKey("value"))
+                    {
+                        process.StartInfo.EnvironmentVariables.Add(
+                            configEnvironmentVariable["name"],
+                            configEnvironmentVariable["value"]);
+                    }
+                    else
+                    {
+                        var badVariable = string.Join(",", configEnvironmentVariable.Select(x => $"{x.Key}={x.Value}"));
+                        throw new KubeConfigException($"Invalid environment variable defined: {badVariable}");
+                    }
                 }
             }
 
@@ -454,6 +452,24 @@ public static string ExecuteExternalCommand(ExternalExecution config)
             process.StartInfo.RedirectStandardError = true;
             process.StartInfo.UseShellExecute = false;
 
+            return process;
+        }
+
+        /// <summary>
+        /// Implementation of the proposal for out-of-tree client
+        /// authentication providers as described here --
+        /// https://github.com/kubernetes/community/blob/master/contributors/design-proposals/auth/kubectl-exec-plugins.md
+        /// Took inspiration from python exec_provider.py --
+        /// https://github.com/kubernetes-client/python-base/blob/master/config/exec_provider.py
+        /// </summary>
+        /// <param name="config">The external command execution configuration</param>
+        /// <returns>
+        /// The token, client certificate data, and the client key data received from the external command execution
+        /// </returns>
+        public static (string, string, string) ExecuteExternalCommand(ExternalExecution config)
+        {
+            var process = CreateRunnableExternalProcess(config);
+
             try
             {
                 process.Start();
@@ -482,7 +498,23 @@ public static string ExecuteExternalCommand(ExternalExecution config)
                         $"external exec failed because api version {responseObject.ApiVersion} does not match {config.ApiVersion}");
                 }
 
-                return responseObject.Status["token"];
+                if (responseObject.Status.ContainsKey("token"))
+                {
+                    return (responseObject.Status["token"], null, null);
+                }
+                else if (responseObject.Status.ContainsKey("clientCertificateData"))
+                {
+                    if (!responseObject.Status.ContainsKey("clientKeyData"))
+                    {
+                        throw new KubeConfigException($"external exec failed missing clientKeyData field in plugin output");
+                    }
+
+                    return (null, responseObject.Status["clientCertificateData"], responseObject.Status["clientKeyData"]);
+                }
+                else
+                {
+                    throw new KubeConfigException($"external exec failed missing token or clientCertificateData field in plugin output");
+                }
             }
             catch (JsonSerializationException ex)
             {
@@ -493,7 +525,6 @@ public static string ExecuteExternalCommand(ExternalExecution config)
                 throw new KubeConfigException($"external exec failed due to uncaught exception: {ex}");
             }
         }
-#endif
 
         /// <summary>
         ///     Loads entire Kube Config from default or explicit file path

src/KubernetesClient/KubernetesMetricsExtensions.cs

@@ -0,0 +1,39 @@
+using k8s.Models;
+using Newtonsoft.Json.Linq;
+using System.Threading.Tasks;
+
+namespace k8s
+{
+    /// <summary>
+    /// Extension methods for Kubernetes metrics.
+    /// </summary>
+    public static class KubernetesMetricsExtensions
+    {
+        /// <summary>
+        /// Get nodes metrics pull from metrics server API.
+        /// </summary>
+        public static async Task<NodeMetricsList> GetKubernetesNodesMetricsAsync(this IKubernetes operations)
+        {
+            JObject customObject = (JObject)await operations.GetClusterCustomObjectAsync("metrics.k8s.io", "v1beta1", "nodes", string.Empty).ConfigureAwait(false);
+            return customObject.ToObject<NodeMetricsList>();
+        }
+
+        /// <summary>
+        /// Get pods metrics pull from metrics server API.
+        /// </summary>
+        public static async Task<PodMetricsList> GetKubernetesPodsMetricsAsync(this IKubernetes operations)
+        {
+            JObject customObject = (JObject)await operations.GetClusterCustomObjectAsync("metrics.k8s.io", "v1beta1", "pods", string.Empty).ConfigureAwait(false);
+            return customObject.ToObject<PodMetricsList>();
+        }
+
+        /// <summary>
+        /// Get pods metrics by namespace pull from metrics server API.
+        /// </summary>
+        public static async Task<PodMetricsList> GetKubernetesPodsMetricsByNamespaceAsync(this IKubernetes operations, string namespaceParameter)
+        {
+            JObject customObject = (JObject)await operations.GetNamespacedCustomObjectAsync("metrics.k8s.io", "v1beta1", namespaceParameter, "pods", string.Empty).ConfigureAwait(false);
+            return customObject.ToObject<PodMetricsList>();
+        }
+    }
+}