Class KubeConfigCluster

Describes a Kubernetes cluster configuration.

Inheritance

object

KubeConfigCluster

Namespace: Neon.Kube.Config

Assembly: Neon.Kube.dll

Syntax

public class KubeConfigCluster

Constructors

KubeConfigCluster()

Default constructor.

Declaration

public KubeConfigCluster()

Properties

Cluster

The cluster properties.

Declaration

[JsonProperty(PropertyName = "cluster", Required = Required.Always)]
[YamlMember(Alias = "cluster", ApplyNamingConventions = false)]
public KubeConfigClusterConfig Cluster { get; set; }

Property Value

Type	Description
KubeConfigClusterConfig

ClusterInfo

Holds additional information about NEONKUBE clusters. This will be null for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public KubeClusterInfo ClusterInfo { get; set; }

Property Value

Type	Description
KubeClusterInfo

Hosting

Holds the HostingOptions for NEONKUBE clusters. This will be null for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public HostingOptions Hosting { get; set; }

Property Value

Type	Description
HostingOptions

HostingEnvironment

Identifies the HostingEnvironment for NEONKUBE clusters. This will be Unknown for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public HostingEnvironment HostingEnvironment { get; set; }

Property Value

Type	Description
HostingEnvironment

HostingNamePrefix

Specifies the prefix added by the hosting environments to virtual machine names. This may be the empty string form NEONKUBE clusters and always will be null for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public string HostingNamePrefix { get; set; }

Property Value

Type	Description
string

IsNeonDesktop

Indicates that this is a neon-desktop cluster. This will be false for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public bool IsNeonDesktop { get; set; }

Property Value

Type	Description
bool

IsNeonKube

Indicates that this is a NEONKUBE cluster. This will be false for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public bool IsNeonKube { get; set; }

Property Value

Type	Description
bool

Name

The local nickname for the cluster.

Declaration

[JsonProperty(PropertyName = "name", Required = Required.Always)]
[YamlMember(Alias = "name", ApplyNamingConventions = false)]
public string Name { get; set; }

Property Value

Type	Description
string

SshPassword

Specifies the SSH padmin assword for 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

[JsonIgnore]
[YamlIgnore]
public string SshPassword { get; set; }

Property Value

Type	Description
string

SshUsername

Specifies the SSH admin username for cluster nodes.

Declaration

[JsonIgnore]
[YamlIgnore]
public string SshUsername { get; set; }

Property Value

Type	Description
string

SsoPassword

Specifies the cluster's SSO admin password.

Declaration

[JsonIgnore]
[YamlIgnore]
public string SsoPassword { get; set; }

Property Value

Type	Description
string

SsoUsername

Specifies the cluster's SSO admin password.

Declaration

[JsonIgnore]
[YamlIgnore]
public string SsoUsername { get; set; }

Property Value

Type	Description
string

TestClusterDefinition

Holds the cluster definition for testing clusters. ClusterFixture uses this decide whether to deploy a new cluster when the definition has changed. This will be null for non-NEONKUBE clusters.

Declaration

[JsonIgnore]
[YamlIgnore]
public ClusterDefinition TestClusterDefinition { get; set; }

Property Value

Type	Description
ClusterDefinition

Methods

GetExtensionValue<T>(string, T)

Returns an extension value.

Declaration

public T GetExtensionValue<T>(string name, T @default)

Parameters

Type	Name	Description
string	name	Specifies the extension name.
T	default	Specifies the value to be returned when the extension is not found.

Returns

Type	Description
T	The extension value.

Type Parameters

Name	Description
T	Specifies the value type.

SetExtensionValue<T>(string, T)

Sets an extension value.

Declaration

public void SetExtensionValue<T>(string name, T value)

Parameters

Type	Name	Description
string	name	Specifies the extension name.
T	value	Specifies the value being set.

Type Parameters

Name	Description
T	Specifies the value type.