Interface IClusterSetupApi

Defines the NEONCLOUD headend cluster setup REST API.

Namespace: Neon.Kube.Models.Headend

Assembly: Neon.Kube.Models.dll

Syntax

[Target("all")]
[Target("headend")]
[ServiceModel("Headend", "ClusterSetup")]
[Route("cluster-setup")]
[ApiVersion("2023-04-06")]
public interface IClusterSetupApi

Methods

CreateClusterAsync()

Generates a new DNS domain like GUID.neoncloud.io for a cluster and registers the required domain names with AWS Route53 using the cluster IP address passed.

Declaration

[HttpPost(null)]
[Route("create")]
Dictionary<string, string> CreateClusterAsync()

Returns

Type	Description
Dictionary<string, string>	A dictionary returning the cluster Id and acceses Token.

GetAzureImageDetailsAsync(string, CpuArchitecture)

Returns the Azure reference for a node image.

Declaration

[HttpGet(null)]
[Route("image/node/azure")]
AzureImageDetails GetAzureImageDetailsAsync(string version, CpuArchitecture architecture)

Parameters

Type	Name	Description
string	version	Specifies the NEONKUBE version.
CpuArchitecture	architecture	Specifies the target CPU architecture.

Returns

Type	Description
AzureImageDetails	The action result.

GetDesktopImageManifestUriAsync(string, string, CpuArchitecture, string)

Returns the URI of the download manifest for a NEONKUBE desktop image.

Declaration

[HttpGet(null)]
[Route("image/desktop")]
string GetDesktopImageManifestUriAsync(string hostingEnvironment, string version, CpuArchitecture architecture, string stageBranch)

Parameters

Type	Name	Description
string	hostingEnvironment	Identifies the hosting environment.
string	version	Specifies the NEONKUBE version.
CpuArchitecture	architecture	Specifies the target CPU architecture.
string	stageBranch	To obtain the URI for a specific staged node image, pass this as the name of the branch from which NEONKUBE libraries were built. When `null` is passed, the URI for the release image for the current build will be returned when the public release has been published, otherwise this will return the URI for the staged image.

Returns

Type	Description
string	The action result.

GetNodeImageManifestUriAsync(string, string, CpuArchitecture, string)

Returns the URI of the download manifest for an on-premise NEONKUBE node image.

Declaration

[HttpGet(null)]
[Route("image/node")]
string GetNodeImageManifestUriAsync(string hostingEnvironment, string version, CpuArchitecture architecture, string stageBranch)

Parameters

Type	Name	Description
string	hostingEnvironment	Identifies the hosting environment.
string	version	Specifies the NEONKUBE version.
CpuArchitecture	architecture	Specifies the target CPU architecture.
string	stageBranch	To obtain the URI for a specific staged node image, pass this as the name of the branch from which NEONKUBE libraries were built. When `null` is passed, the URI for the release image for the current build will be returned when the public release has been published, otherwise this will return the URI for the staged image.

Returns

Type	Description
string	The action result.

PostDeploymentLogAsync(string, DateTime, string, string, string, bool)

Ingests cluster setup log files.

Declaration

[HttpPost(null)]
[Route("deployment-log")]
void PostDeploymentLogAsync(string uploadId, DateTime timestampUtc, string version, string clientId, string userId, bool preparing)

Parameters

Type	Name	Description
string	uploadId	UUID used to name the blob when persisted by the service.
DateTime	timestampUtc	The timestamp (UTC) when the error occurred.
string	version	The NEONKUBE version.
string	clientId	The client installation UUID.
string	userId	The user ID or Empty before we implemented NEONCLOUD users.
bool	preparing	`true` when the failure occured while preparing the cluster, `false` when setting it up.