@stigg/sidecar 2.412.2 → 2.414.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -4
- package/dist/bin/sidecar-linux +0 -0
- package/dist/bin/sidecar-macos +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,8 @@ aws ecr-public get-login-password --region us-east-1 | docker login --username A
|
|
|
34
34
|
Run the service:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
docker run --rm --name stigg-sidecar --memory=1gb --cpus="1"
|
|
37
|
+
docker run --rm --name stigg-sidecar --memory=1gb --cpus="1" \
|
|
38
|
+
--publish=8443:8443 --publish=8080:8080 \
|
|
38
39
|
-e SERVER_API_KEY="<SERVER_API_KEY>" \
|
|
39
40
|
public.ecr.aws/stigg/sidecar:latest
|
|
40
41
|
```
|
|
@@ -56,7 +57,8 @@ docker run --rm --name stigg-sidecar --memory=1gb --cpus="1" --publish=8443:844
|
|
|
56
57
|
| `REDIS_USERNAME` | String | | Redis username |
|
|
57
58
|
| `REDIS_PASSWORD` | String | | Redis password |
|
|
58
59
|
| `REDIS_KEYS_TTL_IN_SECS` | Number | `7 * 24 * 60 * 60` | Time for entitlements to be cached,<br/>in milliseconds |
|
|
59
|
-
| `PORT` | Number | `8443` |
|
|
60
|
+
| `PORT` | Number | `8443` | gRPC/Connect server port (HTTPS) |
|
|
61
|
+
| `METRICS_PORT` | Number | `8080` | Metrics and health endpoints port (HTTP) |
|
|
60
62
|
| `ENTITLEMENTS_FALLBACK` | String | `` | Fallback entitlements in a JSON string format. |
|
|
61
63
|
| `HEALTH_ENDPOINT_URL` | String | `livez` | Health endpoint URL |
|
|
62
64
|
| `READY_ENDPOINT_URL` | String | `readyz` | Ready endpoint URL |
|
|
@@ -64,9 +66,9 @@ docker run --rm --name stigg-sidecar --memory=1gb --cpus="1" --publish=8443:844
|
|
|
64
66
|
|
|
65
67
|
\*Required fields
|
|
66
68
|
|
|
67
|
-
## Health:
|
|
69
|
+
## Health and Metrics:
|
|
68
70
|
|
|
69
|
-
The service exposes
|
|
71
|
+
The service exposes health and metrics endpoints on HTTP server (default port 8080).
|
|
70
72
|
|
|
71
73
|
### `GET /livez`
|
|
72
74
|
|
|
@@ -79,3 +81,7 @@ Healthy response: `{"status":"UP"}`
|
|
|
79
81
|
Returns `200` if the service is ready.
|
|
80
82
|
|
|
81
83
|
Healthy response: `{ "status": "UP" }`
|
|
84
|
+
|
|
85
|
+
### `GET /metrics`
|
|
86
|
+
|
|
87
|
+
Returns Prometheus metrics in text format.
|
package/dist/bin/sidecar-linux
CHANGED
|
Binary file
|
package/dist/bin/sidecar-macos
CHANGED
|
Binary file
|