arig 0.2.4

Polyglot service orchestrator
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ArigConfig",
  "description": "Top-level arig config. Lives at `arig.yaml` by default.",
  "type": "object",
  "properties": {
    "services": {
      "description": "Services to supervise, keyed by service name.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/ServiceConfig"
      }
    }
  },
  "required": [
    "services"
  ],
  "$defs": {
    "ReadyProbe": {
      "type": "object",
      "properties": {
        "tcp": {
          "description": "TCP host:port to connect to. Probe passes when connect() succeeds.",
          "type": [
            "string",
            "null"
          ]
        },
        "timeout": {
          "description": "Total time to keep retrying before giving up. e.g. \"30s\", \"1m 30s\".",
          "type": "string",
          "default": "1m"
        }
      }
    },
    "ServiceConfig": {
      "type": "object",
      "properties": {
        "command": {
          "description": "Command line to execute. Run via the system shell.",
          "type": "string"
        },
        "depends_on": {
          "description": "Other service names that must be ready before this one starts.",
          "type": "array",
          "default": [],
          "items": {
            "type": "string"
          }
        },
        "env": {
          "description": "Extra environment variables to set for the process.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "default": {}
        },
        "ready": {
          "description": "Optional readiness probe. Dependents wait until this passes.",
          "anyOf": [
            {
              "$ref": "#/$defs/ReadyProbe"
            },
            {
              "type": "null"
            }
          ]
        },
        "timeout": {
          "description": "Maximum time a oneshot may run before it's killed and the wave fails.\nIgnored for long-running services. e.g. \"5m\", \"30s\". No default: opt-in.",
          "type": [
            "string",
            "null"
          ],
          "default": null
        },
        "type": {
          "$ref": "#/$defs/ServiceType"
        },
        "working_dir": {
          "description": "Working directory for the command. Relative to the config file's directory.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "command"
      ]
    },
    "ServiceType": {
      "description": "How arig should treat a service for shutdown and exit semantics.",
      "oneOf": [
        {
          "description": "Long-running process; arig keeps it alive and stops it on shutdown.",
          "type": "string",
          "const": "service"
        },
        {
          "description": "Runs to completion once; arig waits for exit before dependents start.",
          "type": "string",
          "const": "oneshot"
        }
      ]
    }
  }
}