Skip to content

Commit

Permalink
docs: remove management api appendix from basic-03 (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
ndr-brt authored Oct 1, 2024
1 parent 27883d7 commit f7ac9bb
Showing 1 changed file with 0 additions and 33 deletions.
33 changes: 0 additions & 33 deletions basic/basic-03-configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,37 +143,4 @@ There are a few things worth mentioning here:
- it's better to pass the config value directly into the business logic than passing the
entire `ServiceExtensionContext`, using configuration objects when there are more than one

## Management API

Part of most connectors will be the management api defined in the
[`management-api`](https://github.com/eclipse-edc/Connector/tree/releases/extensions/control-plane/api/management-api)
module. Therefore, we need to add the following module to the dependency list in our `build.gradle.kts`:

```kotlin
dependencies {
// ...
implementation(libs.edc.management.api)
// ...
}
```

As described in the [README.md](https://github.com/eclipse-edc/Connector/tree/releases/extensions/common/api/management-api-configuration)
of the `api-configuration module`, the management api should be exposed on a separate jetty context. Therefore, it is
necessary to provide the following configuration to the connector:

> Note: The ports could be chosen arbitrarily. In this example, they are aligned to the already existing `web.http.port` setting described above.
```properties
web.http.port=9191
web.http.path=/api
web.http.management.port=9192
web.http.management.path=/management
```

_**Caution**: If you do not provide this configuration, it leads to the problem that the authentication mechanism is
also applied to EVERY request in the _default_ context of Jetty, which includes the DSP communication between two
connectors._

---

[Previous Chapter](../basic-02-health-endpoint/README.md)

0 comments on commit f7ac9bb

Please sign in to comment.