Class KubeSetupProperty

Identifies the cluster setup state available in an ISetupController.

Inheritance
object
KubeSetupProperty
Namespace: Neon.Kube
Assembly: Neon.Kube.dll
Syntax
public static class KubeSetupProperty

Fields

BaseImageName

Property name for a bool that identifies the base image name to be used for preparing a cluster in debug mode. This is the name of the base image file as persisted to our public S3 bucket. This will not be set for cluster setup.

Declaration
public const string BaseImageName = "base-image-name"
Field Value
Type Description
string

BuildDesktopImage

Property name for a bool value indicating that we're building a ready-to-go desktop image.

Declaration
public const string BuildDesktopImage = "build-desktop-image"
Field Value
Type Description
string

ClusterAdvice

Property name for accessing the SetupController<NodeMetadata>'s KubeClusterAdvice client property.

Declaration
public const string ClusterAdvice = "setup-advice"
Field Value
Type Description
string

ClusterProxy

Property name for accessing the SetupController<NodeMetadata>'s ClusterProxy property.

Declaration
public const string ClusterProxy = "cluster-proxy"
Field Value
Type Description
string

DebugMode

Property name for accessing a bool that indicates that we're running cluster prepare/setup in debug mode. In debug mode, setup works like it did in the past, where we deployed the base node image first and then configured the node from that, rather than starting with the node image with assets already prepositioned.

This mode is useful when debugging cluster setup or adding new features.

Declaration
public const string DebugMode = "debug-setup"
Field Value
Type Description
string

DesktopReadyToGo

Property name for a bool value indicating whether we're deploying a cluster using a ready-to-go desktop image.

Declaration
public const string DesktopReadyToGo = "desktop-readytogo"
Field Value
Type Description
string

DesktopServiceProxy

Property name for a DesktopServiceProxy instance that can be used to perform specific privileged operations from a non-privileged process.

Declaration
public const string DesktopServiceProxy = "desktop-service-proxy"
Field Value
Type Description
string

DisableImageDownload

Property name for a boolean indicating that the node image has already been downloaded (e.g. by NEONDESKTOP) and does not need to be downloaded hosting managers during cluster provisioning. Image downloading should be considered to be enabled when this property is not present.

Declaration
public const string DisableImageDownload = "image-download-disabled"
Field Value
Type Description
string

HarborCredentials

Property name for a Credentials object holding the username and password to be used to authenticate podman on the cluster node with the local Harbor registry.

note

Token based credentials are not supported.

Declaration
public const string HarborCredentials = "harbor-credentials"
Field Value
Type Description
string

HostingEnvironment

Property name for determining the current hosting environment: HostingEnvironment,

Declaration
public const string HostingEnvironment = "hosting-environment"
Field Value
Type Description
string

HostingManager

Property name for accessing the SetupController<NodeMetadata>'s IHostingManager property.

Declaration
public const string HostingManager = "hosting-manager"
Field Value
Type Description
string

Insecure

Property name for a bool value indicating we should not secure the cluster 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 const string Insecure = "insecure"
Field Value
Type Description
string

K8sClient

Property name for accessing the SetupController<NodeMetadata>'s Neon.Kubernetes client property.

Declaration
public const string K8sClient = "k8sclient"
Field Value
Type Description
string

MaintainerMode

Property name for accessing a bool that indicates that we're running cluster prepare/setup in maintainer mode.

Declaration
public const string MaintainerMode = "maintainer-setup"
Field Value
Type Description
string

NeonCloudHeadendClient

Property name for accessing the NEONCLOUD headend service client.

Declaration
public const string NeonCloudHeadendClient = "neoncloud-headend-client"
Field Value
Type Description
string

Preparing

Property name for accessing a bool that indicates that we're preparing a cluster vs. setting one up.

Declaration
public const string Preparing = "preparing"
Field Value
Type Description
string

Redact

Property name for a bool indicating whether secrets should be redacted when logging during cluster setup. This should be generally set to true for production deployments.

Declaration
public const string Redact = "redact"
Field Value
Type Description
string

ReleaseMode

Property name for accessing a bool that indicates that we're running cluster prepare/setup in release mode.

Declaration
public const string ReleaseMode = "release-setup"
Field Value
Type Description
string