Skip to content

Update configs+readmes to reflect de-squash of tls #5428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 26, 2021
Merged

Update configs+readmes to reflect de-squash of tls #5428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion examples/demo/otel-collector-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ exporters:

jaeger:
endpoint: jaeger-all-in-one:14250
insecure: true
tls:
insecure: true

processors:
batch:
Expand Down
4 changes: 3 additions & 1 deletion exporter/elasticexporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ exporters:
exporters:
otlp/elastic:
endpoint: "localhost:8200"
insecure: true
tls:
insecure: true
```

## Migration
Expand Down Expand Up @@ -121,6 +122,7 @@ Complete documentation is available on [Elastic.co](https://www.elastic.co/guide
- `apm_server_url` (required): Elastic APM Server URL.
- `api_key` (optional): credential for API Key authorization, if enabled in Elastic APM Server.
- `secret_token` (optional): credential for Secret Token authorization, if enabled in Elastic APM Server.
#### The below options all belong beneath the `tls` header
- `ca_file` (optional): root Certificate Authority (CA) certificate, for verifying the server's identity, if TLS is enabled.
- `cert_file` (optional): client TLS certificate.
- `key_file` (optional): client TLS key.
Expand Down
10 changes: 6 additions & 4 deletions exporter/jaegerexporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following settings are required:
using the gRPC protocol. The valid syntax is described
[here](https://github.com/grpc/grpc/blob/master/doc/naming.md)

By default, TLS is enabled:
By default, TLS is enabled and must be configured under `tls`:

- `insecure` (default = `false`): whether to enable client transport security for
the exporter's connection.
Expand All @@ -31,11 +31,13 @@ Example:
exporters:
jaeger:
endpoint: jaeger-all-in-one:14250
cert_file: file.cert
key_file: file.key
tls:
cert_file: file.cert
key_file: file.key
jaeger/2:
endpoint: jaeger-all-in-one:14250
insecure: true
tls:
insecure: true
```

## Advanced Configuration
Expand Down
3 changes: 2 additions & 1 deletion exporter/loadbalancingexporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ exporters:
protocol:
otlp:
timeout: 1s
insecure: true
tls:
insecure: true
resolver:
static:
hostnames:
Expand Down
3 changes: 2 additions & 1 deletion exporter/loadbalancingexporter/example/otel-agent-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ exporters:
protocol:
otlp:
timeout: 1s
insecure: true
tls:
insecure: true
resolver:
static:
hostnames:
Expand Down
12 changes: 7 additions & 5 deletions exporter/opencensusexporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following settings are required:
using the gRPC protocol. The valid syntax is described
[here](https://github.com/grpc/grpc/blob/master/doc/naming.md)

By default, TLS is enabled:
By default, TLS is enabled and must be configured under `tls`:

- `insecure` (default = `false`): whether to enable client transport security for
the exporter's connection.
Expand All @@ -31,11 +31,13 @@ Example:
exporters:
opencensus:
endpoint: opencensus2:55678
cert_file: file.cert
key_file: file.key
otlp/2:
tls:
cert_file: file.cert
key_file: file.key
opencensus/2:
endpoint: opencensus2:55678
insecure: true
tls:
insecure: true
```

## Advanced Configuration
Expand Down
10 changes: 6 additions & 4 deletions exporter/zipkinexporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The following settings are required:
- `endpoint` (no default): URL to which the exporter is going to send Zipkin trace data.
- `format` (default = `JSON`): The format to sent events in. Can be set to `JSON` or `proto`.

By default, TLS is enabled:
By default, TLS is enabled and must be configured under `tls`:

- `insecure` (default = `false`): whether to enable client transport security for
the exporter's connection.
Expand All @@ -35,11 +35,13 @@ Example:
exporters:
zipkin:
endpoint: "http://some.url:9411/api/v2/spans"
cert_file: file.cert
key_file: file.key
tls:
cert_file: file.cert
key_file: file.key
zipkin/2:
endpoint: "http://some.url:9411/api/v2/spans"
insecure: true
tls:
insecure: true
```

## Advanced Configuration
Expand Down
3 changes: 2 additions & 1 deletion receiver/jaegerreceiver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ receivers:
grpc:
remote_sampling:
endpoint: "jaeger-collector:14250"
insecure: true
tls:
insecure: true
```

Remote sampling can also be directly served by the collector by providing a
Expand Down