Class PrepareClusterOptions
Optionally used to specify options for CreateClusterPrepareControllerAsync(ClusterDefinition, bool, PrepareClusterOptions).
Namespace: Neon.Kube.Setup
Assembly: Neon.Kube.Setup.dll
Syntax
public class PrepareClusterOptionsConstructors
PrepareClusterOptions()
Constructor.
Declaration
public PrepareClusterOptions()Properties
BaseImageName
Optionally specifies the base image name to use for debug mode.
Declaration
public string BaseImageName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
BuildDesktopImage
Optionally indicates that we're building a ready-to-go neon desktop image.
Declaration
public bool BuildDesktopImage { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
DebugMode
Optionally indicates that the cluster will be prepared in debug mode.
Declaration
public bool DebugMode { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
DesktopReadyToGo
Optionally indicates that we're setting up a NEONDESKTOP cluster from a completely prebuilt desktop image. In this case, the controller returned will fully deploy the cluster (so no setup controller needs to be created and run afterwards).
Declaration
public bool DesktopReadyToGo { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
DisableConsoleOutput
Optionally disables status output to the console. This is typically enabled for cluster being provisioned by non-console applications.
Declaration
public bool DisableConsoleOutput { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Insecure
Optionally indicates that the cluster should not be secure nodes with a generated secure password and also that we should allow SSH password authentication, for cluster debugging purposes.
note
WARNING! This should never be used for production clusters.
Declaration
public bool Insecure { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
MaxParallel
Optionally specifies the maximum number of node operations to be performed in parallel. This defaults to 0 which means that we'll use MaxParallel.
Declaration
public int MaxParallel { get; set; }Property Value
| Type | Description |
|---|---|
| int |
NodeImagePath
Optionally specifies the node image path.
note
One of NodeImageUri or NodeImagePath must be specified for on-premise hypervisor based environments. These are ignored for cloud hosting.
Declaration
public string NodeImagePath { get; set; }Property Value
| Type | Description |
|---|---|
| string |
NodeImageUri
Optionally specifies the node image URI.
Declaration
public string NodeImageUri { get; set; }Property Value
| Type | Description |
|---|---|
| string |
PackageCacheEndpoints
Optionally specifies the IP endpoints for the APT package caches to be used by the cluster, overriding the cluster definition settings. This is useful when package caches are already deployed in an environment.
note
Package cache servers are deployed to the control-plane nodes by default.
Declaration
public IEnumerable<IPEndPoint> PackageCacheEndpoints { get; set; }Property Value
| Type | Description |
|---|---|
| IEnumerable<IPEndPoint> |
RemoveExisting
Optionally remove any existing cluster with the same name in the target environment.
Declaration
public bool RemoveExisting { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Unredacted
Optionally indicates that sensitive information won't be redacted from the setup logs (typically used when debugging).
Declaration
public bool Unredacted { get; set; }Property Value
| Type | Description |
|---|---|
| bool |