1freight-agent(1)            General Commands Manual           freight-agent(1)
2
3
4

NAME

6       freight-agent - daemon to download and execute systemd containers
7

SYNOPSIS

9       frieght-agent [options]
10

DESCRIPTION

12       freight-agent  Is  a daemon that executes on a remote host, downloading
13       and  executing  systemd  containers  produced  by  freight-builder.   A
14       freight  administrator can direct configured agents to execute contain‐
15       ers provided in configured yum repositories.
16

OPTIONS

18        freight-agent [OPTIONS]
19
20       -h | --help
21              Display options and usage for the daemon
22
23       -c | --config </path/to/config/file>
24              Specify the config file to use with freight-agent (defaults to
25
26       -l | --list <all|local|running>
27              Select local or global scope in list mode, or list running  con‐
28              tainers
29
30       -v | --verbose
31              Verbose output
32
33       -m | --mode <mode>
34              Specify the mode which freight agent is operating in
35
36       --mode node
37              Operate  in  node  mode - freight-agent listens for and executes
38              container requests
39
40       --mode master
41              Operate in master mode - freight-agent monitors health of  nodes
42              and database /etc/freight-agent/config
43
44       --mode init
45              Preform a one time initalization of the container working direc‐
46              tory for freight-agent.  This is useful for setting up for local
47              container install and execution.
48
49       --mode clean
50              Remove  that  freight-agent  container  root  working directory.
51              This destroys the yum and local rpm databases that  track  which
52              containers  are installed, removes the installed containers, and
53              destroys the existing config retrieved from the database.
54
55
56
57       CONFIG FILE FORMAT
58
59              The config file has the following format
60
61              ---------------------------------------------
62              # These are comments
63
64
65              # The type of database to connect to
66              # postgres is meant for clusters of freight agents on multiple systesm
67              # sqlite is meant for local installations
68              # freightproxy is the xmlrpc proxy to a backend postgres db
69              db = {
70                   dbtype = "postgres | sqlite | freightproxy";
71                   hostaddr = "hostname of db server";
72                   hostport = "optional port of db server
73                   dbname = "Name of database/database file";
74                   user = "User name to access server";
75                   password = "password to access server";
76              };
77
78
79              # configuration for freight-agent when running in node mode
80              node = {
81                   container_root = "Path to container store";
82                   host_bridge = "bridge to use for container communication";
83                   hostname = "name to register in db. defaults to gethostname";
84                   gc_interval = "How often to check for unused containers (0 disables)";
85                   gc_thresh = "Number of gc intervals before a container is removed";
86              };
87
88              # configuration for freight proxy server
89              proxy = {
90                      serverport = "8080";
91                      log = "/tmp/freightproxy.log";
92              };
93
94              master = {
95              };
96
97              ----------------------------------------------
98
99
100
101       Note that the dbtype field supports the following database types
102
103       postgres
104
105       Standard postgres database
106
107       nodb
108
109       A Null db for local freigght agent use
110
111       freightproxy
112
113       Connection to the freightproxy xmlrpc database proxy
114
115
116
117
118Neil Horman                        Apr 2015                   freight-agent(1)