README
¶
README.md
NOTE: This project is the alpha stage of the golang port of https://github.com/opensvc/opensvc.
NOTE: General Availability is expected Q1 2025
A cluster orchestrator with a distinctive feature set
- Simple and powerful
- Targeted at 1-32 nodes clusters
- Human readable services configurations and status
- Coherent alternative to a wide range of integration methods: from systemd to kubernetes
- Highly redundant cluster communications (ucast, mcast, disk, 3rd site relay)
- All nodes symmetric orchestration policies
- Orchestrate application stacks based on containers, and much more
- Provision stacks from template configurations, including disk, vg, fs, ip
- Optional CNI cluster networks, cluster DNS, ingress gateways
- DevOps, or pipelined delivery
Dig Agent Features
Agent Installation
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
exec
command
|
|
|
om
command
|
|
|
ox
command
|
|
|
core
|
|
|
clusterhb
Package clusterhb retrieve hbconfer objects found in node/cluster config
|
Package clusterhb retrieve hbconfer objects found in node/cluster config |
|
clusternode
Package clusternode provides a protected cache for cluster nodes It may be used from crm or from daemon
|
Package clusternode provides a protected cache for cluster nodes It may be used from crm or from daemon |
|
commoncmd
Package commoncmd provides utilities and shared functionality to facilitate operations related to managing remotes objects, nodes, and logs for omcmd and oxcmd.
|
Package commoncmd provides utilities and shared functionality to facilitate operations related to managing remotes objects, nodes, and logs for omcmd and oxcmd. |
|
driver
Package driver is the package serving the driver registry.
|
Package driver is the package serving the driver registry. |
|
hbcfg
Package hbcfg provides helpers to create hb drivers from configuration
|
Package hbcfg provides helpers to create hb drivers from configuration |
|
hbsecobject
Package hbsecobject provides utilities to manage the naming.SecHb object
|
Package hbsecobject provides utilities to manage the naming.SecHb object |
|
hbtype
Package hbtype provides types for hb drivers
|
Package hbtype provides types for hb drivers |
|
mock_monitor
Package mock_monitor is a generated GoMock package.
|
Package mock_monitor is a generated GoMock package. |
|
om
Package om create opensvc command line assembly
|
Package om create opensvc command line assembly |
|
omcrypto
Package omcrypto is responsible for Message Encrypt, Decrypt, DecryptWithNode
|
Package omcrypto is responsible for Message Encrypt, Decrypt, DecryptWithNode |
|
osagentservice
Package osagentservice provides agent tools for os launcher services
|
Package osagentservice provides agent tools for os launcher services |
|
sse
Package sse define Server Side Event feeder for clients
|
Package sse define Server Side Event feeder for clients |
|
statusbus
Package statusbus collects and dispatches object rid status changes
|
Package statusbus collects and dispatches object rid status changes |
|
vpath
Package vpath is a helper package easing the expansion of a virtual path like vol1/etc/nginx.conf to a host path like /srv/svc1data.ns1.vol.clu1/etc/nginx.conf
|
Package vpath is a helper package easing the expansion of a virtual path like vol1/etc/nginx.conf to a host path like /srv/svc1data.ns1.vol.clu1/etc/nginx.conf |
|
Package daemon is responsible ot other opensvc daemons start/stop
|
Package daemon is responsible ot other opensvc daemons start/stop |
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
ccfg
Package ccfg is responsible for the cluster config
|
Package ccfg is responsible for the cluster config |
|
collector
Package collector is the daemon collector main goroutine
|
Package collector is the daemon collector main goroutine |
|
cstat
Package cstat is responsible for the cluster status
|
Package cstat is responsible for the cluster status |
|
daemondata
Package daemondata implements daemon journaled data
|
Package daemondata implements daemon journaled data |
|
daemontesthelper
Package daemonhelper is a helper for daemon components tests
|
Package daemonhelper is a helper for daemon components tests |
|
discover
Package discover implements object discovery for daemon
|
Package discover implements object discovery for daemon |
|
dns
Package dns is responsible for the cluster dns zone management.
|
Package dns is responsible for the cluster dns zone management. |
|
draincommand
Package draincommand is a helper for daemon drain commands
|
Package draincommand is a helper for daemon drain commands |
|
encryptconn
Package encryptconn provides encrypted/decrypted net.Conn
|
Package encryptconn provides encrypted/decrypted net.Conn |
|
hb/hbcrypto
Package hbcrypto handles creation and updates of *atomic.Pointer[omcrypto.T] to follow the cluster name or hb secret object changes.
|
Package hbcrypto handles creation and updates of *atomic.Pointer[omcrypto.T] to follow the cluster name or hb secret object changes. |
|
hb/hbctrl
Package hbctrl manage data and status of daemon heartbeats
|
Package hbctrl manage data and status of daemon heartbeats |
|
hb/hbdisk
Package hbdisk implement a hb disk driver.
|
Package hbdisk implement a hb disk driver. |
|
hb/hbmcast
Package hbmcast implement a hb multicast driver
|
Package hbmcast implement a hb multicast driver |
|
hb/hbrelay
Package hbrelay uses a tiers opensvc agent as a kv store to exchange node data.
|
Package hbrelay uses a tiers opensvc agent as a kv store to exchange node data. |
|
hb/hbucast
Package hbucast implement a hb unicast driver
|
Package hbucast implement a hb unicast driver |
|
hbcache
Package hbcache manage []cluster.HeartbeatStream cache localnode
|
Package hbcache manage []cluster.HeartbeatStream cache localnode |
|
icfg
Package icfg is responsible for local instance.Config
|
Package icfg is responsible for local instance.Config |
|
imon
Package imon is responsible for of local instance state
|
Package imon is responsible for of local instance state |
|
istat
Package istat implements the management of local instance status
|
Package istat implements the management of local instance status |
|
listener/routehttp
Package routehttp provides http mux
|
Package routehttp provides http mux |
|
msgbus
Package msgbus defines the Opensvc messages
|
Package msgbus defines the Opensvc messages |
|
nmon
Package nmon is responsible for the local node states
|
Package nmon is responsible for the local node states |
|
omon
Package omon is responsible for of object.Status
|
Package omon is responsible for of object.Status |
|
remoteconfig
Package remoteconfig defines functions to fetch object config file from api
|
Package remoteconfig defines functions to fetch object config file from api |
|
drivers
|
|
|
resapp
Package resapp provides bases for other app drivers
|
Package resapp provides bases for other app drivers |
|
rescontainerocibase
Package rescontainerocibase provides base settings for to implement resource container oci drivers.
|
Package rescontainerocibase provides base settings for to implement resource container oci drivers. |
|
resvol
Package resvol is the volume resource driver
|
Package resvol is the volume resource driver |
|
util
|
|
|
args
Package args parses a posix arguments string using shlex.Split() and proposes methods to drop options and option-values.
|
Package args parses a posix arguments string using shlex.Split() and proposes methods to drop options and option-values. |
|
bootid
Package bootid provides node boot id.
|
Package bootid provides node boot id. |
|
capabilities
Package capabilities maintain global capabilities
|
Package capabilities maintain global capabilities |
|
command
Package command provide utilities around os/exec package
|
Package command provide utilities around os/exec package |
|
compobj
command
|
|
|
durationlog
Package durationlog provides a helper to log a warning when the delay between 2 events is longer than expected.
|
Package durationlog provides a helper to log a warning when the delay between 2 events is longer than expected. |
|
envprovider
Package envprovider implement function to construct env vars from sec or cfg env items
|
Package envprovider implement function to construct env vars from sec or cfg env items |
|
errcontext
Package errcontext defines a context-aware error handling mechanism using interfaces and a struct that allows sending and receiving a single error.
|
Package errcontext defines a context-aware error handling mechanism using interfaces and a struct that allows sending and receiving a single error. |
|
fcache
Package fcache provide session cache for functions
|
Package fcache provide session cache for functions |
|
funcopt
Package funcopt is a functional options helper package.
|
Package funcopt is a functional options helper package. |
|
httpclientcache
Package httpclientcache serve http client from cache.
|
Package httpclientcache serve http client from cache. |
|
httphelper
Package httphelper implements NewRequest, Do, DoRequest from a requestfactory.T and http.client
|
Package httphelper implements NewRequest, Do, DoRequest from a requestfactory.T and http.client |
|
mock_fnctllock
Package mock_fcntllock is a generated GoMock package.
|
Package mock_fcntllock is a generated GoMock package. |
|
requestfactory
Package requestfactory provides *http.Request factory with default headers and base url.
|
Package requestfactory provides *http.Request factory with default headers and base url. |
|
systemd
Package systemd provides systemd utilities
|
Package systemd provides systemd utilities |
|
timestamp
Package timestamp manage Unix timestamps
|
Package timestamp manage Unix timestamps |
|
usergroup
Package usergroup provides helpers for user and group
|
Package usergroup provides helpers for user and group |
Click to show internal directories.
Click to hide internal directories.