cluster

package

Go to main page

Versions in this module

v0

v0.9.0

Apr 22, 2026

Changes in this version

+ func CreateClusterVolume(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ type NodeDetail struct

+ Cluster string

+ Container string

+ FQDN string

+ IP string

+ Role config.Role

+ Services ServiceHealth

+ Status docker.ContainerState

type NodeHealth

+ State docker.ContainerState

type NodeSummary

+ Cluster string

+ Container string

+ FQDN string

+ IP string

+ func GetAllNodes(ctx context.Context, client *docker.Client, realm string) ([]*NodeSummary, error)

+ type RealmSummary struct

+ Clusters int

+ Name string

+ func GetRealms(ctx context.Context, client *docker.Client) ([]*RealmSummary, error)

type RunConfig

+ CapAdd []string

+ CapDrop []string

+ Devices []string

+ SecurityOpt []string

type Status

+ SlurmVersion string

type WorkerAddOptions

+ CapAdd []string

+ CapDrop []string

+ Devices []string

+ SecurityOpt []string

v0.8.0

Apr 7, 2026

v0.7.1

Apr 7, 2026

v0.7.0

Apr 6, 2026

Changes in this version

+ const DefaultDataMountPath

+ var AllVolumeTypes = []VolumeType

+ type ServiceHealth map[string]bool

+ type VolumeType string

+ const VolumeConfig

+ const VolumeData

+ const VolumeMunge

v0.6.0

Apr 2, 2026

v0.5.0

Apr 1, 2026

v0.4.0

Mar 30, 2026

v0.3.0

Mar 30, 2026

Changes in this version

+ const LabelDataHostPath

+ func BuildContainerExecArgs(container docker.ContainerName, isTTY bool, command []string) []string

+ func DiscoverClusterNames(ctx context.Context, client *docker.Client, realm string) ([]string, error)

+ type MountPoint struct

+ OK bool

+ Path string

+ Source string

+ Type string

+ func GetMountPoints(ctx context.Context, client *docker.Client, realm, clusterName string, ...) ([]MountPoint, error)

type NetworkHealth

+ ClusterDriver string

+ ClusterName string

+ DNSName string

+ MeshDriver string

+ MeshName string

type RunConfig

+ Pull bool

type State

+ const StateEmpty

+ const StateMixed

type Status

+ Mounts []MountPoint

type WorkerAddOptions

+ Pull bool

v0.2.0

Mar 30, 2026

Changes in this version

type Cluster

+ State State

type Node

+ State State

type NodeSummary

+ State State

+ type State string

+ const StatePaused

+ const StateRunning

+ const StateStopped

+ const StateUnknown

type Status

+ Name string

+ Network *NetworkHealth

+ Nodes []*NodeStatus

+ State State

+ Volumes *VolumeHealth

+ type Summary struct

+ Controllers int

+ Name string

+ NodeCount int

+ SlurmVersion string

+ State State

+ Submitters int

+ Workers int

v0.1.0

Mar 27, 2026

Changes in this version

+ const DNSSuffix

+ const LabelCluster

+ const LabelComposeConfigFiles

+ const LabelComposeConfigHash

+ const LabelComposeContainerNumber

+ const LabelComposeNetwork

+ const LabelComposeOneoff

+ const LabelComposeProject

+ const LabelComposeService

+ const LabelComposeVolume

+ const LabelRealm

+ const LabelRole

+ const LabelSlurmVersion

+ func BuildRunArgs(cfg RunConfig) []string

+ func BuildSSHArgs(sshContainer docker.ContainerName, node, cluster string, isTTY bool, ...) []string

+ func ComposeProject(realm, clusterName string) string

+ func ContainerLogArgs(realm, node, cluster string, follow bool) []string

+ func ContainerName(realm, cluster, shortName string) docker.ContainerName

+ func ContainerPrefix(realm, cluster string) string

+ func CreateClusterNetwork(ctx context.Context, client *docker.Client, realm, clusterName string) error

+ func CreateClusterNodes(ctx context.Context, client *docker.Client, meshMgr *mesh.Manager, ...) error

+ func CreateClusterVolumes(ctx context.Context, client *docker.Client, realm, clusterName string) error

+ func CreateNode(ctx context.Context, client *docker.Client, meshMgr *mesh.Manager, ...) (docker.ContainerID, error)

+ func DNSName(shortName, cluster string) string

+ func DNSSearchDomain(cluster string) string

+ func Delete(ctx context.Context, client *docker.Client, meshMgr *mesh.Manager, ...) error

+ func DeleteContainers(ctx context.Context, client *docker.Client, ...) error

+ func DeleteNetwork(ctx context.Context, client *docker.Client, name docker.NetworkName) error

+ func DeleteVolumes(ctx context.Context, client *docker.Client, volumes []docker.VolumeName) error

+ func DeregisterMesh(ctx context.Context, meshMgr *mesh.Manager, clusterName string, ...) error

+ func EnableSlurmServices(ctx context.Context, client *docker.Client, configs []RunConfig) error

+ func EnterTarget(ctx context.Context, client *docker.Client, realm, clusterName string) (string, error)

+ func ExecArgs(ctx context.Context, client *docker.Client, realm string, ...) ([]string, error)

+ func GetMungeKey(ctx context.Context, client *docker.Client, realm, clusterName string) ([]byte, error)

+ func HasOtherClusters(ctx context.Context, client *docker.Client, realm, clusterName string) (bool, error)

+ func NetworkName(realm, cluster string) docker.NetworkName

+ func NextComputeIndex(ctx context.Context, client *docker.Client, realm, clusterName string) (int, error)

+ func NodeLabels(realm, clusterName, role, slurmVersion string, containerNumber int) map[string]string

+ func NodeShortNames(nodes []config.Node) []string

+ func PowerCut(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PowerCycle(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PowerFreeze(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PowerOn(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PowerReboot(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PowerShutdown(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PowerUnfreeze(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ func PreflightCheck(ctx context.Context, client *docker.Client, realm string, cfg *config.Cluster) error

+ func ServiceLogArgs(realm, node, cluster, service string, follow bool) []string

+ func ValidateWorkerAdd(ctx context.Context, client *docker.Client, realm string, ...) error

+ func VolumeName(realm, cluster, volumeType string) docker.VolumeName

+ func WorkerRemove(ctx context.Context, client *docker.Client, meshMgr *mesh.Manager, ...) error

+ func WriteClusterConfig(ctx context.Context, client *docker.Client, realm string, cfg *config.Cluster, ...) error

+ func WriteMungeKey(ctx context.Context, client *docker.Client, realm, clusterName string, ...) error

+ type Cluster struct

+ Name string

+ Nodes []*Node

+ SlurmVersion string

+ Status Status

+ func Create(ctx context.Context, client *docker.Client, meshMgr *mesh.Manager, ...) (*Cluster, error)

+ type ClusterStatus struct

+ Name string

+ Network *NetworkHealth

+ Nodes []*NodeStatus

+ Status Status

+ Volumes *VolumeHealth

+ func GetStatus(ctx context.Context, client *docker.Client, realm, clusterName string) (*ClusterStatus, error)

+ type ClusterSummary struct

+ Controllers int

+ Name string

+ NodeCount int

+ SlurmVersion string

+ Status Status

+ Submitters int

+ Workers int

+ func GetClusters(ctx context.Context, client *docker.Client, realm string) ([]*ClusterSummary, error)

+ type NetworkHealth struct

+ Cluster bool

+ ClusterGateway string

+ ClusterSubnet string

+ DNS bool

+ Mesh bool

+ MeshGateway string

+ MeshSubnet string

+ func GetNetworkHealth(ctx context.Context, client *docker.Client, realm, clusterName string) (*NetworkHealth, error)

+ type NetworkSummary struct

+ Driver string

+ Gateway string

+ Name string

+ Subnet string

+ func GetNetworks(ctx context.Context, client *docker.Client, realm string) ([]*NetworkSummary, error)

+ type Node struct

+ ContainerID docker.ContainerID

+ IP string

+ Name string

+ Role string

+ Status Status

+ func WorkerAdd(ctx context.Context, client *docker.Client, meshMgr *mesh.Manager, ...) ([]*Node, error)

+ type NodeHealth struct

+ Container string

+ IP string

+ Munge bool

+ SSHD bool

+ Services map[string]bool

+ func GetNodeHealth(ctx context.Context, client *docker.Client, ...) (*NodeHealth, error)

+ type NodeStatus struct

+ Health *NodeHealth

+ Name string

+ Role string

+ type NodeSummary struct

+ Name string

+ Role string

+ Status Status

+ func GetNodes(ctx context.Context, client *docker.Client, realm, clusterName string) ([]*NodeSummary, error)

+ type Resources struct

+ Containers []docker.ContainerListEntry

+ Network docker.NetworkName

+ NetworkExists bool

+ Volumes []docker.VolumeName

+ func ListClusterResources(ctx context.Context, client *docker.Client, realm, clusterName string) (*Resources, error)

+ type RunConfig struct

+ CPUs int

+ ClusterName string

+ ContainerNumber int

+ DNSIP string

+ DataHostPath string

+ DataMountPath string

+ Image string

+ Managed bool

+ Memory string

+ Realm string

+ Role string

+ ShortName string

+ SlurmVersion string

+ TmpSize string

+ func NodeRunConfigs(cfg *config.Cluster, realm, dnsIP, slurmVersion string) []RunConfig

+ type Status string

+ const StatusPaused

+ const StatusRunning

+ const StatusStopped

+ const StatusUnknown

+ type VolumeHealth struct

+ Config bool

+ Data bool

+ Munge bool

+ func GetVolumeHealth(ctx context.Context, client *docker.Client, realm, clusterName string) (*VolumeHealth, error)

+ type VolumeSummary struct

+ Driver string

+ Name string

+ func GetVolumes(ctx context.Context, client *docker.Client, realm string) ([]*VolumeSummary, error)

+ type WorkerAddOptions struct

+ CPUs int

+ ClusterName string

+ Count int

+ Image string

+ Memory string

+ TmpSize string

+ Unmanaged bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL