Interface IHostingManagerFactory

Describes the implementation for mapping a hosting environment into a concrete IHostingManager implementation.

Namespace: Neon.Kube.Hosting

Assembly: Neon.Kube.dll

Syntax

public interface IHostingManagerFactory

Methods

GetManager(HostingEnvironment)

Returns the HostingManager for an environment that can be used for validating the hosting related options.

Declaration

HostingManager GetManager(HostingEnvironment environment)

Parameters

Type	Name	Description
HostingEnvironment	environment	The target hosting environment.

Returns

Type	Description
HostingManager	The HostingManager or null if no hosting manager could be located for the specified cluster environment.

GetManager(ClusterProxy, bool, string)

Returns the HostingManager for provisioning a cluster using the default node image URI for the cluster environment.

Declaration

HostingManager GetManager(ClusterProxy cluster, bool cloudMarketplace, string logFolder = null)

Parameters

Type	Name	Description
ClusterProxy	cluster	The cluster being managed.
bool	cloudMarketplace	For cloud environments, this specifies whether the cluster should be provisioned using a VM image from the public cloud marketplace when true or from the private NEONFORGE image gallery for testing when false. This is ignored for on-premise environments. note Only NEONFORGE maintainers will have permission to use the private image.
string	logFolder	The folder where log files are to be written, otherwise or null or empty if logging is disabled. note Specific hosting managers may choose to ignore this when it doesn't make sense.

Returns

Type	Description
HostingManager	The HostingManager or null if no hosting manager could be located for the specified cluster environment.

Exceptions

Type	Condition
NeonKubeException	Thrown if the multiple managers implement support for the same hosting environment.

GetManagerWithNodeImageFile(ClusterProxy, string, string)

Returns the HostingManager for provisioning a cluster from an already downloaded image file already downloaded.

Declaration

HostingManager GetManagerWithNodeImageFile(ClusterProxy cluster, string nodeImagePath = null, string logFolder = null)

Parameters

Type	Name	Description
ClusterProxy	cluster	The cluster being managed.
string	nodeImagePath	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.

Returns

Type	Description
HostingManager	The HostingManager or null if no hosting manager could be located for the specified cluster environment.

Exceptions

Type	Condition
NeonKubeException	Thrown if the multiple managers implement support for the same hosting environment.

GetManagerWithNodeImageUri(ClusterProxy, bool, string, string)

Returns the HostingManager for provisioning a cluster using a node image specified by HTTP/HTTPS URI.

Declaration

HostingManager GetManagerWithNodeImageUri(ClusterProxy cluster, bool cloudMarketplace, string nodeImageUri, string logFolder = null)

Parameters

Type	Name	Description
ClusterProxy	cluster	The cluster being managed.
bool	cloudMarketplace	For cloud environments, this specifies whether the cluster should be provisioned using a VM image from the public cloud marketplace when true or from the private NEONFORGE image gallery for testing when false. This is ignored for on-premise environments. note Only NEONFORGE maintainers will have permission to use the private image.
string	nodeImageUri	The node image URI.
string	logFolder	The folder where log files are to be written, otherwise or null or empty if logging is disabled. note Specific hosting managers may choose to ignore this when it doesn't make sense.

Returns

Type	Description
HostingManager	The HostingManager or null if no hosting manager could be located for the specified cluster environment.

Exceptions

Type	Condition
NeonKubeException	Thrown if the multiple managers implement support for the same hosting environment.

IsCloudEnvironment(HostingEnvironment)

Determines whether a hosting environment is hosted in the cloud.

Declaration

bool IsCloudEnvironment(HostingEnvironment environment)

Parameters

Type	Name	Description
HostingEnvironment	environment	The target hosting environment.

Returns

Type	Description
bool	true for cloud environments.