X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;fp=README.md;h=6f7747da59f86fe7f5a8da682747f971a5413042;hb=927cde433546ffe18bcf16f4d9887aa5c582c976;hp=0000000000000000000000000000000000000000;hpb=87956295b3a222b6b4f946a27efd633175ae7ed4;p=ric-plt%2Fjaegeradapter.git

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f7747d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Jaeger adapter
+
+This repository contains jaeger configuration files, like the heml charts
+
+## Current information
+
+Currently only supported configuration is jaeger-all-in-one deployment.
+The heml chart defines following three services.
+
+### The jaeger agent
+
+Jaeger agent receives trace data from jaeger client(s) with UDP to ports 5775 or 6831 or 6832.
+So the jaeger pods needs to expose these ports and the jaeger agent service IP address
+should be available with DNS.
+
+With these helm charts the DNS entry will be `jaeger-all-in-one-agent`.
+
+### the jaeger collector
+
+Jaeger collector receives trace data from jaeger agent(s) with TCP to ports 14267 or 14268 or 9411.
+Jaeger pod need to expose these ports and the collector service IP address should be available
+with DNS
+
+With these helm charts the DNS entry will be `jaeger-all-in-one-collector`.
+
+### the jaeger query
+
+Jaeger query implements a web service for quering trace data. It should expose a http port, for example 80.
+
+With these helm charts the DNS entry will be `jaeger-all-in-one-query`.
+
+## Config map
+
+A config map for creating trace client configuration is provided. Currently it configures a disabled tracer client.