Class KubeConfigUserConfig

Describes a Kubernetes user's credentials.

Inheritance

object

KubeConfigUserConfig

Namespace: Neon.Kube.Config

Assembly: Neon.Kube.dll

Syntax

public class KubeConfigUserConfig

Constructors

KubeConfigUserConfig()

Default constructor.

Declaration

public KubeConfigUserConfig()

Properties

As

Optionally specifies the username to impersionate.

Declaration

[JsonProperty(PropertyName = "as", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "as", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string As { get; set; }

Property Value

Type	Description
string

AsGroups

Optionally specifies the group IDs to impersionate.

Declaration

[JsonProperty(PropertyName = "as-groups", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "as-groups", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string[] AsGroups { get; set; }

Property Value

Type	Description
string[]

AsUid

Optionally specifies the user ID to impersionate.

Declaration

[JsonProperty(PropertyName = "as-uid", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "as-uid", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string AsUid { get; set; }

Property Value

Type	Description
string

AsUserExtra

Optionally specifies the additional imperionation information.

Declaration

[JsonProperty(PropertyName = "as-user-extra", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "as-user-extra", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public Dictionary<string, string> AsUserExtra { get; set; }

Property Value

Type	Description
Dictionary<string, string>

AuthProvider

Optionally specifies a custom authentication provider plugin.

Declaration

[JsonProperty(PropertyName = "auth-provider", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "auth-provider", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public KubeConfigAuthProvider AuthProvider { get; set; }

Property Value

Type	Description
KubeConfigAuthProvider

ClientCertificate

The optional path to the client certificate for TLS.

Declaration

[JsonProperty(PropertyName = "client-certificate", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "client-certificate", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ClientCertificate { get; set; }

Property Value

Type	Description
string

ClientCertificateData

Optionally specifies the contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate.

Declaration

[JsonProperty(PropertyName = "client-certificate-data", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "client-certificate-data", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ClientCertificateData { get; set; }

Property Value

Type	Description
string

ClientKey

Optionally specifies the path to a client key file for TLS.

Declaration

[JsonProperty(PropertyName = "client-key", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "client-key", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ClientKey { get; set; }

Property Value

Type	Description
string

ClientKeyData

Optionally specifies PEM-encoded data from a client key file for TLS. Overrides ClientKey.

Declaration

[JsonProperty(PropertyName = "client-key-data", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "client-key-data", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ClientKeyData { get; set; }

Property Value

Type	Description
string

Exec

Optionally specifies a custom exec-based authentication plugin.

Declaration

[JsonProperty(PropertyName = "exec", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "exec", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public KubeConfigExecConfig Exec { get; set; }

Property Value

Type	Description
KubeConfigExecConfig

Extensions

Lists any custom extension properties. Extensions are name/value pairs added by vendors to hold arbitrary information. Take care to choose property names that are unlikely to conflict with properties created by other vendors by adding a custom prefix like neonkube.io.MY-PROPERTY, where MY-PROPERTY identifies the property and neonkibe.io helps avoid conflicts.

Declaration

[JsonProperty(PropertyName = "extensions", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "extensions", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull|DefaultValuesHandling.OmitEmptyCollections)]
public List<NamedExtension> Extensions { get; set; }

Property Value

Type	Description
List<NamedExtension>

Password

Optionally specifies the password.

Declaration

[JsonProperty(PropertyName = "password", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "password", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string Password { get; set; }

Property Value

Type	Description
string

Token

Optionally specifies the bearer token for authentication to the kubernetes cluster.

Declaration

[JsonProperty(PropertyName = "token", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "token", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string Token { get; set; }

Property Value

Type	Description
string

TokenFile

Optionaliiy specifies file path to a bearer token for authentication to the kubernetes cluster. If both Token and TokenFile are present, Token takes precedence.

Declaration

[JsonProperty(PropertyName = "tokenFile", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "tokenFile", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string TokenFile { get; set; }

Property Value

Type	Description
string

Username

Optionally specifies the username.

Declaration

[JsonProperty(PropertyName = "username", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "username", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string Username { get; set; }

Property Value

Type	Description
string