Debian Codegraph @

src/ansiblelint/schemas/ansible-navigator-config.json

raw
1 {
2 "$schema": "http://json-schema.org/draft-07/schema",
3 "additionalProperties": false,
4 "description": "See https://ansible.readthedocs.io/projects/navigator/settings/",
5 "properties": {
6 "ansible-navigator": {
7 "additionalProperties": false,
8 "properties": {
9 "ansible": {
10 "additionalProperties": false,
11 "properties": {
12 "cmdline": {
13 "description": "Extra parameters passed to the underlying ansible command (e.g. ansible-playbook, ansible-doc, etc)",
14 "type": "string"
15 },
16 "config": {
17 "additionalProperties": false,
18 "properties": {
19 "help": {
20 "default": false,
21 "description": "Help options for ansible-config command in stdout mode",
22 "enum": [
23 true,
24 false
25 ],
26 "type": "boolean"
27 },
28 "path": {
29 "description": "Specify the path to the ansible configuration file",
30 "type": "string"
31 }
32 }
33 },
34 "doc": {
35 "additionalProperties": false,
36 "properties": {
37 "help": {
38 "default": false,
39 "description": "Help options for ansible-doc command in stdout mode",
40 "enum": [
41 true,
42 false
43 ],
44 "type": "boolean"
45 },
46 "plugin": {
47 "additionalProperties": false,
48 "properties": {
49 "name": {
50 "description": "Specify the plugin name",
51 "type": "string"
52 },
53 "type": {
54 "default": "module",
55 "description": "Specify the plugin type, 'become', 'cache', 'callback', 'cliconf', 'connection', 'filter', 'httpapi', 'inventory', 'keyword', 'lookup', 'module', 'netconf', 'role', 'shell', 'strategy', 'test' or 'vars'",
56 "enum": [
57 "become",
58 "cache",
59 "callback",
60 "cliconf",
61 "connection",
62 "filter",
63 "httpapi",
64 "inventory",
65 "keyword",
66 "lookup",
67 "module",
68 "netconf",
69 "role",
70 "shell",
71 "strategy",
72 "test",
73 "vars"
74 ],
75 "type": "string"
76 }
77 },
78 "type": "object"
79 }
80 },
81 "type": "object"
82 },
83 "inventory": {
84 "additionalProperties": false,
85 "properties": {
86 "entries": {
87 "description": "Specify an inventory file path or comma separated host list",
88 "items": {
89 "type": "string"
90 },
91 "type": "array"
92 },
93 "help": {
94 "default": false,
95 "description": "Help options for ansible-inventory command in stdout mode",
96 "enum": [
97 true,
98 false
99 ],
100 "type": "boolean"
101 }
102 }
103 },
104 "playbook": {
105 "additionalProperties": false,
106 "properties": {
107 "help": {
108 "default": false,
109 "description": "Help options for ansible-playbook command in stdout mode",
110 "enum": [
111 true,
112 false
113 ],
114 "type": "boolean"
115 },
116 "path": {
117 "description": "Specify the playbook name",
118 "type": "string"
119 }
120 }
121 }
122 },
123 "type": "object"
124 },
125 "ansible-builder": {
126 "additionalProperties": false,
127 "properties": {
128 "help": {
129 "default": false,
130 "description": "Help options for ansible-builder command in stdout mode",
131 "enum": [
132 true,
133 false
134 ],
135 "type": "boolean"
136 },
137 "workdir": {
138 "default": ".",
139 "description": "Specify the path that contains ansible-builder manifest files",
140 "type": "string"
141 }
142 },
143 "type": "object"
144 },
145 "ansible-lint": {
146 "additionalProperties": false,
147 "properties": {
148 "config": {
149 "description": "Specify the path to the ansible-lint configuration file",
150 "type": "string"
151 },
152 "lintables": {
153 "description": "Path to files on which to run ansible-lint",
154 "type": "string"
155 }
156 },
157 "type": "object"
158 },
159 "ansible-runner": {
160 "additionalProperties": false,
161 "properties": {
162 "artifact-dir": {
163 "description": "The directory path to store artifacts generated by ansible-runner",
164 "type": "string"
165 },
166 "job-events": {
167 "default": false,
168 "description": "Write ansible-runner job_events in the artifact directory",
169 "enum": [
170 true,
171 false
172 ],
173 "type": "boolean"
174 },
175 "rotate-artifacts-count": {
176 "description": "Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted",
177 "type": "integer"
178 },
179 "timeout": {
180 "description": "The timeout value after which ansible-runner will forcefully stop the execution",
181 "type": "integer"
182 }
183 },
184 "type": "object"
185 },
186 "app": {
187 "default": "welcome",
188 "description": "Subcommands",
189 "enum": [
190 "builder",
191 "collections",
192 "config",
193 "doc",
194 "exec",
195 "images",
196 "inventory",
197 "lint",
198 "replay",
199 "run",
200 "settings",
201 "welcome"
202 ],
203 "type": "string"
204 },
205 "collection-doc-cache-path": {
206 "default": "~/.cache/ansible-navigator/collection_doc_cache.db",
207 "description": "The path to collection doc cache",
208 "type": "string"
209 },
210 "color": {
211 "additionalProperties": false,
212 "properties": {
213 "enable": {
214 "default": true,
215 "description": "Enable the use of color for mode interactive and stdout",
216 "enum": [
217 true,
218 false
219 ],
220 "type": "boolean"
221 },
222 "osc4": {
223 "default": true,
224 "description": "Enable or disable terminal color changing support with OSC 4",
225 "enum": [
226 true,
227 false
228 ],
229 "type": "boolean"
230 }
231 },
232 "type": "object"
233 },
234 "editor": {
235 "additionalProperties": false,
236 "properties": {
237 "command": {
238 "default": "vi +{line_number} {filename}",
239 "description": "Specify the editor command",
240 "type": "string"
241 },
242 "console": {
243 "default": true,
244 "description": "Specify if the editor is console based",
245 "enum": [
246 true,
247 false
248 ],
249 "type": "boolean"
250 }
251 },
252 "type": "object"
253 },
254 "enable-prompts": {
255 "default": false,
256 "description": "Enable prompts for password and in playbooks. This will set mode to stdout and disable playbook artifact creation",
257 "enum": [
258 true,
259 false
260 ],
261 "type": "boolean"
262 },
263 "exec": {
264 "additionalProperties": false,
265 "properties": {
266 "command": {
267 "default": "/bin/bash",
268 "description": "Specify the command to run within the execution environment",
269 "type": "string"
270 },
271 "shell": {
272 "default": true,
273 "description": "Specify the exec command should be run in a shell",
274 "enum": [
275 true,
276 false
277 ],
278 "type": "boolean"
279 }
280 },
281 "type": "object"
282 },
283 "execution-environment": {
284 "additionalProperties": false,
285 "properties": {
286 "container-engine": {
287 "default": "auto",
288 "description": "Specify the container engine (auto=podman then docker)",
289 "enum": [
290 "auto",
291 "podman",
292 "docker"
293 ],
294 "type": "string"
295 },
296 "container-options": {
297 "description": "Extra parameters passed to the container engine command",
298 "items": {
299 "type": "string"
300 },
301 "type": "array"
302 },
303 "enabled": {
304 "default": true,
305 "description": "Enable or disable the use of an execution environment",
306 "enum": [
307 true,
308 false
309 ],
310 "type": "boolean"
311 },
312 "environment-variables": {
313 "additionalProperties": false,
314 "properties": {
315 "pass": {
316 "description": "Specify an existing environment variable to be passed through to and set within the execution environment (--penv MY_VAR)",
317 "items": {
318 "type": "string"
319 },
320 "type": "array"
321 },
322 "set": {
323 "description": "Specify an environment variable and a value to be set within the execution environment (--senv MY_VAR=42)",
324 "type": "object"
325 }
326 },
327 "type": "object"
328 },
329 "image": {
330 "description": "Specify the name of the execution environment image",
331 "type": "string"
332 },
333 "pull": {
334 "additionalProperties": false,
335 "properties": {
336 "arguments": {
337 "description": "Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. --pa='--tls-verify=false'",
338 "items": {
339 "type": "string"
340 },
341 "type": "array"
342 },
343 "policy": {
344 "default": "tag",
345 "description": "Specify the image pull policy always:Always pull the image, missing:Pull if not locally available, never:Never pull the image, tag:if the image tag is 'latest', always pull the image, otherwise pull if not locally available",
346 "enum": [
347 "always",
348 "missing",
349 "never",
350 "tag"
351 ],
352 "type": "string"
353 }
354 }
355 },
356 "volume-mounts": {
357 "additionalProperties": false,
358 "description": "Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)",
359 "items": {
360 "additionalProperties": false,
361 "properties": {
362 "dest": {
363 "type": "string"
364 },
365 "options": {
366 "type": "string"
367 },
368 "src": {
369 "type": "string"
370 }
371 },
372 "required": [
373 "src",
374 "dest"
375 ],
376 "type": "object"
377 },
378 "type": "array"
379 }
380 },
381 "type": "object"
382 },
383 "format": {
384 "default": "yaml",
385 "description": "Specify the format for stdout output.",
386 "enum": [
387 "json",
388 "yaml"
389 ],
390 "type": "string"
391 },
392 "images": {
393 "additionalProperties": false,
394 "properties": {
395 "details": {
396 "default": [
397 "everything"
398 ],
399 "description": "Provide detailed information about the selected execution environment image",
400 "items": {
401 "enum": [
402 "ansible_collections",
403 "ansible_version",
404 "everything",
405 "os_release",
406 "python_packages",
407 "python_version",
408 "redhat_release",
409 "system_packages"
410 ],
411 "type": "string"
412 },
413 "type": "array"
414 }
415 }
416 },
417 "inventory-columns": {
418 "description": "Specify a host attribute to show in the inventory view",
419 "items": {
420 "type": "string"
421 },
422 "type": "array"
423 },
424 "logging": {
425 "additionalProperties": false,
426 "properties": {
427 "append": {
428 "default": true,
429 "description": "Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session",
430 "enum": [
431 true,
432 false
433 ],
434 "type": "boolean"
435 },
436 "file": {
437 "default": "./ansible-navigator.log",
438 "description": "Specify the full path for the ansible-navigator log file",
439 "type": "string"
440 },
441 "level": {
442 "default": "warning",
443 "description": "Specify the ansible-navigator log level",
444 "enum": [
445 "debug",
446 "info",
447 "warning",
448 "error",
449 "critical"
450 ],
451 "type": "string"
452 }
453 },
454 "type": "object"
455 },
456 "mode": {
457 "default": "interactive",
458 "description": "Specify the user-interface mode",
459 "enum": [
460 "stdout",
461 "interactive"
462 ],
463 "type": "string"
464 },
465 "playbook-artifact": {
466 "additionalProperties": false,
467 "properties": {
468 "enable": {
469 "default": true,
470 "description": "Enable or disable the creation of artifacts for completed playbooks. Note: not compatible with '--mode stdout' when playbooks require user input",
471 "enum": [
472 true,
473 false
474 ],
475 "type": "boolean"
476 },
477 "replay": {
478 "description": "Specify the path for the playbook artifact to replay",
479 "type": "string"
480 },
481 "save-as": {
482 "default": "{playbook_dir}/{playbook_name}-artifact-{time_stamp}.json",
483 "description": "Specify the name for artifacts created from completed playbooks. The following placeholders are available: {playbook_dir}, {playbook_name}, {playbook_status}, and {time_stamp}",
484 "type": "string"
485 }
486 },
487 "type": "object"
488 },
489 "settings": {
490 "additionalProperties": false,
491 "properties": {
492 "effective": {
493 "default": false,
494 "description": "Show the effective settings. Defaults, CLI parameters, environment variables, and the settings file will be combined",
495 "type": "boolean"
496 },
497 "sample": {
498 "default": false,
499 "description": "Generate a sample settings file",
500 "type": "boolean"
501 },
502 "schema": {
503 "default": "json",
504 "description": "Generate a schema for the settings file ('json'= draft-07 JSON Schema)",
505 "enum": [
506 "json"
507 ],
508 "type": "string"
509 },
510 "sources": {
511 "default": false,
512 "description": "Show the source of each current settings entry",
513 "type": "boolean"
514 }
515 }
516 },
517 "time-zone": {
518 "default": "UTC",
519 "description": "Specify the IANA time zone to use or 'local' to use the system time zone",
520 "type": "string"
521 }
522 }
523 }
524 },
525 "required": [
526 "ansible-navigator"
527 ],
528 "title": "ansible-navigator settings v26",
529 "type": "object",
530 "version": "26"
531 }