Class XenServerHostingManager

Manages cluster provisioning on the XenServer hypervisor.

Inheritance

object

HostingManager

XenServerHostingManager

Implements

IHostingManager

Inherited Members

HostingManager.MaxAsyncParallelHostingOperations

HostingManager.SupportsFsTrim(HostingEnvironment)

HostingManager.SupportsFsZero(HostingEnvironment)

HostingManager.Load(Action)

HostingManager.Dispose()

HostingManager.MaxParallel

HostingManager.WaitSeconds

HostingManager.NodeMtu

HostingManager.AddSetupSteps(SetupController<NodeDefinition>)

HostingManager.CanManageRouter

HostingManager.UpdateInternetRoutingAsync()

HostingManager.EnableInternetSshAsync()

HostingManager.DisableInternetSshAsync()

HostingManager.GetDatacenterCoordinatesAsync()

HostingManager.CheckForIPConflictsAsync(ClusterDefinition)

HostingManager.AssignNodeAddresses(ClusterDefinition)

HostingManager.ValidateCluster(ClusterDefinition, List<HostedNodeInfo>, HostingReadiness)

HostingManager.DefaultStatusTimeout

HostingManager.PauseClusterAsync()

HostingManager.ResumeClusterAsync()

Namespace: Neon.Kube.Hosting.XenServer

Assembly: Neon.Kube.XenServer.dll

Syntax

[HostingProvider(HostingEnvironment.XenServer)]
public class XenServerHostingManager : HostingManager, IHostingManager

Remarks

Optional capability support:

Pausable	YES
Stoppable	YES

Constructors

XenServerHostingManager()

Creates an instance that is only capable of validating the hosting related options in the cluster definition.

Declaration

public XenServerHostingManager()

XenServerHostingManager(ClusterProxy, bool, string, string, string)

Creates an instance that is capable of provisioning a cluster on XenServer/XCP-ng servers.

Declaration

public XenServerHostingManager(ClusterProxy cluster, bool cloudMarketplace, string nodeImageUri = null, string nodeImagePath = null, string logFolder = null)

Parameters

Type	Name	Description
ClusterProxy	cluster	The cluster being managed.
bool	cloudMarketplace	Ignored.
string	nodeImageUri	Optionally specifies the node image URI.
string	nodeImagePath	Optionally specifies the path to the local node image file.
string	logFolder	The folder where log files are to be written, otherwise or null or empty if logging is disabled.

Remarks

note

One of nodeImageUri or nodeImagePath must be specified.

Properties

Capabilities

Returns flags describing any optional capabilities supported by the hosting manager.

Declaration

public override HostingCapabilities Capabilities { get; }

Property Value

Type	Description
HostingCapabilities

Overrides

HostingManager.Capabilities

HostingEnvironment

Returns the hosting environment implemented by the manager.

Declaration

public override HostingEnvironment HostingEnvironment { get; }

Property Value

Type	Description
HostingEnvironment

Overrides

HostingManager.HostingEnvironment

RequiresNodeAddressCheck

Returns true if the hosting manager requires that the LAN be scanned for devices assigned IP addresses that may conflict with node addresses. This is typically required only for clusters deployed on-premise because cloud clusters are typically provisioned to their own isolated network.

Declaration

public override bool RequiresNodeAddressCheck { get; }

Property Value

Type	Description
bool

Overrides

HostingManager.RequiresNodeAddressCheck

Methods

AddPostProvisioningSteps(SetupController<NodeDefinition>)

Adds any steps to be performed after the node has been otherwise prepared.

Declaration

public override void AddPostProvisioningSteps(SetupController<NodeDefinition> controller)

Parameters

Type	Name	Description
SetupController<NodeDefinition>	controller	The target setup controller.

Overrides

HostingManager.AddPostProvisioningSteps(SetupController<NodeDefinition>)

AddPostSetupSteps(SetupController<NodeDefinition>)

Adds any stps to be performed after cluster setup.

