Class ClusterInfo

Holds details about a cluster.

Inheritance

object

ClusterInfo

Namespace: Neon.Kube

Assembly: Neon.Kube.dll

Syntax

public class ClusterInfo

Constructors

ClusterInfo()

Default constructor used for deserializion.

Declaration

public ClusterInfo()

Properties

ClusterId

Globally unique cluster identifier. This is set during cluster setup and is used to distinguish between customer clusters.

Declaration

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

Property Value

Type	Description
string

ClusterVersion

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

Declaration

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

Property Value

Type	Description
string

CreationTimestamp

Timestamp representing the date that the cluster was created.

Declaration

[JsonProperty(PropertyName = "CreationTimestamp", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public DateTime? CreationTimestamp { get; set; }

Property Value

Type	Description
DateTime?

Datacenter

Identifies where the cluster is hosted as specified by Datacenter in the cluster definition. That property defaults to the empty string for on-premise clusters and the the region for cloud based clusters.

Declaration

[JsonProperty(PropertyName = "Datacenter", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string Datacenter { get; set; }

Property Value

Type	Description
string

Description

Optionally describes the cluster for humans.

Declaration

[JsonProperty(PropertyName = "Description", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string Description { get; set; }

Property Value

Type	Description
string

Domain

Identifies the DNS domain assigned to the cluster when it was provisioned.

Declaration

[JsonProperty(PropertyName = "Domain", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string Domain { get; set; }

Property Value

Type	Description
string

FeatureOptions

Describes which optional components have been deployed to the cluster.

Declaration

[JsonProperty(PropertyName = "FeatureOptions", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public FeatureOptions FeatureOptions { get; set; }

Property Value

Type	Description
FeatureOptions

HostingEnvironment

Identifies the cloud or other hosting platform. definition.

Declaration

[JsonProperty(PropertyName = "HostingEnvironment", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
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 empty.

Declaration

[JsonProperty(PropertyName = "HostingNamePrefix", Required = Required.AllowNull)]
public string HostingNamePrefix { get; set; }

Property Value

Type	Description
string

IsDesktop

Indicates whether the cluster is a neon-desktop cluster. This defaults to false.

Declaration

[JsonProperty(PropertyName = "IsDesktop", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public bool IsDesktop { get; set; }

Property Value

Type	Description
bool

KubernetesVersion

Identifies the version of Kubernetes installed on the cluster.

Declaration

[JsonProperty(PropertyName = "KubernetesVersion", Required = Required.Always)]
public string KubernetesVersion { get; set; }

Property Value

Type	Description
string

Latitude

Optionally specifies the latitude of the cluster location. This is a value between -90 and +90 degrees.

note

Latitude and Longitude must both be specified together or not at all.

Declaration

[JsonProperty(PropertyName = "Latitude", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public double? Latitude { get; set; }

Property Value

Type	Description
double?

Longitude

Optionally specifies the longitude of the cluster location. This is a value between -180 and +180 degrees.

note

Latitude and Longitude must both be specified together or not at all.

Declaration

[JsonProperty(PropertyName = "Longitude", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public double? Longitude { get; set; }

Property Value

Type	Description
double?

Name

Identifies the cluster by name as specified by Name in the cluster definition.

Declaration

[JsonProperty(PropertyName = "Name", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string Name { get; set; }

Property Value

Type	Description
string

OrganizationId

Identifies the organization that owns the cluster.

Declaration

[JsonProperty(PropertyName = "OrganizationId", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string OrganizationId { get; set; }

Property Value

Type	Description
string

PublicAddresses

Lists the IP addresses that can be used to communicate with the cluster.

For cloud deployed clusters, this will be configured by default with the public IP address assigned to the cluster load balancer. For on-premis clusters, this will be set to the IP addresses of the control-plane nodes by default.

Users may also customize this by setting IP addresses in the cluster definition. This is often done for clusters behind a router mapping the public IP address to the LAN address for cluster nodes.

Declaration

[JsonProperty(PropertyName = "PublicAddresses", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public List<string> PublicAddresses { get; set; }

Property Value

Type	Description
List<string>

Purpose

Indicates how the cluster is being used as specified by Purpose. definition.

Declaration

[JsonProperty(PropertyName = "Purpose", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public ClusterPurpose Purpose { get; set; }

Property Value

Type	Description
ClusterPurpose

Summary

Human readable string that summarizes the cluster state.

Declaration

[JsonProperty(PropertyName = "Summary", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string Summary { get; set; }

Property Value

Type	Description
string