[skywalking] branch telemetry-ssl updated: Documents

[ha...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hanahmily pushed a commit to branch telemetry-ssl
in repository https://gitbox.apache.org/repos/asf/skywalking.git


The following commit(s) were added to refs/heads/telemetry-ssl by this push:
     new ced9ee2  Documents
ced9ee2 is described below

commit ced9ee29a8ec70e5ad720a06db3e089e5d1abc25
Author: Gao Hongtao <ha...@gmail.com>
AuthorDate: Thu Sep 3 11:16:40 2020 +0800

    Documents
    
    Signed-off-by: Gao Hongtao <ha...@gmail.com>
---
 docs/en/setup/backend/backend-fetcher.md   | 11 ++++++++++-
 docs/en/setup/backend/backend-telemetry.md | 18 +++++++++++++++++-
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/docs/en/setup/backend/backend-fetcher.md b/docs/en/setup/backend/backend-fetcher.md
index cff6e27..dfda0cf 100644
--- a/docs/en/setup/backend/backend-fetcher.md
+++ b/docs/en/setup/backend/backend-fetcher.md
@@ -42,7 +42,7 @@ metricsPath: <path>
 staticConfig:
   # The targets specified by the static config.
   targets:
-    [ - <host> ]
+    [ - <target> ]
   # Labels assigned to all metrics fetched from the targets.
   labels:
     [ <labelname>: <labelvalue> ... ]
@@ -51,6 +51,15 @@ metricsRules:
    [ - <metric_rules> ]
 ```
 
+#### <target>
+
+```yaml
+# The url of target exporter. the format should be complied with "java.net.URI"
+url: <string>
+# The path of root CA file.
+sslCaFilePath: <string>
+```
+
 #### <metric_rules>
 
 ```yaml
diff --git a/docs/en/setup/backend/backend-telemetry.md b/docs/en/setup/backend/backend-telemetry.md
index 35e519f..7f7efc0 100644
--- a/docs/en/setup/backend/backend-telemetry.md
+++ b/docs/en/setup/backend/backend-telemetry.md
@@ -8,9 +8,12 @@ telemetry:
   prometheus:
     host: ${SW_TELEMETRY_PROMETHEUS_HOST:0.0.0.0}
     port: ${SW_TELEMETRY_PROMETHEUS_PORT:1234}
+    sslEnabled: ${SW_TELEMETRY_PROMETHEUS_SSL_ENABLED:false}
+    sslKeyPath: ${SW_TELEMETRY_PROMETHEUS_SSL_KEY_PATH:""}
+    sslCertChainPath: ${SW_TELEMETRY_PROMETHEUS_SSL_CERT_CHAIN_PATH:""}
 ```
 
-but you can set one of `prometheus` or `so11y` to enable them, for more information, refer to the details below.
+but you can set one of `prometheus` to enable them, for more information, refer to the details below.
 
 ## Prometheus
 Prometheus is supported as telemetry implementor. 
@@ -32,6 +35,19 @@ telemetry:
     port: 1543
 ```
 
+Set SSL relevant settings to expose a secure endpoint. Notice private key file and cert chain file could be uploaded once
+changes are applied to them.
+```yaml
+telemetry:
+  selector: ${SW_TELEMETRY:prometheus}
+  prometheus:
+    host: 127.0.0.1
+    port: 1543
+    sslEnabled: true
+    sslKeyPath: /etc/ssl/key.pem
+    sslCertChainPath: /etc/ssl/cert-chain.pem
+```
+
 ### Grafana Visualization
 Provide the grafana dashboard settings. Check [SkyWalking Telemetry dashboard](grafana.json) config.