Declaration

public override void AddPostSetupSteps(SetupController<NodeDefinition> controller)

Parameters

Type	Name	Description
SetupController<NodeDefinition>	controller	The target setup controller.

Overrides

HostingManager.AddPostSetupSteps(SetupController<NodeDefinition>)

AddProvisioningSteps(SetupController<NodeDefinition>)

Adds the steps required to the setup controller passed that creates and initializes the cluster resources such as the virtual machines, networks, load balancers, network security groups, public IP addresses.

Declaration

public override void AddProvisioningSteps(SetupController<NodeDefinition> controller)

Parameters

Type	Name	Description
SetupController<NodeDefinition>	controller	The setup controller.

Overrides

HostingManager.AddProvisioningSteps(SetupController<NodeDefinition>)

CheckDeploymentReadinessAsync(ClusterDefinition)

Performs any final hosting environmet readiness check before deploying a cluster.

Declaration

public override Task CheckDeploymentReadinessAsync(ClusterDefinition clusterDefinition)

Parameters

Type	Name	Description
ClusterDefinition	clusterDefinition	Specifies the cluster definition.

Returns

Type	Description
Task	The tracking Task.

Overrides

HostingManager.CheckDeploymentReadinessAsync(ClusterDefinition)

Exceptions

Type	Condition
HostingReadinessException	Thrown if any problems were detected.

CheckForConflictsAsync(ClusterDefinition)

Checks for any conflicts that might arise when provisoning a cluster. Currently, this checks for existing machines using IP addresses that will conflict with one or more of the cluster nodes.

Declaration

public override Task<string> CheckForConflictsAsync(ClusterDefinition clusterDefinition)

Parameters

Type	Name	Description
ClusterDefinition	clusterDefinition	Specifies the cluster definition.

Returns

Type	Description
Task<string>	null when there are no conflicts, otherise a string detailing the conflicts.

Overrides

HostingManager.CheckForConflictsAsync(ClusterDefinition)

DeleteClusterAsync(ClusterDefinition)

Deletes an existing cluster by terminating any nodes and then removing node VMs and any related resources as well as the related local cluster login by default. The cluster does not need to be running.

note

This operation may not be supported for all environments.

Declaration

public override Task DeleteClusterAsync(ClusterDefinition clusterDefinition = null)

Parameters

Type	Name	Description
ClusterDefinition	clusterDefinition	Optionally specifies a cluster definition. This is used in situations where you need to remove a cluster without having its kubeconfig context. Use this with extreme care because in the mode, the cluster cannot be queried to determine whether it's locked or not and locked clusters will be deleted too.

Returns

Type	Description
Task	The tracking Task.

Overrides

HostingManager.DeleteClusterAsync(ClusterDefinition)

Exceptions

Type	Condition
NotSupportedException	Thrown if the hosting environment doesn't support this operation.

Dispose(bool)

Releases any important resources associated with the instance.

Declaration

public override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	Pass true if the instance is being disposed as opposed to being finalized.

Overrides

HostingManager.Dispose(bool)

GetClusterAddresses()

Returns the IP address to be used to access the cluster. For clusters deployed the the cloud, this will be the ingress IP address assigned to the load balancer. For on-premise clusters, this returns the private IP addresses for the control-plane nodes.

Declaration

public override IEnumerable<string> GetClusterAddresses()

Returns

Type	Description
IEnumerable<string>	The list of cluster IP addresses.

Overrides

HostingManager.GetClusterAddresses()

GetClusterHealthAsync(TimeSpan)

Retrieves the health status of the current cluster from the hosting manager's perspective This includes information about the infrastructure provisioned for the cluster.

Declaration

public override Task<ClusterHealth> GetClusterHealthAsync(TimeSpan timeout = default)

Parameters

Type	Name	Description
TimeSpan	timeout	Optionally specifies the maximum time to wait for the result. This defaults to 15 seconds.

Returns

