Skip to content

Commit

Permalink
[FLINK-33965][autoscaler] Generate the configuration doc for autoscal…
Browse files Browse the repository at this point in the history
…er standalone
  • Loading branch information
1996fanrui committed Jan 2, 2024
1 parent 334068b commit 042cc4f
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/content/docs/operations/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@ Like other resource options these can be configured on both an operator and a pe

{{< generated/auto_scaler_configuration >}}

### Autoscaler Standalone Configuration

Unlike other resource options, these options only work with autoscaler standalone process.

{{< generated/autoscaler_standalone_configuration >}}

### System Metrics Configuration

Operator system metrics configuration. Cannot be overridden on a per-resource basis.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<table class="configuration table table-bordered">
<thead>
<tr>
<th class="text-left" style="width: 20%">Key</th>
<th class="text-left" style="width: 15%">Default</th>
<th class="text-left" style="width: 10%">Type</th>
<th class="text-left" style="width: 55%">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><h5>autoscaler.standalone.control-loop.interval</h5></td>
<td style="word-wrap: break-word;">10 s</td>
<td>Duration</td>
<td>The interval of autoscaler standalone control loop.</td>
</tr>
<tr>
<td><h5>autoscaler.standalone.fetcher.flink-cluster.host</h5></td>
<td style="word-wrap: break-word;">"localhost"</td>
<td>String</td>
<td>The host name of flink cluster when the flink-cluster fetcher is used.</td>
</tr>
<tr>
<td><h5>autoscaler.standalone.fetcher.flink-cluster.port</h5></td>
<td style="word-wrap: break-word;">8081</td>
<td>Integer</td>
<td>The port of flink cluster when the flink-cluster fetcher is used.</td>
</tr>
</tbody>
</table>
7 changes: 7 additions & 0 deletions flink-kubernetes-docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ under the License.
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-autoscaler-standalone</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
</dependency>

<!-- Test -->
<dependency>
<groupId>org.junit.jupiter</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ public class ConfigOptionsDocGenerator {
new OptionsClassLocation(
"flink-kubernetes-operator",
"org.apache.flink.kubernetes.operator.metrics"),
new OptionsClassLocation("flink-autoscaler", "org.apache.flink.autoscaler.config")
new OptionsClassLocation("flink-autoscaler", "org.apache.flink.autoscaler.config"),
new OptionsClassLocation(
"flink-autoscaler-standalone",
"org.apache.flink.autoscaler.standalone.config")
};
static final String DEFAULT_PATH_PREFIX = "src/main/java";

Expand Down

0 comments on commit 042cc4f

Please sign in to comment.