Skip to content

Commit 0fe237f

Browse files
authored
Improve documentation for BuildDefaultConfig (#423)
The current documentation only mentions that it uses a default config file. However, it actually works with a lot more than that and it is helpful to see that in the documentation.
1 parent fcfeeed commit 0fe237f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/KubernetesClient/KubernetesClientConfiguration.ConfigFile.cs

+5-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@ public partial class KubernetesClientConfiguration
3131
public string CurrentContext { get; private set; }
3232

3333
/// <summary>
34-
/// Initializes a new instance of the <see cref="KubernetesClientConfiguration" /> from config file
34+
/// Initializes a new instance of the <see cref="KubernetesClientConfiguration" /> from default locations
35+
/// If the KUBECONFIG environment variable is set, then that will be used.
36+
/// Next, it looks for a config file at <see cref="KubeConfigDefaultLocation"/>.
37+
/// Then, it checks whether it is executing inside a cluster and will use <see cref="InClusterConfig()" />.
38+
/// Finally, if nothing else exists, it creates a default config with localhost:8080 as host.
3539
/// </summary>
3640
public static KubernetesClientConfiguration BuildDefaultConfig()
3741
{

0 commit comments

Comments
 (0)