Debian Codegraph @

src/ansiblelint/schemas/ansible-navigator.json

raw
1 {
2 "$defs": {
3 "AnsibleBuilderModel": {
4 "additionalProperties": false,
5 "properties": {
6 "workdir": {
7 "default": "/tmp/",
8 "description": "Specify the path that contains ansible-builder manifest files",
9 "title": "Workdir",
10 "type": "string"
11 }
12 },
13 "type": "object"
14 },
15 "AnsibleModel": {
16 "additionalProperties": false,
17 "properties": {
18 "cmdline": {
19 "description": "Extra parameters passed to the corresponding command",
20 "title": "Cmdline",
21 "type": "string"
22 },
23 "config": {
24 "description": "Specify the path to the ansible configuration file",
25 "title": "Config",
26 "type": "string"
27 },
28 "inventories": {
29 "description": "Specify an inventory file path or host list",
30 "items": {
31 "type": "string"
32 },
33 "title": "Inventories",
34 "type": "array"
35 },
36 "playbook": {
37 "description": "Specify the playbook name",
38 "title": "Playbook",
39 "type": "string"
40 }
41 },
42 "title": "AnsibleModel",
43 "type": "object"
44 },
45 "AnsibleNavigatorModel": {
46 "additionalProperties": false,
47 "properties": {
48 "ansible": {
49 "$ref": "#/$defs/AnsibleModel"
50 },
51 "ansible-builder": {
52 "$ref": "#/$defs/AnsibleBuilderModel"
53 },
54 "ansible-runner": {
55 "$ref": "#/$defs/AnsibleRunnerModel"
56 },
57 "app": {
58 "default": "welcome",
59 "description": "Subcommands",
60 "enum": [
61 "collections",
62 "config",
63 "doc",
64 "exec",
65 "images",
66 "inventory",
67 "replay",
68 "run",
69 "welcome"
70 ],
71 "title": "App",
72 "type": "string"
73 },
74 "collection-doc-cache-path": {
75 "default": "$HOME/.cache/ansible-navigator/collection_doc_cache.db",
76 "description": "The path to collection doc cache",
77 "title": "Collection-Doc-Cache-Path",
78 "type": "string"
79 },
80 "color": {
81 "$ref": "#/$defs/ColorModel"
82 },
83 "documentation": {
84 "$ref": "#/$defs/DocumentationModel"
85 },
86 "editor": {
87 "$ref": "#/$defs/EditorModel"
88 },
89 "exec": {
90 "$ref": "#/$defs/ExecModel"
91 },
92 "execution-environment": {
93 "$ref": "#/$defs/ExecutionEnvironmentModel"
94 },
95 "help-builder": {
96 "default": false,
97 "description": "Help options for ansible-builder command in stdout mode",
98 "title": "Help-Builder",
99 "type": "boolean"
100 },
101 "help-config": {
102 "default": false,
103 "description": "Help options for ansible-config command in stdout mode",
104 "title": "Help-Config",
105 "type": "boolean"
106 },
107 "help-doc": {
108 "default": false,
109 "description": "Help options for ansible-doc command in stdout mode",
110 "title": "Help-Doc",
111 "type": "boolean"
112 },
113 "help-inventory": {
114 "default": false,
115 "description": "Help options for ansible-inventory command in stdout mode",
116 "title": "Help-Inventory",
117 "type": "boolean"
118 },
119 "help-playbook": {
120 "default": false,
121 "description": "Help options for ansible-playbook command in stdout mode",
122 "title": "Help-Playbook",
123 "type": "boolean"
124 },
125 "inventory-columns": {
126 "description": "Specify a host attribute to show in the inventory view",
127 "items": {
128 "type": "string"
129 },
130 "title": "Inventory-Columns",
131 "type": "array"
132 },
133 "logging": {
134 "$ref": "#/$defs/LoggingModel"
135 },
136 "mode": {
137 "default": "interactive",
138 "description": "Specify the user-interface mode",
139 "enum": ["stdout", "interactive"],
140 "title": "Mode",
141 "type": "string"
142 },
143 "playbook-artifact": {
144 "$ref": "#/$defs/PlaybookArtifactModel"
145 }
146 },
147 "title": "AnsibleNavigatorModel",
148 "type": "object"
149 },
150 "AnsibleRunnerModel": {
151 "additionalProperties": false,
152 "properties": {
153 "artifact-dir": {
154 "description": "The directory path to store artifacts generated by ansible-runner",
155 "title": "Artifact-Dir",
156 "type": "string"
157 },
158 "rotate-artifacts-count": {
159 "description": "Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted",
160 "title": "Rotate-Artifacts-Count",
161 "type": "integer"
162 },
163 "timeout": {
164 "description": "The timeout value after which ansible-runner will force stop the execution",
165 "title": "Timeout",
166 "type": "integer"
167 }
168 },
169 "title": "AnsibleRunnerModel",
170 "type": "object"
171 },
172 "ColorModel": {
173 "additionalProperties": false,
174 "properties": {
175 "enable": {
176 "default": false,
177 "description": "Enable the use of color in the display",
178 "title": "Enable",
179 "type": "boolean"
180 },
181 "osc4": {
182 "default": true,
183 "description": "Enable or disable terminal color changing support with OSC 4",
184 "title": "Osc4",
185 "type": "boolean"
186 }
187 },
188 "title": "ColorModel",
189 "type": "object"
190 },
191 "DocumentationModel": {
192 "additionalProperties": false,
193 "properties": {
194 "plugin": {
195 "$ref": "#/$defs/PluginModel"
196 }
197 },
198 "title": "DocumentationModel",
199 "type": "object"
200 },
201 "EditorModel": {
202 "additionalProperties": false,
203 "properties": {
204 "command": {
205 "default": "vi +{line_number} {filename}",
206 "description": "Specify the editor command",
207 "title": "Command",
208 "type": "string"
209 },
210 "console": {
211 "default": true,
212 "description": "Specify if the editor is console based",
213 "title": "Console",
214 "type": "boolean"
215 }
216 },
217 "title": "EditorModel",
218 "type": "object"
219 },
220 "EnvironmentVariablesModel": {
221 "additionalProperties": false,
222 "properties": {
223 "pass": {
224 "description": "Specify an exiting environment variable to be passed through to and set within the execution environment",
225 "items": {
226 "type": "string"
227 },
228 "title": "Pass",
229 "type": "array"
230 },
231 "set": {
232 "additionalProperties": {
233 "type": "string"
234 },
235 "description": "Specify an environment variable and a value to be set within the execution environment",
236 "title": "Set",
237 "type": "object"
238 }
239 },
240 "title": "EnvironmentVariablesModel",
241 "type": "object"
242 },
243 "ExecModel": {
244 "additionalProperties": false,
245 "properties": {
246 "command": {
247 "default": "/bin/bash",
248 "description": "Specify the command to run within the execution environment",
249 "title": "Command",
250 "type": "string"
251 },
252 "shell": {
253 "default": true,
254 "description": "Specify the exec command should be run in a shell",
255 "title": "Shell",
256 "type": "boolean"
257 }
258 },
259 "title": "ExecModel",
260 "type": "object"
261 },
262 "ExecutionEnvironmentModel": {
263 "additionalProperties": false,
264 "properties": {
265 "container-engine": {
266 "default": "auto",
267 "description": "Specify the container engine (auto=podman then docker)",
268 "enum": ["auto", "podman", "docker"],
269 "title": "Container-Engine",
270 "type": "string"
271 },
272 "container-options": {
273 "description": "Extra parameters passed to the container engine command",
274 "items": {
275 "type": "string"
276 },
277 "title": "Container-Options",
278 "type": "array"
279 },
280 "enabled": {
281 "default": true,
282 "description": "Enable or disable the use of an execution environment",
283 "title": "Enabled",
284 "type": "boolean"
285 },
286 "environment-variables": {
287 "$ref": "#/$defs/EnvironmentVariablesModel"
288 },
289 "image": {
290 "default": "ghcr.io/ansible/community-ansible-dev-tools:latest",
291 "description": "Specify the name of the execution environment image",
292 "title": "Image",
293 "type": "string"
294 },
295 "pull-policy": {
296 "default": "tag",
297 "description": "Specify the image pull policy.\nalways: Always pull the image\nmissing: Pull if not locally available\nnever: Never pull the image\ntag: if the image tag is 'latest', always pull the image, otherwise pull if not locally available",
298 "enum": ["always", "missing", "never", "tag"],
299 "title": "Pull-Policy",
300 "type": "string"
301 },
302 "volume-mounts": {
303 "description": "Specify volume to be bind mounted within an execution environment",
304 "items": {
305 "$ref": "#/$defs/VolumeMountsModel"
306 },
307 "title": "Volume-Mounts",
308 "type": "array"
309 }
310 },
311 "title": "ExecutionEnvironmentModel",
312 "type": "object"
313 },
314 "LoggingModel": {
315 "additionalProperties": false,
316 "properties": {
317 "append": {
318 "default": true,
319 "description": "Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session",
320 "title": "Append",
321 "type": "boolean"
322 },
323 "file": {
324 "default": "$PWD/ansible-navigator.",
325 "description": "Specify the full path for the ansible-navigator log file",
326 "title": "File",
327 "type": "string"
328 },
329 "level": {
330 "default": "warning",
331 "description": "Specify the ansible-navigator log level",
332 "enum": ["debug", "info", "warning", "error", "critical"],
333 "title": "Level",
334 "type": "string"
335 }
336 },
337 "title": "LoggingModel",
338 "type": "object"
339 },
340 "PlaybookArtifactModel": {
341 "additionalProperties": false,
342 "properties": {
343 "enable": {
344 "default": true,
345 "description": "Enable or disable the creation of artifacts for completed playbooks.\nNote: not compatible with 'mode: stdout' when playbooks require user input",
346 "title": "Enable",
347 "type": "boolean"
348 },
349 "replay": {
350 "description": "Specify the path for the playbook artifact to replay",
351 "title": "Replay",
352 "type": "string"
353 },
354 "save-as": {
355 "default": "{playbook_dir}/{playbook_name}-artifact-{ts_utc}.json",
356 "description": "Specify the name for artifacts created from completed playbooks",
357 "title": "Save-As",
358 "type": "string"
359 }
360 },
361 "title": "PlaybookArtifactModel",
362 "type": "object"
363 },
364 "PluginModel": {
365 "additionalProperties": false,
366 "properties": {
367 "name": {
368 "description": "Specify the plugin name",
369 "title": "Name",
370 "type": "string"
371 },
372 "type": {
373 "default": "module",
374 "description": "Specify the plugin type",
375 "enum": [
376 "become",
377 "cache",
378 "callback",
379 "cliconf",
380 "connection",
381 "httpapi",
382 "inventory",
383 "lookup",
384 "module",
385 "netconf",
386 "shell",
387 "strategy",
388 "vars"
389 ],
390 "title": "Type",
391 "type": "string"
392 }
393 },
394 "title": "PluginModel",
395 "type": "object"
396 },
397 "VolumeMountsModel": {
398 "additionalProperties": false,
399 "properties": {
400 "dest": {
401 "title": "Dest",
402 "type": "string"
403 },
404 "label": {
405 "title": "Label",
406 "type": "string"
407 },
408 "src": {
409 "title": "Src",
410 "type": "string"
411 }
412 },
413 "required": ["src", "dest"],
414 "title": "VolumeMountsModel",
415 "type": "object"
416 }
417 },
418 "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible-navigator.json",
419 "$schema": "http://json-schema.org/draft-07/schema",
420 "additionalProperties": false,
421 "examples": ["ansible-navigator.yml"],
422 "properties": {
423 "ansible-navigator": {
424 "$ref": "#/$defs/AnsibleNavigatorModel"
425 }
426 },
427 "required": ["ansible-navigator"],
428 "title": "Ansible-Navigator Configuration Schema",
429 "type": "object"
430 }