Skip to content

Commit f160d65

Browse files
committed
README.md: add some minimal information for this project
1 parent d6882f6 commit f160d65

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
echo-api
22
========
33

4-
Stupid sinatra app that returns back info about the request
4+
Sinatra app that returns back info about HTTP/1 requests.
55

66
https://echo-api.3scale.net/
7+
8+
## Container image
9+
10+
A container image can be found at quay.io/3scale/echoapi:stable.
11+
12+
## Running on Openshift/Istio
13+
14+
You can find contributed templates for deploying `echo-api` on Openshift
15+
and Istio in the `contrib` directory.
16+
17+
## Running with Jaeger support
18+
19+
Just pass in the environment variables below to the program:
20+
21+
- `OPENTRACING_TRACER` set to `jaeger`.
22+
- `JAEGER_SERVICE_NAME` can optionally be set, default is `echo-api`.
23+
- `JAEGER_AGENT_HOST` set to the hostname/address of the Jaeger's agent.
24+
- `JAEGER_AGENT_PORT` set to the port where the Jaeger's agent listens.
25+
26+
The `JAGER_AGENT_HOST` and `JAEGER_AGENT_PORT` variables can be omitted for
27+
a default local agent listening at `127.0.0.1` and port `6831`.

0 commit comments

Comments
 (0)