goiardi: github.com/ctdk/goiardi/config Index | Files

package config

import "github.com/ctdk/goiardi/config"

Package config parses command line flags and config files, and defines options used elsewhere in goiardi.


Package Files

config.go syslog.go vault.go


const ChefVersion = "11.1.7"

The chef version we're at least aiming for, even if it's not complete yet.

const DefaultTimeSlew = "15m"

The default time difference allowed between the server's clock and the time in the X-OPS-TIMESTAMP header.

const MaxAPIVersion = "1"

Maximum supported API version

const MinAPIVersion = "0"

Minimum supported API version

const Version = "0.11.9"

The goiardi version.


var Config = initConfig()

Config struct with the options specified on the command line or in the config file.

var GitHash = "unknown"

GitHash is the git hash (supplied with '-ldflags "-X config.GitHash=<hash>"') of goiardi when it was compiled.

var Key = &SigningKeys{}

Key is the initialized shovey public and private keys.

var LogLevelNames = map[string]int{"debug": 5, "info": 4, "warning": 3, "error": 2, "critical": 1, "fatal": 0}

LogLevelNames give convenient, easier to remember than number name for the different levels of logging.

var SupportedAPIVersions = []string{"0", "1"}

All supported API versions

func ListenAddr Uses

func ListenAddr() string

ListenAddr builds the address and port goiardi is configured to listen on.

func ParseConfigOptions Uses

func ParseConfigOptions() error

ParseConfigOptions reads and applies arguments from the command line and the configuration file, merging them together as needed, with command line options taking precedence over options in the config file.

func PprofWhitelisted Uses

func PprofWhitelisted(remoteIP net.IP) bool

func ServerBaseURL Uses

func ServerBaseURL() string

ServerBaseURL returns the base scheme+hostname portion of a goiardi URL.

func ServerHostname Uses

func ServerHostname() string

ServerHostname returns the hostname and port goiardi is configured to use.

func UsingDB Uses

func UsingDB() bool

UsingDB returns true if we're using any db engine, false if using the in-memory data store.

func UsingExternalSecrets Uses

func UsingExternalSecrets() bool

type Conf Uses

