Command line
rungar is the daemon and its command line in one binary. rungar serve runs the daemon; rungar validate and rungar config read a configuration file and need nothing else. Every other command asks the running daemon, through its socket, which root and the rungar group alone may use: run them with sudo -u rungar, or as root.
Commands
Running the daemon
| Command | Description |
|---|---|
rungar serve | Run the daemon. |
Checking a configuration
| Command | Description |
|---|---|
rungar validate | Check a configuration file, without contacting GitHub or any provider. |
rungar config | Print a configuration file as the daemon would run it, in YAML. |
rungar config migrate | Rewrite a configuration file for this version of Rungar. |
Seeing what the daemon does
| Command | Description |
|---|---|
rungar status | Show what the daemon is doing: its scale sets, providers and runners. |
rungar events | Show what the daemon has done to runners, providers and scale sets, and why. |
Changing what the daemon does
| Command | Description |
|---|---|
rungar scale-sets | List, inspect, pause, resume and remove scale sets. |
rungar scale-sets inspect | Show one scale set: in the configuration, in the daemon, on GitHub, and its runners. |
rungar scale-sets ls | List the configured scale sets, and those found only by their runners. |
rungar scale-sets pause | Stop a scale set taking jobs, leaving its busy runners to finish. |
rungar scale-sets resume | Have a paused scale set take jobs again. |
rungar scale-sets rm | Remove a scale set that is no longer configured: its runners, then the scale set on GitHub. |
rungar providers | List, inspect, disable, drain and enable providers. |
rungar providers disable | Take a provider out of placement, leaving its runners to finish. |
rungar providers drain | Disable a provider, and wait until its runners are gone. |
rungar providers enable | Put a provider back into placement. |
rungar providers inspect | Show one provider: its status, the scale sets on it, and its runners. |
rungar providers ls | List providers: their status, runners, weight and scale sets. |
rungar runners | List and remove runners. |
rungar runners ls | List runners: their machines, what the daemon knows of them, what GitHub says, and their jobs. |
rungar runners rm | Remove runners, the safe way round. |
rungar reconcile | Have the daemon compare scale sets with the fleet now. |
Global flags
| Flag | Description |
|---|---|
--socket string | The daemon’s socket (default $RUNGAR_SOCKET, or /run/rungar/rungar.sock). |
The commands that ask the daemon take --socket; every command takes -h, --help.
rungar --version prints the version.