Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ph4r5h4d/wait4it
A simple go application to test whether a port or a service is ready or not
https://github.com/ph4r5h4d/wait4it
aerospike elasticsearch golang memcached mysql-connection postgresql rabbitmq redis tcp-check tcp-port wait-for-it
Last synced: 3 months ago
JSON representation
A simple go application to test whether a port or a service is ready or not
- Host: GitHub
- URL: https://github.com/ph4r5h4d/wait4it
- Owner: ph4r5h4d
- License: gpl-3.0
- Created: 2020-01-25T18:16:37.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T14:10:57.000Z (4 months ago)
- Last Synced: 2024-07-27T07:31:24.612Z (3 months ago)
- Topics: aerospike, elasticsearch, golang, memcached, mysql-connection, postgresql, rabbitmq, redis, tcp-check, tcp-port, wait-for-it
- Language: Go
- Homepage:
- Size: 439 KB
- Stars: 84
- Watchers: 5
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# wait4it
   [](https://hub.docker.com/r/ph4r5h4d/wait4it)   
A simple go application to test whether a port is ready to accept a connection or check
MySQL, PostgreSQL, MongoDB or Redis server is ready or not, Also you can do Http call and check
the response code and text in response.
It also supports **timeout** so it can wait for a particular time and then fail.
## Supported Modules
* TCP port
* MySQL
* PostgresQL
* Http
* MongoDB
* Redis
* RabbitMQ
* Memcached
* ElasticSearch
* Aerospike
## Install
You can download the latest [release](https://github.com/ph4r5h4d/wait4it/releases), or you can build it yourself.
To build just run `go build`.
## Configuration
### Environment variables
The following environment variables are supported:
* `W4IT_TYPE` (check type [http, tcp, mysql, postgres])
* `W4IT_TIMEOUT` (timeout in seconds)
* `W4IT_HOST` (the host to check)
* `W4IT_PORT` (port to check on the host)
* `W4IT_USERNAME` (username for the services that needs username)
* `W4IT_PASSWORD` (password for the services that needs password)
* `W4IT_DBNAME` (database name for MySQL or PostgreSQL)
* `W4IT_SSL_MODE` (whether to enable or disable ssl-mode for Postgres [disable, enable])
* `W4IT_OPERATION_MODE` (to select operation mode for redis [standalone, cluster])
* `W4IT_HTTP_STATUS_CODE` (for Http check, which status code to expect)
* `W4IT_HTTP_TEXT` (for Http check, find substring inside the response)
* `W4IT_HTTP_FOLLOW_REDIRECT` (Whether to follow the redirect while doing the HTTP check [true, false] default is *true*)
### Command Line Args
The following command-line flags are supported
* `-type` (check type [http, tcp, mysql, postgres])
* `-h` (the host to check, default is 127.0.0.1)
* `-p` (port to check on the host)
* `-t` (timeout in seconds, time to wait before considering the operation as failed. default is 30)
* `-u` (username for the services that needs username)
* `-P` (password for the services that needs password)
* `-n` (database name for MySQL or PostgreSQL)
* `-ssl` (whether to enable or disable ssl-mode for Postgres [disable, enable])
* `-operation-mode` (to select operation mode for redis [standalone, cluster])
* `-http-status` (for Http check, which status code to expect)
* `-http-text` (for Http check, find substring inside the response)
* `-http-follow-redirect` (Whether to follow the redirect while doing the HTTP check [true, false], default is *true*)
### Sample
Check a TCP port
```bash
./wait4it -type=tcp -h=127.0.0.1 -p=8080 -t=60
```
Check a MySQL instance
```bash
./wait4it -type=mysql -h=127.0.0.1 -p=3306 -t=60 -u=root -P=secret -n=app
```
Check a PostgresQL instance
```bash
./wait4it -type=postgres -h=127.0.0.1 -p=5432 -t=60 -u=postgres -P=secret -ssl=disable
```
Check HTTP response and text
```bash
./wait4it -type=http -h=https://farshad.nematdoust.com -t=60 -status-code=200 -http-text="Software Engineer"
./wait4it -type=http -h=https://nematdoust.com -t=60 -status-code=301 -W4IT_HTTP_FOLLOW_REDIRECT=false
```
Check a MongoDB instance
```bash
./wait4it -type=mongo -p=27017 -t=60 -u=mongoadmin -P=secret -h=127.0.0.1
```
Check a Redis instance
```bash
./wait4it -type=redis -p=6379 -t=60 -P=secret -h=127.0.0.1
# if your redis is not password protected
./wait4it -type=redis -p=6379 -t=60 -h=127.0.0.1
# if you use redis cluster
./wait4it -type=redis -p=6379 -t=60 -P=secret -operation-mode=cluster -h=127.0.0.1
```
Check a RabbitMQ instance
```bash
./wait4it -type=rabbitmq -p=5267 -t=60 -u=guest -P=guest -h=127.0.0.1
```
Check a Memcached instance
```bash
./wait4it -type=memcached -h=127.0.0.1 -p=11211 -t=60
```
Check ElasticSearch instance
```bash
./wait4it -type=elasticsearch -h=http://127.0.0.1 -p=9200 -t=60
```
Check a Aerospike instance
```bash
./wait4it -type=aerospike -h=127.0.0.1 -p=3000 -t=60
```
### Docker
You can run this `wait4it` inside a docker container, and it's possible to run this container as init container inside
K8s and Openshift.
You can use the following image in Docker Hub:
`docker pull ph4r5h4d/wait4it`
Inside container you can do the following:
#### Sample
Check a TCP port
```bash
docker run ph4r5h4d/wait4it -type=tcp -h=127.0.0.1 -p=8080 -t=60
```
Check a MySQL instance
```bash
docker run ph4r5h4d/wait4it -type=mysql -h=127.0.0.1 -p=3306 -t=60 -u=root -P=secret -n=app
```
Check a PostgresQL instance
```bash
docker run ph4r5h4d/wait4it -type=postgres -h=127.0.0.1 -p=5432 -t=60 -u=postgres -P=secret -ssl=disable
```
Check HTTP response and text
```bash
docker run ph4r5h4d/wait4it -type=http -h=https://farshad.nematdoust.com -t=60 -status-code=200 -http-text="Software Engineer"
docker run ph4r5h4d/wait4it -type=http -type=http -h=https://nematdoust.com -t=60 -status-code=301 -W4IT_HTTP_FOLLOW_REDIRECT=false
```
Check a MongoDB instance
```bash
docker run ph4r5h4d/wait4it -type=mongo -p=32768 -t=60 -u=mongoadmin -P=secret -h=127.0.0.1
```
Check a RabbitMQ instance
```bash
docker run ph4r5h4d/wait4it -type=rabbitmq -p=5267 -t=60 -u=guest -P=guest -h=127.0.0.1
```
Check a Redis instance
```bash
docker run ph4r5h4d/wait4it -type=redis -p=6379 -t=60 -P=secret -h=127.0.0.1
# if your redis is not password protected
docker run ph4r5h4d/wait4it -type=redis -p=6379 -t=60 -h=127.0.0.1
# if you use redis cluster
docker run ph4r5h4d/wait4it -type=redis -p=6379 -t=60 -P=secret -operation-mode=cluster -h=127.0.0.1
```
Check a Memcached instance
```bash
docker run ph4r5h4d/wait4it -type=memcached -h=127.0.0.1 -p=11211
```
Check a ElasticSearch instance
```bash
docker run ph4r5h4d/wait4it -type=elasticsearch -h=http://127.0.0.1 -p=9200
```
Check a Aerospike instance
```bash
docker run ph4r5h4d/wait4it -type=aerospike -h=127.0.0.1 -p=3000 -t=60
```
## Notes
#### Configuration
* note that environment variables have higher priority than command-line arguments.
This means if you define both `W4IT_TYPE` and `-type`, the application takes the value of the environment variable into account.
#### Exit codes
* 0: connection established successfully
* 1: timed out
* 2: mostly means a validation error or something wrong with the input data
#### Http check
* for the Http check if you do not define status code it will check for 200 status code
* if `http-text` is not defined then wait4it will check the status code
#### Postgres check
* if `ssl` is not defined then it's `disable` by default
#### MongoDB check
* for the moment only username/password authentication mechanism is supported.
#### Redis check
* if `operation-mode` is not defined then it's `standalone` by default. Redis Sentinel is not supported yet.
* this version can only check one host within Redis cluster, using multiple hosts to check cluster status for Redis will be added in the next version.
#### Memcached check
* for the moment multiple hosts and cluster checks are not supported.
#### ElasticSearch
* for the moment multiple hosts and cluster checks are not supported.
* as you know, username/password authentication mechanism is only supported along with the X-Pack extension and if the X-Pack extension wasn't activated, filling username/password won't have any effect. According to these reasons, username/password isn't required.