Class HostingResourceAvailability

Returned by GetResourceAvailabilityAsync(long, long) indicating whether a hosting environment has sufficient resources available to deploy a cluster.

Inheritance

object

HostingResourceAvailability

Namespace: Neon.Kube.Hosting

Assembly: Neon.Kube.dll

Syntax

public class HostingResourceAvailability

Remarks

The CanBeDeployed property returns true when the environment has sufficent resources to deploy the cluster.

Properties

CanBeDeployed

Returns true when the cluster can be deployed.

Declaration

[JsonProperty(PropertyName = "CanBeDeployed", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "canBeDeployed", ApplyNamingConventions = false)]
public bool CanBeDeployed { get; }

Property Value

Type	Description
bool

Constraints

Details the constraints preventing the cluster from being deployed.

Declaration

[JsonProperty(PropertyName = "Constraints", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "constraints", ApplyNamingConventions = false)]
public Dictionary<string, List<HostingResourceConstraint>> Constraints { get; set; }

Property Value

Type	Description
Dictionary<string, List<HostingResourceConstraint>>

Remarks

This is a dictionary mapping hosting environment entity names to one or more resource constraints preventing cluster deployment. The entity names are hosting environment specific and will refer to things like virtualization hosts for environments like Hyper-V and XenServer, server pools for bare metal, or datacenters for clouds like AWS, Azure, and Google.

Each constraint includes information about the constrained resource as well as the cluster nodes that exceeded the constraint.