From b84204371e14d046f1d577c9f162f997252899c8 Mon Sep 17 00:00:00 2001
From: jacob-delgado <jacob.delgado@volunteers.acasi.info>
Date: Fri, 2 Apr 2021 16:25:30 -0600
Subject: [PATCH] Add installation instructions for use with tracing
 configurability (#8828)

* Add installation instructions for use with tracing configurability

Fixes https://github.com/istio/istio.io/issues/7288

* Move installation to top

* Use istio meta cluster id env instead of canonical name

* add enable tracing option to meshconfig yaml
---
 .../configurability/index.md                  | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/content/en/docs/tasks/observability/distributed-tracing/configurability/index.md b/content/en/docs/tasks/observability/distributed-tracing/configurability/index.md
index cd4f47adcf..90f0429783 100644
--- a/content/en/docs/tasks/observability/distributed-tracing/configurability/index.md
+++ b/content/en/docs/tasks/observability/distributed-tracing/configurability/index.md
@@ -55,6 +55,33 @@ always provided in the annotations to ensure that the traces are reported
 correctly for the workload.
 {{< /warning >}}
 
+## Installation
+
+Using these features opens new possibilities for managing traces in your environment.
+
+In this example, we will sample all traces and add a tag named `clusterID`
+using the `ISTIO_META_CLUSTER_ID` environment variable injected into your pod. Only the
+first 256 characters of the value will be used.
+
+{{< text bash >}}
+$ cat <<EOF > ./tracing.yaml
+apiVersion: install.istio.io/v1alpha1
+kind: IstioOperator
+spec:
+  meshConfig:
+    enableTracing: true
+    defaultConfig:
+      tracing:
+        sampling: 100.0
+        max_path_tag_length: 256
+        custom_tags:
+          clusterID:
+          environment:
+            name: ISTIO_META_CLUSTER_ID
+EOF
+$ istioctl install -f ./tracing.yaml
+{{< /text >}}
+
 ### Using `MeshConfig` for trace settings
 
 All tracing options can be configured globally via `MeshConfig`.
@@ -67,6 +94,7 @@ apiVersion: install.istio.io/v1alpha1
 kind: IstioOperator
 spec:
   meshConfig:
+    enableTracing: true
     defaultConfig:
       tracing:
         sampling: 10
@@ -130,6 +158,7 @@ apiVersion: install.istio.io/v1alpha1
 kind: IstioOperator
 spec:
   meshConfig:
+    enableTracing: true
     defaultConfig:
       tracing:
         sampling: 50
@@ -157,6 +186,7 @@ You can customize the tags using any of the three supported options below.
     kind: IstioOperator
     spec:
       meshConfig:
+        enableTracing: true
         defaultConfig:
           tracing:
             custom_tags:
@@ -173,6 +203,7 @@ You can customize the tags using any of the three supported options below.
     kind: IstioOperator
     spec:
       meshConfig:
+        enableTracing: true
         defaultConfig:
           tracing:
             custom_tags:
@@ -195,6 +226,7 @@ You can customize the tags using any of the three supported options below.
     kind: IstioOperator
     spec:
       meshConfig:
+        enableTracing: true
         defaultConfig:
           tracing:
             custom_tags:
@@ -214,6 +246,7 @@ apiVersion: install.istio.io/v1alpha1
 kind: IstioOperator
 spec:
   meshConfig:
+    enableTracing: true
     defaultConfig:
       tracing:
         max_path_tag_length: <VALUE>