Skip to content

fix(schema): Make inventory JSON Schema match actually accepted inventories #4801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(schema): Make inventory JSON Schema match actually accepted inventories #4801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 120 additions & 32 deletions src/ansiblelint/schemas/inventory.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,154 @@
{
"$defs": {
"group": {
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#inventory-basics-formats-hosts-and-groups",
"properties": {
"children": {
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#grouping-groups-parent-child-group-relationships",
"pattern": "^[a-zA-Z_]\\w*$",
"patternProperties": {
"[a-zA-Z-_0-9]": {
"^[a-zA-Z_]\\w*$": {
"$ref": "#/$defs/group"
}
}
},
"title": "Children",
"type": ["object", "string", "null"]
},
"hosts": {
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#inventory-basics-formats-hosts-and-groups",
"examples": [
{
"foo.example.com": null
},
"foo.example.com",
{
"www[01:50].example.com": null
},
{
"www[01:50:2].example.com": null
}
],
"minLength": 1,
"patternProperties": {
"[a-zA-Z.-_0-9]": {
".": {
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#inventory-basics-formats-hosts-and-groups",
"patternProperties": {
"^[a-zA-Z_]\\w*$": {
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#assigning-a-variable-to-one-machine-host-variables",
"title": "Host Variable"
}
},
"title": "Host",
"type": ["object", "null"]
}
},
"type": ["object", "string"]
"title": "Hosts",
"type": ["object", "string", "null"]
},
"vars": {
"type": "object"
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#assigning-a-variable-to-many-machines-group-variables",
"examples": [
{
"ntp_server": "ntp.atlanta.example.com",
"proxy": "proxy.atlanta.example.com"
}
],
"pattern": "^[a-zA-Z_]\\w*$",
"patternProperties": {
"^[a-zA-Z_]\\w*$": {
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#assigning-a-variable-to-many-machines-group-variables",
"title": "Group Variable"
}
},
"title": "Group Variables",
"type": ["object", "string", "null"]
}
},
"title": "Group",
"type": ["object", "null"]
},
"special-group": {
"additionalProperties": false,
"properties": {
"children": {
"type": ["object", "null"]
},
"groups": {
"type": ["object", "null"]
},
"hosts": {
"type": ["object", "null"]
},
"vars": {
"type": ["object", "null"]
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/inventory.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": true,
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html",
"examples": [
"inventory.yaml",
"inventory.yml",
"inventory/*.yml",
"inventory/*.yaml"
{
"dbservers": {
"hosts": {
"one.example.com": null,
"three.example.com": null,
"two.example.com": null
}
},
"ungrouped": {
"hosts": {
"mail.example.com": null
}
},
"webservers": {
"hosts": {
"bar.example.com": null,
"foo.example.com": null
}
}
},
{
"atlanta": {
"hosts": {
"host1": {
"http_port": 80,
"maxRequestsPerChild": 808
},
"host2": {
"http_port": 303,
"maxRequestsPerChild": 909
}
}
}
},
{
"webservers": {
"hosts": {
"www[01:50].example.com": null
}
}
},
{
"webservers": {
"hosts": {
"www[01:50:2].example.com": null
}
}
}
],
"markdownDescription": "All keys at top levels are groups with `all` and `ungrouped` having a special meaning.\n\nSee [How to build your inventory](https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html)",
"patternProperties": {
"^[a-zA-Z_]\\w*$": {
"$ref": "#/$defs/group"
}
},
"properties": {
"all": {
"$ref": "#/$defs/special-group"
"$ref": "#/$defs/group",
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#default-groups"
},
"ungrouped": {
"$ref": "#/$defs/group"
"$ref": "#/$defs/group",
"description": "See https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#default-groups"
}
},
"title": "Ansible Inventory Schema",
"type": "object"
"title": "Ansible Inventory",
"type": "object",
"x-ansible-lint": [
"inventory.yaml",
"inventory.yml",
"inventory/*.yml",
"inventory/*.yaml"
]
}
17 changes: 16 additions & 1 deletion test/schemas/negative_test/inventory/broken_dev_inventory.yml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,16 @@
"params": {
"additionalProperty": "foo"
},
"schemaPath": "#/$defs/special-group/additionalProperties"
"schemaPath": "#/additionalProperties"
},
{
"instancePath": "/all",
"keyword": "additionalProperties",
"message": "must NOT have additional properties",
"params": {
"additionalProperty": "foo"
},
"schemaPath": "#/additionalProperties"
}
]
```
Expand All @@ -23,6 +32,12 @@ stdout:
"status": "fail",
"successes": [],
"errors": [
{
"filename": "negative_test/inventory/broken_dev_inventory.yml",
"path": "$.all",
"message": "Additional properties are not allowed ('foo' was unexpected)",
"has_sub_errors": false
},
{
"filename": "negative_test/inventory/broken_dev_inventory.yml",
"path": "$.all",
Expand Down
Loading