| Option |
Description |
Extended Description |
|
|
Use an alternate base directory (git checkout of puppet repository)
|
Option to set the base checkout directory of puppet repository (basedir.rb)
|
|
|
Run bootstrap script for the current directory too
|
Option to bootstrap the current directory (by default, the bootstrap script is NOT
run when the catalog builds in the current directory). (bootstrap_current.rb)
|
--bootstrap-environment "key1=val1,key2=val2,..."
|
Bootstrap script environment variables in key=value format
|
Allow the bootstrap environment to be set up via the command line. (bootstrap_environment.rb)
|
--bootstrap-script FILENAME
|
Bootstrap script relative to checkout directory
|
Allow specification of a bootstrap script. This runs after checking out the directory, and before running
puppet there. Good for running librarian to install modules, and anything else site-specific that needs
to be done. (bootstrap_script.rb)
|
|
|
Bootstrap from-dir and/or to-dir and then exit
|
Option to bootstrap directories and then exit (bootstrap_then_exit.rb)
|
--bootstrapped-from-dir DIRNAME
|
Use a pre-bootstrapped 'from' directory
|
Allow (or create) directories that are already bootstrapped. Handy to allow "bootstrap once, build many"
to save time when diffing multiple catalogs on this system. (bootstrapped_dirs.rb)
|
--bootstrapped-to-dir DIRNAME
|
Use a pre-bootstrapped 'to' directory
|
Allow (or create) directories that are already bootstrapped. Handy to allow "bootstrap once, build many"
to save time when diffing multiple catalogs on this system. (bootstrapped_dirs.rb)
|
|
|
Cache bootstrapped origin/master at this path
|
Cache a bootstrapped checkout of 'master' and use that for time-saving when the SHA
has not changed. (cached_master_dir.rb)
|
--catalog-only
--no-catalog-only
|
Only compile the catalog for the "to" branch but do not diff
|
When set, --catalog-only will only compile the catalog for the 'to' branch, and skip any
diffing activity. The catalog will be printed to STDOUT or written to the output file. (catalog_only.rb)
|
|
|
Enable/disable colors in output
|
Color printing option (color.rb)
|
--compare-file-text
--no-compare-file-text
|
Compare text, not source location, of file resources
|
When a file is specified with `source => 'puppet:///modules/something/foo.txt'`, remove
the 'source' attribute and populate the 'content' attribute with the text of the file.
This allows for a diff of the content, rather than a diff of the location, which is
what is most often desired. (compare_file_text.rb)
|
|
|
Print debugging messages to STDERR
|
Debugging option (debug.rb)
|
|
|
Print debugging output for bootstrap script
|
Option to print debugging output for the bootstrap script in addition to the normal
debugging output. Note that `--debug` must also be enabled for this option to have
any effect. (debug_bootstrap.rb)
|
|
|
Print default header with output
|
Provide ability to set custom header or to display no header at all (header.rb)
|
--display-datatype-changes
--no-display-datatype-changes
|
Display changes in data type even when strings match
|
Toggle on or off the display of data type changes when the string representation
is the same. For example with this enabled, '42' (the string) and 42 (the integer)
will be displayed as a difference. With this disabled, this is not displayed as a
difference. (display_datatype_changes.rb)
|
--display-detail-add
--no-display-detail-add
|
Display parameters and other details for added resources
|
Provide ability to display details of 'added' resources in the output. (display_detail_add.rb)
|
--display-source
--no-display-source
|
Show source file and line for each difference
|
Display source filename and line number for diffs (display_source_file_line.rb)
|
|
|
Path to ENC script, relative to checkout directory or absolute
|
Path to external node classifier, relative to the base directory of the checkout. (enc.rb)
|
|
|
Fact file to use instead of node lookup
|
Allow an existing fact file to be provided, to avoid pulling facts from PuppetDB. (fact_file.rb)
|
|
|
Facts terminus: one of yaml, facter
|
Get the facts terminus. Generally this is 'yaml' and a fact file will be loaded from PuppetDB or
elsewhere in the environment. However it can be set to 'facter' which will run facter on the host
on which this is running. (facts_terminus.rb)
|
-f FROM_BRANCH
--from FROM_BRANCH
|
Branch you are coming from
|
Set the 'from' and 'to' branches, which is used to compile catalogs. A branch of '.' means to use
the current contents of the base code directory without any git checkouts. (to_from_branch.rb)
|
|
|
Use a pre-compiled catalog 'from'
|
If pre-compiled catalogs are available, these can be used to short-circuit the build process.
These files must exist and be in Puppet catalog format. (existing_catalogs.rb)
|
|
|
Path to ENC script (for the from catalog only)
|
Path to external node classifier, relative to the base directory of the checkout. (enc.rb)
|
--from-puppetdb
--no-from-puppetdb
|
Pull "from" catalog from PuppetDB instead of compiling
|
Set --from-puppetdb to pull most recent catalog from PuppetDB instead of compiling (from_puppetdb.rb)
|
|
|
Specify header for output
|
Provide ability to set custom header or to display no header at all (header.rb)
|
|
|
Relative path to hiera YAML file
|
Specify a relative path to the Hiera yaml file (hiera_config.rb)
|
|
|
Path to hiera data directory, relative to top directory of repository
|
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
Puppet control repo template, the value of this should be 'hieradata', which is the default. (hiera_path.rb)
|
|
|
Path prefix to strip when munging hiera.yaml
|
Specify the path to strip off the datadir to munge hiera.yaml file (hiera_path_strip.rb)
|
-n HOSTNAME
--hostname HOSTNAME
|
Use PuppetDB facts from last run of hostname
|
Set hostname, which is used to look up facts in PuppetDB, and in the header of diff display. (hostname.rb)
|
--ignore "Type1[Title1],Type2[Title2],..."
|
More resources to ignore in format type[title]
|
Options used when comparing catalogs - set ignored changes. (ignore.rb)
|
--ignore-attr "attr1,attr2,..."
|
Attributes to ignore
|
Specify attributes to ignore (ignore_attr.rb)
|
--ignore-tags STRING1[,STRING2[,...]]
|
Specify tags to ignore
|
Provide ability to set one or more tags, which will cause catalog-diff
to ignore any changes for any defined type where this tag is set. (ignore_tags.rb)
|
--include-tags
--no-include-tags
|
Include changes to tags in the diff output
|
Options used when comparing catalogs - tags are generally ignored; you can un-ignore them. (include_tags.rb)
|
--master-cache-branch BRANCH
|
Branch to cache
|
Allow override of the branch that is cached. This defaults to 'origin/master'. (master_cache_branch.rb)
|
|
|
Disable ENC
|
Path to external node classifier, relative to the base directory of the checkout. (enc.rb)
|
|
|
Do not print a header
|
Provide ability to set custom header or to display no header at all (header.rb)
|
|
|
Disable hiera config file installation
|
Specify a relative path to the Hiera yaml file (hiera_config.rb)
|
|
|
Do not use any default hiera path settings
|
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
Puppet control repo template, the value of this should be 'hieradata', which is the default. (hiera_path.rb)
|
|
|
Do not use any default hiera path strip settings
|
Specify the path to strip off the datadir to munge hiera.yaml file (hiera_path_strip.rb)
|
|
|
Disable ignoring based on tags
|
Provide ability to set one or more tags, which will cause catalog-diff
to ignore any changes for any defined type where this tag is set. (ignore_tags.rb)
|
-o FILENAME
--output-file FILENAME
|
Output results into FILENAME
|
Output file option (output_file.rb)
|
|
|
Output format: text,json
|
Output format option (output_format.rb)
|
|
|
Enable or disable parallel processing
|
Disable or enable parallel processing of catalogs. (parallel.rb)
|
|
|
Specify parser (default, future)
|
Enable future parser for both branches or for just one (parser.rb)
|
--parser-from PARSER_NAME
|
Specify parser (default, future)
|
Enable future parser for both branches or for just one (parser.rb)
|
|
|
Specify parser (default, future)
|
Enable future parser for both branches or for just one (parser.rb)
|
--pass-env-vars VAR1[,VAR2[,...]]
|
Environment variables to pass
|
One or more environment variables that should be made available to the Puppet binary when parsing
the catalog. For example, --pass-env-vars FOO,BAR will make the FOO and BAR environment variables
available. Setting these variables is your responsibility outside of octocatalog-diff. (pass_env_vars.rb)
|
|
|
CA certificate that signed the ENC API certificate
|
Specify the CA certificate for the Puppet Enterprise ENC. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (pe_enc_ssl_ca.rb)
|
--pe-enc-ssl-client-cert FILENAME
|
SSL client certificate to connect to PE ENC
|
Specify the client certificate for connecting to the Puppet Enterprise ENC. This must be specified along with
--pe-enc-ssl-client-key in order to work. (pe_enc_ssl_client_cert.rb)
|
--pe-enc-ssl-client-key FILENAME
|
SSL client key to connect to PE ENC
|
Specify the client key for connecting to Puppet Enterprise ENC. This must be specified along with
--pe-enc-ssl-client-cert in order to work. (pe_enc_ssl_client_key.rb)
|
|
|
Token to access the Puppet Enterprise ENC API
|
Specify the access token to access the Puppet Enterprise ENC. Refer to
https://docs.puppet.com/pe/latest/nc_forming_requests.html#authentication for
details on generating and obtaining a token. Use this option to specify the text
of the token. (Use --pe-enc-token-file to read the content of the token from a file.) (pe_enc_token.rb)
|
|
|
Path containing token for PE node classifier, relative or absolute
|
Specify the access token to access the Puppet Enterprise ENC. Refer to
https://docs.puppet.com/pe/latest/nc_forming_requests.html#authentication for
details on generating and obtaining a token. Use this option if the token is stored
in a file, to read the content of the token from the file. (pe_enc_token_file.rb)
|
|
|
Base URL for Puppet Enterprise ENC endpoint
|
Specify the URL to the Puppet Enterprise ENC API. By default, the node classifier service
listens on port 4433 and all endpoints are relative to the /classifier-api/ path. That means
the likely value for this option will be something like:
https://your-pe-console-server:4433/classifier-api (pe_enc_url.rb)
|
--puppetdb-ssl-ca FILENAME
|
CA certificate that signed the PuppetDB certificate
|
Specify the CA certificate for PuppetDB. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (puppetdb_ssl_ca.rb)
|
--puppetdb-ssl-client-cert FILENAME
|
SSL client certificate to connect to PuppetDB
|
Specify the client certificate for connecting to PuppetDB. This must be specified along with
--puppetdb-ssl-client-key in order to work. (puppetdb_ssl_client_cert.rb)
|
--puppetdb-ssl-client-key FILENAME
|
SSL client key to connect to PuppetDB
|
Specify the client key for connecting to PuppetDB. This must be specified along with
--puppetdb-ssl-client-cert in order to work. (puppetdb_ssl_client_key.rb)
|
--puppetdb-ssl-client-password PASSWORD
|
Password for SSL client key to connect to PuppetDB
|
Specify the password for a PEM or PKCS12 private key on the command line.
Note that `--puppetdb-ssl-client-password-file` is slightly more secure because
the text of the password won't appear in the process list. (puppetdb_ssl_client_password.rb)
|
--puppetdb-ssl-client-password-file FILENAME
|
Read password for SSL client key from a file
|
Specify the password for a PEM or PKCS12 private key, by reading it from a file. (puppetdb_ssl_client_password_file.rb)
|
|
|
PuppetDB base URL
|
Specify the base URL for PuppetDB. This will generally look like https://puppetdb.yourdomain.com:8081 (puppetdb_url.rb)
|
|
|
Quiet (no status messages except errors)
|
Quiet option (quiet.rb)
|
|
|
Retry building a failed catalog N times
|
Transient errors can cause catalog compilation problems. This adds an option to retry
a failed catalog multiple times before kicking out an error message. (retry_failed_catalog.rb)
|
--safe-to-delete-cached-master-dir PATH
|
OK to delete cached master directory at this path
|
By specifying a directory path here, you are explicitly giving permission to the program
to delete it if it believes it needs to be created (e.g., if the SHA has changed of the
cached directory). (safe_to_delete_cached_master_dir.rb)
|
--storeconfigs
--no-storeconfigs
|
Enable integration with puppetdb for collected resources
|
Set storeconfigs (integration with PuppetDB for collected resources) (storeconfigs.rb)
|
--suppress-absent-file-details
--no-suppress-absent-file-details
|
Suppress certain attributes of absent files
|
If enabled, this option will suppress changes to certain attributes of a file, if the
file is specified to be 'absent' in the target catalog. Suppressed changes in this case
include user, group, mode, and content, because a removed file has none of those. (suppress_absent_file_details.rb)
|
-t TO_BRANCH
--to TO_BRANCH
|
Branch you are going to
|
Set the 'from' and 'to' branches, which is used to compile catalogs. A branch of '.' means to use
the current contents of the base code directory without any git checkouts. (to_from_branch.rb)
|
|
|
Use a pre-compiled catalog 'to'
|
If pre-compiled catalogs are available, these can be used to short-circuit the build process.
These files must exist and be in Puppet catalog format. (existing_catalogs.rb)
|
|
|
Path to ENC script (for the to catalog only)
|
Path to external node classifier, relative to the base directory of the checkout. (enc.rb)
|