Skip to content

Commit f9fffdc

Browse files
committed
Add warning for changes in future version
1 parent 8d1cd71 commit f9fffdc

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

content/en/documentation/pro/jobrunr-pro-multi-dashboard.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ As the diagram shows, the Multi Dashboard is smart enough to handle different ty
4646
* Add `jobrunr-pro-dashboard-multi-instance` as a dependency.
4747
* JDK 21 or higher
4848

49-
> The package `jobrunr-pro-dashboard-multi-instance` is planned to be renamed to `jobrunr-pro-multi-cluster-dashboard`.
49+
> ⚠️ The package `jobrunr-pro-dashboard-multi-instance` is planned to be renamed to `jobrunr-pro-multi-cluster-dashboard`.
5050
5151
#### Web server setup
5252

@@ -80,7 +80,7 @@ var multiClusterWebServer = new MultiClusterWebServer(
8080
usingStandardMultiWebServerConfiguration()
8181
.andContextPath("/multi")
8282
.andHost("localhost", 8000)
83-
.andApiKey("my-api-token")
83+
.andApiKey("my-api-key")
8484
// .and(...) more config (see MultiClusterWebServerConfiguration's API)
8585
,
8686
usingStandardMultiClusterConfiguration()
@@ -112,15 +112,18 @@ JobRunrPro
112112
.useDashboard(usingStandardDashboardConfiguration()
113113
.andPort(9000)
114114
// .and... your usual dashboard web server config
115-
.andAutoDiscovery("https://multi-cluster.acme.com/multi", "my-api-token", "Order fulfillment service")
115+
.andAutoDiscovery("https://multi-cluster.acme.com/multi", "my-api-key", "Order fulfillment service")
116116
```
117117

118118
That's it! As soon as the above cluster has booted, it'll announce itself and communicate its URL to the `MultiClusterWebServer`.
119119

120+
> ⚠️ We pulled the `apiKey` configuration out of the auto-discovery configuration. In the next release this configuration is changing from `.andAutoDiscovery("https://multi-cluster.acme.com/multi", "my-api-key", "Order fulfillment service")` to `andApiKey("my-api-key").andAutoDiscovery("https://multi-cluster.acme.com/multi", "Order fulfillment service")`.
121+
120122
> **Note**: if provided, the API-Key needs to be shared by both servers.
121123

122124
> For alternative auto-discovery configuration see the API of `JobRunrDashboardWebServerConfiguration`.
123125

126+
124127
### Authentication
125128

126129
The Multi-Cluster Dashboard supports the same [user authentication schemes]({{< ref "guides/authentication" >}}) as a regular JobRunr Pro Dashboard. The only way to authenticate server-to-server communication is to configure shared API keys. Once configured, servers pass the key along with each request. A valid API key provides full access to all the endpoints.

0 commit comments

Comments
 (0)