Skip to content

Commit 8176e6d

Browse files
authored
Improve configauth docs (#8348)
Based on open-telemetry/opentelemetry-collector-contrib#26352, I realized that the confighttp and configgrpc helpers lack links to the configauth package. This PR fixes that and updates the list of known authenticators. Signed-off-by: Juraci Paixão Kröhling <[email protected]>
1 parent d29c591 commit 8176e6d

File tree

4 files changed

+20
-3
lines changed

4 files changed

+20
-3
lines changed

config/configauth/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,16 @@ This module defines necessary interfaces to implement server and client type aut
88
The currently known authenticators are:
99

1010
- Server Authenticators
11-
- [oidc](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/oidcauthextension)
11+
- [Basic Auth Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/basicauthextension)
12+
- [Bearer Token Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/bearertokenauthextension)
13+
- [OIDC Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/oidcauthextension)
1214

1315
- Client Authenticators
14-
- [oauth2](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/oauth2clientauthextension)
15-
- [BearerToken](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/bearertokenauthextension)
16+
- [ASAP Client Authentication Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/asapauthextension)
17+
- [Basic Auth Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/basicauthextension)
18+
- [Bearer Token Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/bearertokenauthextension)
19+
- [OAuth2 Client Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/oauth2clientauthextension)
20+
- [Sigv4 Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/sigv4authextension)
1621

1722
Examples:
1823
```yaml

config/configgrpc/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ README](../configtls/README.md).
2626
- `timeout`
2727
- [`read_buffer_size`](https://godoc.org/google.golang.org/grpc#ReadBufferSize)
2828
- [`write_buffer_size`](https://godoc.org/google.golang.org/grpc#WriteBufferSize)
29+
- [`auth`](../configauth/README.md)
2930

3031
Please note that [`per_rpc_auth`](https://pkg.go.dev/google.golang.org/grpc#PerRPCCredentials) which allows the credentials to send for every RPC is now moved to become an [extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/bearertokenauthextension). Note that this feature isn't about sending the headers only during the initial connection as an `authorization` header under the `headers` would do: this is sent for every RPC performed during an established connection.
3132

@@ -35,6 +36,8 @@ Example:
3536
exporters:
3637
otlp:
3738
endpoint: otelcol2:55690
39+
auth:
40+
authenticator: some-authenticator-extension
3841
tls:
3942
ca_file: ca.pem
4043
cert_file: cert.pem
@@ -107,3 +110,4 @@ see [confignet README](../confignet/README.md).
107110
- [`read_buffer_size`](https://godoc.org/google.golang.org/grpc#ReadBufferSize)
108111
- [`tls`](../configtls/README.md)
109112
- [`write_buffer_size`](https://godoc.org/google.golang.org/grpc#WriteBufferSize)
113+
- [`auth`](../configauth/README.md)

config/confighttp/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,16 @@ README](../configtls/README.md).
2727
- [`max_idle_conns_per_host`](https://golang.org/pkg/net/http/#Transport)
2828
- [`max_conns_per_host`](https://golang.org/pkg/net/http/#Transport)
2929
- [`idle_conn_timeout`](https://golang.org/pkg/net/http/#Transport)
30+
- [`auth`](../configauth/README.md)
3031

3132
Example:
3233

3334
```yaml
3435
exporter:
3536
otlp:
3637
endpoint: otelcol2:55690
38+
auth:
39+
authenticator: some-authenticator-extension
3740
tls:
3841
ca_file: ca.pem
3942
cert_file: cert.pem
@@ -66,6 +69,7 @@ will not be enabled.
6669
not set, browsers use a default of 5 seconds.
6770
- `endpoint`: Valid value syntax available [here](https://github.com/grpc/grpc/blob/master/doc/naming.md)
6871
- [`tls`](../configtls/README.md)
72+
- [`auth`](../configauth/README.md)
6973

7074
You can enable [`attribute processor`][attribute-processor] to append any http header to span's attribute using custom key. You also need to enable the "include_metadata"
7175

@@ -77,6 +81,8 @@ receivers:
7781
protocols:
7882
http:
7983
include_metadata: true
84+
auth:
85+
authenticator: some-authenticator-extension
8086
cors:
8187
allowed_origins:
8288
- https://foo.bar.com

receiver/otlpreceiver/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ The following settings are configurable:
3737
Several helper files are leveraged to provide additional capabilities automatically:
3838

3939
- [gRPC settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configgrpc/README.md) including CORS
40+
- [HTTP settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/README.md)
4041
- [TLS and mTLS settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)
42+
- [Auth settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configauth/README.md)
4143

4244
## Writing with HTTP/JSON
4345

0 commit comments

Comments
 (0)