https://github.com/cookpad/wait-side-car
Wait essential side-car containers to be available.
https://github.com/cookpad/wait-side-car
Last synced: about 1 month ago
JSON representation
Wait essential side-car containers to be available.
- Host: GitHub
- URL: https://github.com/cookpad/wait-side-car
- Owner: cookpad
- Created: 2018-07-21T01:59:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-31T08:38:36.000Z (almost 7 years ago)
- Last Synced: 2025-02-08T02:44:16.725Z (3 months ago)
- Language: Go
- Size: 19.5 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
wait-side-car
=============
Wrapper command line tool to wait side-car Envoy containers on application startup.
- Wait Envoy side-car with retry every 300 millseconds.
- Retry on connection errors in case Envoy hasn't listen the socket yet.
- Retry on unhealth responses in case Envoy hasn't fetch upstream hosts/routes from xDS API yet.
- If Envoy responds a healthy response, stop retrying.
- Timeout all waiting procedures after `--timeout` millseconds. Even if timed out, go next step (timeout is not failure here).
- Call execve(2) to start user program with current environment variables and rest of command line arguments.
## Usage
Common flags:
- `--timeout`: Overall timeout millseconds.
- `--envoy-host-header`: A host header to access to specific upstream serivce via Envoy.
For HTTP web APIs:
- `--envoy-healthcheck-url`: A URL to check accessibility to upstream service via Envoy (e.g. `http://envoy/hc` or `http://127.0.0.1:9211/hc`)
```
wait-side-car --timeout=10000 --envoy-host-header=user-service --envoy-healthcheck-url=http://envoy/hc /usr/local/bin/my-app -b 0.0.0.0 -p 8080 another-arg
```
For gRPC servers:
- `--envoy-grpc-insecure-healthcheck-addr`: A pair of IP address (or DNS name) and port to check accessibility to upstream gRPC service via Envoy (e.g `envoy:8080` or `127.0.0.1:9211`)
```
wait-side-car --timeout=10000 --envoy-host-header=user-service --envoy-grpc-insecure-healthcheck-addr=envoy:8080 /usr/local/bin/my-app run-job --job-name=record-count-of-users
```
## Development
Required tools:
- dep: https://github.com/golang/dep
- goreleaser: https://github.com/goreleaser/goreleaser
```
dep ensure
```
Releasing:
```
git tag -s vx.y.z
GITHUB_TOKEN=xxx goreleaser --rm-dist
```
Personal memo: I'm using [envchain](https://github.com/sorah/envchain) for the `GITHUB_TOKEN` value.