Skip to content
Snippets Groups Projects
Commit 933a2d41 authored by Erik Reid's avatar Erik Reid
Browse files

updated config schema

parent 4ceae654
No related branches found
No related tags found
No related merge requests found
......@@ -42,18 +42,19 @@ The following is an example:
```python
INVENTORY_PROVIDER_CONFIG_FILENAME = "/somepath/config.json"
ENABLE_TESTING_ROUTES = True
```
- `INVENTORY_PROVIDER_CONFIG_FILENAME`: run-time accessible filename
- `INVENTORY_PROVIDER_CONFIG_FILENAME`: [REQUIRED] Run-time accessible filename
of a json file containing the server configuration parameters. This file
must be formatted according to the following json schema:
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"alarms-db": {
"definitions": {
"database_credentials": {
"type": "object",
"properties": {
"hostname": {"type": "string"},
......@@ -63,12 +64,19 @@ must be formatted according to the following json schema:
},
"required": ["hostname", "dbname", "username", "password"],
"additionalProperties": False
},
}
},
"type": "object",
"properties": {
"alarms-db": {"$ref": "#/definitions/database_credentials"},
"ops-db": {"$ref": "#/definitions/database_credentials"},
"oid_list.conf": {"type": "string"},
"routers_community.conf": {"type": "string"},
"ssh": {
"type": "object",
"properties": {
"username": {"type": "string"},
"private-key": {"type": "string"},
"known-hosts": {"type": "string"}
},
......@@ -83,19 +91,57 @@ must be formatted according to the following json schema:
},
"required": ["hostname", "port"],
"additionalProperties": False
},
"junosspace": {
"api": {"type": "string"},
"username": {"type": "string"},
"password": {"type": "string"}
},
"infinera-dna": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {"type": "string"},
"address": {"type": "string"}
},
"required": ["name", "address"],
"additionalProperties": False
}
},
"coriant-tnms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {"type": "string"},
"address": {"type": "string"}
},
"required": ["name", "address"],
"additionalProperties": False
}
}
},
"required": [
"alarms-db",
"ops-db",
"oid_list.conf",
"routers_community.conf",
"ssh",
"redis"],
"redis",
"junosspace",
"infinera-dna",
"coriant-tnms"],
"additionalProperties": False
}
```
- `ENABLE_TESTING_ROUTES`: [OPTIONAL (default value: False)]
Flat (can be any value that evaluates to True) to enable
routes to special utilities used for testing.
*This must never be enabled in a production environment.*
## Running this module
This module has been tested in the following execution environments:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment