Skip to content

Commit c444859

Browse files
committed
Document the rest of the environment variables
1 parent ea6be62 commit c444859

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/advanced-environment-variables.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ The following environment variables have special meaning to octocatalog-diff:
44

55
### `OCTOCATALOG_DIFF_CONFIG_FILE`
66

7+
This environment variable is used to locate the configuration file for the CLI. The use of configuration files is described generally in:
8+
9+
- [Configuration](/doc/configuration.md)
10+
711
### `OCTOCATALOG_DIFF_CUSTOM_VERSION`
812

913
When set, the `octocatalog-diff` CLI will display this as the version number within debugging, instead of the version number in the package. This is most useful if you want to use or include a git SHA in the version number.
@@ -41,10 +45,26 @@ This variable is used internally for the parallelized logic for catalog compilat
4145

4246
### `OCTOCATALOG_DIFF_VERSION`
4347

48+
This variable is used when building the gem, to override the default version. This is used for internal testing of `octocatalog-diff` before public releases. This variable is not useful outside the build context.
49+
4450
### `PUPPETDB_HOST`
4551

52+
This variable specifies the fully qualified domain name or IP address of the PuppetDB server.
53+
54+
Note: If `PUPPETDB_URL` is specified, then `PUPPETDB_HOST` is not consulted.
55+
4656
### `PUPPETDB_PORT`
4757

58+
This variable specifies the port number of the PuppetDB server.
59+
60+
Note: If `PUPPETDB_URL` is specified, then `PUPPETDB_PORT` is not consulted.
61+
4862
### `PUPPETDB_URL`
4963

64+
This variable specifies the URL to the PuppetDB server.
65+
66+
Example: `https://puppetdb.example.net:8081`
67+
5068
### `PUPPET_FACT_DIR`
69+
70+
This variable specifies the directory path where puppet fact files are stored. (Fact files must be named `<fqdn>.yaml` where `<fqdn>` is specified when running `octocatalog-diff`.)

0 commit comments

Comments
 (0)