Skip to content

Commit c0c721d

Browse files
committed
update readme with authentication details
Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>
1 parent 88789b6 commit c0c721d

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

data-prepper-plugins/otlp-source/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,34 @@ source:
6060
max_delay: 5s # defaults to 2s
6161
```
6262

63+
### Authentication Configurations
64+
65+
By default, the otlp input is unauthenticated.
66+
67+
The following is an example of how to run the server with HTTP Basic authentication:
68+
69+
```yaml
70+
source:
71+
otlp:
72+
authentication:
73+
http_basic:
74+
username: my-user
75+
password: my_s3cr3t
76+
```
77+
78+
You can also explicitly disable authentication with:
79+
80+
```yaml
81+
source:
82+
otlp:
83+
authentication:
84+
unauthenticated:
85+
```
86+
87+
This plugin uses pluggable authentication for GRPC servers. To provide custom authentication,
88+
create a plugin which implements [`GrpcAuthenticationProvider`](../armeria-common/src/main/java/org/opensearch/dataprepper/armeria/authentication/GrpcAuthenticationProvider.java)
89+
90+
6391
### SSL
6492

6593
- ssl(Optional) => A boolean enables TLS/SSL. Default is `true`.

0 commit comments

Comments
 (0)