Class KubeNodeFolder

Enumerates the paths of important directories on cluster node servers.

Inheritance

object

KubeNodeFolder

Namespace: Neon.Kube

Assembly: Neon.Kube.dll

Syntax

public static class KubeNodeFolder

Remarks

note

Although these constants are referenced by C# code, Linux scripts are likely to hardcode these strings. You should do a search and replace whenever you change any of these values.

note

Changing any of these will likely break [neon-cli] interactions with existing clusters that use the previous folder path. Be ver sure you know what you're doing when you make changes.

Fields

Bin

Path to the cluster executable files directory.

Declaration

public const string Bin = "/lib/neonkube/bin"

Field Value

Type	Description
string

Config

Path to the cluster configuration directory.

Declaration

public const string Config = "/etc/neonkube"

Field Value

Type	Description
string

Helm

Path to the cluster setup Helm charts folder.

Declaration

public const string Helm = "/lib/neonkube/helm"

Field Value

Type	Description
string

NeonRun

Folder where NEONKUBE related components will maintain runtime state.

Declaration

public const string NeonRun = "/run/neonkube"

Field Value

Type	Description
string

Scripts

Path to the cluster management scripts directory.

Declaration

public const string Scripts = "/lib/neonkube/scripts"

Field Value

Type	Description
string

Setup

Path to the cluster setup scripts directory.

Declaration

public const string Setup = "/lib/neonkube/setup"

Field Value

Type	Description
string

State

Path to the cluster setup state directory.

Declaration

public const string State = "/var/local/neonkube"

Field Value

Type	Description
string

Tmpfs

Root folder on the local tmpfs (shared memory) folder where cluster will persist misc temporary files.

Declaration

public const string Tmpfs = "/dev/shm/neonkube"

Field Value

Type	Description
string

Methods

Download(string)

Path to the user download directory.

Declaration

public static string Download(string username)

Parameters

Type	Name	Description
string	username	The username.

Returns

Type	Description
string	The directory path.

Exec(string)

The user folder where cluster tools can upload, unpack, and then execute CommandBundles as well as store temporary command output files.

Declaration

public static string Exec(string username)

Parameters

Type	Name	Description
string	username	The username.

Returns

Type	Description
string	The directory path.

Home(string)

Path to a user archive directory.

Declaration

public static string Home(string username)

Parameters

Type	Name	Description
string	username	The username.

Returns

Type	Description
string	The directory path.

NeonHome(string)

Path to a user's .neon home directory.

Declaration

public static string NeonHome(string username)

Parameters

Type	Name	Description
string	username	The username.

Returns

Type	Description
string	The directory path.

Upload(string)

Path to a user upload directory.

Declaration

public static string Upload(string username)

Parameters

Type	Name	Description
string	username	The username.

Returns

Type	Description
string	The directory path.