From fae63ed297811421f58f4726442d98330615be32 Mon Sep 17 00:00:00 2001 From: Daniel Nelson Date: Mon, 1 Jul 2019 12:14:30 -0700 Subject: [PATCH] Clarify that cisco mdt telemetry tcp transport does not support TLS --- plugins/inputs/cisco_telemetry_mdt/README.md | 26 ++++++++++--------- .../cisco_telemetry_mdt.go | 8 +++--- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/plugins/inputs/cisco_telemetry_mdt/README.md b/plugins/inputs/cisco_telemetry_mdt/README.md index 08f180b2e..2848d0493 100644 --- a/plugins/inputs/cisco_telemetry_mdt/README.md +++ b/plugins/inputs/cisco_telemetry_mdt/README.md @@ -14,22 +14,24 @@ The TCP dialout transport is supported on IOS XR (32-bit and 64-bit) 6.1.x and l ```toml [[inputs.cisco_telemetry_mdt]] - ## Telemetry transport (one of: tcp, grpc) - transport = "grpc" + ## Telemetry transport can be "tcp" or "grpc". TLS is only supported when + ## using the grpc transport. + transport = "grpc" - ## Address and port to host telemetry listener - service_address = ":57000" + ## Address and port to host telemetry listener + service_address = ":57000" - ## Enable TLS for GRPC transport - # tls_cert = "/etc/telegraf/cert.pem" - # tls_key = "/etc/telegraf/key.pem" + ## Enable TLS; grpc transport only. + # tls_cert = "/etc/telegraf/cert.pem" + # tls_key = "/etc/telegraf/key.pem" - ## Enable TLS client authentication and define allowed CA certificates - # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"] + ## Enable TLS client authentication and define allowed CA certificates; grpc + ## transport only. + # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"] - ## Define aliases to map telemetry encoding paths to simple measurement names - [inputs.cisco_telemetry_mdt.aliases] - ifstats = "ietf-interfaces:interfaces-state/interface/statistics" + ## Define aliases to map telemetry encoding paths to simple measurement names + [inputs.cisco_telemetry_mdt.aliases] + ifstats = "ietf-interfaces:interfaces-state/interface/statistics" ``` ### Example Output: diff --git a/plugins/inputs/cisco_telemetry_mdt/cisco_telemetry_mdt.go b/plugins/inputs/cisco_telemetry_mdt/cisco_telemetry_mdt.go index fc018a31e..74480cb8a 100644 --- a/plugins/inputs/cisco_telemetry_mdt/cisco_telemetry_mdt.go +++ b/plugins/inputs/cisco_telemetry_mdt/cisco_telemetry_mdt.go @@ -348,17 +348,19 @@ func (c *CiscoTelemetryMDT) Stop() { } const sampleConfig = ` - ## Telemetry transport (one of: tcp, grpc) + ## Telemetry transport can be "tcp" or "grpc". TLS is only supported when + ## using the grpc transport. transport = "grpc" ## Address and port to host telemetry listener service_address = ":57000" - ## Enable TLS for GRPC transport + ## Enable TLS; grpc transport only. # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" - ## Enable TLS client authentication and define allowed CA certificates + ## Enable TLS client authentication and define allowed CA certificates; grpc + ## transport only. # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"] ## Define aliases to map telemetry encoding paths to simple measurement names