Class DeploymentOptions

Specifies cluster deployment options used by ClusterFixture as well as potentially by custom tools.

Inheritance

object

DeploymentOptions

Namespace: Neon.Kube.ClusterDef

Assembly: Neon.Kube.dll

Syntax

public class DeploymentOptions

Properties

Prefix

Optional prefix combined with the cluster name to generate the resource group name when deploying the cluster to a cloud environment or combined with the node name for other environments. This is typically used by unit tests deployed by ClusterFixture but can also be used by custom tools to avoid conflicts when multiple tests may be running in parallel (probably on different machines) as well as providing a way to identify and remove clusters or VMs orphaned by previous interrupted tests or tool runs.

This will typically be set to something identifying the machine, user, and/or tool running the test like runner0, jeff, or runner0-jeff.

note

A dash will be appended automatically to non-null prefixes before prepending this to the cluster name.

Declaration

[JsonProperty(PropertyName = "Prefix", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "prefix", ApplyNamingConventions = false)]
public string Prefix { get; set; }

Property Value

Type	Description
string

Methods

GetPrefixedName(string)

Prefixes the name passed with Prefix and a dash when Prefix is not null or empty.

Declaration

public string GetPrefixedName(string name)

Parameters

Type	Name	Description
string	name	The name being prefixed.

Returns

Type	Description
string	The prefixed name.