Update lightstep doc. (#9125)

* update lightstep doc.

* Add comment.

* update.
This commit is contained in:
Pengyuan Bian 2021-03-10 14:32:48 -08:00 committed by GitHub
parent ad7820ce8d
commit 73b171db0a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 23 deletions

View File

@ -62,29 +62,7 @@ use your own cert and your own pool's endpoint (`host:port`).
Follow these steps if you're using the Public or Developer Mode Satellites, or if you're using on-premise Satellites with a TLS certificate.
1. Deploy Istio with the following configuration parameters specified:
- `pilot.traceSampling=100`
- `global.proxy.tracer="lightstep"`
- `meshConfig.defaultConfig.tracing.tlsSettings.mode="SIMPLE"`
- `meshConfig.defaultConfig.tracing.tlsSettings.caCertificates="/etc/lightstep/cacert.pem"`
- `global.tracer.lightstep.address="ingest.lightstep.com:443"`
- `global.tracer.lightstep.accessToken="<access-token>"`
You can set these parameters using the `--set key=value` syntax
when you run the install command. For example:
{{< text bash >}}
$ istioctl install \
--set values.pilot.traceSampling=100 \
--set values.global.proxy.tracer="lightstep" \
--set meshConfig.defaultConfig.tracing.tlsSettings.mode="SIMPLE" \
--set meshConfig.defaultConfig.tracing.tlsSettings.caCertificates="/etc/lightstep/cacert.pem" \
--set values.global.tracer.lightstep.
address="ingest.lightstep.com:443" \
--set values.global.tracer.lightstep.accessToken="<access-token>" \
{{< /text >}}
1. Store your satellite pool's certificate authority certificate as a secret in the default namespace.
1. Store your satellite pool's certificate authority certificate as a secret in the default and `istio-system` namespace, the latter for use by the Istio gateways.
Download and use [this certificate](https://docs.lightstep.com/docs/instrument-with-istio-as-your-service-mesh#cacertpem-file).
If you deploy the Bookinfo application in a different namespace, create the secret in that namespace instead.
@ -108,6 +86,48 @@ Follow these steps if you're using the Public or Developer Mode Satellites, or i
EOF
{{< /text >}}
1. Deploy Istio with the following configuration parameters specified:
{{< text yaml >}}
global:
proxy:
tracer: "lightstep"
tracer:
lightstep:
address: "ingest.lightstep.com:443"
accessToken: "<access-token>"
meshConfig:
defaultConfig:
tracing:
sampling: 100
tlsSettings
mode: "SIMPLE"
# Specifying ca certificate here will moute `lightstep.cacert` secret volume
# at all sidecars by default.
caCertificates="/etc/lightstep/cacert.pem"
components:
ingressGateways:
# `lightstep.cacert` secret volume needs to be mount at gateways via k8s overlay.
- name: istio-ingressgateway
enabled: true
k8s:
overlays:
- kind: Deployment
name: istio-ingressgateway
patches:
- path: spec.template.spec.containers[0].volumeMounts[-1]
value: |
name: lightstep-certs
mountPath: /etc/lightstep
readOnly: true
- path: spec.template.spec.volumes[-1]
value: |
name: lightstep-certs
secret:
secretName: lightstep.cacert
optional: true
{{< /text >}}
## Install and run the Bookinfo app
1. Follow the [instructions to deploy the Bookinfo sample application](/docs/examples/bookinfo/#deploying-the-application).