Skip to content

Commit

Permalink
Fix TLS config in readme (open-telemetry#4095)
Browse files Browse the repository at this point in the history
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu committed Sep 23, 2021
1 parent a05ce07 commit 8971643
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 24 deletions.
10 changes: 6 additions & 4 deletions config/configtls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,22 @@ Example:
exporters:
otlp:
endpoint: myserver.local:55690
insecure: false
tls:
insecure: false
ca_file: server.crt
cert_file: client.crt
key_file: client.key
min_version: "1.1"
max_version: "1.2"
otlp/insecure:
endpoint: myserver.local:55690
insecure: true
tls:
insecure: true
otlp/secure_no_verify:
endpoint: myserver.local:55690
insecure: false
insecure_skip_verify: true
tls:
insecure: false
insecure_skip_verify: true
```
## Server Configuration
Expand Down
6 changes: 4 additions & 2 deletions examples/k8s/otel-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ data:
exporters:
otlp:
endpoint: "otel-collector.default:4317"
insecure: true
tls:
insecure: true
sending_queue:
num_consumers: 4
queue_size: 100
Expand Down Expand Up @@ -127,7 +128,8 @@ data:
exporters:
otlp:
endpoint: "http://someotlp.target.com:4317" # Replace with a real endpoint.
insecure: true
tls:
insecure: true
service:
extensions: [zpages]
pipelines:
Expand Down
21 changes: 12 additions & 9 deletions exporter/otlpexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,30 @@ If a scheme of `https` is used then client transport security is enabled and ove

By default, TLS is enabled:

- `insecure` (default = `false`): whether to enable client transport security for
the exporter's connection.
- `tls:`

- `insecure` (default = `false`): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required:

- `cert_file` (no default): path to the TLS cert to use for TLS required connections. Should
only be used if `insecure` is set to false.
- `key_file` (no default): path to the TLS key to use for TLS required connections. Should
only be used if `insecure` is set to false.
- `tls:`

- `cert_file` (no default): path to the TLS cert to use for TLS required connections. Should only be used if `insecure` is set to false.
- `key_file` (no default): path to the TLS key to use for TLS required connections. Should only be used if `insecure` is set to false.

Example:

```yaml
exporters:
otlp:
endpoint: otelcol2:4317
cert_file: file.cert
key_file: file.key
tls:
cert_file: file.cert
key_file: file.key
otlp/2:
endpoint: otelcol2:4317
insecure: true
tls:
insecure: true
```
## Advanced Configuration
Expand Down
14 changes: 5 additions & 9 deletions exporter/otlphttpexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,11 @@ The following settings can be optionally configured:
- `logs_endpoint` (no default): The target URL to send log data to (e.g.: https://example.com:4318/v1/logs).
If this setting is present the `endpoint` setting is ignored logs.

- `insecure` (default = false): when set to true disables verifying the server's
certificate chain and host name. The connection is still encrypted but server identity
is not verified.
- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should
only be used if `insecure` is set to false.
- `cert_file` path to the TLS cert to use for TLS required connections. Should
only be used if `insecure` is set to false.
- `key_file` path to the TLS key to use for TLS required connections. Should
only be used if `insecure` is set to false.
- `tls:`
- `insecure` (default = false): when set to true disables verifying the server's certificate chain and host name. The connection is still encrypted but server identity is not verified.
- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should only be used if `insecure` is set to false.
- `cert_file` path to the TLS cert to use for TLS required connections. Should only be used if `insecure` is set to false.
- `key_file` path to the TLS key to use for TLS required connections. Should only be used if `insecure` is set to false.

- `compression` (default = none): Compression type to use (only gzip is supported today)

Expand Down

0 comments on commit 8971643

Please sign in to comment.