README
¶
om3
The Go port and continuation of opensvc/opensvc.
om3 is a cluster orchestrator for small-to-mid clusters — a coherent alternative to stitching together systemd, container runtimes, and ad-hoc scripts, with symmetric orchestration on every node.
Features
- Targeted at 1-32 node clusters, human-readable service configurations and status
- Highly redundant cluster communications (unicast, multicast, disk, third-site relay)
- Deploy application stacks on containers, persistent or volatile volumes, or low-level resources — disks, volume groups, filesystems, IP addresses, app launchers
- Native, zeroconf, encrypted datastores, with keys exposed as files for your deployments
- Manage everything through the API, the
omcommand line, or theoxterminal UI
Install
See the installation guide — the complete documentation lives there too.
Play
Deploy a simple service:
om test/svc/simple deploy --kw fs#1.type=flag --kw nodes='*' --kw orchestrate=ha
Then open an ox session and watch it move around the cluster.
Examples
Browse ready-to-use templates — VIPs, cluster DNS, ingress gateways, ACME, HA NFS, meshed VPN backend networks, and more.
Docker Image Signing
All OpenSVC Docker images published to ghcr.io/opensvc are signed with Cosign using Sigstore's keyless signing via GitHub Actions OIDC. The signing is performed automatically by the release workflow on Git tag creation.
To verify an image signature:
cosign verify \
--certificate-oidc-issuer=https://token.actions.githubusercontent.com \
--certificate-identity-regexp='^https://github.com/opensvc/om3/.github/workflows/release-go-docker-push-version.yml@' \
ghcr.io/opensvc/om:TAG
Replace TAG with the version (e.g., 3.0.0-rc30). Note that the v prefix from Git tags is stripped in Docker image tags.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
exec
command
|
|
|
om
command
|
|
|
ox
command
|
|
|
core
|
|
|
claim
Package claim is a namespace's claim on a cluster resource.
|
Package claim is a namespace's claim on a cluster resource. |
|
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. |
|
commoncmd/helptest
Package helptest holds the checks the om and ox command trees must both pass.
|
Package helptest holds the checks the om and ox command trees must both pass. |
|
credential
Package credential handles the <username>:<password> pair a node is handed to create a user with, once it is alone in its own cluster and no longer reachable with the credentials of the cluster it left.
|
Package credential handles the <username>:<password> pair a node is handed to create a user with, once it is alone in its own cluster and no longer reachable with the credentials of the cluster it left. |
|
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 |
|
ipam
Package ipam allocates the addresses of an om network on one node.
|
Package ipam allocates the addresses of an om network on one node. |
|
keyoprbac
Package keyoprbac is the rbac policy of the object configuration keywords: which of them a user holding no root grant may set, and with which values.
|
Package keyoprbac is the rbac policy of the object configuration keywords: which of them a user holding no root grant may set, and with which values. |
|
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/hbdedup
Package hbdedup drops the decoding of a heartbeat frame a peer already delivered over another heartbeat link.
|
Package hbdedup drops the decoding of a heartbeat frame a peer already delivered over another heartbeat link. |
|
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 |
|
metricsplit
Package metricsplit holds no code.
|
Package metricsplit holds no code. |
|
mntmon
Package mntmon is responsible for monitoring filesystem mount/umount/remount events and publishing them as pubsub events.
|
Package mntmon is responsible for monitoring filesystem mount/umount/remount events and publishing them as pubsub events. |
|
msgbus
Package msgbus defines the Opensvc messages
|
Package msgbus defines the Opensvc messages |
|
netmon
Package netmon is responsible for monitoring network link and IP address changes via netlink and publishing them as pubsub events.
|
Package netmon is responsible for monitoring network link and IP address changes via netlink and publishing them as pubsub events. |
|
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 |
|
pgmetrics
Package pgmetrics provides Prometheus metrics for cgroup resource usage under the opensvc.slice hierarchy.
|
Package pgmetrics provides Prometheus metrics for cgroup resource usage under the opensvc.slice hierarchy. |
|
remoteconfig
Package remoteconfig defines functions to fetch object config file from api
|
Package remoteconfig defines functions to fetch object config file from api |
|
session
Package session remembers the actions the daemon ran, so a client that submitted one can ask how it ended.
|
Package session remembers the actions the daemon ran, so a client that submitted one can ask how it ended. |
|
drivers
|
|
|
arrayhds
Package arrayhds drives a Hitachi array through the HiCommand Device Manager command line interface.
|
Package arrayhds drives a Hitachi array through the HiCommand Device Manager command line interface. |
|
arrayhp3par
Package arrayhp3par drives an HPE 3PAR array through its command line interface.
|
Package arrayhp3par drives an HPE 3PAR array through its command line interface. |
|
arrayxtremio
Package arrayxtremio drives a Dell EMC XtremIO array through its rest api.
|
Package arrayxtremio drives a Dell EMC XtremIO array through its rest api. |
|
claimnetwork
Package claimnetwork is a namespace's claim on the addresses of a network.
|
Package claimnetwork is a namespace's claim on the addresses of a network. |
|
claimpool
Package claimpool is a namespace's claim on the space of a pool.
|
Package claimpool is a namespace's claim on the space of a pool. |
|
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. |
|
resfssgcp_nfs
Package resfssgcp_nfs provides the SGCP NFS filesystem driver
|
Package resfssgcp_nfs provides the SGCP NFS filesystem driver |
|
resvol
Package resvol is the volume resource driver
|
Package resvol is the volume resource driver |
|
shared/hp3par
Package hp3par holds what the drivers of an HPE 3PAR array have in common: how a command line is built for the array, and how it is run.
|
Package hp3par holds what the drivers of an HPE 3PAR array have in common: how a command line is built for the array, and how it is run. |
|
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. |
|
arithmetic
Package arithmetic evaluates the arithmetic a configuration keyword holds, so a size can be written as a share of another size rather than as a number somebody worked out by hand.
|
Package arithmetic evaluates the arithmetic a configuration keyword holds, so a size can be written as a share of another size rather than as a number somebody worked out by hand. |
|
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
|
|
|
deepcopy
Package deepcopy copies the values the daemon datasets hold in fields typed any, where the concrete type is not known at compile time and so cannot be copied by a hand-written DeepCopy method.
|
Package deepcopy copies the values the daemon datasets hold in fields typed any, where the concrete type is not known at compile time and so cannot be copied by a hand-written DeepCopy method. |
|
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. |
|
flagvalue
Package flagvalue holds the option types the standard library and pflag do not provide, for the command sets that need them.
|
Package flagvalue holds the option types the standard library and pflag do not provide, for the command sets that need them. |
|
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 |
|
ini
Package ini implements a lossless reader and writer for the INI dialect used by the OpenSVC configuration files.
|
Package ini implements a lossless reader and writer for the INI dialect used by the OpenSVC configuration files. |
|
metricsreg
Package metricsreg holds the prometheus registries the daemon serves apart from the default one.
|
Package metricsreg holds the prometheus registries the daemon serves apart from the default one. |
|
mock_fnctllock
Package mock_fcntllock is a generated GoMock package.
|
Package mock_fcntllock is a generated GoMock package. |
|
prioqueue
Package prioqueue implements a priority queue using a heap-based implementation.
|
Package prioqueue implements a priority queue using a heap-based implementation. |
|
random
Package random provides utilities for generating random data
|
Package random provides utilities for generating random data |
|
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. |
|
sessioncache
Package sessioncache provide session cache for functions
|
Package sessioncache provide session cache for functions |
|
sgcp
Package sgcp provides utility functions for SGCP API interactions.
|
Package sgcp provides utility functions for SGCP API interactions. |
|
sgcpserverfortest
command
|
|
|
systemd
Package systemd provides systemd utilities
|
Package systemd provides systemd utilities |
|
tabwriter
Package tabwriter preserves ANSI color codes and aligns columns based on visible width (excluding ANSI escape sequences).
|
Package tabwriter preserves ANSI color codes and aligns columns based on visible width (excluding ANSI escape sequences). |
|
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 |
|
xfsquota
Package xfsquota sets and reads the project quotas an xfs filesystem can put on a directory tree.
|
Package xfsquota sets and reads the project quotas an xfs filesystem can put on a directory tree. |
Click to show internal directories.
Click to hide internal directories.