Class KubeClusterInfo

Holds extended NEONKUBE related cluster information.

Inheritance

object

KubeClusterInfo

Namespace: Neon.Kube.Config

Assembly: Neon.Kube.dll

Syntax

public class KubeClusterInfo

Constructors

KubeClusterInfo()

Default constructor.

Declaration

public KubeClusterInfo()

Properties

ClusterDomain

Specifies the cluster domain.

Declaration

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

Property Value

Type	Description
string

ClusterId

Specifies a UUID for the cluster.

Declaration

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

Property Value

Type	Description
string

ClusterName

Specifies the cluster name.

Declaration

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

Property Value

Type	Description
string

ClusterVersion

Specifies the NEONKUBE version of the cluster. This is formatted as a SemanticVersion.

Declaration

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

Property Value

Type	Description
string

SshCredentials

Returns a SshCredentials instance suitable for connecting to a cluster node.

Declaration

[JsonIgnore]
[YamlIgnore]
public SshCredentials SshCredentials { get; }

Property Value

Type	Description
SshCredentials

SshKey

The public and private parts of the SSH client key used to authenticate a SSH session with a cluster node.

Declaration

[JsonProperty(PropertyName = "SshClientKey", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "sshClientKey", ApplyNamingConventions = false)]
public KubeSshKey SshKey { get; set; }

Property Value

Type	Description
KubeSshKey

SshPassword

Specifies the SSH admin password for the cluster nodes.

note

Technically, this is actually the admin user account password on the cluster nodes, not an SSH password because clusters disable SSH password authentication.

Declaration

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

Property Value

Type	Description
string

SshUsername

Specifies the SSH admin username for the cluster nodes.

Declaration

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

Property Value

Type	Description
string

SsoPassword

Specifies the SSO admin password.

Declaration

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

Property Value

Type	Description
string

SsoUsername

Specifies the SSO admin username.

Declaration

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

Property Value

Type	Description
string