-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathshell-config.schema
262 lines (262 loc) · 11.5 KB
/
shell-config.schema
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
{
"type": "object",
"title": "kafka-shell user configuration JSON schema",
"required": [
"version",
"enable",
"cluster",
"clusters"
],
"properties": {
"version": {
"type": "integer",
"title": "Version",
"description": "The version of the configuration schema. Currently, it must be 1.",
"default": 1,
"enum": [
1
]
},
"enable": {
"type": "object",
"title": "Feature Toggles",
"description": "Enable or disable features within the shell.",
"required": [
"history",
"save_on_exit",
"auto_complete",
"auto_suggest",
"inline_help",
"fuzzy_search"
],
"properties": {
"history": {
"type": "boolean",
"title": "Enable History",
"description": "If enabled, history will be saved between sessions to ~/.kafka-shell-history.",
"default": true,
"examples": [
true,
false
]
},
"save_on_exit": {
"type": "boolean",
"title": "Enable Save On Exit",
"description": "If enabled, user configuration changes will be saved on exit from kafka-shell.",
"default": true,
"examples": [
true,
false
]
},
"auto_complete": {
"type": "boolean",
"title": "Enable Auto Complete",
"description": "If enabled, the autocomplete dropdown will be shown as you type.",
"default": true,
"examples": [
true,
false
]
},
"auto_suggest": {
"type": "boolean",
"title": "Enable Auto Suggest",
"description": "If enabled, suggestions from history will be shown as gray text (like the fish shell).",
"default": true,
"examples": [
true,
false
]
},
"inline_help": {
"type": "boolean",
"title": "Enable Inline Help",
"description": "Enable inline help and descriptions of commands within the autocomplete dropdown.",
"default": true,
"examples": [
true,
false
]
},
"fuzzy_search": {
"type": "boolean",
"title": "Enable Fuzzy Search",
"description": "Enable fuzzy searching of autocomplete dropdown selections.",
"default": true,
"examples": [
true,
false
]
}
},
"additionalProperties": false
},
"cluster": {
"type": "string",
"title": "Selected Cluster",
"description": "The default cluster to be selected on initialization of kafka-shell.",
"default": "local",
"examples": [
"local",
"test-cluster"
],
"pattern": "^(.*)$"
},
"clusters": {
"type": "object",
"title": "List of clusters to be used",
"patternProperties": {
"^(.*)$": {
"type": "object",
"title": "Cluster",
"description": "Properties for a Kafka cluster",
"properties": {
"bootstrap_servers": {
"type": "string",
"title": "Kafka Bootstrap Servers",
"description": "The Kafka broker(s) to connect to.",
"default": "",
"examples": [
"localhost:9092"
],
"pattern": "^(.*)$"
},
"zookeeper_connect": {
"type": "string",
"title": "Zookeeper Connect URL",
"description": "The Zookeeper nodes to connect to.",
"default": "",
"examples": [
"localhost:2181"
],
"pattern": "^(.*)$"
},
"schema_registry_url": {
"type": "string",
"title": "Schema Registry URL",
"description": "The Schema Registry URL to connect to.",
"default": "",
"examples": [
"http://localhost:8081"
],
"pattern": "^https?://(.*)$|^\\$.*$"
},
"ksql_server_url": {
"type": "string",
"title": "KSQL Server URL",
"description": "The KSQL Server URL to connect to.",
"default": "",
"examples": [
"http://localhost:8088"
],
"pattern": "^https?://(.*)$|^\\$.*$"
},
"command_prefix": {
"type": "string",
"title": "Command Prefix",
"description": "Prefix all commands with another command, such as a 'docker exec'.",
"default": "",
"examples": [
"docker run --net=host -it --entrypoint run devshawn/confluent-tools"
],
"pattern": "^(.*)$"
},
"command_file_extension": {
"type": "string",
"title": "Command File Extension",
"description": "Add a file extension such as '.sh' or .bat' to the commands.",
"default": "",
"examples": [
"sh",
"bat"
],
"pattern": "^sh$|^bat$"
},
"consumer_settings": {
"type": "object",
"title": "Consumer Settings",
"description": "Settings for configuring consumer CLI tools.",
"properties": {
"config": {
"type": "string",
"title": "Consumer Config",
"description": "Configuration path for properties file passed to --consumer.config.",
"default": "",
"examples": [
"/tmp/consumer.properties"
],
"pattern": "^(.*).properties$"
},
"properties": {
"type": "object",
"title": "Consumer Properties",
"description": "Properties to send to the consumer CLIs by default.",
"patternProperties": {
"^(.*)$": {
"title": "Consumer Property",
"description": "Property to send to the consumer CLIs by default."
}
}
}
},
"additionalProperties": false
},
"producer_settings": {
"type": "object",
"title": "Producer Settings",
"description": "Settings for configuring producer CLI tools.",
"properties": {
"config": {
"type": "string",
"title": "Consumer Config",
"description": "Configuration path for properties file passed to --producer.config.",
"default": "",
"examples": [
"/tmp/producer.properties"
],
"pattern": "^(.*).properties$"
},
"properties": {
"type": "object",
"title": "Producer Properties",
"description": "Properties to send to the producer CLIs by default.",
"patternProperties": {
"^[a-z]+(\\.[a-z]+)*$": {
"title": "Producer Property",
"description": "Property to send to the producer CLIs by default."
}
},
"additionalProperties": true
}
},
"additionalProperties": false
},
"admin_client_settings": {
"type": "object",
"title": "Admin Client Settings",
"description": "Settings for configuring admin client within the CLI tools.",
"properties": {
"config": {
"type": "string",
"title": "Admin Client Config",
"description": "Configuration path for properties file passed to --command-config.",
"default": "",
"examples": [
"/tmp/admin.properties"
],
"pattern": "^(.*).properties$"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}