type Conf struct {
    Ipaddress            string
    Port                 int
    Hostname             string
    ProxyHostname        string `toml:"proxy-hostname"`
    ProxyPort            int    `toml:"proxy-port"`
    ConfFile             string `toml:"conf-file"`
    IndexFile            string `toml:"index-file"`
    DataStoreFile        string `toml:"data-file"`
    DebugLevel           int    `toml:"debug-level"`
    LogLevel             string `toml:"log-level"`
    FreezeInterval       int    `toml:"freeze-interval"`
    FreezeData           bool   `toml:"freeze-data"`
    LogFile              string `toml:"log-file"`
    SysLog               bool   `toml:"syslog"`
    UseAuth              bool   `toml:"use-auth"`
    TimeSlew             string `toml:"time-slew"`
    TimeSlewDur          time.Duration
    ConfRoot             string       `toml:"conf-root"`
    UseSSL               bool         `toml:"use-ssl"`
    SSLCert              string       `toml:"ssl-cert"`
    SSLKey               string       `toml:"ssl-key"`
    HTTPSUrls            bool         `toml:"https-urls"`
    DisableWebUI         bool         `toml:"disable-webui"`
    UseMySQL             bool         `toml:"use-mysql"`
    MySQL                MySQLdb      `toml:"mysql"`
    UsePostgreSQL        bool         `toml:"use-postgresql"`
    PostgreSQL           PostgreSQLdb `toml:"postgresql"`
    LocalFstoreDir       string       `toml:"local-filestore-dir"`
    LogEvents            bool         `toml:"log-events"`
    LogEventKeep         int          `toml:"log-event-keep"`
    SkipLogExtended      bool         `toml:"skip-log-extended"`
    DoExport             bool
    DoImport             bool
    ImpExFile            string
    ObjMaxSize           int64    `toml:"obj-max-size"`
    JSONReqMaxSize       int64    `toml:"json-req-max-size"`
    UseUnsafeMemStore    bool     `toml:"use-unsafe-mem-store"`
    DbPoolSize           int      `toml:"db-pool-size"`
    MaxConn              int      `toml:"max-connections"`
    UseSerf              bool     `toml:"use-serf"`
    SerfEventAnnounce    bool     `toml:"serf-event-announce"`
    SerfAddr             string   `toml:"serf-addr"`
    UseShovey            bool     `toml:"use-shovey"`
    SignPrivKey          string   `toml:"sign-priv-key"`
    DotSearch            bool     `toml:"dot-search"`
    ConvertSearch        bool     `toml:"convert-search"`
    PgSearch             bool     `toml:"pg-search"`
    UseStatsd            bool     `toml:"use-statsd"`
    StatsdAddr           string   `toml:"statsd-addr"`
    StatsdType           string   `toml:"statsd-type"`
    StatsdInstance       string   `toml:"statsd-instance"`
    UseS3Upload          bool     `toml:"use-s3-upload"`
    AWSRegion            string   `toml:"aws-region"`
    S3Bucket             string   `toml:"s3-bucket"`
    AWSDisableSSL        bool     `toml:"aws-disable-ssl"`
    S3Endpoint           string   `toml:"s3-endpoint"`
    S3FilePeriod         int      `toml:"s3-file-period"`
    UseExtSecrets        bool     `toml:"use-external-secrets"`
    VaultAddr            string   `toml:"vault-addr"`
    VaultShoveyKey       string   `toml:"vault-shovey-key"`
    EnvVars              []string `toml:"env-vars"`
    IndexValTrim         int      `toml:"index-val-trim"`
    PprofWhitelist       []string `toml:"pprof-whitelist"`
    PurgeNodeStatusAfter string   `toml:"purge-status-after"`
    PurgeReportsAfter    string   `toml:"purge-reports-after"`
    PurgeSandboxesAfter  string   `toml:"purge-sandboxes-after"`
    PurgeNodeStatusDur   time.Duration
    PurgeReportsDur      time.Duration
    PurgeSandboxesDur    time.Duration
    SearchQueryDebug     bool

Conf is the master struct for holding configuration options.

type MySQLdb Uses

type MySQLdb struct {
    Username    string            `long:"username" description:"MySQL username" env:"GOIARDI_MYSQL_USERNAME"`
    Password    string            `long:"password" description:"MySQL password" env:"GOIARDI_MYSQL_PASSWORD"`
    Protocol    string            `long:"protocol" description:"MySQL protocol (tcp or unix)" env:"GOIARDI_MYSQL_PROTOCOL"`
    Address     string            `long:"address" description:"MySQL IP address, hostname, or path to a socket" env:"GOIARDI_MYSQL_ADDRESS"`
    Port        string            `long:"port" description:"MySQL TCP port" env:"GOIARDI_MYSQL_PORT"`
    Dbname      string            `long:"dbname" description:"MySQL database name" env:"GOIARDI_MYSQL_DBNAME"`
    ExtraParams map[string]string `toml:"extra_params" long:"extra-params" description:"Extra configuration parameters for MySQL. Specify them like '--mysql-extra-params=foo:bar'. Multiple extra parameters can be specified by supplying the --mysql-extra-params flag multiple times. If using an environment variable, split up multiple parameters with #, like so: GOIARDI_MYSQL_EXTRA_PARAMS='foo:bar#baz:bug'." env:"GOIARDI_MYSQL_EXTRA_PARAMS" env-delim:"#"`

MySQLdb holds MySQL connection options.

type Options Uses

type Options struct {
    Version              bool         `short:"v" long:"version" description:"Print version info."`
    Verbose              []bool       `short:"V" long:"verbose" description:"Show verbose debug information. Repeat for more verbosity."`
    ConfFile             string       `short:"c" long:"config" description:"Specify a config file to use." env:"GOIARDI_CONFIG"`
    Ipaddress            string       `short:"I" long:"ipaddress" description:"Listen on a specific IP address." env:"GOIARDI_IPADDRESS"`
    Hostname             string       `short:"H" long:"hostname" description:"Hostname to use for this server. Defaults to hostname reported by the kernel." env:"GOIARDI_HOSTNAME"`
    Port                 int          `short:"P" long:"port" description:"Port to listen on. If port is set to 443, SSL will be activated. (default: 4545)" env:"GOIARDI_PORT"`
    ProxyHostname        string       `short:"Z" long:"proxy-hostname" description:"Hostname to report to clients if this goiardi server is behind a proxy using a different hostname. See also --proxy-port. Can be used with --proxy-port or alone, or not at all." env:"GOIARDI_PROXY_HOSTNAME"`
    ProxyPort            int          `short:"W" long:"proxy-port" description:"Port to report to clients if this goiardi server is behind a proxy using a different port than the port goiardi is listening on. Can be used with --proxy-hostname or alone, or not at all." env:"GOIARDI_PROXY_PORT"`
    IndexFile            string       `short:"i" long:"index-file" description:"File to save search index data to." env:"GOIARDI_INDEX_FILE"`
    DataStoreFile        string       `short:"D" long:"data-file" description:"File to save data store data to." env:"GOIARDI_DATA_FILE"`
    FreezeInterval       int          `short:"F" long:"freeze-interval" description:"Interval in seconds to freeze in-memory data structures to disk if there have been any changes (requires -i/--index-file and -D/--data-file options to be set). (Default 10 seconds.)" env:"GOIARDI_FREEZE_INTERVAL"`
    LogFile              string       `short:"L" long:"log-file" description:"Log to file X" env:"GOIARDI_LOG_FILE"`
    SysLog               bool         `short:"s" long:"syslog" description:"Log to syslog rather than a log file. Incompatible with -L/--log-file." env:"GOIARDI_SYSLOG"`
    LogLevel             string       `short:"g" long:"log-level" description:"Specify logging verbosity. Performs the same function as -V, but works like the 'log-level' option in the configuration file. Acceptable values are 'debug', 'info', 'warning', 'error', 'critical', and 'fatal'." env:"GOIARDI_LOG_LEVEL"`
    TimeSlew             string       `long:"time-slew" description:"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." env:"GOIARDI_TIME_SLEW"`
    ConfRoot             string       `long:"conf-root" description:"Root directory for configs and certificates. Default: the directory the config file is in, or the current directory if no config file is set." env:"GOIARDI_CONF_ROOT"`
    UseAuth              bool         `short:"A" long:"use-auth" description:"Use authentication. Default: false. (NB: At a future time, the default behavior will change to authentication being enabled.)" env:"GOIARDI_USE_AUTH"`
    UseSSL               bool         `long:"use-ssl" description:"Use SSL for connections. If --port is set to 433, this will automatically be turned on. If it is set to 80, it will automatically be turned off. Default: off. Requires --ssl-cert and --ssl-key." env:"GOIARDI_USE_SSL"`
    SSLCert              string       `long:"ssl-cert" description:"SSL certificate file. If a relative path, will be set relative to --conf-root." env:"GOIARDI_SSL_CERT"`
    SSLKey               string       `long:"ssl-key" description:"SSL key file. If a relative path, will be set relative to --conf-root." env:"GOIARDI_SSL_KEY"`
    HTTPSUrls            bool         `long:"https-urls" description:"Use 'https://' in URLs to server resources if goiardi is not using SSL for its connections. Useful when goiardi is sitting behind a reverse proxy that uses SSL, but is communicating with the proxy over HTTP." env:"GOIARDI_HTTPS_URLS"`
    DisableWebUI         bool         `long:"disable-webui" description:"If enabled, disables connections and logins to goiardi over the webui interface." env:"GOIARDI_DISABLE_WEBUI"`
    UseMySQL             bool         `long:"use-mysql" description:"Use a MySQL database for data storage. Configure database options in the config file." env:"GOIARDI_USE_MYSQL"`
    MySQL                MySQLdb      `group:"MySQL connection options (requires --use-mysql)" namespace:"mysql"`
    UsePostgreSQL        bool         `long:"use-postgresql" description:"Use a PostgreSQL database for data storage. Configure database options in the config file." env:"GOIARDI_USE_POSTGRESQL"`
    PostgreSQL           PostgreSQLdb `group:"PostgreSQL connection options (requires --use-postgresql)" namespace:"postgresql"`
    LocalFstoreDir       string       `long:"local-filestore-dir" description:"Directory to save uploaded files in. Optional when running in in-memory mode, *mandatory* (unless using S3 uploads) for SQL mode." env:"GOIARDI_LOCAL_FILESTORE_DIR"`
    LogEvents            bool         `long:"log-events" description:"Log changes to chef objects." env:"GOIARDI_LOG_EVENTS"`
    LogEventKeep         int          `short:"K" long:"log-event-keep" description:"Number of events to keep in the event log. If set, the event log will be checked periodically and pruned to this number of entries." env:"GOIARDI_LOG_EVENT_KEEP"`
    SkipLogExtended      bool         `long:"skip-log-extended" description:"If set, do not save a JSON encoded blob of the object being logged when logging an event." env:"GOIARDI_SKIP_LOG_EXTENDED"`
    Export               string       `short:"x" long:"export" description:"Export all server data to the given file, exiting afterwards. Should be used with caution. Cannot be used at the same time as -m/--import."`
    Import               string       `short:"m" long:"import" description:"Import data from the given file, exiting afterwards. Cannot be used at the same time as -x/--export."`
    ObjMaxSize           int64        `short:"Q" long:"obj-max-size" description:"Maximum object size in bytes for the file store. Default 10485760 bytes (10MB)." env:"GOIARDI_OBJ_MAX_SIZE"`
    JSONReqMaxSize       int64        `short:"j" long:"json-req-max-size" description:"Maximum size for a JSON request from the client. Per chef-pedant, default is 1000000." env:"GOIARDI_JSON_REQ_MAX_SIZE"`
    UseUnsafeMemStore    bool         `long:"use-unsafe-mem-store" description:"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. If this is enabled goiardi will run faster in in-memory mode, but one goroutine could change an object while it's being used by another. Has no effect when using an SQL backend. (DEPRECATED - will be removed in a future release.)"`
    DbPoolSize           int          `long:"db-pool-size" description:"Number of idle db connections to maintain. Only useful when using one of the SQL backends. Default is 0 - no idle connections retained" env:"GOIARDI_DB_POOL_SIZE"`
    MaxConn              int          `long:"max-connections" description:"Maximum number of connections allowed for the database. Only useful when using one of the SQL backends. Default is 0 - unlimited." env:"GOIARDI_MAX_CONN"`
    UseSerf              bool         `long:"use-serf" description:"If set, have goidari use serf to send and receive events and queries from a serf cluster. Required for shovey." env:"GOIARDI_USE_SERF"`
    SerfEventAnnounce    bool         `long:"serf-event-announce" description:"Announce log events and joining the serf cluster over serf, as serf events. Requires --use-serf." env:"GOIARDI_SERF_EVENT_ANNOUNCE"`
    SerfAddr             string       `long:"serf-addr" description:"IP address and port to use for RPC communication with a serf agent. Defaults to" env:"GOIARDI_SERF_ADDR"`
    UseShovey            bool         `long:"use-shovey" description:"Enable using shovey for sending jobs to nodes. Requires --use-serf." env:"GOIARDI_USE_SHOVEY"`
    SignPrivKey          string       `long:"sign-priv-key" description:"Path to RSA private key used to sign shovey requests." env:"GOIARDI_SIGN_PRIV_KEY"`
    DotSearch            bool         `long:"dot-search" description:"If set, searches will use . to separate elements instead of _." env:"GOIARDI_DOT_SEARCH"`
    ConvertSearch        bool         `long:"convert-search" description:"If set, convert _ syntax searches to . syntax. Only useful if --dot-search is set." env:"GOIARDI_CONVERT_SEARCH"`
    PgSearch             bool         `long:"pg-search" description:"Use the new Postgres based search engine instead of the default ersatz Solr. Requires --use-postgresql, automatically turns on --dot-search. --convert-search is recommended, but not required." env:"GOIARDI_PG_SEARCH"`
    UseStatsd            bool         `long:"use-statsd" description:"Whether or not to collect statistics about goiardi and send them to statsd." env:"GOIARDI_USE_STATSD"`
    StatsdAddr           string       `long:"statsd-addr" description:"IP address and port of statsd instance to connect to. (default 'localhost:8125')" env:"GOIARDI_STATSD_ADDR"`
    StatsdType           string       `long:"statsd-type" description:"statsd format, can be either 'standard' or 'datadog' (default 'standard')" env:"GOIARDI_STATSD_TYPE"`
    StatsdInstance       string       `long:"statsd-instance" description:"Statsd instance name to use for this server. Defaults to the server's hostname, with '.' replaced by '_'." env:"GOIARDI_STATSD_INSTANCE"`
    UseS3Upload          bool         `long:"use-s3-upload" description:"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." env:"GOIARDI_USE_S3_UPLOAD"`
    AWSRegion            string       `long:"aws-region" description:"AWS region to use S3 uploads." env:"GOIARDI_AWS_REGION"`
    S3Bucket             string       `long:"s3-bucket" description:"The name of the S3 bucket storing the files." env:"GOIARDI_S3_BUCKET"`
    AWSDisableSSL        bool         `long:"aws-disable-ssl" description:"Set to disable SSL for the endpoint. Mostly useful just for testing." env:"GOIARDI_AWS_DISABLE_SSL"`
    S3Endpoint           string       `long:"s3-endpoint" description:"Set a different endpoint than the default s3.amazonaws.com. Mostly useful for testing with a fake S3 service, or if using an S3-compatible service." env:"GOIARDI_S3_ENDPOINT"`
    S3FilePeriod         int          `long:"s3-file-period" description:"Length of time, in minutes, to allow files to be saved to or retrieved from S3 by the client. Defaults to 15 minutes." env:"GOIARDI_S3_FILE_PERIOD"`
    UseExtSecrets        bool         `long:"use-external-secrets" description:"Use an external service to store secrets (currently user/client public keys). Currently only vault is supported." env:"GOIARDI_USE_EXTERNAL_SECRETS"`
    VaultAddr            string       `long:"vault-addr" description:"Specify address of vault server (i.e. Defaults to the value of VAULT_ADDR."`
    VaultShoveyKey       string       `long:"vault-shovey-key" description:"Specify a path in vault holding shovey's private key. The key must be put in vault as 'privateKey=<contents>'." env:"GOIARDI_VAULT_SHOVEY_KEY"`
    IndexValTrim         int          `short:"T" long:"index-val-trim" description:"Trim values indexed for chef search to this many characters (keys are untouched). If not set or set <= 0, trimming is disabled. This behavior will change with the next major release." env:"GOIARDI_INDEX_VAL_TRIM"`
    PprofWhitelist       []string     `short:"y" long:"pprof-whitelist" description:"Address to allow to access /debug/pprof (in addition to localhost). Specify multiple times to allow more addresses." env:"GOIARDI_PPROF_WHITELIST" env-delim:","`
    PurgeReportsAfter    string       `long:"purge-reports-after" description:"Time to purge old reports after, given in golang duration format (e.g. \"720h\"). Default is not to purge them at all." env:"GOIARDI_PURGE_REPORTS_AFTER"`
    PurgeNodeStatusAfter string       `long:"purge-status-after" description:"Time to purge old node statuses after, given in golang duration format (e.g. \"720h\"). Default is not to purge them at all." env:"GOIARDI_PURGE_STATUS_AFTER"`
    PurgeSandboxesAfter  string       `long:"purge-sandboxes-after" description:"Time to purge old reports after, given in golang duration format (e.g. \"720h\"). Default is to purge them after one week. Set this to '0s' to disable sandbox purging." env:"GOIARDI_PURGE_SANDBOXES_AFTER"`
    // hidden argument to print a formatted man page to stdout and exit
    PrintManPage bool `long:"print-man-page" hidden:"true"`
    // hidden argument to enable logging full postgres search queries
    SearchQueryDebug bool `long:"sqdbg" hidden:"true"`

Options holds options set from the command line or (in most cases) environment variables, which are then merged with the options in Conf. Configurations from the command line/env vars are preferred to those set in the config file.

type PostgreSQLdb Uses

type PostgreSQLdb struct {
    Username string `long:"username" description:"PostgreSQL user name" env:"GOIARDI_POSTGRESQL_USERNAME"`
    Password string `long:"password" description:"PostgreSQL password" env:"GOIARDI_POSTGRESQL_PASSWORD"`
    Host     string `long:"host" description:"PostgreSQL IP host, hostname, or path to a socket" env:"GOIARDI_POSTGRESQL_HOST"`
    Port     string `long:"port" description:"PostgreSQL TCP port" env:"GOIARDI_POSTGRESQL_PORT"`
    Dbname   string `long:"dbname" description:"PostgreSQL database name" env:"GOIARDI_POSTGRESQL_DBNAME"`
    SSLMode  string `long:"ssl-mode" description:"PostgreSQL SSL mode ('enable' or 'disable')" env:"GOIARDI_POSTGRESQL_SSL_MODE"`

PostgreSQLdb holds Postgres connection options.

type SigningKeys Uses

type SigningKeys struct {
    PrivKey *rsa.PrivateKey

SigningKeys are the public and private keys for signing shovey requests.

Package config imports 17 packages (graph) and is imported by 104 packages. Updated 2019-02-26. Refresh now. Tools for package owners.