waitup 1.0.0

Wait for TCP ports and HTTP endpoints to be available. Essential for Docker, K8s, and CI/CD pipelines to ensure services are ready before proceeding.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

# Example Docker Compose demonstrating waitup usage
version: "3.8"

services:
  # Database service
  postgres:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: testdb
      POSTGRES_USER: testuser
      POSTGRES_PASSWORD: testpass
    ports:
      - "5432:5432"
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U testuser -d testdb"]
      interval: 5s
      timeout: 5s
      retries: 5

  # Redis cache
  redis:
    image: redis:7-alpine
    ports:
      - "6379:6379"
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      timeout: 3s
      retries: 5

  # Example web API that depends on database and cache
  web-api:
    image: nginx:alpine
    ports:
      - "8080:80"
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy

  # Example: Using waitup as init container
  app-with-waitup:
    image: alpine:latest
    depends_on:
      - postgres
      - redis
      - web-api
    command: |
      sh -c "
        # Install waitup (in real usage, you'd use the waitup image)
        echo 'Simulating waitup checking dependencies...'
        sleep 2
        echo 'Dependencies ready! Starting application...'
        sleep 10
        echo 'Application running...'
      "

  # Example: Using waitup container directly
  waitup-example:
    build:
      context: .
      dockerfile: Dockerfile
    command: |
      postgres:5432
      redis:6379
      web-api:80
      --timeout 60s
      --interval 2s
      --verbose
      --
      echo "All services are ready! Application can start now."
    depends_on:
      - postgres
      - redis
      - web-api

  # Example: Wait for external HTTP service
  waitup-http:
    build:
      context: .
      dockerfile: Dockerfile
    command: |
      https://httpbin.org/status/200
      --expect-status 200
      --timeout 30s
      --json
    profiles:
      - http-example

  # Example: Wait for any of multiple services (failover scenario)
  waitup-any:
    build:
      context: .
      dockerfile: Dockerfile
    command: |
      postgres:5432
      backup-postgres:5432
      --any
      --timeout 30s
      --verbose
      --
      echo "At least one database is available!"
    depends_on:
      - postgres
    profiles:
      - failover-example

# Example networks
networks:
  default:
    driver: bridge

# Example volumes
volumes:
  postgres_data:
    driver: local
  redis_data:
    driver: local