grpc/schema.json at 0c73e3ffeb821dda438a1ac51d32ff28750bb9cc · roadrunner-server/grpc · GitHub

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
120
121
122
123
124
{
  "$id": "https://raw.githubusercontent.com/roadrunner-server/grpc/refs/heads/master/schema.json",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "description": "All the valid configuration parameters for the gRPC plugin for RoadRunner.",
  "type": "object",
  "title": "roadrunner-grpc",
  "additionalProperties": false,
  "required": [
    "proto",
    "listen"
  ],
  "properties": {
    "listen": {
      "description": "gRPC address to listen on. Supports both TCP and Unix sockets.",
      "type": "string",
      "minLength": 1,
      "examples": [
        "tcp://127.0.0.1:443",
        "${TCP:-tcp://127.0.0.1:443}",
        "tcp://127.0.0.1:${TCP_PORT}"
      ]
    },
    "proto": {
      "type": "array",
      "minItems": 1,
      "description": "Proto file(s) to use. Multiple files are supported. Wildcards are allowed in the proto field.",
      "items": {
        "type": "string",
        "minLength": 1,
        "examples": [
          "*.proto",
          "first.proto",
          "second.proto"
        ]
      }
    },
    "interceptors": {
      "description": "List of registered unary gRPC interceptor plugin names.",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 1
      },
      "examples": [
        [
          "sample-grpc-interceptor"
        ],
        [
          "auth-interceptor",
          "ratelimit-interceptor"
        ]
      ]
    },
    "tls": {
      "description": "GRPC TLS configuration",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "key": {
          "$ref": "https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json#/$defs/SSL/properties/key"
        },
        "cert": {
          "$ref": "https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json#/$defs/SSL/properties/cert"
        },
        "root_ca": {
          "$ref": "https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json#/$defs/SSL/properties/root_ca"
        },
        "client_auth_type": {
          "$ref": "https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json#/$defs/ClientAuthType"
        }
      },
      "required": [
        "key",
        "cert"
      ]
    },
    "max_send_msg_size": {
      "type": "integer",
      "description": "Maximum send message size in MB.",
      "default": 50
    },
    "max_recv_msg_size": {
      "type": "integer",
      "description": "Maximum receive message size in MB.",
      "default": 50
    },
    "max_connection_idle": {
      "description": " MaxConnectionIdle is a duration for the amount of time after which an idle connection would be closed by sending a GoAway. Idle duration is defined by the most recent time the number of outstanding RPCs became zero or since the connection was established. Defaults to infinite.",
      "$ref": "#/$defs/duration"
    },
    "max_connection_age": {
      "description": "The maximum duration a connection may exist before it will be closed by sending a GoAway. A random jitter of +/-10% will be added to MaxConnectionAge to spread out connection storms. Defaults to infinite.",
      "$ref": "#/$defs/duration"
    },
    "max_connection_age_grace": {
      "description": "The duration after MaxConnectionAge after which the connection will be forcibly closed. Defaults to infinite.",
      "$ref": "#/$defs/duration"
    },
    "max_concurrent_streams": {
      "description": "The maximum number of concurrent streams. Empty or 0 defaults to 10.",
      "type": "integer",
      "default": 10
    },
    "ping_time": {
      "description": "Duration of no activity after which the server pings the client to see if the transport is still alive. If set below 1s, a minimum value of 1s will be used instead.",
      "$ref": "#/$defs/duration",
      "default": "2h"
    },
    "timeout": {
      "description": "The duration to wait for a response to a keepalive check, after which the connection is closed.",
      "$ref": "#/$defs/duration",
      "default": "20s"
    },
    "pool": {
      "$ref": "https://raw.githubusercontent.com/roadrunner-server/pool/refs/heads/master/schema.json"
    }
  },
  "$defs": {
    "duration": {
      "$ref": "https://raw.githubusercontent.com/roadrunner-server/roadrunner/refs/heads/master/schemas/config/3.0.schema.json#/definitions/Duration"
    }
  }
}