Type	Description
Task<ClusterHealth>	The ClusterHealth information for the current cluster. note When there is no current cluster, the health information will return indicating that no cluster was found.

Overrides

HostingManager.GetClusterHealthAsync(TimeSpan)

GetDataDisk(LinuxSshProxy)

Identifies the data disk device for a node. This returns the data disk's device name when an uninitialized data disk exists or "PRIMARY" when the OS disk will be used for data.

Declaration

public override string GetDataDisk(LinuxSshProxy node)

Parameters

Type	Name	Description
LinuxSshProxy	node

Returns

Type	Description
string	The disk device name or "PRIMARY".

Overrides

HostingManager.GetDataDisk(LinuxSshProxy)

Remarks

note

This will not work after the node's data disk has been initialized.

GetResourceAvailabilityAsync(long, long)

Returns the availability of resources required to deploy a cluster.

Declaration

public override Task<HostingResourceAvailability> GetResourceAvailabilityAsync(long reserveMemory = 0, long reservedDisk = 0)

Parameters

Type	Name	Description
long	reserveMemory	Optionally specifies the amount of host memory (in bytes) to be reserved for host operations.
long	reservedDisk	Optionally specifies the amount of host disk disk (in bytes) to be reserved for host operations.

Returns

Type	Description
Task<HostingResourceAvailability>	Details about whether cluster deployment can proceed.

Overrides

HostingManager.GetResourceAvailabilityAsync(long, long)

Remarks

The optional reserveMemory and reservedDisk parameters can be used to specify memory and disk that are to be reserved for the host environment. Hosting manager implementations are free to ignore this when they don't really makse sense.

This is currently used for Hyper-V based clusters running on a user workstation or laptop to ensure that deployed clusters don't adverserly impact the host machine too badly.

These parameters don't really make sense for cloud or dedicated hypervisor hosting environments because those environemnts will still work well when all available resources are consumed.

GetSshEndpoint(string)

Returns the FQDN or IP address (as a string) and the port to use to establish a SSH connection to a specific node.

Declaration

public override (string Address, int Port) GetSshEndpoint(string nodeName)

Parameters

Type	Name	Description
string	nodeName	The target node's name.

Returns

Type	Description
(string Address, int Port)	A (string Address, int Port) tuple.

Overrides

HostingManager.GetSshEndpoint(string)

Remarks

This will return the direct private node endpoint by default. If EnableInternetSshAsync() has been called and is supported by the hosting manager, then this returns the public address of the cluster along with the public NAT port.

Load()

Ensures that the assembly hosting this hosting manager is loaded.

Declaration

public static void Load()

StartClusterAsync()

Starts a cluster if it's not already running.

note

This operation may not be supported for all environments.

Declaration

public override Task StartClusterAsync()

Returns

Type	Description
Task	The tracking Task.

Overrides

HostingManager.StartClusterAsync()

Exceptions

Type	Condition
NotSupportedException	Thrown if the hosting environment doesn't support this operation.

StopClusterAsync(StopMode)

Shuts down a cluster if it's running.

note

This operation may not be supported for all environments.

Declaration

public override Task StopClusterAsync(StopMode stopMode = StopMode.Graceful)

Parameters

Type	Name	Description
StopMode	stopMode	Optionally specifies how the cluster nodes are stopped. This defaults to Graceful.

Returns

Type	Description
Task	The tracking Task.

Overrides

HostingManager.StopClusterAsync(StopMode)

Exceptions

Type	Condition
NotSupportedException	Thrown if the hosting environment doesn't support this operation.

Validate(ClusterDefinition)

Verifies that a cluster is valid for the hosting manager, customizing properties as required.

Declaration

public override void Validate(ClusterDefinition clusterDefinition)

Parameters

Type	Name	Description
ClusterDefinition	clusterDefinition

Overrides

HostingManager.Validate(ClusterDefinition)

Exceptions

Type	Condition
ClusterDefinitionException	Thrown if any problems were detected.

Implements

IHostingManager