Merge pull request #2 from scottrigby/jaeger-readme

Update Readme for jaeger chart

Author: naseemkullah

.github/workflows/release.yaml

@@ -14,12 +14,18 @@ jobs:
 
       - name: Configure Git
         run: |
-          git config user.name "GitHub Actions"
-          git config user.email noreply@github.com
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
       # See https://github.com/helm/chart-releaser-action/issues/6
-      - name: Initialize Helm
-        run: helm init --client-only
+      # For now, install the same version of Tiller as the chart-testing Helm
+      # client version: v2.15.2.
+      - name: Install Helm
+        run: |
+          curl -sSLo get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get
+          chmod 700 get_helm.sh
+          DESIRED_VERSION=v2.15.2 ./get_helm.sh
+          helm init --client-only
 
       - name: Add dependency chart repos
         run: |

charts/jaeger/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 appVersion: 1.15.1
 description: A Jaeger Helm chart for Kubernetes
 name: jaeger
-version: 0.17.3
+version: 0.17.4
 keywords:
   - jaeger
   - opentracing

charts/jaeger/README.md

@@ -1,6 +1,6 @@
 # Jaeger
 
-[Jaeger](http://jaeger.readthedocs.io/en/latest/) is a distributed tracing system.
+[Jaeger](https://www.jaegertracing.io/) is a distributed tracing system.
 
 ## Introduction
 
@@ -68,18 +68,24 @@ data:
 
 ## Installing the Chart
 
+Add the Jaeger Tracing Helm repository:
+
+```console
+$ helm repo add jaegertracing https://jaegertracing.github.io/helm-charts
+```
+
 To install the chart with the release name `myrel`, run the following command:
 
 ```bash
-$ helm install incubator/jaeger --name myrel
+$ helm install jaegertracing/jaeger --name myrel
 ```
 
 After a few minutes, you should see a 3 node Cassandra instance, a Jaeger DaemonSet, a Jaeger Collector, and a Jaeger Query (UI) pod deployed into your Kubernetes cluster.
 
 IMPORTANT NOTE: For testing purposes, the footprint for Cassandra can be reduced significantly in the event resources become constrained (such as running on your local laptop or in a Vagrant environment). You can override the resources required run running this command:
 
 ```bash
-helm install incubator/jaeger --name myrel --set cassandra.config.max_heap_size=1024M --set cassandra.config.heap_new_size=256M --set cassandra.resources.requests.memory=2048Mi --set cassandra.resources.requests.cpu=0.4 --set cassandra.resources.limits.memory=2048Mi --set cassandra.resources.limits.cpu=0.4
+helm install jaegertracing/jaeger --name myrel --set cassandra.config.max_heap_size=1024M --set cassandra.config.heap_new_size=256M --set cassandra.resources.requests.memory=2048Mi --set cassandra.resources.requests.cpu=0.4 --set cassandra.resources.limits.memory=2048Mi --set cassandra.resources.limits.cpu=0.4
 ```
 
 > **Tip**: List all releases using `helm list`
@@ -89,7 +95,7 @@ helm install incubator/jaeger --name myrel --set cassandra.config.max_heap_size=
 If you already have an existing running Cassandra cluster, you can configure the chart as follows to use it as your backing store (make sure you replace `<HOST>`, `<PORT>`, etc with your values):
 
 ```bash
-helm install incubator/jaeger --name myrel --set provisionDataStore.cassandra=false --set storage.cassandra.host=<HOST> --set storage.cassandra.port=<PORT> --set storage.cassandra.user=<USER> --set storage.cassandra.password=<PASSWORD>
+helm install jaegertracing/jaeger --name myrel --set provisionDataStore.cassandra=false --set storage.cassandra.host=<HOST> --set storage.cassandra.port=<PORT> --set storage.cassandra.user=<USER> --set storage.cassandra.password=<PASSWORD>
 ```
 
 > **Tip**: It is highly encouraged to run the Cassandra cluster with storage persistence.
@@ -146,15 +152,15 @@ data:
 
 ```bash
 kubectl apply -f jaeger-tls-cassandra-secret.yaml
-helm install incubator/jaeger --name myrel --values values.yaml
+helm install jaegertracing/jaeger --name myrel --values values.yaml
 ```
 
 ## Installing the Chart using a New ElasticSearch Cluster
 
 To install the chart with the release name `myrel` using a new ElasticSearch cluster instead of Cassandra (default), run the following command:
 
 ```bash
-$ helm install incubator/jaeger --name myrel --set provisionDataStore.cassandra=false  --set provisionDataStore.elasticsearch=true --set storage.type=elasticsearch
+$ helm install jaegertracing/jaeger --name myrel --set provisionDataStore.cassandra=false  --set provisionDataStore.elasticsearch=true --set storage.type=elasticsearch
 ```
 
 After a few minutes, you should see 2 ElasticSearch client nodes, 2 ElasticSearch data nodes, 3 ElasticSearch master nodes, a Jaeger DaemonSet, a Jaeger Collector, and a Jaeger Query (UI) pod deployed into your Kubernetes cluster.
@@ -166,7 +172,7 @@ After a few minutes, you should see 2 ElasticSearch client nodes, 2 ElasticSearc
 If you already have an existing running ElasticSearch cluster, you can configure the chart as follows to use it as your backing store:
 
 ```bash
-helm install incubator/jaeger --name myrel --set provisionDataStore.cassandra=false --set provisionDataStore.elasticsearch=false --set storage.type=elasticsearch --set storage.elasticsearch.host=<HOST> --set storage.elasticsearch.port=<PORT> --set storage.elasticsearch.user=<USER> --set storage.elasticsearch.password=<password>
+helm install jaegertracing/jaeger --name myrel --set provisionDataStore.cassandra=false --set provisionDataStore.elasticsearch=false --set storage.type=elasticsearch --set storage.elasticsearch.host=<HOST> --set storage.elasticsearch.port=<PORT> --set storage.elasticsearch.user=<USER> --set storage.elasticsearch.password=<password>
 ```
 
 > **Tip**: It is highly encouraged to run the ElasticSearch cluster with storage persistence.
@@ -226,7 +232,7 @@ data:
 
 ```bash
 kubectl apply -f jaeger-tls-cfgmap.yaml
-helm install incubator/jaeger --name myrel --values jaeger-values.yaml
+helm install jaegertracing/jaeger --name myrel --values jaeger-values.yaml
 ```
 
 ## Uninstalling the Chart
@@ -363,7 +369,7 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
 ```bash
 $ helm install --name myrel \
     --set cassandra.config.rack_name=rack2 \
-    incubator/jaeger
+    jaegertracing/jaeger
 ```
 
 Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart.

charts/jaeger/values.yaml

@@ -92,7 +92,7 @@ schema:
   ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
   podLabels: {}
   ## Deadline for cassandra schema creation job
-  activeDeadlineSeconds: 120
+  activeDeadlineSeconds: 300
   # traceTtl: 172800
   # dependenciesTtl: 0
 

ct.yaml

@@ -0,0 +1,7 @@
+# See https://github.com/helm/chart-testing#configuration
+remote: origin
+chart-dirs:
+  - charts
+chart-repos:
+  - incubator=https://kubernetes-charts-incubator.storage.googleapis.com
+helm-extra-args: --timeout=500