GOIARDI(8)

🌸 NAME 🌸

goiardi — it's a Chef server, bestie, and it's written in Go ✨ This is the GOIARDI(8) page, so it lives over in the System Administration Utilities corner of the manual. yeah. sysadmin girlies, this one's for you 💅

🎀 DESCRIPTION 🎀

okay so the whole entire vibe of running this thing is:

💅 Usage:

goiardi [OPTIONS]

that's it, that's the shape of it. now buckle up because the options list is long 💀

✨ Application Options ✨

• -v, --version — print version info. short and sweet, we love a low-effort queen 🫶
• -V, --verbose — show verbose debug information. and like, you can repeat it for even more verbosity. stack it, bestie 👑
• -c, --config= — specify a config file to use.
• -I, --ipaddress= — listen on a specific IP address.
• -H, --hostname= — the hostname to use for this server. defaults to the hostname the kernel reports back. so if you don't say anything, the kernel decides for you 🌸
• -P, --port= — the port to listen on. heads up: if the port is set to 443, SSL gets activated. (default: 4545)
• -Z, --proxy-hostname= — the hostname to report to clients if this goiardi server is sitting behind a proxy that uses a different hostname. see also --proxy-port. you can run it with --proxy-port, or alone, or literally not at all, your call 🦋
• -W, --proxy-port= — the port to report to clients if this goiardi server is behind a proxy using a different port than the port goiardi itself is listening on. can go with --proxy-hostname, or alone, or not at all. no rules 💜
• -i, --index-file= — file to save search index data to.
• -D, --data-file= — file to save data store data to.
• -F, --freeze-interval= — interval in seconds to freeze in-memory data structures to disk if there have been any changes (and yeah, this one requires the -i/--index-file and -D/--data-file options to be set, so don't come crying to me). (Default 10 seconds.)
• -L, --log-file= — log to file X.
• -s, --syslog — log to syslog rather than a log file. it is incompatible with -L/--log-file, so pick a lane bestie 💅
• --time-slew= — the time difference allowed between the server's clock and the time in the X-OPS-TIMESTAMP header. formatted like 5m, 150s, etc. defaults to 15m.
• --conf-root= — root directory for configs and certificates. Default: the directory the config file is in, or the current directory if no config file is set.
• -A, --use-auth — use authentication. Default: false.
• --use-ssl — use SSL for connections. if --port is set to 433, this automatically gets turned on. if it's set to 80, it automatically gets turned off. Default: off. requires --ssl-cert and --ssl-key.
• --ssl-cert= — SSL certificate file. if it's a relative path, it'll be set relative to --conf-root.
• --ssl-key= — SSL key file. relative path? same deal, relative to --conf-root.
• --https-urls — use https:// in URLs to server resources if goiardi is not using SSL for its connections. super handy when goiardi is chillin' behind a reverse proxy that uses SSL, but is talking to that proxy over HTTP.
• --disable-webui — if enabled, this disables connections and logins to goiardi over the webui interface. doors closed, nobody home 🚪
• --use-mysql — use a MySQL database for data storage. configure the database options in the config file.
• --use-postgresql — use a PostgreSQL database for data storage. configure the database options in the config file.
• --local-filestore-dir= — directory to save uploaded files in. optional when running in in-memory mode, mandatory (unless you're doing S3 uploads) for SQL mode.
• --log-events — log changes to chef objects.
• -K, --log-event-keep= — number of events to keep in the event log. if it's set, the event log gets checked periodically and pruned down to this number of entries. spring cleaning, but automatic ✨
• -x, --export= — export all server data to the given file, and then exit afterwards. > ⚠️ should be used with caution. cannot be used at the same time as -m/--import.
• -m, --import= — import data from the given file, and then exit afterwards. cannot be used at the same time as -x/--export.
• -Q, --obj-max-size= — maximum object size in bytes for the file store. Default 10485760 bytes (10MB).
• -j, --json-req-max-size= — maximum size for a JSON request from the client. per chef-pedant, the default is 1000000.
• --use-unsafe-mem-store — use the faster, but less safe, old method of storing data in the in-memory data store with pointers, rather than encoding the data with gob and giving a new copy of the object to each requestor. turn this on and goiardi runs faster in in-memory mode, but one goroutine could change an object while it's being used by another 😭. has no effect when you're using an SQL backend.
• --db-pool-size= — number of idle db connections to maintain. only useful when you're using one of the SQL backends. Default is 0 — no idle connections retained.
• --max-connections= — maximum number of connections allowed for the database. only useful when using one of the SQL backends. Default is 0 — unlimited.
• --use-serf — if set, have goidari use serf to send and receive events and queries from a serf cluster. required for shovey.
• --serf-event-announce — announce log events and joining the serf cluster over serf, as serf events. requires --use-serf.
• --serf-addr= — IP address and port to use for RPC communication with a serf agent. defaults to 127.0.0.1:7373.
• --use-shovey — enable using shovey for sending jobs to nodes. requires --use-serf.
• --sign-priv-key= — path to the RSA private key used to sign shovey requests.
• --dot-search — if set, searches will use . to separate elements instead of _.
• --convert-search — if set, convert _ syntax searches to . syntax. only useful if --dot-search is set.
• --pg-search — use the new Postgres based search engine instead of the default ersatz Solr. requires --use-postgresql, and automatically turns on --dot-search. --convert-search is recommended, but not required.
• --use-statsd — whether or not to collect statistics about goiardi and send them to statsd.
• --statsd-addr= — IP address and port of the statsd instance to connect to. (default 'localhost:8125')
• --statsd-type= — statsd format, can be either 'standard' or 'datadog' (default 'standard')
• --statsd-instance= — statsd instance name to use for this server. defaults to the server's hostname, with . replaced by _.
• --use-s3-upload — store cookbook files in S3 rather than locally in memory or on disk. this or --local-filestore-dir must be set in SQL mode. cannot be used with in-memory mode.
• --aws-region= — AWS region to use for S3 uploads.
• --s3-bucket= — the name of the S3 bucket storing the files.
• --aws-disable-ssl — set this to disable SSL for the endpoint. mostly useful just for testing.
• --s3-endpoint= — set a different endpoint than the default s3.amazonaws.com. mostly useful for testing with a fake S3 service, or if you're using an S3-compatible service.
• --s3-file-period= — length of time, in minutes, to allow files to be saved to or retrieved from S3 by the client. defaults to 15 minutes.

🙋 Help Options

• -h, --help — show this help message 🫶

💫 COMPATIBILITY 💫

this version of Goiardi is aiming for compatibility with Chef Server version 11.1.7. periodt 💖

🦋 SEE ALSO 🦋

the complete Goiardi documentation is maintained as Sphinx docs online, and the latest version can be found right here:

https://goiardi.readthedocs.io/en/latest/

if the goiardi-doc package is installed, you should be able to browse them offline by pointing your browser at this local URL:

file:///usr/share/doc/goiardi-doc/html/index.html

🙈 okay important heads up: this manpage was automatically generated by the Debian goiardi maintainers. please do not file bugs about its content with the Goiardi upstream authors. not their fault, not their problem, don't do it bestie.

and that's a wrap on this whole page, which is goiardi version 0.11.0, dated November 2016 💜 go be a main character with your Chef server, ily, bye 🎀✨