Documentation
¶
Index ¶
- Variables
- func EvalVars[T any](object *T, vars map[string]string) error
- func GetJobs(jobsFilter ...string) map[string]*common.Job
- func GetLoadsConfigGraph() graph.Graph[string, string]
- func GetLoadsFromConfig(loadsFilter ...string) map[string]*common.Load
- func GetNodes(nodesFilter ...string) map[string]*common.Node
- func GetVersion() string
- func ResetJobsConfig()
- func ResetLoadsConfig()
- func ResetNodesConfig()
- type AgentConfig
- type ArtifactsRepository
- type Config
- type JobsConfig
- type LoadsConfig
- type MeshConfig
- type MeshTransport
- type NetworkConfig
- type NodesConfig
Constants ¶
This section is empty.
Variables ¶
View Source
var ( BuildGitCommit string Version = "dev" )
Functions ¶
func EvalVars ¶ added in v0.2.4
EvalVars replaces every occurrence of {{var}} with the corresponding value from vars, mutating object in place. object must be a pointer.
func GetVersion ¶
func GetVersion() string
func ResetJobsConfig ¶ added in v0.2.5
func ResetJobsConfig()
func ResetLoadsConfig ¶ added in v0.1.2
func ResetLoadsConfig()
func ResetNodesConfig ¶ added in v0.1.2
func ResetNodesConfig()
Types ¶
type AgentConfig ¶ added in v0.2.0
type AgentConfig struct {
// Address to bind the agent API.
// Default: 127.0.0.1
ListenAddress string `json:"listen_address"`
// Port to bind the agent API.
// Default: 9000
ListenPort int `json:"listen_port"`
// Path to CNI plugins.
// Default: /usr/lib/cni (Linux) or %ProgramData%\realm\cni (Windows)
CniPath string `json:"cni_path"`
// Name of the ZFS pool for container volumes.
// Default: realm_volumes
VolumesPool string `json:"volumes_pool"`
// Enable ZFS for volume management.
// When true, uses ZFS-based volume implementation.
// When false, uses directory-based volume implementation.
// Default: false
ZFS bool `json:"zfs"`
// Log output format.
// Valid values: "text", "json"
// Default: text
LogFormat string `json:"log_format"`
// Containerd socket path.
// Default: /run/containerd/containerd.sock (Linux) or npipe://./pipe/containerd-containerd (Windows)
ContainerdSock string `json:"containerd_sock"`
// Containerd namespace to use.
// Default: realm
ContainerdNamespace string `json:"containerd_namespace"`
// Artifacts repository (experimental)
Artifacts ArtifactsRepository `json:"artifacts"`
}
AgentConfig holds the configuration for the realm agent. All fields are optional and have platform-specific or sensible defaults.
type ArtifactsRepository ¶ added in v0.2.4
type ArtifactsRepository struct {
AuthRequired bool `json:"auth_required"`
// Path to raw artifacts
RawArtifactsPath *string `json:"raw_path,omitempty"`
}
ArtifactRepositoryConfig
type Config ¶
type Config struct {
// Path to store realm data (ID file, database, logs, mesh configs...).
// Default: /var/lib/realm (Linux) or %ProgramData%\realm (Windows)
DataPath string `json:"data_path"`
Agent AgentConfig `json:"agent"`
Nodes NodesConfig `json:"nodes"`
Loads LoadsConfig `json:"loads"`
Jobs JobsConfig `json:"jobs"`
// Autoconfigured network Config
NetworkConfig NetworkConfig `json:"-"`
MeshConfig *MeshConfig `json:"mesh,omitempty"`
// contains filtered or unexported fields
}
func Init ¶
Init reads configuration from file or environment variables. If configFilePath is provided, it will be used instead of the default locations.
func InitFromBuffer ¶
func (*Config) GetLoadsGraph ¶ added in v0.1.2
func (Config) NeedsCloudInit ¶ added in v0.1.8
type JobsConfig ¶ added in v0.2.5
type LoadsConfig ¶
type LoadsConfig map[string]common.LoadConfig
type MeshConfig ¶ added in v0.2.2
type MeshConfig struct {
ServerUrl string `json:"server"`
Transport MeshTransport `json:"transport,omitempty"`
LinkCode string `json:"link_code"`
}
type MeshTransport ¶ added in v0.2.2
type MeshTransport string
const ( MeshTransportUDP MeshTransport = "udp" MeshTransportWebsocket MeshTransport = "websocket" )
type NodesConfig ¶ added in v0.2.5
type NodesConfig map[string]*common.NodeConfig
Click to show internal directories.
Click to hide internal directories.