Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@killbillio
killbillio committed Oct 31, 2024
1 parent f51298d commit 0724497
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 0 deletions.
47 changes: 47 additions & 0 deletions 0.24/userguide_configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2634,6 +2634,53 @@ <h3 id="_translation_properties">Translation Properties</h3>
</table>
</div>
<div class="sect2">
<h3 id="_queue_properties">Queue Properties</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property Name/Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Configuration Method</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.killbill.queue.creator.name
/KILLBILL_QUEUE_CREATOR_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Allow to override the default naming based on Hostname</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">System Property/Environment Variable</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.killbill.queue.creator.autoGeneratedName
/KILLBILL_QUEUE_CREATOR_AUTOGENERATE_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If set to true and <code>org.killbill.queue.creator.name</code> is not set, generate a UUID instead of using default hostname</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">System Property/Environment Variable</p></td>
</tr>
</tbody>
</table>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
In case of a Tomcat-based environment, the above properties can be configured as system properties. In case of Docker systems, they can be set via the environment variables mentioned above.
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_persistent_busnotification_queue_configuration_notes">Persistent Bus/Notification Queue Configuration Notes</h3>
<div class="paragraph">
<p>Note that the <strong>Persistence Bus</strong> and <strong>Notification Queue</strong> configuration properties use a substitution parameter called <code>instanceName</code>. This is because the properties defined here are built to be used across multiple instances. Kill Bill typically uses two persistent buses named <code>main</code> and <code>external</code> and one notification queue named <code>main</code>. Thus, <code>instanceName</code> needs to be replaced with appropriate values while specifying these properties. Some common examples of <code>instanceName</code> are <code>main</code>, <code>external</code>, and <code>analytics</code></p>
Expand Down
47 changes: 47 additions & 0 deletions latest/userguide_configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2634,6 +2634,53 @@ <h3 id="_translation_properties">Translation Properties</h3>
</table>
</div>
<div class="sect2">
<h3 id="_queue_properties">Queue Properties</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property Name/Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Configuration Method</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.killbill.queue.creator.name
/KILLBILL_QUEUE_CREATOR_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Allow to override the default naming based on Hostname</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">System Property/Environment Variable</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.killbill.queue.creator.autoGeneratedName
/KILLBILL_QUEUE_CREATOR_AUTOGENERATE_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If set to true and <code>org.killbill.queue.creator.name</code> is not set, generate a UUID instead of using default hostname</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">System Property/Environment Variable</p></td>
</tr>
</tbody>
</table>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
In case of a Tomcat-based environment, the above properties can be configured as system properties. In case of Docker systems, they can be set via the environment variables mentioned above.
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_persistent_busnotification_queue_configuration_notes">Persistent Bus/Notification Queue Configuration Notes</h3>
<div class="paragraph">
<p>Note that the <strong>Persistence Bus</strong> and <strong>Notification Queue</strong> configuration properties use a substitution parameter called <code>instanceName</code>. This is because the properties defined here are built to be used across multiple instances. Kill Bill typically uses two persistent buses named <code>main</code> and <code>external</code> and one notification queue named <code>main</code>. Thus, <code>instanceName</code> needs to be replaced with appropriate values while specifying these properties. Some common examples of <code>instanceName</code> are <code>main</code>, <code>external</code>, and <code>analytics</code></p>
Expand Down

0 comments on commit 0724497

Please sign in to comment.