Skip to content

Commit 1a5b61c

Browse files
committed
docs: explain use_external_addr configuration field (hetznercloud/fleeting-plugin-hetzner!109)
1 parent 6946008 commit 1a5b61c

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ swap:
8282
"""
8383

8484
[runners.autoscaler.connector_config]
85+
# without private network, the instances are only reachable through their public addresses.
8586
use_external_addr = true
8687

8788
[[runners.autoscaler.policy]]

docs/references/configuration.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The [`[runners.autoscaler.plugin_config]` section](https://docs.gitlab.com/runne
117117

118118
## Autoscaler configuration
119119

120-
The [`[runners.autoscaler]` section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersautoscaler-section) have parameters that may interest you:
120+
Below are parameters from the [`[runners.autoscaler]` section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersautoscaler-section) that are important for our plugin:
121121

122122
<table>
123123
<tr>
@@ -136,13 +136,20 @@ The [`[runners.autoscaler]` section](https://docs.gitlab.com/runner/configuratio
136136

137137
## Connector configuration
138138

139-
The [`[runners.autoscaler.connector_config]` section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersautoscalerconnector_config-section) have parameters that are only partially supported:
139+
Below are parameters from the [`[runners.autoscaler.connector_config]` section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersautoscalerconnector_config-section) that are important for our plugin:
140140

141141
<table>
142142
<tr>
143143
<th>Parameter</th>
144144
<th>Value</th>
145145
</tr>
146+
<tr>
147+
<td><code>use_external_addr</code></td>
148+
<td>
149+
Access the instances through their public addresses. Note that without private
150+
networks, this field must be set to <code>true</code>.
151+
</td>
152+
</tr>
146153
<tr>
147154
<td><code>os</code></td>
148155
<td>Only <code>linux</code> is supported.</td>

0 commit comments

Comments
 (0)