Skip to content

Commit 2446680

Browse files
committed
Document auto-generation for new puppetdb options
1 parent b1cad49 commit 2446680

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

doc/optionsref.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ Usage: octocatalog-diff [command line options]
8787
--to-puppet-binary STRING Full path to puppet binary for the to branch
8888
--from-puppet-binary STRING Full path to puppet binary for the from branch
8989
--facts-terminus STRING Facts terminus: one of yaml, facter
90+
--puppetdb-token TOKEN Token to access the PuppetDB API
91+
--puppetdb-token-file PATH Path containing token for PuppetDB API, relative or absolute
9092
--puppetdb-url URL PuppetDB base URL
9193
--puppetdb-ssl-ca FILENAME CA certificate that signed the PuppetDB certificate
9294
--puppetdb-ssl-client-cert FILENAME
@@ -1374,6 +1376,36 @@ the text of the password won't appear in the process list. (<a href="../lib/octo
13741376
</td>
13751377
</tr>
13761378

1379+
<tr>
1380+
<td valign=top>
1381+
<pre><code>--puppetdb-token TOKEN</code></pre>
1382+
</td>
1383+
<td valign=top>
1384+
Token to access the PuppetDB API
1385+
</td>
1386+
<td valign=top>
1387+
Specify the PE RBAC token to access the PuppetDB API. Refer to
1388+
https://puppet.com/docs/pe/latest/rbac/rbac_token_auth_intro.html#generate-a-token-using-puppet-access
1389+
for details on generating and obtaining a token. Use this option to specify the text
1390+
of the token. (Use --puppetdb-token-file to read the content of the token from a file.) (<a href="../lib/octocatalog-diff/cli/options/puppetdb_token.rb">puppetdb_token.rb</a>)
1391+
</td>
1392+
</tr>
1393+
1394+
<tr>
1395+
<td valign=top>
1396+
<pre><code>--puppetdb-token-file PATH</code></pre>
1397+
</td>
1398+
<td valign=top>
1399+
Path containing token for PuppetDB API, relative or absolute
1400+
</td>
1401+
<td valign=top>
1402+
Specify the PE RBAC token to access the PuppetDB API. Refer to
1403+
https://puppet.com/docs/pe/latest/rbac/rbac_token_auth_intro.html#generate-a-token-using-puppet-access
1404+
for details on generating and obtaining a token. Use this option to specify the text
1405+
in a file, to read the content of the token from the file. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_token_file.rb">puppetdb_token_file.rb</a>)
1406+
</td>
1407+
</tr>
1408+
13771409
<tr>
13781410
<td valign=top>
13791411
<pre><code>--puppetdb-url URL</code></pre>

0 commit comments

Comments
 (0)