repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
maxisam/mgob | df68a26390249703d5ac59bd173eba247dce44d2 | 2023-04-26T18:34:39 | charts/mgob/values.schema.json | 116 | 2024-05-27T06:24:10.75163Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"replicaCount": {
"enum": [
0,
1
],
"type": "integer"
}
},
"required": [
"replicaCount"
],
"title": "Values schema",
"type": "object"
} | MIT | en |
GannettDigital/jstransform | f5c78899fe32a6e16f5768f27b6405b958d5858d | 2020-03-25T17:09:14 | transform/test_data/xml/repeatedScalarNode.json | 22 | 2024-05-27T04:07:37.055608Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Test a scalar value which has multiple repeated items matching it in the xml",
"properties": {
"approved": {
"transform": {
"ows": {
"from": [
{
"xmlPath": "/onl:story/onl:approved"
}
]
}
},
"type": "boolean"
},
"average": {
"transform": {
"ows": {
"from": [
{
"xmlPath": "/onl:story/onl:average"
}
]
}
},
"type": "number"
},
"body": {
"transform": {
"ows": {
"from": [
{
"xmlPath": "/onl:story/onl:content/onl:paragraphs/onl:paragraph/onl:body"
}
]
}
},
"type": "string"
},
"count": {
"transform": {
"ows": {
"from": [
{
"xmlPath": "/onl:story/onl:count"
}
]
}
},
"type": "integer"
}
},
"type": "object"
} | MIT | en |
hans000/minecraft-assets-helper | 98307c632a0e8cb22ddb3b9730c998b427ff67a2 | 2021-01-03T07:44:24 | assets/linters/blockstates.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$id": "https://raw.githubusercontent.com/haima16/texture-json/master/src/blockstate.json",
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"degree": {
"enum": [
0,
90,
180,
270
],
"type": "number"
},
"face": {
"enum": [
"east",
"south",
"west",
"north",
"side"
],
"type": "string"
},
"model": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"model": {
"description": "\u6307\u5b9a\u6a21\u578b\u6587\u4ef6\u7684\u8def\u5f84\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID",
"title": "model \u6a21\u578b",
"type": "string"
},
"uvlock": {
"description": "\u53ef\u4e3atrue\u6216false\uff08\u9ed8\u8ba4\uff09\u3002\u8bbe\u7f6e\u4e3atrue\u5c06\u9501\u5b9a\u65b9\u5757\u6750\u8d28\u7684\u65cb\u8f6c\u65b9\u5411\u3002\u8fd9\u6837\u5728\u4f7f\u7528\u4e0a\u9762\u7684 x\u548c y\u6807\u7b7e\u65f6\u6750\u8d28\u5c06\u4e0d\u4f1a\u8ddf\u7740\u65b9\u5757\u4e00\u8d77\u65cb\u8f6c\u3002",
"title": "uvlock\u8d34\u56fe\u9501\u5b9a",
"type": "boolean"
},
"x": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ex\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "x\u65cb\u8f6c\u8f74"
},
"y": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ey\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "y\u65cb\u8f6c\u8f74"
}
},
"required": [
"model"
],
"type": "object"
},
"model+weight": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"model": {
"description": "\u6307\u5b9a\u6a21\u578b\u6587\u4ef6\u7684\u8def\u5f84\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID",
"title": "model \u6a21\u578b",
"type": "string"
},
"uvlock": {
"description": "\u53ef\u4e3atrue\u6216false\uff08\u9ed8\u8ba4\uff09\u3002\u8bbe\u7f6e\u4e3atrue\u5c06\u9501\u5b9a\u65b9\u5757\u6750\u8d28\u7684\u65cb\u8f6c\u65b9\u5411\u3002\u8fd9\u6837\u5728\u4f7f\u7528\u4e0a\u9762\u7684 x\u548c y\u6807\u7b7e\u65f6\u6750\u8d28\u5c06\u4e0d\u4f1a\u8ddf\u7740\u65b9\u5757\u4e00\u8d77\u65cb\u8f6c\u3002",
"title": "uvlock \u8d34\u56fe\u9501\u5b9a",
"type": "boolean"
},
"weight": {
"default": 1,
"description": "\u8bbe\u7f6e\u6a21\u578b\u5728\u6e38\u620f\u4e2d\u88ab\u9009\u7528\u7684\u51e0\u7387\uff0c\u9ed8\u8ba4\u4e3a1\uff08100%\uff09\u3002\u5982\u679c\u591a\u4e8e\u4e00\u4e2a\u6a21\u578b\u88ab\u7528\u5728\u540c\u4e00\u4e2a\u53d8\u79cd\uff0c\u6bcf\u4e2a\u6a21\u578b\u88ab\u9009\u4e2d\u7684\u51e0\u7387\u5c06\u4f1a\u4e3a\u6b64\u6a21\u578b\u7684weight\u503c\u9664\u4ee5\u6240\u6709\u6a21\u578bweight\u7684\u603b\u548c\u3002",
"title": "weight \u6743\u91cd",
"type": "integer"
},
"x": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ex\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "x\u65cb\u8f6c\u8f74"
},
"y": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ey\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "y\u65cb\u8f6c\u8f74"
}
},
"required": [
"model"
],
"type": "object"
},
"modelprops": {
"oneOf": [
{
"$ref": "#/definitions/model",
"description": "\u952e\u540d\u4e3a\u7531\u9017\u53f7\u5206\u9694\u7684\u65b9\u5757\u72b6\u6001\uff08facing=east,half=lower\uff09"
},
{
"description": "\u952e\u540d\u4e3a\u7531\u9017\u53f7\u5206\u9694\u7684\u65b9\u5757\u72b6\u6001\uff08facing=east,half=lower\uff09\u3002\u4f7f\u7528\u4e0d\u540c\u7684\u6807\u7b7e\u6307\u5b9a\u4e0d\u540c\u6a21\u578b\uff0c\u6e38\u620f\u6e32\u67d3\u65f6\u5c06\u4f1a\u5728\u5217\u8868\u5185\u968f\u673a\u9009\u62e9\u4e00\u4e2a\u6a21\u578b",
"items": {
"$ref": "#/definitions/model+weight"
},
"type": "array"
}
]
}
},
"oneOf": [
{
"properties": {
"variants": {
"additionalProperties": {
"$ref": "#/definitions/modelprops"
},
"description": "\u8bbe\u7f6e\u4e0d\u540c\u72b6\u6001\u5bf9\u5e94\u7684\u6a21\u578b",
"title": "variants \u7a77\u4e3e",
"type": "object"
}
},
"required": [
"variants"
]
},
{
"properties": {
"multipart": {
"description": "\u4ee3\u66ffvariants\uff0c\u57fa\u4e8e\u65b9\u5757\u72b6\u6001\u5c5e\u6027\u4ee5\u6765\u7ec4\u5408\u6a21\u578b",
"items": {
"additionalProperties": false,
"properties": {
"apply": {
"$ref": "#/definitions/modelprops",
"description": "\u6307\u5b9a\u4f7f\u7528\u7684\u6a21\u578b\u53ca\u5176\u5c5e\u6027\u3002\u53ef\u4ee5\u62e5\u6709\u5355\u4e2a\u6a21\u578b\u6216\u8005\u6a21\u578b\u7684\u5217\u8868\u3002\u5982\u679c\u4f7f\u7528\u5217\u8868\uff0c\u5217\u8868\u5185\u4f7f\u7528\u4e0d\u540c\u7684\u6807\u7b7e\u6307\u5b9a\u4e0d\u540c\u6a21\u578b\uff0c\u6e38\u620f\u6e32\u67d3\u65f6\u5c06\u4f1a\u5728\u5217\u8868\u5185\u968f\u673a\u9009\u62e9\u4e00\u4e2a\u6a21\u578b"
},
"when": {
"additionalProperties": {
"description": "\u65b9\u5757\u72b6\u6001\u540d\u79f0\u3002\u53ea\u80fd\u89c4\u5b9a\u4e00\u4e2a\u65b9\u5757\u72b6\u6001\u3002\u4f46\u65b9\u5757\u72b6\u6001\u53ef\u4ee5\u6709\u591a\u4e2a\u503c\uff0c\u7531|\u6765\u5206\u9694\uff0c\u4f7f\u5f97\u4e0d\u540c\u72b6\u6001\u5747\u53ef\u4ee5\u5339\u914d\u3002\u4e0d\u80fd\u548cOR\u6807\u7b7e\u540c\u65f6\u51fa\u73b0",
"type": "string"
},
"description": "\u5217\u51fa\u8be5\u4f7f\u7528\u6a21\u578b\u7684\u5fc5\u987b\u6ee1\u8db3\u7684\u60c5\u51b5\u3002\u5f53\u672a\u8bbe\u7f6e\u65f6\uff0c\u603b\u662f\u4f7f\u7528\u8be5\u6a21\u578b",
"properties": {
"OR": {
"description": "\u5982\u679c\u8be5\u6807\u7b7e\u5305\u542b\u7684\u4efb\u610f\u4e00\u4e2a\u6761\u4ef6\u8fd4\u56de\u4e3atrue\u65f6\u5339\u914d\u3002\u4e0d\u80fd\u540c\u65f6\u8bbe\u5b9a\u5176\u4ed6\u5355\u72ec\u7684\u60c5\u51b5",
"items": {
"description": "\u65b9\u5757\u72b6\u6001\u3002\u4e00\u4e2a\u952e\u503c\u5bf9\u53ea\u80fd\u89c4\u5b9a\u4e00\u4e2a\u65b9\u5757\u72b6\u6001\u3002\u4f46\u65b9\u5757\u72b6\u6001\u53ef\u4ee5\u6709\u591a\u4e2a\u503c\uff0c\u7531|\u6765\u5206\u9694\uff0c\u4f7f\u5f97\u4e0d\u540c\u72b6\u6001\u5747\u53ef\u4ee5\u5339\u914d",
"maxProperties": 1,
"minProperties": 1,
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"required": [
"apply"
],
"type": "object"
},
"title": "multipart \u7ec4\u88c5",
"type": "array"
}
},
"required": [
"multipart"
]
}
],
"type": "object"
} | MIT | zh |
hans000/minecraft-assets-helper | 98307c632a0e8cb22ddb3b9730c998b427ff67a2 | 2021-01-03T07:44:24 | assets/linters/models-item.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$id": "https://raw.githubusercontent.com/haima16/texture-json/master/src/models-item.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"display": {
"$ref": "./models-block.json#/definitions/positionProps",
"title": "display \u663e\u793a"
},
"elements": {
"description": "\u5217\u51fa\u6a21\u578b\u7684\u6240\u6709\u5143\u7d20,\u8fd9\u4e9b\u5143\u7d20\u53ea\u80fd\u4e3a\u957f\u65b9\u4f53\u5f62\u6001\u3002\u5982\u679c\u540c\u65f6\u8bbe\u7f6e\u4e86parent\u548celements\uff0c\u6b64\u6a21\u578b\u7684elements\u6807\u7b7e\u5c06\u8986\u76d6\u7236\u7c7b\u6a21\u578bparent\u4e0b\u7684elements\u6807\u7b7e",
"items": {
"$ref": "./models-block.json#/definitions/element"
},
"minimum": 1,
"title": "elements \u5143\u7d20",
"type": "array"
},
"gui_light": {
"description": "\u4ec5\u5728gui\u4e2d\u4f7f\u7528\u3002\u53ef\u4ee5\u662ffront\u6216side\u3002\u8bbe\u4e3aside\uff0c\u6a21\u578b\u4f1a\u88ab\u6e32\u67d3\u4e3a\u957f\u65b9\u4f53\u5f62\u72b6\u3002\u8bbe\u4e3afront\uff0c\u6a21\u578b\u4f1a\u4ee5\u5e73\u9762\u6750\u8d28\u586b\u6ee1\u4e00\u6574\u683c",
"enum": [
"side",
"front"
],
"title": "gui_light",
"type": "string"
},
"overrides": {
"description": "\u6307\u5b9a\u57fa\u4e8e\u7269\u54c1\u60c5\u51b5\u6807\u7b7e\u800c\u8986\u5199\u4e0d\u540c\u6a21\u578b\u7684\u60c5\u51b5\u3002\u6240\u6709\u60c5\u51b5\u90fd\u6309\u4ece\u4e0a\u5230\u4e0b\u7684\u987a\u5e8f\u8fdb\u884c\u68c0\u6d4b\uff0c\u76f4\u5230\u6709\u5b8c\u5168\u5339\u914d\u7684\u8c13\u8bcd\u3002\u4f46\u662f\uff0c\u5982\u679c\u5df2\u7ecf\u88ab\u8986\u5199\u8fc7\u4e00\u6b21\uff0c\u5219\u4f1a\u5ffd\u7565\u8986\u5199\uff0c\u8fd9\u53ef\u4ee5\u907f\u514d\u5728\u8986\u5199\u5230\u540c\u4e00\u6a21\u578b\u65f6\u51fa\u73b0\u9012\u5f52",
"items": {
"additionalProperties": false,
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"model": {
"description": "\u5f53\u7b26\u5408\u60c5\u51b5\u65f6\u4f7f\u7528\u7684\u6a21\u578b\u6587\u4ef6\u7684\u8def\u5f84\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID",
"title": "model \u6a21\u578b",
"type": "string"
},
"predicate": {
"description": "\u6307\u5b9a\u60c5\u51b5",
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"angle": {
"description": "\u5224\u65ad\u6307\u5357\u9488\u7684\u89d2\u5ea6\uff0c\u4ee5\u5341\u8fdb\u5236\u5c0f\u4e8e1\u7684\u6570\u503c\u8868\u8fbe",
"title": "angle \u89d2\u5ea6",
"type": "number"
},
"blocking": {
"description": "\u5224\u65ad\u76fe\u724c\u662f\u5426\u4e3a\u683c\u6321\u72b6\u6001\u3002\u683c\u6321\u65f6\u4e3a1",
"enum": [
0,
1
],
"title": "blocking \u683c\u6321",
"type": "number"
},
"broken": {
"description": "\u5224\u65ad\u9798\u7fc5\u662f\u5426\u7834\u635f\u3002\u7834\u635f\u65f6\u4e3a1",
"enum": [
0,
1
],
"title": "blocking \u7834\u635f",
"type": "number"
},
"cast": {
"description": "\u5224\u65ad\u9493\u9c7c\u7aff\u662f\u5426\u5df2\u629b\u51fa\u3002\u5df2\u629b\u51fa\u65f6\u4e3a1",
"enum": [
0,
1
],
"title": "cast \u629b\u63b7",
"type": "number"
},
"cooldown": {
"description": "\u5224\u65ad\u672b\u5f71\u73cd\u73e0/\u7d2b\u9882\u679c\u7684\u5269\u4f59\u51b7\u5374\u65f6\u95f4\uff0c\u4ee5\u5341\u8fdb\u5236\u30010\u52301\u4e4b\u95f4\u7684\u6570\u503c\u8868\u8fbe",
"maximum": 1,
"minimum": 0,
"title": "cooldown \u51b7\u5374",
"type": "number"
},
"custom_model_data": {
"description": "\u7528\u4e8e\u4f7f\u7528\u81ea\u5b9a\u4e49\u6a21\u578b\u7684\u7269\u54c1\uff0c\u7528\u6574\u6570\u8868\u8fbe",
"title": "custom_model_data \u81ea\u5b9a\u4e49\u6a21\u578b",
"type": "integer"
},
"damage": {
"description": "\u5224\u65ad\u62e5\u6709\u8010\u4e45\u503c\u7684\u7269\u54c1\u7684\u5df2\u53d7\u635f\u7a0b\u5ea6\uff0c\u4ee5\u5341\u8fdb\u5236\u30010\u52301\u4e4b\u95f4\u7684\u6570\u503c\u8868\u8fbe",
"maximum": 1,
"minimum": 0,
"title": "damage \u635f\u4f24\u503c",
"type": "number"
},
"damaged": {
"description": "\u5224\u65ad\u62e5\u6709\u8010\u4e45\u503c\u7684\u7269\u54c1\u662f\u5426\u4e3a\u5df2\u53d7\u635f\u72b6\u6001\u3002\u5df2\u53d7\u635f\u65f6\u4e3a1\u3002\u82e5\u7269\u54c1\u62e5\u6709Unbreakable\u6807\u7b7e\u65f6\uff0c\u6b64\u6570\u503c\u4e3a0\uff0c\u4e14damage\u6807\u7b7e\u7684\u6570\u503c\u53ef\u4ee5\u4e0d\u4e3a0",
"maximum": 1,
"minimum": 0,
"title": "damage \u53d7\u635f",
"type": "number"
},
"lefthanded": {
"description": "\u6307\u5b9a\u88ab\u5de6\u624b\u73a9\u5bb6\u4f7f\u7528\u7684\u6a21\u578b\uff0c\u4f1a\u5f71\u54cd\u5176\u5728\u7269\u54c1\u680f\u7684\u663e\u793a\u6837\u5f0f\uff0c\u4ee5\u53ca\u73a9\u5bb6\u62ff\u8d77\u6216\u7a7f\u5728\u8eab\u4e0a\u65f6\u7684\u89c6\u89c9\u6837\u5f0f",
"title": "lefthanded",
"type": "string"
},
"pull": {
"description": "\u5224\u65ad\u5f13\u88ab\u62c9\u4f38\u7684\u7a0b\u5ea6\uff0c\u4ee5\u5341\u8fdb\u5236\uff0c0\u52301\u4e4b\u95f4\u7684\u6570\u503c\u8868\u8fbe\u3002\u6ca1\u88ab\u62c9\u4f38\u65f6\u4e3a0\uff0c\u88ab\u5b8c\u5168\u62c9\u4f38\u65f6\u4e3a1",
"maximum": 1,
"minimum": 0,
"title": "pull \u62c9\u4f38",
"type": "number"
},
"pulling": {
"description": "\u5224\u65ad\u5f13\u662f\u5426\u88ab\u62c9\u4f38\u3002\u88ab\u62c9\u4f38\u65f6\u4e3a1",
"enum": [
0,
1
],
"title": "pull \u62c9\u4f38\u72b6\u6001",
"type": "number"
},
"throwing": {
"description": "\u7528\u4e8e\u4e09\u53c9\u621f\u4ee5\u5224\u65ad\u4e09\u53c9\u621f\u662f\u5426\u5373\u5c06\u88ab\u73a9\u5bb6\u6254\u51fa\u3002\u5982\u679c\u4e3a1\uff0c\u5219\u4e09\u53c9\u621f\u51c6\u5907\u6254\u51fa",
"enum": [
0,
1
],
"title": "throwing \u6295\u63b7\u72b6\u6001",
"type": "number"
},
"time": {
"description": "\u5224\u65ad\u65f6\u949f\u7684\u65f6\u95f4\uff0c\u4ee5\u5341\u8fdb\u5236\uff0c0\u52301\u4e4b\u95f4\u7684\u6570\u503c\u8868\u8fbe",
"maximum": 1,
"minimum": 0,
"title": "time \u65f6\u95f4",
"type": "number"
}
},
"title": "predicate \u65ad\u8a00",
"type": "object"
}
},
"required": [
"predicate",
"model"
],
"type": "object"
},
"minimum": 1,
"title": "overrides",
"type": "array"
},
"parent": {
"description": "\u7ee7\u627f\u5176\u4ed6\u6a21\u578b\u6587\u4ef6\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID\u3002\u5982\u679c\u540c\u65f6\u8bbe\u7f6e\u4e86parent\u548celements\uff0c\u90a3\u4e48\u6b64\u6a21\u578b\u7684elements\u6807\u7b7e\u5c06\u8986\u76d6\u7236\u7c7b\u6a21\u578bparent\u4e0b\u7684elements\u6807\u7b7e",
"title": "parent \u7236\u7ea7",
"type": "string"
},
"textures": {
"additionalProperties": {
"description": "\u5b9a\u4e49\u4e00\u4e2a\u6750\u8d28\u53d8\u91cf\u5e76\u5206\u914d\u6750\u8d28",
"type": "string"
},
"description": "\u5b9a\u4e49\u65b9\u5757\u9897\u7c92\u7684\u6750\u8d28\u4ee5\u53ca\u6a21\u578b\u6240\u4f7f\u7528\u7684\u6750\u8d28\u53d8\u91cf\u3002\u952e\u503c\u53ef\u4ee5\u4e3a\u6750\u8d28\u6587\u4ef6\u7684\u8def\u5f84\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID\uff0c\u4e5f\u53ef\u4ee5\u4e3a\u53e6\u4e00\u4e2a\u6750\u8d28\u53d8\u91cf",
"patternProperties": {
"^layer[0-9]{1,}$": {
"description": "\u4ec5\u7528\u4e8e\u6307\u5b9a\u5728\u7269\u54c1\u680f\u5185\u4f7f\u7528\u7684\u7269\u54c1\u7684\u56fe\u6807\u3002\u5141\u8bb8\u6709\u8d85\u8fc7\u4e00\u5c42\uff08\u6bd4\u5982\u5237\u602a\u86cb\uff09\uff0c\u4f46\u662f\u6bcf\u4e2a\u7269\u54c1\u53ef\u80fd\u7684\u5c42\u6570\u90fd\u662f\u786c\u7f16\u7801\u7684\u3002\u5fc5\u987b\u7ed3\u5408builtin/generated\u7528",
"type": "string"
}
},
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"particle": {
"description": "\u65b9\u5757\u5bf9\u5e94\u7684\u9897\u7c92\u7684\u6750\u8d28\u3002\u73a9\u5bb6\u5728\u4e0b\u754c\u4f20\u9001\u95e8\u4e2d\u65f6\u4e5f\u4f1a\u4f7f\u7528\u6b64\u6750\u8d28\u3002\u6ce8\u610f\uff1a\u6240\u6709\u975e\u6a21\u578b\u6e32\u67d3\u7684\u65b9\u5757\u7684\u7834\u574f\u53ef\u4ee5\u4e3a\u786c\u7f16\u7801",
"title": "particle \u7c92\u5b50",
"type": "string"
}
},
"title": "textures \u7eb9\u7406",
"type": "object"
}
},
"type": "object"
} | MIT | zh |
hans000/minecraft-assets-helper | b71c759de20559824b490b412fd1f48ad15d9d89 | 2023-01-27T12:28:04 | assets/linters/animation.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"defaultSnippets": [
{
"body": {
"animation": {
"frames": [],
"frametime": 2
}
},
"label": "\u5feb\u901f\u751f\u6210animation mcmeta",
"prefix": "init"
}
],
"description": "\u52a8\u6001\u6750\u8d28\u7684\u914d\u7f6e\u4fe1\u606f",
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"animation": {
"description": "\u52a8\u6001\u7eb9\u7406\u7684\u6570\u636e\u7684\u6807\u7b7e",
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"frames": {
"description": "\u4e00\u4e2a\u5e27\u5217\u8868\n\u5e27\u7684\u663e\u793a\u987a\u5e8f\u9ed8\u8ba4\u4e3a\u4ece\u4e0a\u81f3\u4e0b",
"items": {
"oneOf": [
{
"description": "\u6307\u5b9a\u5f00\u59cb\u64ad\u653e\u7684\u5e27\u7684\u4f4d\u7f6e\uff0c\u6700\u4e0a\u9762\u7684\u4e00\u5e27\u4e3a 0",
"type": "integer"
},
{
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"index": {
"description": "\u6307\u5b9a\u5f00\u59cb\u64ad\u653e\u7684\u5e27\u7684\u4f4d\u7f6e\uff0c\u6700\u4e0a\u9762\u7684\u4e00\u5e27\u4e3a0",
"type": "integer"
},
"time": {
"description": "\u8fd9\u4e00\u5e27\u7684\u663e\u793a\u65f6\u95f4\uff08\u5355\u4f4d\uff1a\u523b\uff09\uff0c\u8986\u76d6\u7684\u201cframetime\u201d",
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array"
},
"frametime": {
"description": "\u8bbe\u7f6e\u5728\u6bcf\u4e2a\u6e38\u620f\u523b\u5185\u6bcf\u4e00\u5e27\u7684\u65f6\u95f4\u589e\u91cf\u3002\u9ed8\u8ba4\u4e3a1",
"type": "integer"
},
"height": {
"description": "\u65b9\u5757\u7684\u9ad8\u5ea6\n\u4ee5\u76f4\u63a5\u6bd4\u4f8b\u800c\u4e0d\u662f\u50cf\u7d20\u4e3a\u5355\u4f4d\u3002\u8fd9\u5728\u539f\u7248\u4e2d\u6ca1\u6709\u4f7f\u7528\uff0c\u4f46\u662f\u53ef\u4ee5\u88abmod\u4f7f\u7528\u4ee5\u5177\u6709\u4e0d\u662f\u5b8c\u6574\u6b63\u65b9\u5f62\u7684\u5e27",
"type": "integer"
},
"interpolate": {
"description": "\u82e5\u4e3a true\uff0cMinecraft \u5c06\u4f1a\u5728\u5e27\u4e0e\u5e27\u4e4b\u95f4\u751f\u6210\u4e00\u5f20\u95f4\u9694\u65f6\u95f4\u5927\u4e8e1\u7684\u5e27\uff0c\u9ed8\u8ba4\u4e3afalse",
"type": "boolean"
},
"width": {
"description": "\u65b9\u5757\u7684\u5bbd\u5ea6\n\u4ee5\u76f4\u63a5\u6bd4\u4f8b\u800c\u4e0d\u662f\u50cf\u7d20\u4e3a\u5355\u4f4d\u3002\u8fd9\u5728\u539f\u7248\u4e2d\u6ca1\u6709\u4f7f\u7528\uff0c\u4f46\u662f\u53ef\u4ee5\u88abmod\u4f7f\u7528\u4ee5\u5177\u6709\u4e0d\u662f\u5b8c\u6574\u6b63\u65b9\u5f62\u7684\u5e27",
"type": "integer"
}
},
"title": "\u52a8\u753b",
"type": "object"
}
},
"type": "object"
} | MIT | zh |
hans000/minecraft-assets-helper | 9f943ead4c26960ab88a40a3a41a1f85a2a9c146 | 2023-01-03T03:30:58 | assets/linters/animation.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"defaultSnippets": [
{
"body": {
"animation": {
"frames": [],
"frametime": 2
}
},
"label": "\u5feb\u901f\u751f\u6210animation mcmeta",
"prefix": "init"
}
],
"description": "\u52a8\u6001\u6750\u8d28\u7684\u914d\u7f6e\u4fe1\u606f",
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"animation": {
"description": "\u52a8\u6001\u7eb9\u7406\u7684\u6570\u636e\u7684\u6807\u7b7e",
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"frames": {
"description": "\u4e00\u4e2a\u5e27\u5217\u8868\n\u5e27\u7684\u663e\u793a\u987a\u5e8f\u9ed8\u8ba4\u4e3a\u4ece\u4e0a\u81f3\u4e0b",
"oneOf": [
{
"description": "\u6307\u5b9a\u5f00\u59cb\u64ad\u653e\u7684\u5e27\u7684\u4f4d\u7f6e\uff0c\u6700\u4e0a\u9762\u7684\u4e00\u5e27\u4e3a 0",
"type": "integer"
},
{
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"index": {
"description": "\u6307\u5b9a\u5f00\u59cb\u64ad\u653e\u7684\u5e27\u7684\u4f4d\u7f6e\uff0c\u6700\u4e0a\u9762\u7684\u4e00\u5e27\u4e3a0",
"type": "integer"
},
"time": {
"description": "\u8fd9\u4e00\u5e27\u7684\u663e\u793a\u65f6\u95f4\uff08\u5355\u4f4d\uff1a\u523b\uff09\uff0c\u8986\u76d6\u7684\u201cframetime\u201d",
"type": "integer"
}
},
"type": "object"
}
],
"type": "array"
},
"frametime": {
"description": "\u8bbe\u7f6e\u5728\u6bcf\u4e2a\u6e38\u620f\u523b\u5185\u6bcf\u4e00\u5e27\u7684\u65f6\u95f4\u589e\u91cf\u3002\u9ed8\u8ba4\u4e3a1",
"type": "integer"
},
"height": {
"description": "\u65b9\u5757\u7684\u9ad8\u5ea6\n\u4ee5\u76f4\u63a5\u6bd4\u4f8b\u800c\u4e0d\u662f\u50cf\u7d20\u4e3a\u5355\u4f4d\u3002\u8fd9\u5728\u539f\u7248\u4e2d\u6ca1\u6709\u4f7f\u7528\uff0c\u4f46\u662f\u53ef\u4ee5\u88abmod\u4f7f\u7528\u4ee5\u5177\u6709\u4e0d\u662f\u5b8c\u6574\u6b63\u65b9\u5f62\u7684\u5e27",
"type": "integer"
},
"interpolate": {
"description": "\u82e5\u4e3a true\uff0cMinecraft \u5c06\u4f1a\u5728\u5e27\u4e0e\u5e27\u4e4b\u95f4\u751f\u6210\u4e00\u5f20\u95f4\u9694\u65f6\u95f4\u5927\u4e8e1\u7684\u5e27\uff0c\u9ed8\u8ba4\u4e3afalse",
"type": "boolean"
},
"width": {
"description": "\u65b9\u5757\u7684\u5bbd\u5ea6\n\u4ee5\u76f4\u63a5\u6bd4\u4f8b\u800c\u4e0d\u662f\u50cf\u7d20\u4e3a\u5355\u4f4d\u3002\u8fd9\u5728\u539f\u7248\u4e2d\u6ca1\u6709\u4f7f\u7528\uff0c\u4f46\u662f\u53ef\u4ee5\u88abmod\u4f7f\u7528\u4ee5\u5177\u6709\u4e0d\u662f\u5b8c\u6574\u6b63\u65b9\u5f62\u7684\u5e27",
"type": "integer"
}
},
"title": "\u52a8\u753b",
"type": "object"
}
},
"type": "object"
} | MIT | zh |
hans000/minecraft-assets-helper | 9f943ead4c26960ab88a40a3a41a1f85a2a9c146 | 2023-01-03T03:30:58 | assets/linters/shared/text_component.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$ref": "#/definitions/text_component",
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"text_component": {
"oneOf": [
{
"title": "Equivalent to {\"text\":\"Value\"}",
"type": [
"boolean",
"string",
"number"
]
},
{
"$ref": "#/definitions/text_object"
},
{
"items": {
"$ref": "#/definitions/text_component"
},
"title": "Equivalent to firstItem with \"extra\": [nextItems]",
"type": "array"
}
]
},
"text_object": {
"oneOf": [
{
"not": {
"required": [
"translate",
"with",
"score",
"selector",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"text": {
"title": "The direct text to apply",
"type": "string"
}
},
"required": [
"text"
]
},
{
"not": {
"required": [
"text",
"score",
"selector",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"translate": {
"parser": "TranslateKey",
"title": "The translation string to translate",
"type": "string"
},
"with": {
"description": "Extra items to apply in place of %s and %{x}$s in the translation string. These items inherit from the base component in styling, such as text colour and italics",
"items": {
"$ref": "#/definitions/text_component"
},
"title": "Replacements",
"type": "array"
}
},
"required": [
"translate"
]
},
{
"not": {
"required": [
"text",
"translate",
"with",
"selector",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"score": {
"properties": {
"name": {
"params": {
"amount": "single",
"isScoreHolder": true,
"type": "entities"
},
"parser": "Entity",
"title": "Entity selector whose score to show",
"type": "string"
},
"objective": {
"parser": "Objective",
"title": "Objective to show score from",
"type": "string"
},
"value": {
"description": "Will be converted to a string if needed",
"title": "A default when score not found",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"name",
"objective"
],
"title": "A score to display",
"type": "object"
}
},
"required": [
"score"
]
},
{
"not": {
"required": [
"text",
"translate",
"with",
"score",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"selector": {
"description": "If there are multiple, they will be comma seperated until the last value with an 'and'",
"params": {
"amount": "multiple",
"type": "entities"
},
"parser": "Entity",
"title": "An entity to mention",
"type": "string"
}
},
"required": [
"selector"
]
},
{
"not": {
"required": [
"text",
"translate",
"with",
"score",
"selector",
"nbt",
"interpret"
]
},
"properties": {
"keybind": {
"enum": [
"key.attack",
"key.use",
"key.forward",
"key.left",
"key.back",
"key.right",
"key.jump",
"key.sneak",
"key.sprint",
"key.drop",
"key.inventory",
"key.chat",
"key.playerlist",
"key.pickItem",
"key.command",
"key.screenshot",
"key.togglePerspective",
"key.smoothCamera",
"key.fullscreen",
"key.spectatorOutlines",
"key.swapHands",
"key.saveToolbarActivator",
"key.loadToolbarActivator",
"key.advancements",
"key.hotbar.1",
"key.hotbar.2",
"key.hotbar.3",
"key.hotbar.4",
"key.hotbar.5",
"key.hotbar.6",
"key.hotbar.7",
"key.hotbar.8",
"key.hotbar.9"
],
"title": "The name of the keybind to show",
"type": "string"
}
},
"required": [
"keybind"
]
},
{
"not": {
"required": [
"score",
"selector",
"text",
"translate",
"with"
]
},
"oneOf": [
{
"not": {
"required": [
"entity",
"storage"
]
},
"properties": {
"block": {
"params": {
"dimension": 3
},
"parser": "Vector",
"title": "The coordinates of the block which uses the same format as /setblock",
"type": "string"
}
},
"required": [
"block"
]
},
{
"not": {
"required": [
"block",
"storage"
]
},
"properties": {
"entity": {
"params": {
"amount": "single",
"type": "entities"
},
"parser": "Entity",
"title": "The target selector",
"type": "string"
}
},
"required": [
"entity"
]
},
{
"not": {
"required": [
"block",
"entity"
]
},
"properties": {
"storage": {
"params": {
"registry": "$storages"
},
"parser": "Identity",
"title": "The namespaced ID of the storage",
"type": "string"
}
},
"required": [
"storage"
]
}
],
"properties": {
"interpret": {
"title": "Whether contents of selected tags should be interpreted as chat components",
"type": "boolean"
},
"nbt": {
"parser": "NbtPath",
"title": "The NBT Path",
"type": "string"
}
},
"required": [
"nbt"
]
}
],
"properties": {
"block": {},
"bold": {
"title": "Whether to have the text bold",
"type": "boolean"
},
"clickEvent": {
"description": "Action to perform when this text is left clicked on",
"oneOf": [
{
"properties": {
"action": {
"description": "Opens the web address in value",
"enum": [
"open_url"
]
},
"value": {
"title": "The URL of the web page",
"type": "string"
}
}
},
{
"properties": {
"action": {
"description": "Runs the command in value",
"enum": [
"run_command"
]
},
"value": {
"params": {
"leadingSlash": true
},
"parser": "Command",
"title": "The command to run",
"type": "string"
}
}
},
{
"properties": {
"action": {
"description": "Changes the book page",
"enum": [
"change_page"
]
},
"value": {
"title": "The page number",
"type": "string"
}
}
},
{
"properties": {
"action": {
"description": "Replaces the player's chat window with value",
"enum": [
"suggest_command"
]
},
"value": {
"params": {
"leadingSlash": true
},
"parser": "Command",
"title": "The command to suggest",
"type": "string"
}
}
}
],
"properties": {
"action": {},
"value": {}
},
"required": [
"action",
"value"
],
"title": "Action on click",
"type": "object"
},
"color": {
"oneOf": [
{
"enum": [
"black",
"dark_blue",
"dark_green",
"dark_aqua",
"dark_red",
"dark_purple",
"gold",
"gray",
"dark_gray",
"blue",
"green",
"aqua",
"red",
"light_purple",
"yellow",
"white",
"reset"
]
},
{
"pattern": "#[0-9a-f]{1,6}",
"type": "string"
}
],
"title": "The colour of the text"
},
"entity": {},
"extra": {
"$ref": "#/definitions/text_component",
"description": "These items inherit from the base component in styling, such as text colour and italics",
"title": "Additional items to add",
"type": "array"
},
"hoverEvent": {
"description": "What to show upon a hover",
"oneOf": [
{
"properties": {
"action": {
"enum": [
"show_text"
]
},
"contents": {
"$ref": "#/definitions/text_component"
},
"value": {
"$ref": "#/definitions/text_component"
}
}
},
{
"properties": {
"action": {
"enum": [
"show_entity"
]
},
"contents": {
"properties": {
"id": {
"parser": "Uuid",
"type": "string"
},
"name": {
"$ref": "#/definitions/text_component"
},
"type": {
"params": {
"registry": "minecraft:entity_type"
},
"parser": "Identity",
"type": "string"
}
},
"type": "object"
},
"value": {
"params": {
"category": "minecraft:entity",
"id": "spgoding:i-am-guaranteed-not-to-exist",
"type": "Compound"
},
"parser": "Nbt",
"type": "string"
}
}
},
{
"properties": {
"action": {
"enum": [
"show_item"
]
},
"contents": {
"properties": {
"count": {
"maximum": 64,
"minimum": 1,
"type": "number"
},
"id": {
"params": {
"registry": "minecraft:item"
},
"parser": "Identity",
"type": "string"
},
"tag": {
"params": {
"category": "minecraft:item",
"id": [
{
"Child": "id"
}
],
"type": "Compound"
},
"parser": "Nbt",
"type": "string"
}
},
"type": "object"
},
"value": {
"params": {
"category": "minecraft:item",
"id": "spgoding:i-am-guaranteed-not-to-exist",
"type": "Compound"
},
"parser": "Nbt",
"type": "string"
}
}
}
],
"properties": {
"action": {},
"contents": {},
"value": {}
},
"required": [
"action"
],
"type": "object"
},
"insertion": {
"description": "When the player SHIFT-clicks on a section of text, what to add to their chat window",
"title": "Insertion text",
"type": "string"
},
"interpret": {},
"italic": {
"title": "Whether to have the text in italics",
"type": "boolean"
},
"keybind": {},
"nbt": {},
"obfuscated": {
"description": "This makes the text cycle through characters with the same width",
"title": "Whether to have the text obfuscated",
"type": "boolean"
},
"score": {},
"selector": {},
"storage": {},
"strikethrough": {
"title": "Whether to have the text strikethroughed",
"type": "boolean"
},
"text": {},
"translate": {},
"underlined": {
"title": "Whether to have the text underlined",
"type": "boolean"
},
"with": {}
},
"type": "object"
}
}
} | MIT | zh |
hans000/minecraft-assets-helper | 9f943ead4c26960ab88a40a3a41a1f85a2a9c146 | 2023-01-03T03:30:58 | assets/linters/blockstates.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"degree": {
"enum": [
0,
90,
180,
270
],
"type": "number"
},
"face": {
"enum": [
"east",
"south",
"west",
"north",
"side"
],
"type": "string"
},
"model": {
"minItems": 1,
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"model": {
"description": "\u6307\u5b9a\u6a21\u578b\u6587\u4ef6\u7684\u8def\u5f84\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID",
"title": "model \u6a21\u578b",
"type": "string"
},
"uvlock": {
"description": "\u53ef\u4e3atrue\u6216false\uff08\u9ed8\u8ba4\uff09\u3002\u8bbe\u7f6e\u4e3atrue\u5c06\u9501\u5b9a\u65b9\u5757\u6750\u8d28\u7684\u65cb\u8f6c\u65b9\u5411\u3002\u8fd9\u6837\u5728\u4f7f\u7528\u4e0a\u9762\u7684 x\u548c y\u6807\u7b7e\u65f6\u6750\u8d28\u5c06\u4e0d\u4f1a\u8ddf\u7740\u65b9\u5757\u4e00\u8d77\u65cb\u8f6c\u3002",
"title": "uvlock\u8d34\u56fe\u9501\u5b9a",
"type": "boolean"
},
"x": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ex\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "x\u65cb\u8f6c\u8f74"
},
"y": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ey\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "y\u65cb\u8f6c\u8f74"
}
},
"required": [
"model"
],
"type": "object"
},
"model+weight": {
"minItems": 1,
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"model": {
"description": "\u6307\u5b9a\u6a21\u578b\u6587\u4ef6\u7684\u8def\u5f84\uff0c\u683c\u5f0f\u4e3a\u547d\u540d\u7a7a\u95f4ID",
"title": "model \u6a21\u578b",
"type": "string"
},
"uvlock": {
"description": "\u53ef\u4e3atrue\u6216false\uff08\u9ed8\u8ba4\uff09\u3002\u8bbe\u7f6e\u4e3atrue\u5c06\u9501\u5b9a\u65b9\u5757\u6750\u8d28\u7684\u65cb\u8f6c\u65b9\u5411\u3002\u8fd9\u6837\u5728\u4f7f\u7528\u4e0a\u9762\u7684 x\u548c y\u6807\u7b7e\u65f6\u6750\u8d28\u5c06\u4e0d\u4f1a\u8ddf\u7740\u65b9\u5757\u4e00\u8d77\u65cb\u8f6c\u3002",
"title": "uvlock \u8d34\u56fe\u9501\u5b9a",
"type": "boolean"
},
"weight": {
"default": 1,
"description": "\u8bbe\u7f6e\u6a21\u578b\u5728\u6e38\u620f\u4e2d\u88ab\u9009\u7528\u7684\u51e0\u7387\uff0c\u9ed8\u8ba4\u4e3a1\uff08100%\uff09\u3002\u5982\u679c\u591a\u4e8e\u4e00\u4e2a\u6a21\u578b\u88ab\u7528\u5728\u540c\u4e00\u4e2a\u53d8\u79cd\uff0c\u6bcf\u4e2a\u6a21\u578b\u88ab\u9009\u4e2d\u7684\u51e0\u7387\u5c06\u4f1a\u4e3a\u6b64\u6a21\u578b\u7684weight\u503c\u9664\u4ee5\u6240\u6709\u6a21\u578bweight\u7684\u603b\u548c\u3002",
"title": "weight \u6743\u91cd",
"type": "integer"
},
"x": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ex\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "x\u65cb\u8f6c\u8f74"
},
"y": {
"$ref": "#/definitions/degree",
"description": "\u6a21\u578b\u76f8\u5bf9\u4e8ey\u8f74\u7684\u65cb\u8f6c\uff0c\u589e\u91cf90\u5ea6\u3002",
"title": "y\u65cb\u8f6c\u8f74"
}
},
"required": [
"model"
],
"type": "object"
},
"modelprops": {
"oneOf": [
{
"$ref": "#/definitions/model",
"description": "\u952e\u540d\u4e3a\u7531\u9017\u53f7\u5206\u9694\u7684\u65b9\u5757\u72b6\u6001\uff08facing=east,half=lower\uff09"
},
{
"description": "\u952e\u540d\u4e3a\u7531\u9017\u53f7\u5206\u9694\u7684\u65b9\u5757\u72b6\u6001\uff08facing=east,half=lower\uff09\u3002\u4f7f\u7528\u4e0d\u540c\u7684\u6807\u7b7e\u6307\u5b9a\u4e0d\u540c\u6a21\u578b\uff0c\u6e38\u620f\u6e32\u67d3\u65f6\u5c06\u4f1a\u5728\u5217\u8868\u5185\u968f\u673a\u9009\u62e9\u4e00\u4e2a\u6a21\u578b",
"items": {
"$ref": "#/definitions/model+weight"
},
"type": "array"
}
]
}
},
"oneOf": [
{
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"variants": {
"additionalProperties": {
"$ref": "#/definitions/modelprops"
},
"description": "\u8bbe\u7f6e\u4e0d\u540c\u72b6\u6001\u5bf9\u5e94\u7684\u6a21\u578b",
"title": "variants \u7a77\u4e3e",
"type": "object"
}
},
"required": [
"variants"
]
},
{
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"multipart": {
"description": "\u4ee3\u66ffvariants\uff0c\u57fa\u4e8e\u65b9\u5757\u72b6\u6001\u5c5e\u6027\u4ee5\u6765\u7ec4\u5408\u6a21\u578b",
"items": {
"properties": {
"__comment": {
"description": "\u6ce8\u91ca",
"type": "string"
},
"apply": {
"$ref": "#/definitions/modelprops",
"description": "\u6307\u5b9a\u4f7f\u7528\u7684\u6a21\u578b\u53ca\u5176\u5c5e\u6027\u3002\u53ef\u4ee5\u62e5\u6709\u5355\u4e2a\u6a21\u578b\u6216\u8005\u6a21\u578b\u7684\u5217\u8868\u3002\u5982\u679c\u4f7f\u7528\u5217\u8868\uff0c\u5217\u8868\u5185\u4f7f\u7528\u4e0d\u540c\u7684\u6807\u7b7e\u6307\u5b9a\u4e0d\u540c\u6a21\u578b\uff0c\u6e38\u620f\u6e32\u67d3\u65f6\u5c06\u4f1a\u5728\u5217\u8868\u5185\u968f\u673a\u9009\u62e9\u4e00\u4e2a\u6a21\u578b"
},
"when": {
"additionalProperties": {
"description": "\u65b9\u5757\u72b6\u6001\u540d\u79f0\u3002\u53ea\u80fd\u89c4\u5b9a\u4e00\u4e2a\u65b9\u5757\u72b6\u6001\u3002\u4f46\u65b9\u5757\u72b6\u6001\u53ef\u4ee5\u6709\u591a\u4e2a\u503c\uff0c\u7531|\u6765\u5206\u9694\uff0c\u4f7f\u5f97\u4e0d\u540c\u72b6\u6001\u5747\u53ef\u4ee5\u5339\u914d\u3002\u4e0d\u80fd\u548cOR\u6807\u7b7e\u540c\u65f6\u51fa\u73b0",
"type": "string"
},
"description": "\u5217\u51fa\u8be5\u4f7f\u7528\u6a21\u578b\u7684\u5fc5\u987b\u6ee1\u8db3\u7684\u60c5\u51b5\u3002\u5f53\u672a\u8bbe\u7f6e\u65f6\uff0c\u603b\u662f\u4f7f\u7528\u8be5\u6a21\u578b",
"properties": {
"OR": {
"description": "\u5982\u679c\u8be5\u6807\u7b7e\u5305\u542b\u7684\u4efb\u610f\u4e00\u4e2a\u6761\u4ef6\u8fd4\u56de\u4e3atrue\u65f6\u5339\u914d\u3002\u4e0d\u80fd\u540c\u65f6\u8bbe\u5b9a\u5176\u4ed6\u5355\u72ec\u7684\u60c5\u51b5",
"items": {
"description": "\u65b9\u5757\u72b6\u6001\u3002\u4e00\u4e2a\u952e\u503c\u5bf9\u53ea\u80fd\u89c4\u5b9a\u4e00\u4e2a\u65b9\u5757\u72b6\u6001\u3002\u4f46\u65b9\u5757\u72b6\u6001\u53ef\u4ee5\u6709\u591a\u4e2a\u503c\uff0c\u7531|\u6765\u5206\u9694\uff0c\u4f7f\u5f97\u4e0d\u540c\u72b6\u6001\u5747\u53ef\u4ee5\u5339\u914d",
"maxProperties": 1,
"minProperties": 1,
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"required": [
"apply"
],
"type": "object"
},
"title": "multipart \u7ec4\u88c5",
"type": "array"
}
},
"required": [
"multipart"
]
}
],
"type": "object"
} | MIT | zh |
hans000/minecraft-assets-helper | 98307c632a0e8cb22ddb3b9730c998b427ff67a2 | 2021-01-03T07:44:24 | assets/linters/shared/text_component.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$id": "https://raw.githubusercontent.com/haima16/texture-json/master/src/shared/text_component.json",
"$ref": "#/definitions/text_component",
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"text_component": {
"oneOf": [
{
"title": "Equivalent to {\"text\":\"Value\"}",
"type": [
"boolean",
"string",
"number"
]
},
{
"$ref": "#/definitions/text_object"
},
{
"items": {
"$ref": "#/definitions/text_component"
},
"title": "Equivalent to firstItem with \"extra\": [nextItems]",
"type": "array"
}
]
},
"text_object": {
"additionalProperties": false,
"oneOf": [
{
"not": {
"required": [
"translate",
"with",
"score",
"selector",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"text": {
"title": "The direct text to apply",
"type": "string"
}
},
"required": [
"text"
]
},
{
"not": {
"required": [
"text",
"score",
"selector",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"translate": {
"parser": "TranslateKey",
"title": "The translation string to translate",
"type": "string"
},
"with": {
"description": "Extra items to apply in place of %s and %{x}$s in the translation string. These items inherit from the base component in styling, such as text colour and italics",
"items": {
"$ref": "#/definitions/text_component"
},
"title": "Replacements",
"type": "array"
}
},
"required": [
"translate"
]
},
{
"not": {
"required": [
"text",
"translate",
"with",
"selector",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"score": {
"additionalProperties": false,
"properties": {
"name": {
"params": {
"amount": "single",
"isScoreHolder": true,
"type": "entities"
},
"parser": "Entity",
"title": "Entity selector whose score to show",
"type": "string"
},
"objective": {
"parser": "Objective",
"title": "Objective to show score from",
"type": "string"
},
"value": {
"description": "Will be converted to a string if needed",
"title": "A default when score not found",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"name",
"objective"
],
"title": "A score to display",
"type": "object"
}
},
"required": [
"score"
]
},
{
"not": {
"required": [
"text",
"translate",
"with",
"score",
"keybind",
"nbt",
"interpret"
]
},
"properties": {
"selector": {
"description": "If there are multiple, they will be comma seperated until the last value with an 'and'",
"params": {
"amount": "multiple",
"type": "entities"
},
"parser": "Entity",
"title": "An entity to mention",
"type": "string"
}
},
"required": [
"selector"
]
},
{
"not": {
"required": [
"text",
"translate",
"with",
"score",
"selector",
"nbt",
"interpret"
]
},
"properties": {
"keybind": {
"enum": [
"key.attack",
"key.use",
"key.forward",
"key.left",
"key.back",
"key.right",
"key.jump",
"key.sneak",
"key.sprint",
"key.drop",
"key.inventory",
"key.chat",
"key.playerlist",
"key.pickItem",
"key.command",
"key.screenshot",
"key.togglePerspective",
"key.smoothCamera",
"key.fullscreen",
"key.spectatorOutlines",
"key.swapHands",
"key.saveToolbarActivator",
"key.loadToolbarActivator",
"key.advancements",
"key.hotbar.1",
"key.hotbar.2",
"key.hotbar.3",
"key.hotbar.4",
"key.hotbar.5",
"key.hotbar.6",
"key.hotbar.7",
"key.hotbar.8",
"key.hotbar.9"
],
"title": "The name of the keybind to show",
"type": "string"
}
},
"required": [
"keybind"
]
},
{
"not": {
"required": [
"score",
"selector",
"text",
"translate",
"with"
]
},
"oneOf": [
{
"not": {
"required": [
"entity",
"storage"
]
},
"properties": {
"block": {
"params": {
"dimension": 3
},
"parser": "Vector",
"title": "The coordinates of the block which uses the same format as /setblock",
"type": "string"
}
},
"required": [
"block"
]
},
{
"not": {
"required": [
"block",
"storage"
]
},
"properties": {
"entity": {
"params": {
"amount": "single",
"type": "entities"
},
"parser": "Entity",
"title": "The target selector",
"type": "string"
}
},
"required": [
"entity"
]
},
{
"not": {
"required": [
"block",
"entity"
]
},
"properties": {
"storage": {
"params": {
"registry": "$storages"
},
"parser": "Identity",
"title": "The namespaced ID of the storage",
"type": "string"
}
},
"required": [
"storage"
]
}
],
"properties": {
"interpret": {
"title": "Whether contents of selected tags should be interpreted as chat components",
"type": "boolean"
},
"nbt": {
"parser": "NbtPath",
"title": "The NBT Path",
"type": "string"
}
},
"required": [
"nbt"
]
}
],
"properties": {
"block": {},
"bold": {
"title": "Whether to have the text bold",
"type": "boolean"
},
"clickEvent": {
"additionalProperties": false,
"description": "Action to perform when this text is left clicked on",
"oneOf": [
{
"properties": {
"action": {
"description": "Opens the web address in value",
"enum": [
"open_url"
]
},
"value": {
"title": "The URL of the web page",
"type": "string"
}
}
},
{
"properties": {
"action": {
"description": "Runs the command in value",
"enum": [
"run_command"
]
},
"value": {
"params": {
"leadingSlash": true
},
"parser": "Command",
"title": "The command to run",
"type": "string"
}
}
},
{
"properties": {
"action": {
"description": "Changes the book page",
"enum": [
"change_page"
]
},
"value": {
"title": "The page number",
"type": "string"
}
}
},
{
"properties": {
"action": {
"description": "Replaces the player's chat window with value",
"enum": [
"suggest_command"
]
},
"value": {
"params": {
"leadingSlash": true
},
"parser": "Command",
"title": "The command to suggest",
"type": "string"
}
}
}
],
"properties": {
"action": {},
"value": {}
},
"required": [
"action",
"value"
],
"title": "Action on click",
"type": "object"
},
"color": {
"oneOf": [
{
"enum": [
"black",
"dark_blue",
"dark_green",
"dark_aqua",
"dark_red",
"dark_purple",
"gold",
"gray",
"dark_gray",
"blue",
"green",
"aqua",
"red",
"light_purple",
"yellow",
"white",
"reset"
]
},
{
"pattern": "#[0-9a-f]{1,6}",
"type": "string"
}
],
"title": "The colour of the text"
},
"entity": {},
"extra": {
"$ref": "#/definitions/text_component",
"description": "These items inherit from the base component in styling, such as text colour and italics",
"title": "Additional items to add",
"type": "array"
},
"hoverEvent": {
"additionalProperties": false,
"description": "What to show upon a hover",
"oneOf": [
{
"properties": {
"action": {
"enum": [
"show_text"
]
},
"contents": {
"$ref": "#/definitions/text_component"
},
"value": {
"$ref": "#/definitions/text_component"
}
}
},
{
"properties": {
"action": {
"enum": [
"show_entity"
]
},
"contents": {
"properties": {
"id": {
"parser": "Uuid",
"type": "string"
},
"name": {
"$ref": "#/definitions/text_component"
},
"type": {
"params": {
"registry": "minecraft:entity_type"
},
"parser": "Identity",
"type": "string"
}
},
"type": "object"
},
"value": {
"params": {
"category": "minecraft:entity",
"id": "spgoding:i-am-guaranteed-not-to-exist",
"type": "Compound"
},
"parser": "Nbt",
"type": "string"
}
}
},
{
"properties": {
"action": {
"enum": [
"show_item"
]
},
"contents": {
"properties": {
"count": {
"maximum": 64,
"minimum": 1,
"type": "number"
},
"id": {
"params": {
"registry": "minecraft:item"
},
"parser": "Identity",
"type": "string"
},
"tag": {
"params": {
"category": "minecraft:item",
"id": [
{
"Child": "id"
}
],
"type": "Compound"
},
"parser": "Nbt",
"type": "string"
}
},
"type": "object"
},
"value": {
"params": {
"category": "minecraft:item",
"id": "spgoding:i-am-guaranteed-not-to-exist",
"type": "Compound"
},
"parser": "Nbt",
"type": "string"
}
}
}
],
"properties": {
"action": {},
"contents": {},
"value": {}
},
"required": [
"action"
],
"type": "object"
},
"insertion": {
"description": "When the player SHIFT-clicks on a section of text, what to add to their chat window",
"title": "Insertion text",
"type": "string"
},
"interpret": {},
"italic": {
"title": "Whether to have the text in italics",
"type": "boolean"
},
"keybind": {},
"nbt": {},
"obfuscated": {
"description": "This makes the text cycle through characters with the same width",
"title": "Whether to have the text obfuscated",
"type": "boolean"
},
"score": {},
"selector": {},
"storage": {},
"strikethrough": {
"title": "Whether to have the text strikethroughed",
"type": "boolean"
},
"text": {},
"translate": {},
"underlined": {
"title": "Whether to have the text underlined",
"type": "boolean"
},
"with": {}
},
"type": "object"
}
}
} | MIT | zh |
hans000/minecraft-assets-helper | 9f943ead4c26960ab88a40a3a41a1f85a2a9c146 | 2023-01-03T03:30:58 | assets/linters/misc.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"texture": {
"description": "\u5305\u542b\u4e86\u7eb9\u7406\u7684\u6570\u636e",
"properties": {
"blur": {
"description": "\u6307\u5b9a\u4ece\u8fd1\u8ddd\u79bb\u89c2\u5bdf\u65f6\u662f\u5426\u5bfc\u81f4\u7eb9\u7406\u6a21\u7cca\u3002\u9ed8\u8ba4\u4e3afalse",
"type": "boolean"
},
"clamp": {
"description": "\u6307\u5b9a\u662f\u5426\u5728\u539f\u6765\u7684\u60c5\u51b5\u4e0b\u4ee5\u4f38\u5c55\u7eb9\u7406\u4ee3\u66ff\u5e73\u94fa\u7eb9\u7406\u3002\u9ed8\u8ba4\u4e3afalse",
"type": "boolean"
},
"mipmaps": {
"description": "\u7eb9\u7406\u7684\u81ea\u5b9a\u4e49mipmap\u503c",
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | zh |
hans000/minecraft-assets-helper | 9f943ead4c26960ab88a40a3a41a1f85a2a9c146 | 2023-01-03T03:30:58 | assets/linters/credits.json | 5 | 2024-05-28T00:25:18.744667Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"defaultSnippets": [
{
"body": {
"section": "$1",
"titles": [
{
"names": [
"$3"
],
"title": "$2"
}
]
},
"label": "\u5feb\u901f\u751f\u6210credits",
"prefix": "init"
}
],
"description": "\u63d0\u4f9b\u8457\u4f5c\u58f0\u660e",
"properties": {
"section": {
"description": "\u901a\u5e38\u4e3a\u90e8\u95e8\u540d\u79f0\uff0c\u5982\u201cDesign\u201d\u201cProgramming\u201d\u201cAudio\u201d\u7b49",
"title": "\u6807\u9898",
"type": "string"
},
"titles": {
"description": "\u804c\u4f4d\u5217\u8868",
"items": {
"properties": {
"names": {
"description": "\u59d3\u540d\u5217\u8868",
"items": {
"description": "\u59d3\u540d",
"type": "string"
},
"type": "array"
},
"title": {
"description": "\u804c\u4f4d\u7684\u540d\u79f0\uff0c\u5982\u201cTechnical Director\u201d\u201cGame Developers\u201d\u201cSoftware Engineers\u201d\u7b49",
"type": "string"
}
},
"required": [
"title",
"names"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"section",
"titles"
],
"type": "object"
} | MIT | zh |
ecmwf/earthkit-data | 09abe161020f9a811401c80ad6857f354dd01793 | 2024-05-08T14:23:43 | src/earthkit/data/conf/gridspec_schema.json | 43 | 2024-05-27T04:29:48.011169Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"type": false
}
},
"then": {
"anyOf": [
{
"required": [
"grid"
]
},
{
"required": [
"area"
]
}
]
}
},
{
"if": {
"properties": {
"type": {
"const": "regular_ll"
}
},
"required": [
"type"
]
},
"then": {
"anyOf": [
{
"properties": {
"grid": {
"type": "array"
}
},
"required": [
"grid"
]
},
{
"required": [
"area"
]
}
]
}
},
{
"if": {
"properties": {
"type": {
"const": "reduced_ll"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"type": "number"
}
},
"required": [
"grid"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "regular_gg"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"pattern": "^F?\\d+",
"type": [
"string",
"number"
]
}
},
"required": [
"grid"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "reduced_gg"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"pattern": "^[N,O]{1}\\d+",
"type": "string"
}
},
"required": [
"grid"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "mercator"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"type": "array"
}
},
"required": [
"grid",
"nx",
"ny",
"lad"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "polar_stereographic"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"type": "array"
}
},
"required": [
"grid",
"first_point",
"nx",
"ny",
"lad"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "lambert"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"type": "array"
}
},
"required": [
"grid",
"first_point",
"nx",
"ny",
"lad",
"lov",
"latin_1",
"latin_2"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "lambert_azimuthal_equal_area"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"type": "array"
}
},
"required": [
"grid",
"first_point",
"nx",
"ny",
"standard_parallel",
"central_longitude"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "sh"
}
},
"required": [
"type"
]
},
"then": {
"required": [
"J",
"K",
"M"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "healpix"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"grid": {
"pattern": "^H\\d+",
"type": "string"
}
},
"required": [
"grid",
"ordering"
]
}
}
],
"description": "Gridspec definition for earthkit",
"properties": {
"J": {
"description": "J number for spehrical harmonics.",
"minimum": 1,
"type": "integer"
},
"K": {
"description": "J number for spehrical harmonics.",
"minimum": 1,
"type": "integer"
},
"M": {
"description": "M number for spehrical harmonics.",
"minimum": 1,
"type": "integer"
},
"angle_of_rotation": {
"default": 0,
"description": "Angle of rotation in degrees.",
"type": "number"
},
"area": {
"description": "Area of the grid as an array of [north, west, south, east] in degrees.",
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
"central_longitude": {
"description": "Central longitude in degrees.",
"type": "number"
},
"first_point": {
"default": null,
"description": "First gridpoint as an array of [lat, lon] in degrees.",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": [
"array"
]
},
"grid": {
"description": "Grid resolution/increment in degrees or metres.",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"pattern": "^[F,N,O,H]?\\d+",
"type": [
"array",
"number",
"string"
]
},
"i_scans_negatively": {
"default": 0,
"description": "Scanning mode in i direction.",
"enum": [
0,
1
],
"type": "number"
},
"j_points_consecutive": {
"default": 0,
"description": "Indicate if points in j direction are consecutive.",
"enum": [
0,
1
],
"type": "number"
},
"j_scans_positively": {
"default": 0,
"description": "Scanning mode in j direction.",
"enum": [
0,
1
],
"type": "number"
},
"lad": {
"description": "Number of points in y direction",
"type": "number"
},
"latin_1": {
"description": "Number of points in y direction",
"type": "number"
},
"latin_2": {
"description": "Number of points in y direction",
"type": "number"
},
"lov": {
"description": "Number of points in y direction",
"type": "number"
},
"nx": {
"description": "Number of points in x direction.",
"minimum": 1,
"type": "integer"
},
"ny": {
"description": "Number of points in y direction.",
"minimum": 1,
"type": "integer"
},
"ordering": {
"description": "Healpix grid ordering",
"enum": [
"ring",
"nested"
],
"type": "string"
},
"orientation": {
"default": 0,
"description": "Orientation of the grid in degrees.",
"type": "number"
},
"rotation": {
"default": null,
"description": "Location of the South Pole of the rotated grid as an array of [lat, lon] in degrees.",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": [
"array"
]
},
"standard_parallel": {
"description": "Latitude of standrad parallel in degrees.",
"type": "number"
},
"type": {
"description": "Unique identifier of the grid",
"enum": [
"regular_ll",
"reduced_ll",
"regular_gg",
"reduced_gg",
"mercator",
"polar_stereographic",
"lambert",
"lambert_azimuthal_equal_area",
"sh",
"healpix"
],
"type": "string"
}
},
"title": "Gridspec",
"type": "object"
} | Apache-2.0 | en |
score-spec/score-go | 713e8456a14146fe3e0ac2d3cb6c00591a6ba317 | 2024-01-25T16:02:24 | schema/files/score-v1b1.json | 19 | 2024-05-27T04:33:54.069241Z | {
"$defs": {
"container": {
"additionalProperties": false,
"description": "The container name.",
"properties": {
"args": {
"description": "If specified, overrides container entry point arguments.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"command": {
"description": "If specified, overrides container entry point.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"files": {
"description": "The extra files to mount.",
"items": {
"oneOf": [
{
"required": [
"content"
]
},
{
"required": [
"source"
]
}
],
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"deprecated": true,
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
}
],
"description": "The inline content for the file."
},
"mode": {
"description": "The file access mode.",
"type": "string"
},
"noExpand": {
"description": "If set to true, the placeholders expansion will not occur in the contents of the file.",
"type": "boolean"
},
"source": {
"description": "The relative or absolute path to the content file.",
"minLength": 1,
"type": "string"
},
"target": {
"description": "The file path and name.",
"type": "string"
}
},
"required": [
"target"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"image": {
"description": "The image name and tag.",
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The liveness probe for the container."
},
"readinessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The readiness probe for the container."
},
"resources": {
"additionalProperties": false,
"description": "The compute resources for the container.",
"minProperties": 1,
"properties": {
"limits": {
"$ref": "#/$defs/resourcesLimits",
"description": "The maximum allowed resources for the container."
},
"requests": {
"$ref": "#/$defs/resourcesLimits",
"description": "The minimal resources required for the container."
}
},
"type": "object"
},
"variables": {
"additionalProperties": {
"type": "string"
},
"description": "The environment variables for the container.",
"minProperties": 1,
"type": "object"
},
"volumes": {
"description": "The volumes to mount.",
"items": {
"properties": {
"path": {
"description": "An optional sub path in the volume.",
"type": "string"
},
"read_only": {
"description": "Indicates if the volume should be mounted in a read-only mode.",
"type": "boolean"
},
"source": {
"description": "The external volume reference.",
"type": "string"
},
"target": {
"description": "The target mount on the container.",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"image"
],
"type": "object"
},
"containerProbe": {
"additionalProperties": false,
"minProperties": 1,
"properties": {
"httpGet": {
"$ref": "#/$defs/httpProbe"
}
},
"type": "object"
},
"httpProbe": {
"additionalProperties": false,
"description": "An HTTP probe details.",
"properties": {
"host": {
"description": "Host name to connect to. Defaults to the container IP.",
"type": "string"
},
"httpHeaders": {
"description": "Additional HTTP headers to send with the request",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The HTTP header name.",
"type": "string"
},
"value": {
"description": "The HTTP header value.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "The path of the HTTP probe endpoint.",
"type": "string"
},
"port": {
"description": "The path of the HTTP probe endpoint.",
"type": "integer"
},
"scheme": {
"description": "Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"resource": {
"additionalProperties": false,
"description": "The resource name.",
"properties": {
"class": {
"description": "A specialisation of the resource type.",
"pattern": "^[a-z0-9](?:-?[a-z0-9]+)+$",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata for the resource.",
"minProperties": 1,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations that apply to the property.",
"minProperties": 1,
"type": "object"
}
},
"type": "object"
},
"params": {
"description": "The parameters used to validate or provision the resource in the environment.",
"type": "object"
},
"type": {
"description": "The resource in the target environment.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"resourcesLimits": {
"additionalProperties": false,
"description": "The compute resources limits.",
"minProperties": 1,
"properties": {
"cpu": {
"description": "The CPU limit.",
"type": "string"
},
"memory": {
"description": "The memory limit.",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"additionalProperties": false,
"description": "The network port description.",
"properties": {
"port": {
"description": "The public service port.",
"type": "integer"
},
"protocol": {
"description": "The transport level protocol. Defaults to TCP.",
"type": "string"
},
"targetPort": {
"description": "The internal service port. This will default to 'port' if not provided.",
"type": "integer"
}
},
"required": [
"port"
],
"type": "object"
}
},
"$id": "https://score.dev/schemas/score",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Score workload specification",
"properties": {
"apiVersion": {
"description": "The declared Score Specification version.",
"type": "string"
},
"containers": {
"additionalProperties": {
"$ref": "#/$defs/container"
},
"description": "The declared Score Specification version.",
"minProperties": 1,
"type": "object"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata description of the Workload.",
"properties": {
"name": {
"description": "A string that can describe the Workload.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"resources": {
"additionalProperties": {
"$ref": "#/$defs/resource"
},
"description": "The dependencies needed by the Workload.",
"minProperties": 1,
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "The service that the workload provides.",
"properties": {
"ports": {
"additionalProperties": {
"$ref": "#/$defs/servicePort"
},
"description": "List of network ports published by the service.",
"minProperties": 1,
"type": "object"
}
},
"type": "object"
}
},
"required": [
"apiVersion",
"metadata",
"containers"
],
"title": "Score schema",
"type": "object"
} | Apache-2.0 | en |
score-spec/score-go | aa64f2227370b97213c4aa7667d8972c9a14fbe3 | 2024-02-28T11:04:52 | schema/files/score-v1b1.json | 19 | 2024-05-27T04:33:54.069241Z | {
"$defs": {
"container": {
"additionalProperties": false,
"description": "The specification of a Container within the Workload.",
"properties": {
"args": {
"description": "If specified, overrides the arguments passed to the container entrypoint.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "If specified, overrides the entrypoint defined in the container image.",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The extra files to mount into the container.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"target",
"content"
]
},
{
"required": [
"target",
"source"
]
}
],
"properties": {
"content": {
"description": "The inline content for the file.",
"type": "string"
},
"mode": {
"description": "The optional file access mode in octal encoding. For example 0600.",
"pattern": "^0?[0-7]{3}$",
"type": "string"
},
"noExpand": {
"description": "If set to true, the placeholders expansion will not occur in the contents of the file.",
"type": "boolean"
},
"source": {
"description": "The relative or absolute path to the content file.",
"minLength": 1,
"type": "string"
},
"target": {
"description": "The file path to expose in the container.",
"minLength": 1,
"type": "string"
}
},
"required": [
"target"
],
"type": "object"
},
"type": "array"
},
"image": {
"description": "The container image name and tag.",
"minLength": 1,
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The liveness probe for the container."
},
"readinessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The readiness probe for the container."
},
"resources": {
"additionalProperties": false,
"description": "The compute resources for the container.",
"properties": {
"limits": {
"$ref": "#/$defs/resourcesLimits",
"description": "The maximum allowed resources for the container."
},
"requests": {
"$ref": "#/$defs/resourcesLimits",
"description": "The minimal resources required for the container."
}
},
"type": "object"
},
"variables": {
"additionalProperties": {
"type": "string"
},
"description": "The environment variables for the container.",
"propertyNames": {
"minLength": 1,
"pattern": "^[^=]+$"
},
"type": "object"
},
"volumes": {
"description": "The volumes to mount.",
"items": {
"additionalProperties": false,
"properties": {
"path": {
"description": "An optional sub path in the volume.",
"type": "string"
},
"readOnly": {
"description": "Indicates if the volume should be mounted in a read-only mode.",
"type": "boolean"
},
"source": {
"description": "The external volume reference.",
"type": "string"
},
"target": {
"description": "The target mount on the container.",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"image"
],
"type": "object"
},
"containerProbe": {
"additionalProperties": false,
"properties": {
"httpGet": {
"$ref": "#/$defs/httpProbe"
}
},
"required": [
"httpGet"
],
"type": "object"
},
"httpProbe": {
"additionalProperties": false,
"description": "An HTTP probe details.",
"properties": {
"host": {
"description": "Host name to connect to. Defaults to the workload IP. The is equivalent to a Host HTTP header.",
"minLength": 1,
"type": "string"
},
"httpHeaders": {
"description": "Additional HTTP headers to send with the request",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The HTTP header name.",
"pattern": "^[A-Za-z0-9_-]+$",
"type": "string"
},
"value": {
"description": "The HTTP header value.",
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "The path to access on the HTTP server.",
"type": "string"
},
"port": {
"description": "The port to access on the workload.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"scheme": {
"description": "Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
}
},
"required": [
"port",
"path"
],
"type": "object"
},
"resource": {
"additionalProperties": false,
"description": "The set of Resources associated with this Workload.",
"properties": {
"class": {
"description": "A specialisation of the Resource type.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata for the Resource.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations that apply to the Resource. The annotation can contain A-Z, a-z, 0-9, and '-' and may contain an optional /-separated RFC1123 Host Name prefix.",
"propertyNames": {
"maxLength": 316,
"minLength": 2,
"pattern": "^(([a-z0-9][a-z0-9-]{0,61}[a-z0-9])(\\.[a-z0-9][a-z0-9-]{0,61}[a-z0-9])*/)?[A-Za-z0-9][A-Za-z0-9._-]{0,61}[A-Za-z0-9]$"
},
"type": "object"
}
},
"type": "object"
},
"params": {
"additionalProperties": true,
"description": "Optional parameters used to provision the Resource in the environment.",
"type": "object"
},
"type": {
"description": "The Resource type. This should be a type supported by the Score implementations being used.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"resourcesLimits": {
"additionalProperties": false,
"description": "The compute and memory resource limits.",
"properties": {
"cpu": {
"description": "The CPU limit as whole or fractional CPUs. 'm' indicates milli-CPUs. For example 2 or 125m.",
"pattern": "^\\d*(?:m|\\.\\d+)?$",
"type": "string"
},
"memory": {
"description": "The memory limit in bytes with optional unit specifier. For example 125M or 1Gi.",
"pattern": "^[1-9]\\d*(K|M|G|T|Ki|Mi|Gi|Ti)?$",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"additionalProperties": false,
"description": "The network port description.",
"properties": {
"port": {
"description": "The public service port.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"description": "The transport level protocol. Defaults to TCP.",
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"targetPort": {
"description": "The internal service port. This will default to 'port' if not provided.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"port"
],
"type": "object"
}
},
"$id": "https://score.dev/schemas/score",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Score workload specification",
"properties": {
"apiVersion": {
"description": "The declared Score Specification version.",
"pattern": "^score\\.dev/v1b1$",
"type": "string"
},
"containers": {
"additionalProperties": {
"$ref": "#/$defs/container"
},
"description": "The declared Score Specification version. The container name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"minProperties": 1,
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata description of the Workload.",
"properties": {
"name": {
"description": "A string that can describe the Workload. This must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"resources": {
"additionalProperties": {
"$ref": "#/$defs/resource"
},
"description": "The Resource dependencies needed by the Workload. The resource name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "The service that the workload provides.",
"properties": {
"ports": {
"additionalProperties": {
"$ref": "#/$defs/servicePort"
},
"description": "The set of named network ports published by the service. The service name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"apiVersion",
"metadata",
"containers"
],
"title": "Score schema",
"type": "object"
} | Apache-2.0 | en |
score-spec/score-go | 74f0b2308476ab292a88c6a94ef9c05199ba3775 | 2024-03-06T17:21:41 | schema/files/score-v1b1.json | 19 | 2024-05-27T04:33:54.069241Z | {
"$defs": {
"container": {
"additionalProperties": false,
"description": "The specification of a Container within the Workload.",
"properties": {
"args": {
"description": "If specified, overrides the arguments passed to the container entrypoint.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "If specified, overrides the entrypoint defined in the container image.",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The extra files to mount into the container.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"target",
"content"
]
},
{
"required": [
"target",
"source"
]
}
],
"properties": {
"content": {
"description": "The inline content for the file.",
"type": "string"
},
"mode": {
"description": "The optional file access mode in octal encoding. For example 0600.",
"pattern": "^0?[0-7]{3}$",
"type": "string"
},
"noExpand": {
"description": "If set to true, the placeholders expansion will not occur in the contents of the file.",
"type": "boolean"
},
"source": {
"description": "The relative or absolute path to the content file.",
"minLength": 1,
"type": "string"
},
"target": {
"description": "The file path to expose in the container.",
"minLength": 1,
"type": "string"
}
},
"required": [
"target"
],
"type": "object"
},
"type": "array"
},
"image": {
"description": "The container image name and tag.",
"minLength": 1,
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The liveness probe for the container."
},
"readinessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The readiness probe for the container."
},
"resources": {
"additionalProperties": false,
"description": "The compute resources for the container.",
"properties": {
"limits": {
"$ref": "#/$defs/resourcesLimits",
"description": "The maximum allowed resources for the container."
},
"requests": {
"$ref": "#/$defs/resourcesLimits",
"description": "The minimal resources required for the container."
}
},
"type": "object"
},
"variables": {
"additionalProperties": {
"type": "string"
},
"description": "The environment variables for the container.",
"propertyNames": {
"minLength": 1,
"pattern": "^[^=]+$"
},
"type": "object"
},
"volumes": {
"description": "The volumes to mount.",
"items": {
"additionalProperties": false,
"properties": {
"path": {
"description": "An optional sub path in the volume.",
"type": "string"
},
"readOnly": {
"description": "Indicates if the volume should be mounted in a read-only mode.",
"type": "boolean"
},
"source": {
"description": "The external volume reference.",
"type": "string"
},
"target": {
"description": "The target mount on the container.",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"image"
],
"type": "object"
},
"containerProbe": {
"additionalProperties": false,
"properties": {
"httpGet": {
"$ref": "#/$defs/httpProbe"
}
},
"required": [
"httpGet"
],
"type": "object"
},
"httpProbe": {
"additionalProperties": false,
"description": "An HTTP probe details.",
"properties": {
"host": {
"description": "Host name to connect to. Defaults to the workload IP. The is equivalent to a Host HTTP header.",
"minLength": 1,
"type": "string"
},
"httpHeaders": {
"description": "Additional HTTP headers to send with the request",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The HTTP header name.",
"pattern": "^[A-Za-z0-9_-]+$",
"type": "string"
},
"value": {
"description": "The HTTP header value.",
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "The path to access on the HTTP server.",
"type": "string"
},
"port": {
"description": "The port to access on the workload.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"scheme": {
"description": "Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
}
},
"required": [
"port",
"path"
],
"type": "object"
},
"resource": {
"additionalProperties": false,
"description": "The set of Resources associated with this Workload.",
"properties": {
"class": {
"description": "An optional specialisation of the Resource type.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
},
"id": {
"description": "An optional external Resource identifier. When two resources share the same type, class, and id, they are considered the same resource when used across related Workloads. The id must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata for the Resource.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations that apply to the Resource. The annotation can contain A-Z, a-z, 0-9, and '-' and may contain an optional /-separated RFC1123 Host Name prefix.",
"propertyNames": {
"maxLength": 316,
"minLength": 2,
"pattern": "^(([a-z0-9][a-z0-9-]{0,61}[a-z0-9])(\\.[a-z0-9][a-z0-9-]{0,61}[a-z0-9])*/)?[A-Za-z0-9][A-Za-z0-9._-]{0,61}[A-Za-z0-9]$"
},
"type": "object"
}
},
"type": "object"
},
"params": {
"additionalProperties": true,
"description": "Optional parameters used to provision the Resource in the environment.",
"type": "object"
},
"type": {
"description": "The Resource type. This should be a type supported by the Score implementations being used.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"resourcesLimits": {
"additionalProperties": false,
"description": "The compute and memory resource limits.",
"properties": {
"cpu": {
"description": "The CPU limit as whole or fractional CPUs. 'm' indicates milli-CPUs. For example 2 or 125m.",
"pattern": "^\\d*(?:m|\\.\\d+)?$",
"type": "string"
},
"memory": {
"description": "The memory limit in bytes with optional unit specifier. For example 125M or 1Gi.",
"pattern": "^[1-9]\\d*(K|M|G|T|Ki|Mi|Gi|Ti)?$",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"additionalProperties": false,
"description": "The network port description.",
"properties": {
"port": {
"description": "The public service port.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"description": "The transport level protocol. Defaults to TCP.",
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"targetPort": {
"description": "The internal service port. This will default to 'port' if not provided.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"port"
],
"type": "object"
}
},
"$id": "https://score.dev/schemas/score",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Score workload specification",
"properties": {
"apiVersion": {
"description": "The declared Score Specification version.",
"pattern": "^score\\.dev/v1b1$",
"type": "string"
},
"containers": {
"additionalProperties": {
"$ref": "#/$defs/container"
},
"description": "The declared Score Specification version. The container name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"minProperties": 1,
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata description of the Workload.",
"properties": {
"name": {
"description": "A string that can describe the Workload. This must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"resources": {
"additionalProperties": {
"$ref": "#/$defs/resource"
},
"description": "The Resource dependencies needed by the Workload. The resource name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "The service that the workload provides.",
"properties": {
"ports": {
"additionalProperties": {
"$ref": "#/$defs/servicePort"
},
"description": "The set of named network ports published by the service. The service name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"apiVersion",
"metadata",
"containers"
],
"title": "Score schema",
"type": "object"
} | Apache-2.0 | en |
score-spec/score-go | 2b44195381f2c0c6ef278085e046f13a464db1f4 | 2024-02-26T08:54:04 | schema/files/score-v1b1.json | 19 | 2024-05-27T04:33:54.069241Z | {
"$defs": {
"container": {
"additionalProperties": false,
"description": "The specification of a Container within the Workload.",
"properties": {
"args": {
"description": "If specified, overrides the arguments passed to the container entrypoint.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "If specified, overrides the entrypoint defined in the container image.",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The extra files to mount into the container.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"target",
"content"
]
},
{
"required": [
"target",
"source"
]
}
],
"properties": {
"content": {
"description": "The inline content for the file.",
"type": "string"
},
"mode": {
"description": "The optional file access mode in octal encoding. For example 0600.",
"pattern": "^0?[0-7]{3}$",
"type": "string"
},
"noExpand": {
"description": "If set to true, the placeholders expansion will not occur in the contents of the file.",
"type": "boolean"
},
"source": {
"description": "The relative or absolute path to the content file.",
"minLength": 1,
"type": "string"
},
"target": {
"description": "The file path to expose in the container.",
"minLength": 1,
"type": "string"
}
},
"required": [
"target"
],
"type": "object"
},
"type": "array"
},
"image": {
"description": "The container image name and tag.",
"minLength": 1,
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The liveness probe for the container."
},
"readinessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The readiness probe for the container."
},
"resources": {
"additionalProperties": false,
"description": "The compute resources for the container.",
"properties": {
"limits": {
"$ref": "#/$defs/resourcesLimits",
"description": "The maximum allowed resources for the container."
},
"requests": {
"$ref": "#/$defs/resourcesLimits",
"description": "The minimal resources required for the container."
}
},
"type": "object"
},
"variables": {
"additionalProperties": {
"type": "string"
},
"description": "The environment variables for the container.",
"propertyNames": {
"minLength": 1,
"pattern": "^[^=]+$"
},
"type": "object"
},
"volumes": {
"description": "The volumes to mount.",
"items": {
"additionalProperties": false,
"properties": {
"path": {
"description": "An optional sub path in the volume.",
"type": "string"
},
"readOnly": {
"description": "Indicates if the volume should be mounted in a read-only mode.",
"type": "boolean"
},
"source": {
"description": "The external volume reference.",
"type": "string"
},
"target": {
"description": "The target mount on the container.",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"image"
],
"type": "object"
},
"containerProbe": {
"additionalProperties": false,
"properties": {
"httpGet": {
"$ref": "#/$defs/httpProbe"
}
},
"required": [
"httpGet"
],
"type": "object"
},
"httpProbe": {
"additionalProperties": false,
"description": "An HTTP probe details.",
"properties": {
"host": {
"description": "Host name to connect to. Defaults to the workload IP. The is equivalent to a Host HTTP header.",
"type": "string"
},
"httpHeaders": {
"description": "Additional HTTP headers to send with the request",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The HTTP header name.",
"pattern": "^[A-Za-z0-9_-]+$",
"type": "string"
},
"value": {
"description": "The HTTP header value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"path": {
"description": "The path to access on the HTTP server.",
"type": "string"
},
"port": {
"description": "The port to access on the workload.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"scheme": {
"description": "Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
}
},
"required": [
"port",
"path"
],
"type": "object"
},
"resource": {
"additionalProperties": false,
"description": "The set of Resources associated with this Workload.",
"properties": {
"class": {
"description": "A specialisation of the Resource type.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata for the Resource.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations that apply to the Resource. The annotation can contain A-Z, a-z, 0-9, and '-' and may contain an optional /-separated RFC1123 Host Name prefix.",
"propertyNames": {
"maxLength": 316,
"minLength": 2,
"pattern": "^(([a-z0-9][a-z0-9-]{0,61}[a-z0-9])(\\.[a-z0-9][a-z0-9-]{0,61}[a-z0-9])*/)?[A-Za-z0-9][A-Za-z0-9._-]{0,61}[A-Za-z0-9]$"
},
"type": "object"
}
},
"type": "object"
},
"params": {
"additionalProperties": true,
"description": "Optional parameters used to provision the Resource in the environment.",
"type": "object"
},
"type": {
"description": "The Resource type. This should be a type supported by the Score implementations being used.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"resourcesLimits": {
"additionalProperties": false,
"description": "The compute and memory resource limits.",
"properties": {
"cpu": {
"description": "The CPU limit as whole or fractional CPUs. 'm' indicates milli-CPUs. For example 2 or 125m.",
"pattern": "^\\d*(?:m|\\.\\d+)?$",
"type": "string"
},
"memory": {
"description": "The memory limit in bytes with optional unit specifier. For example 125M or 1Gi.",
"pattern": "^[1-9]\\d*(K|M|G|T|Ki|Mi|Gi|Ti)?$",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"additionalProperties": false,
"description": "The network port description.",
"properties": {
"port": {
"description": "The public service port.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"description": "The transport level protocol. Defaults to TCP.",
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"targetPort": {
"description": "The internal service port. This will default to 'port' if not provided.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"port"
],
"type": "object"
}
},
"$id": "https://score.dev/schemas/score",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Score workload specification",
"properties": {
"apiVersion": {
"description": "The declared Score Specification version.",
"pattern": "^score\\.dev/v1b1$",
"type": "string"
},
"containers": {
"additionalProperties": {
"$ref": "#/$defs/container"
},
"description": "The declared Score Specification version. The container name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"minProperties": 1,
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata description of the Workload.",
"properties": {
"name": {
"description": "A string that can describe the Workload. This must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"resources": {
"additionalProperties": {
"$ref": "#/$defs/resource"
},
"description": "The Resource dependencies needed by the Workload. The resource name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "The service that the workload provides.",
"properties": {
"ports": {
"additionalProperties": {
"$ref": "#/$defs/servicePort"
},
"description": "The set of named network ports published by the service. The service name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"apiVersion",
"metadata",
"containers"
],
"title": "Score schema",
"type": "object"
} | Apache-2.0 | en |
score-spec/score-go | b6113312d32dcd6d958859a3c69135b654c89ad8 | 2024-03-19T11:17:18 | schema/files/score-v1b1.json | 19 | 2024-05-27T04:33:54.069241Z | {
"$defs": {
"container": {
"additionalProperties": false,
"description": "The specification of a Container within the Workload.",
"properties": {
"args": {
"description": "If specified, overrides the arguments passed to the container entrypoint.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "If specified, overrides the entrypoint defined in the container image.",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The extra files to mount into the container.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"target",
"content"
]
},
{
"required": [
"target",
"source"
]
}
],
"properties": {
"content": {
"description": "The inline content for the file.",
"type": "string"
},
"mode": {
"description": "The optional file access mode in octal encoding. For example 0600.",
"pattern": "^0?[0-7]{3}$",
"type": "string"
},
"noExpand": {
"description": "If set to true, the placeholders expansion will not occur in the contents of the file.",
"type": "boolean"
},
"source": {
"description": "The relative or absolute path to the content file.",
"minLength": 1,
"type": "string"
},
"target": {
"description": "The file path to expose in the container.",
"minLength": 1,
"type": "string"
}
},
"required": [
"target"
],
"type": "object"
},
"type": "array"
},
"image": {
"description": "The container image name and tag.",
"minLength": 1,
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The liveness probe for the container."
},
"readinessProbe": {
"$ref": "#/$defs/containerProbe",
"description": "The readiness probe for the container."
},
"resources": {
"additionalProperties": false,
"description": "The compute resources for the container.",
"properties": {
"limits": {
"$ref": "#/$defs/resourcesLimits",
"description": "The maximum allowed resources for the container."
},
"requests": {
"$ref": "#/$defs/resourcesLimits",
"description": "The minimal resources required for the container."
}
},
"type": "object"
},
"variables": {
"additionalProperties": {
"type": "string"
},
"description": "The environment variables for the container.",
"propertyNames": {
"minLength": 1,
"pattern": "^[^=]+$"
},
"type": "object"
},
"volumes": {
"description": "The volumes to mount.",
"items": {
"additionalProperties": false,
"properties": {
"path": {
"description": "An optional sub path in the volume.",
"type": "string"
},
"readOnly": {
"description": "Indicates if the volume should be mounted in a read-only mode.",
"type": "boolean"
},
"source": {
"description": "The external volume reference.",
"type": "string"
},
"target": {
"description": "The target mount on the container.",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"image"
],
"type": "object"
},
"containerProbe": {
"additionalProperties": false,
"properties": {
"httpGet": {
"$ref": "#/$defs/httpProbe"
}
},
"required": [
"httpGet"
],
"type": "object"
},
"httpProbe": {
"additionalProperties": false,
"description": "An HTTP probe details.",
"properties": {
"host": {
"description": "Host name to connect to. Defaults to the workload IP. The is equivalent to a Host HTTP header.",
"minLength": 1,
"type": "string"
},
"httpHeaders": {
"description": "Additional HTTP headers to send with the request",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The HTTP header name.",
"pattern": "^[A-Za-z0-9_-]+$",
"type": "string"
},
"value": {
"description": "The HTTP header value.",
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "The path to access on the HTTP server.",
"type": "string"
},
"port": {
"description": "The port to access on the workload.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"scheme": {
"description": "Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
}
},
"required": [
"port",
"path"
],
"type": "object"
},
"resource": {
"additionalProperties": false,
"description": "The set of Resources associated with this Workload.",
"properties": {
"class": {
"description": "An optional specialisation of the Resource type.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
},
"id": {
"description": "An optional external Resource identifier. When two resources share the same type, class, and id, they are considered the same resource when used across related Workloads. The id must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata for the Resource.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations that apply to the Resource. The annotation can contain A-Z, a-z, 0-9, and '-' and may contain an optional /-separated RFC1123 Host Name prefix.",
"propertyNames": {
"maxLength": 316,
"minLength": 2,
"pattern": "^(([a-z0-9][a-z0-9-]{0,61}[a-z0-9])(\\.[a-z0-9][a-z0-9-]{0,61}[a-z0-9])*/)?[A-Za-z0-9][A-Za-z0-9._-]{0,61}[A-Za-z0-9]$"
},
"type": "object"
}
},
"type": "object"
},
"params": {
"additionalProperties": true,
"description": "Optional parameters used to provision the Resource in the environment.",
"type": "object"
},
"type": {
"description": "The Resource type. This should be a type supported by the Score implementations being used.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"resourcesLimits": {
"additionalProperties": false,
"description": "The compute and memory resource limits.",
"properties": {
"cpu": {
"description": "The CPU limit as whole or fractional CPUs. 'm' indicates milli-CPUs. For example 2 or 125m.",
"pattern": "^\\d*(?:m|\\.\\d+)?$",
"type": "string"
},
"memory": {
"description": "The memory limit in bytes with optional unit specifier. For example 125M or 1Gi.",
"pattern": "^[1-9]\\d*(K|M|G|T|Ki|Mi|Gi|Ti)?$",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"additionalProperties": false,
"description": "The network port description.",
"properties": {
"port": {
"description": "The public service port.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"description": "The transport level protocol. Defaults to TCP.",
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"targetPort": {
"description": "The internal service port. This will default to 'port' if not provided.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"port"
],
"type": "object"
}
},
"$id": "https://score.dev/schemas/score",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Score workload specification",
"properties": {
"apiVersion": {
"description": "The declared Score Specification version.",
"pattern": "^score\\.dev/v1b1$",
"type": "string"
},
"containers": {
"additionalProperties": {
"$ref": "#/$defs/container"
},
"description": "The declared Score Specification version. The container name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"minProperties": 1,
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"metadata": {
"additionalProperties": true,
"description": "The metadata description of the Workload.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations that apply to the Workload. The annotation can contain A-Z, a-z, 0-9, and '-' and may contain an optional /-separated RFC1123 Host Name prefix.",
"propertyNames": {
"maxLength": 316,
"minLength": 2,
"pattern": "^(([a-z0-9][a-z0-9-]{0,61}[a-z0-9])(\\.[a-z0-9][a-z0-9-]{0,61}[a-z0-9])*/)?[A-Za-z0-9][A-Za-z0-9._-]{0,61}[A-Za-z0-9]$"
},
"type": "object"
},
"name": {
"description": "A string that can describe the Workload. This must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"resources": {
"additionalProperties": {
"$ref": "#/$defs/resource"
},
"description": "The Resource dependencies needed by the Workload. The resource name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "The service that the workload provides.",
"properties": {
"ports": {
"additionalProperties": {
"$ref": "#/$defs/servicePort"
},
"description": "The set of named network ports published by the service. The service name must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.",
"propertyNames": {
"maxLength": 63,
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"apiVersion",
"metadata",
"containers"
],
"title": "Score schema",
"type": "object"
} | Apache-2.0 | en |
budimanjojo/talhelper | a222d7ac83db5af5140c360906df26fd578073f1 | 2024-04-29T07:00:18 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ConfigFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"mountPath": {
"type": "string"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"ExtensionService": {
"additionalProperties": false,
"properties": {
"configFiles": {
"description": "The config files for the extension service",
"items": {
"$ref": "#/$defs/ConfigFile"
},
"type": "array"
},
"environment": {
"description": "The environment for the extension service",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the extension service config",
"type": "string"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}{{if .Secureboot}}-secureboot{{end}}{{if and .Secureboot .UseUKI}}-uki.efi{{else}}.iso{{end}}",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer{{if .Secureboot}}-secureboot{{end}}/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
},
"secureboot": {
"default": false,
"description": "Whether to enable Secure Boot",
"type": "boolean"
},
"useUKI": {
"default": false,
"description": "Whether to use UKI if Secure Boot is enabled",
"type": "boolean"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
},
"physical": {
"type": "boolean"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensionServices": {
"description": "Machine extension services specification",
"items": {
"$ref": "#/$defs/ExtensionService"
},
"type": "array"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ignoreHostname": {
"description": "Whether to set \"machine.network.hostname\" to the generated config file",
"type": "boolean"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"overrideExtraManifests": {
"description": "Whether \"extraManifests\" defined here should override the one defined in node group",
"type": "boolean"
},
"overridePatches": {
"description": "Whether \"patches\" defined here should override the one defined in node group",
"type": "boolean"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"NodeConfigs": {
"additionalProperties": false,
"properties": {
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensionServices": {
"description": "Machine extension services specification",
"items": {
"$ref": "#/$defs/ExtensionService"
},
"type": "array"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"type": "object"
},
"Overlay": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "object"
}
},
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
},
"overlay": {
"$ref": "#/$defs/Overlay"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | a3d828bd4c7756e43c7e2af28268a07fbd66e215 | 2023-12-17T06:59:40 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "DEPRECATED: will not do anything",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | d48d491ab1a6682ae6f65429cddb2314458ab926 | 2023-12-09T04:21:32 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | d0a0d501088461715a0d9d301f66a3c9aa80a5eb | 2024-01-18T05:28:43 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "DEPRECATED: will not do anything",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | b3d53d55a32e4089e84a6b207aed8f32dd5c64d3 | 2023-10-28T09:55:05 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"$ref": "#/$defs/InstallDiskSizeMatcher"
},
"type": {
"type": "integer"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallDiskSizeMatchData": {
"additionalProperties": false,
"properties": {
"Op": {
"type": "string"
},
"Size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSizeMatcher": {
"additionalProperties": false,
"properties": {
"MatchData": {
"$ref": "#/$defs/InstallDiskSizeMatchData"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "List of additional system extensions to install",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelector",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "ClusterInlineManifest",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | d695e0b275d09dca5c2f279bc6720112e67f47dd | 2023-11-29T03:32:21 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 63622de1d3d09e690155834499f74c03aed8e12b | 2024-01-22T04:47:07 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"overrideExtraManifests": {
"description": "Whether \"extraManifests\" defined here should override the one defined in node group",
"type": "boolean"
},
"overridePatches": {
"description": "Whether \"patches\" defined here should override the one defined in node group",
"type": "boolean"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"NodeConfigs": {
"additionalProperties": false,
"properties": {
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 750d7003e30c5f9c8c0e43662a373dcc1eb69065 | 2023-10-30T04:08:21 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"$ref": "#/$defs/InstallDiskSizeMatcher"
},
"type": {
"type": "integer"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallDiskSizeMatchData": {
"additionalProperties": false,
"properties": {
"Op": {
"type": "string"
},
"Size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSizeMatcher": {
"additionalProperties": false,
"properties": {
"MatchData": {
"$ref": "#/$defs/InstallDiskSizeMatchData"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelector",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "ClusterInlineManifest",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 2ad1aff9fb226b2d7cf98250a478afee67f8a76f | 2023-12-23T04:45:31 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "DEPRECATED: will not do anything",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 7528d1d603ff7f3e2fb6ff52f4f8d1c12eeb5dd5 | 2024-01-17T09:30:43 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "DEPRECATED: will not do anything",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 3d5f8c2e8489446f85d832b247bc623f2198bd67 | 2024-01-18T09:18:38 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "DEPRECATED: will not do anything",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"extraManifests": {
"description": "List of manifest files to be added to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Firewall specification for all controlplane nodes"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"extraManifests": {
"description": "List of manifest files to be added to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Firewall specification for all worker nodes"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 1422c8eb8b6e8fb37961a3427d2df0e6b8d9d8ab | 2024-02-20T04:37:05 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}{{if .Secureboot}}-secureboot{{end}}{{if and .Secureboot .UseUKI}}-uki.efi{{else}}.iso{{end}}",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer{{if .Secureboot}}-secureboot{{end}}/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
},
"secureboot": {
"default": false,
"description": "Whether to enable Secure Boot",
"type": "boolean"
},
"useUKI": {
"default": false,
"description": "Whether to use UKI if Secure Boot is enabled",
"type": "boolean"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
},
"physical": {
"type": "boolean"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ignoreHostname": {
"description": "Whether to set \"machine.network.hostname\" to the generated config file",
"type": "boolean"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"overrideExtraManifests": {
"description": "Whether \"extraManifests\" defined here should override the one defined in node group",
"type": "boolean"
},
"overridePatches": {
"description": "Whether \"patches\" defined here should override the one defined in node group",
"type": "boolean"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"NodeConfigs": {
"additionalProperties": false,
"properties": {
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 4493ad172c58fa0b1a0b713ae48ada1757be04d5 | 2024-01-23T07:35:41 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}{{if .Secureboot}}-secureboot{{end}}{{if and .Secureboot .UseUKI}}-uki.efi{{else}}.iso{{end}}",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer{{if .Secureboot}}-secureboot{{end}}/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
},
"secureboot": {
"default": false,
"description": "Whether to enable Secure Boot",
"type": "boolean"
},
"useUKI": {
"default": false,
"description": "Whether to use UKI if Secure Boot is enabled",
"type": "boolean"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"overrideExtraManifests": {
"description": "Whether \"extraManifests\" defined here should override the one defined in node group",
"type": "boolean"
},
"overridePatches": {
"description": "Whether \"patches\" defined here should override the one defined in node group",
"type": "boolean"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"NodeConfigs": {
"additionalProperties": false,
"properties": {
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 3c570ab5fe357c461beb37cf39d4ed4529fdbf9b | 2023-11-21T13:41:00 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | a2dba9e8a89b350c40927d5724b464635c40e1a1 | 2023-11-02T06:11:38 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 323f85fcc4564ffae4e858b92e7701368f7d6f55 | 2023-10-30T04:22:15 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"$ref": "#/$defs/InstallDiskSizeMatcher"
},
"type": {
"type": "integer"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallDiskSizeMatchData": {
"additionalProperties": false,
"properties": {
"Op": {
"type": "string"
},
"Size": {
"type": "integer"
}
},
"type": "object"
},
"InstallDiskSizeMatcher": {
"additionalProperties": false,
"properties": {
"MatchData": {
"$ref": "#/$defs/InstallDiskSizeMatchData"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelector",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
budimanjojo/talhelper | 0aea76680da4462030f5baef7fe270115c35f26e | 2023-11-29T04:51:26 | pkg/config/schemas/talconfig.json | 201 | 2024-05-27T05:43:50.188605Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"InstallExtensionConfig": {
"additionalProperties": false,
"properties": {
"image": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extensions": {
"description": "DEPRECATED: use \"schematic\" instead",
"items": {
"$ref": "#/$defs/InstallExtensionConfig"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/cniConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/controlPlane",
"description": "Configurations targetted for controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosImageURL": {
"default": "ghcr.io/siderolabs/installer",
"description": "The image URL used to perform installation",
"type": "string"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/worker",
"description": "Configurations targetted for worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
},
"cniConfig": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of CNI to use",
"type": "string"
},
"urls": {
"description": "List of URLs containing manifests to apply for the CNI",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"controlPlane": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all controlplane nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all controlplane nodes"
}
},
"type": "object"
},
"worker": {
"additionalProperties": false,
"properties": {
"configPatches": {
"description": "DEPRECATED: use \"patches\" instead",
"items": {
"type": "object"
},
"type": "array"
},
"inlinePatch": {
"description": "DEPRECATED: use \"patches\" instead",
"type": "object"
},
"patches": {
"description": "Patches to be applied to all worker nodes",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be applied to all worker nodes"
}
},
"type": "object"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | BSD-3-Clause | en |
ow-mods/owml | 480a66f6622e918848c8e15d860356c4f8abb99e | 2023-03-17T05:26:23 | schemas/config_schema.json | 79 | 2024-05-28T03:02:02.982291Z | {
"$docs": {
"Hide_In_Nav": true
},
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"definitions": {
"options": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"$ref": "#/definitions/optionsObject"
}
]
},
"type": "object"
},
"optionsNumber": {
"properties": {
"value": {
"type": "number"
}
},
"type": "object"
},
"optionsObject": {
"allOf": [
{
"properties": {
"dlcOnly": {
"description": "Should this setting only show when the DLC is owned?",
"type": "boolean"
},
"title": {
"description": "Label to show in the options menu",
"type": "string"
},
"tooltip": {
"description": "Tooltip to show when hovering on the option",
"type": "string"
},
"type": {
"enum": [
"separator",
"slider",
"toggle",
"selector",
"text",
"number"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"if": {
"properties": {
"type": {
"const": "separator"
}
}
},
"then": {
"$ref": "#/definitions/optionsSeparator"
}
},
{
"if": {
"properties": {
"type": {
"const": "toggle"
}
}
},
"then": {
"$ref": "#/definitions/optionsToggle"
}
},
{
"if": {
"properties": {
"type": {
"const": "number"
}
}
},
"then": {
"$ref": "#/definitions/optionsNumber"
}
},
{
"if": {
"properties": {
"type": {
"const": "text"
}
}
},
"then": {
"$ref": "#/definitions/optionsText"
}
},
{
"if": {
"properties": {
"type": {
"const": "slider"
}
}
},
"then": {
"$ref": "#/definitions/optionsSlider"
}
},
{
"if": {
"properties": {
"type": {
"const": "selector"
}
}
},
"then": {
"$ref": "#/definitions/optionsSelector"
}
}
]
},
"optionsSelector": {
"properties": {
"options": {
"description": "List of options the user selects from",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"type": "string"
}
},
"required": [
"options"
],
"type": "object"
},
"optionsSeparator": {
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"optionsSlider": {
"properties": {
"max": {
"description": "Maximum value for this slider",
"type": "number"
},
"min": {
"description": "Minimum value for this slider",
"type": "number"
},
"value": {
"type": "number"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"optionsText": {
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"optionsToggle": {
"properties": {
"value": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"$schema": {
"description": "The JSON schema for this config",
"type": "string"
},
"enabled": {
"description": "Should this mod be loaded?",
"type": "boolean"
},
"settings": {
"$ref": "#/definitions/options",
"description": "Options for users to edit"
}
},
"required": [
"enabled"
],
"type": "object"
} | MIT | en |
ow-mods/owml | 480a66f6622e918848c8e15d860356c4f8abb99e | 2023-03-17T05:26:23 | docs/content/pages/schemas/config_schema.json | 79 | 2024-05-28T03:02:02.982291Z | {
"$docs": {
"Hide_In_Nav": true
},
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"definitions": {
"options": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"$ref": "#/definitions/optionsObject"
}
]
},
"type": "object"
},
"optionsNumber": {
"properties": {
"value": {
"type": "number"
}
},
"type": "object"
},
"optionsObject": {
"allOf": [
{
"properties": {
"dlcOnly": {
"description": "Should this setting only show when the DLC is owned?",
"type": "boolean"
},
"title": {
"description": "Label to show in the options menu",
"type": "string"
},
"tooltip": {
"description": "Tooltip to show when hovering on the option",
"type": "string"
},
"type": {
"enum": [
"separator",
"slider",
"toggle",
"selector",
"text",
"number"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"if": {
"properties": {
"type": {
"const": "separator"
}
}
},
"then": {
"$ref": "#/definitions/optionsSeparator"
}
},
{
"if": {
"properties": {
"type": {
"const": "toggle"
}
}
},
"then": {
"$ref": "#/definitions/optionsToggle"
}
},
{
"if": {
"properties": {
"type": {
"const": "number"
}
}
},
"then": {
"$ref": "#/definitions/optionsNumber"
}
},
{
"if": {
"properties": {
"type": {
"const": "text"
}
}
},
"then": {
"$ref": "#/definitions/optionsText"
}
},
{
"if": {
"properties": {
"type": {
"const": "slider"
}
}
},
"then": {
"$ref": "#/definitions/optionsSlider"
}
},
{
"if": {
"properties": {
"type": {
"const": "selector"
}
}
},
"then": {
"$ref": "#/definitions/optionsSelector"
}
}
]
},
"optionsSelector": {
"properties": {
"options": {
"description": "List of options the user selects from",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"type": "string"
}
},
"required": [
"options"
],
"type": "object"
},
"optionsSeparator": {
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"optionsSlider": {
"properties": {
"max": {
"description": "Maximum value for this slider",
"type": "number"
},
"min": {
"description": "Minimum value for this slider",
"type": "number"
},
"value": {
"type": "number"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"optionsText": {
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"optionsToggle": {
"properties": {
"value": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"$schema": {
"description": "The JSON schema for this config",
"type": "string"
},
"enabled": {
"description": "Should this mod be loaded?",
"type": "boolean"
},
"settings": {
"$ref": "#/definitions/options",
"description": "Options for users to edit"
}
},
"required": [
"enabled"
],
"type": "object"
} | MIT | en |
YOURLS/charts | 439d7b1c3ea54e322125ce4ecb90f34646b239bc | 2021-03-17T01:21:55 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$schema": "https://json-schema.org/schema#",
"properties": {
"db": {
"description": "All of these values are only used when mysql.enabled is set to false",
"properties": {
"database": {
"default": "yourls",
"title": "Database name",
"type": "string"
},
"existingSecret": {
"default": "",
"title": "Database existing secret",
"type": "string"
},
"host": {
"default": "localhost:3306",
"title": "Database host",
"type": "string"
},
"password": {
"default": "",
"title": "Database password",
"type": "string"
},
"port": {
"default": "3306",
"title": "Database port",
"type": "integer"
},
"user": {
"default": "yourls",
"title": "Database user",
"type": "string"
}
},
"required": [
"database",
"host",
"password",
"port",
"user"
],
"title": "Database configuration",
"type": "object"
},
"extraEnv": {
"default": [],
"description": "Extra environment variables which will be saved in a release-specific secret or retrieved via valueFrom.",
"title": "Additional environment variables",
"type": "array"
},
"image": {
"description": "https://hub.docker.com/_/yourls?tab=tags",
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"title": "Image pull policy",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Secrets must be manually created in the namespace.",
"title": "Specify image pull secrets",
"type": "array"
},
"registry": {
"default": "docker.io",
"title": "YOURLS image registry",
"type": "string"
},
"repository": {
"default": "yourls",
"title": "YOURLS image name",
"type": "string"
},
"tag": {
"default": "1.8.1",
"title": "YOURLS image tag",
"type": "string"
}
},
"title": "YOURLS image version",
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"properties": {
"kubernetes.io/ingress.class": {
"default": "nginx",
"title": "Hub ingress class",
"type": "string"
}
},
"required": [
"kubernetes.io/ingress.class"
],
"title": "Hub ingress annotations",
"type": "object"
},
"enabled": {
"default": false,
"title": "Enable YOURLS ingress",
"type": "boolean"
},
"rules": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingressrule-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress rules",
"type": "array"
},
"tls": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingresstls-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress tls",
"type": "array"
}
},
"required": [
"annotations",
"enabled"
],
"type": "object"
},
"mysql": {
"default": {},
"description": "More information here: https://github.com/bitnami/charts/blob/master/bitnami/mysql/values.yaml",
"title": "MySQL chart configuration",
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"default": false,
"title": "Use persistent volume to store data",
"type": "boolean"
},
"size": {
"default": "10Gi",
"title": "Size of persistent volume claim",
"type": "string"
},
"storageClassName": {
"default": "",
"title": "Type of persistent volume claim",
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"replicaCount": {
"default": 1,
"title": "Number of app replicas",
"type": "integer"
},
"resources": {
"default": {},
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#resourcerequirements-v1-core",
"title": "Hub pod resource requirements",
"type": "object"
},
"service": {
"properties": {
"httpsPort": {
"default": 443,
"title": "YOURLS service secure port",
"type": "integer"
},
"port": {
"default": 80,
"title": "YOURLS service port",
"type": "integer"
},
"type": {
"default": "LoadBalancer",
"title": "YOURLS service type",
"type": "string"
}
},
"required": [
"port",
"type"
],
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"properties": {
"password": {
"default": "",
"description": "Defaults to a random 10-character alphanumeric string if not set",
"title": "Application password",
"type": "string"
},
"passwordExistingSecret": {
"default": "",
"description": "If set, yourls.password is ignored",
"title": "Existing secret with application password",
"type": "string"
},
"site": {
"default": "http://yourls",
"description": "Short URLs site referring to the app, used to construct short URLs.",
"title": "Site of the app",
"type": "string"
},
"tablePrefix": {
"default": "yourls_",
"title": "Table prefix",
"type": "string"
},
"username": {
"default": "user",
"title": "User of the application",
"type": "string"
}
},
"type": "object"
}
},
"required": [],
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | 4b0b3a9abb504133d5020e251a85abad7c17613f | 2021-10-31T03:05:08 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$schema": "https://json-schema.org/schema#",
"properties": {
"externalDatabase": {
"description": "If MySQL is disabled. Use this section to specify the external database details",
"form": true,
"properties": {
"database": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Name",
"type": "string"
},
"host": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Host",
"type": "string"
},
"password": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Password",
"type": "string"
},
"port": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Port",
"type": "integer"
},
"user": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Username",
"type": "string"
}
},
"title": "External Database Details",
"type": "object"
},
"ingress": {
"form": true,
"properties": {
"enabled": {
"description": "Enable the ingress resource that allows you to access the YOURLS installation.",
"form": true,
"title": "Use a custom hostname",
"type": "boolean"
},
"hostname": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Hostname",
"type": "string"
},
"tls": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Create a TLS secret",
"type": "boolean"
}
},
"title": "Ingress Configuration",
"type": "object"
},
"metrics": {
"properties": {
"enabled": {
"description": "Prometheus Exporter / Metrics",
"form": true,
"title": "Enable Metrics",
"type": "boolean"
}
},
"type": "object"
},
"mysql": {
"form": true,
"properties": {
"enabled": {
"description": "Whether to deploy a mysql server to satisfy the applications database requirements. To use an external database switch this off and configure the external database details",
"form": true,
"title": "Use a new MySQL database hosted in the cluster",
"type": "boolean"
},
"primary": {
"properties": {
"persistence": {
"properties": {
"size": {
"form": true,
"hidden": {
"path": "mysql/enabled",
"value": false
},
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Volume Size",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "MySQL Details",
"type": "object"
},
"persistence": {
"properties": {
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
},
"service": {
"form": true,
"properties": {
"type": {
"description": "Allowed values: \"ClusterIP\", \"NodePort\" and \"LoadBalancer\"",
"form": true,
"title": "Service Type",
"type": "string"
}
},
"title": "Service Configuration",
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Use an init container to set required folder permissions on the data volume before mounting it in the final destination",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
}
},
"type": "object"
},
"yourls": {
"form": true,
"properties": {
"domain": {
"form": true,
"title": "Domain",
"type": "string"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password",
"type": "string"
},
"scheme": {
"form": true,
"title": "Scheme",
"type": "string"
},
"username": {
"form": true,
"title": "Username",
"type": "string"
}
},
"title": "YOURLS Configuration parameters",
"type": "object"
}
},
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | 2bc6d4d14ef96767d0ccf9dd252fea2f2d9c2fe9 | 2021-03-19T01:33:42 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$schema": "https://json-schema.org/schema#",
"properties": {
"db": {
"description": "All of these values are only used when mysql.enabled is set to false",
"properties": {
"database": {
"default": "yourls",
"title": "Database name",
"type": "string"
},
"existingSecret": {
"default": "",
"title": "Database existing secret",
"type": "string"
},
"host": {
"default": "localhost:3306",
"title": "Database host",
"type": "string"
},
"password": {
"default": "",
"title": "Database password",
"type": "string"
},
"port": {
"default": "3306",
"title": "Database port",
"type": "integer"
},
"user": {
"default": "yourls",
"title": "Database user",
"type": "string"
}
},
"required": [
"database",
"host",
"password",
"port",
"user"
],
"title": "Database configuration",
"type": "object"
},
"extraEnv": {
"default": [],
"description": "Extra environment variables which will be saved in a release-specific secret or retrieved via valueFrom.",
"title": "Additional environment variables",
"type": "array"
},
"image": {
"description": "https://hub.docker.com/_/yourls?tab=tags",
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"title": "Image pull policy",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Secrets must be manually created in the namespace.",
"title": "Specify image pull secrets",
"type": "array"
},
"registry": {
"default": "docker.io",
"title": "YOURLS image registry",
"type": "string"
},
"repository": {
"default": "yourls",
"title": "YOURLS image name",
"type": "string"
},
"tag": {
"default": "{{ .Chart.AppVersion }}",
"title": "YOURLS image tag",
"type": "string"
}
},
"title": "YOURLS image version",
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"properties": {
"kubernetes.io/ingress.class": {
"default": "nginx",
"title": "Hub ingress class",
"type": "string"
}
},
"required": [
"kubernetes.io/ingress.class"
],
"title": "Hub ingress annotations",
"type": "object"
},
"enabled": {
"default": false,
"title": "Enable YOURLS ingress",
"type": "boolean"
},
"rules": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingressrule-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress rules",
"type": "array"
},
"tls": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingresstls-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress tls",
"type": "array"
}
},
"required": [
"annotations",
"enabled"
],
"type": "object"
},
"mysql": {
"default": {},
"description": "More information here: https://github.com/bitnami/charts/blob/master/bitnami/mysql/values.yaml",
"title": "MySQL chart configuration",
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"default": false,
"title": "Use persistent volume to store data",
"type": "boolean"
},
"size": {
"default": "10Gi",
"title": "Size of persistent volume claim",
"type": "string"
},
"storageClassName": {
"default": "",
"title": "Type of persistent volume claim",
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"replicaCount": {
"default": 1,
"title": "Number of app replicas",
"type": "integer"
},
"resources": {
"default": {},
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#resourcerequirements-v1-core",
"title": "Hub pod resource requirements",
"type": "object"
},
"service": {
"properties": {
"httpsPort": {
"default": 443,
"title": "YOURLS service secure port",
"type": "integer"
},
"port": {
"default": 80,
"title": "YOURLS service port",
"type": "integer"
},
"type": {
"default": "LoadBalancer",
"title": "YOURLS service type",
"type": "string"
}
},
"required": [
"port",
"type"
],
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"properties": {
"password": {
"default": "",
"description": "Defaults to a random 10-character alphanumeric string if not set",
"title": "Application password",
"type": "string"
},
"passwordExistingSecret": {
"default": "",
"description": "If set, yourls.password is ignored",
"title": "Existing secret with application password",
"type": "string"
},
"site": {
"default": "http://yourls",
"description": "Short URLs site referring to the app, used to construct short URLs.",
"title": "Site of the app",
"type": "string"
},
"tablePrefix": {
"default": "yourls_",
"title": "Table prefix",
"type": "string"
},
"username": {
"default": "user",
"title": "User of the application",
"type": "string"
}
},
"type": "object"
}
},
"required": [],
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | 9f298c50e203faae06a36d0bc1c3628bf24b39ae | 2021-02-09T23:58:02 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$schema": "https://json-schema.org/schema#",
"properties": {
"db": {
"description": "All of these values are only used when mysql.enabled is set to false",
"properties": {
"database": {
"default": "yourls",
"title": "Database name",
"type": "string"
},
"existingSecret": {
"default": "",
"title": "Database existing secret",
"type": "string"
},
"host": {
"default": "localhost:3306",
"title": "Database host",
"type": "string"
},
"password": {
"default": "",
"title": "Database password",
"type": "string"
},
"port": {
"default": "3306",
"title": "Database port",
"type": "integer"
},
"user": {
"default": "yourls",
"title": "Database user",
"type": "string"
}
},
"required": [
"database",
"host",
"password",
"port",
"user"
],
"title": "Database configuration",
"type": "object"
},
"extraEnv": {
"default": [],
"description": "Extra environment variables which will be saved in a release-specific secret or retrieved via valueFrom.",
"title": "Additional environment variables",
"type": "array"
},
"image": {
"description": "https://hub.docker.com/_/yourls?tab=tags",
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"title": "Image pull policy",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Secrets must be manually created in the namespace.",
"title": "Specify image pull secrets",
"type": "array"
},
"registry": {
"default": "docker.io",
"title": "YOURLS image registry",
"type": "string"
},
"repository": {
"default": "yourls",
"title": "YOURLS image name",
"type": "string"
},
"tag": {
"default": "1.7.9",
"title": "YOURLS image tag",
"type": "string"
}
},
"title": "YOURLS image version",
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"properties": {
"kubernetes.io/ingress.class": {
"default": "nginx",
"title": "Hub ingress class",
"type": "string"
}
},
"required": [
"kubernetes.io/ingress.class"
],
"title": "Hub ingress annotations",
"type": "object"
},
"enabled": {
"default": false,
"title": "Enable YOURLS ingress",
"type": "boolean"
},
"rules": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingressrule-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress rules",
"type": "array"
},
"tls": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingresstls-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress tls",
"type": "array"
}
},
"required": [
"annotations",
"enabled"
],
"type": "object"
},
"mysql": {
"default": {},
"description": "More information here: https://github.com/bitnami/charts/blob/master/bitnami/mysql/values.yaml",
"title": "MySQL chart configuration",
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"default": false,
"title": "Use persistent volume to store data",
"type": "boolean"
},
"size": {
"default": "10Gi",
"title": "Size of persistent volume claim",
"type": "string"
},
"storageClassName": {
"default": "",
"title": "Type of persistent volume claim",
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"replicaCount": {
"default": 1,
"title": "Number of app replicas",
"type": "integer"
},
"resources": {
"default": {},
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#resourcerequirements-v1-core",
"title": "Hub pod resource requirements",
"type": "object"
},
"service": {
"properties": {
"httpsPort": {
"default": 443,
"title": "YOURLS service secure port",
"type": "integer"
},
"port": {
"default": 80,
"title": "YOURLS service port",
"type": "integer"
},
"type": {
"default": "LoadBalancer",
"title": "YOURLS service type",
"type": "string"
}
},
"required": [
"port",
"type"
],
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"properties": {
"password": {
"default": "",
"description": "Defaults to a random 10-character alphanumeric string if not set",
"title": "Application password",
"type": "string"
},
"passwordExistingSecret": {
"default": "",
"description": "If set, yourls.password is ignored",
"title": "Existing secret with application password",
"type": "string"
},
"site": {
"default": "http://yourls",
"description": "Short URLs site referring to the app, used to construct short URLs.",
"title": "Site of the app",
"type": "string"
},
"tablePrefix": {
"default": "yourls_",
"title": "Table prefix",
"type": "string"
},
"username": {
"default": "user",
"title": "User of the application",
"type": "string"
}
},
"type": "object"
}
},
"required": [],
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | ae02a88dd82946f3ed7b2078cba70d7eb4966414 | 2022-02-28T00:34:55 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$defs": {
"image": {
"properties": {
"pullPolicy": {
"description": "Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'",
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"title": "Specify a imagePullPolicy",
"type": "string"
},
"pullSecrets": {
"description": "https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"title": "Optionally specify an array of imagePullSecrets",
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "Container image description",
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"httpHeaders": {
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"limits": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
}
},
"$schema": "https://json-schema.org/schema#",
"properties": {
"affinity": {
"type": "object"
},
"allowEmptyPassword": {
"type": "boolean"
},
"args": {
"type": "array"
},
"autoscaling": {
"properties": {
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"targetCPU": {
"type": "integer"
},
"targetMemory": {
"type": "integer"
}
},
"type": "object"
},
"clusterDomain": {
"type": "string"
},
"command": {
"type": "array"
},
"commonAnnotations": {
"type": "object"
},
"commonLabels": {
"type": "object"
},
"containerPorts": {
"properties": {
"http": {
"type": "integer"
},
"https": {
"type": "integer"
}
},
"type": "object"
},
"containerSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
},
"customLivenessProbe": {
"type": "object"
},
"customPostInitScripts": {
"type": "object"
},
"customReadinessProbe": {
"type": "object"
},
"diagnosticMode": {
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"externalDatabase": {
"description": "If MySQL is disabled. Use this section to specify the external database details",
"form": true,
"properties": {
"database": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Name",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"host": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Host",
"type": "string"
},
"password": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Password",
"type": "string"
},
"port": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Port",
"type": "integer"
},
"user": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Username",
"type": "string"
}
},
"title": "External Database Details",
"type": "object"
},
"extraContainerPorts": {
"type": "array"
},
"extraDeploy": {
"type": "array"
},
"extraEnvVars": {
"type": "array"
},
"extraEnvVarsCM": {
"type": "string"
},
"extraEnvVarsSecret": {
"type": "string"
},
"extraVolumeMounts": {
"type": "array"
},
"extraVolumes": {
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"type": "array"
},
"imageRegistry": {
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"type": "object"
},
"hostAliases": {
"items": {
"properties": {
"hostnames": {
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"allOf": [
{
"$ref": "#/$defs/image"
},
{
"properties": {
"appPath": {
"default": "/var/www/html",
"title": "Specify app files path",
"type": "string"
},
"debug": {
"default": false,
"title": "Enable image debug mode",
"type": "boolean"
}
}
}
],
"title": "YOURLS container image"
},
"ingress": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": "string"
},
"enabled": {
"description": "Enable the ingress resource that allows you to access the YOURLS installation.",
"form": true,
"title": "Use a custom hostname",
"type": "boolean"
},
"extraHosts": {
"type": "array"
},
"extraPaths": {
"type": "array"
},
"extraTls": {
"type": "array"
},
"hostname": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Hostname",
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"type": "string"
},
"secrets": {
"type": "array"
},
"selfSigned": {
"type": "boolean"
},
"tls": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Create a TLS secret",
"type": "boolean"
}
},
"title": "Ingress Configuration",
"type": "object"
},
"initContainers": {
"type": "array"
},
"kubeVersion": {
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"metrics": {
"properties": {
"enabled": {
"description": "Prometheus Exporter / Metrics",
"form": true,
"title": "Enable Metrics",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"service": {
"properties": {
"annotations": {
"properties": {
"prometheus.io/port": {
"type": "string"
},
"prometheus.io/scrape": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
}
},
"type": "object"
},
"serviceMonitor": {
"properties": {
"additionalLabels": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"honorLabels": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"namespace": {
"type": "string"
},
"relabellings": {
"type": "array"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"mysql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mysql/values.schema.json"
},
{
"properties": {
"enabled": {
"default": true,
"description": "Deploy a MySQL server to satisfy the application database",
"type": "boolean"
}
}
}
],
"description": "https://artifacthub.io/packages/helm/bitnami/mysql",
"title": "MySQL chart configuration"
},
"nameOverride": {
"type": "string"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array"
}
},
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"type": "string"
},
"minAvailable": {
"type": "integer"
}
},
"type": "object"
},
"persistence": {
"description": "https://kubernetes.io/docs/user-guide/persistent-volumes/",
"properties": {
"accessMode": {
"type": "string"
},
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"existingClaim": {
"type": "string"
},
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"title": "Persistence Parameters",
"type": "object"
},
"podAffinityPreset": {
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"title": "Number of YOURLS replicas to deploy",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/resources"
},
"schedulerName": {
"description": "https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/",
"type": "string"
},
"service": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"clusterIP": {
"type": "string"
},
"externalTrafficPolicy": {
"type": "string"
},
"extraPorts": {
"type": "array"
},
"httpsPort": {
"type": "integer"
},
"httpsTargetPort": {
"type": "string"
},
"loadBalancerIP": {
"type": "string"
},
"loadBalancerSourceRanges": {
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"type": "string"
},
"https": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"type": {
"description": "Allowed values: \"ClusterIP\", \"NodePort\" and \"LoadBalancer\"",
"form": true,
"title": "Service Type",
"type": "string"
}
},
"title": "Service Configuration",
"type": "object"
},
"serviceAccountName": {
"type": "string"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"type": "array"
},
"updateStrategy": {
"description": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy",
"properties": {
"rollingUpdate": {
"type": "object"
},
"type": {
"enum": [
"Recreate",
"RollingUpdate"
],
"type": "string"
}
},
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Use an init container to set required folder permissions on the data volume before mounting it in the final destination",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"securityContext": {
"properties": {
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"form": true,
"properties": {
"domain": {
"examples": [
"exemple.com"
],
"form": true,
"title": "Domain name for YOURLS",
"type": "string"
},
"existingSecret": {
"description": "Must contain keys `username` and `password`. When it's set, the `yourls.password` and `yourls.password` parameters are ignored.",
"title": "Name of existing secret containing YOURLS credentials",
"type": "string"
},
"extraConfigContent": {
"type": "string"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password",
"type": "string"
},
"plugins": {
"description": "Not currently in use",
"type": "string"
},
"scheme": {
"default": "http",
"enum": [
"http",
"https"
],
"form": true,
"title": "HTTP Scheme for YOURLS",
"type": "string"
},
"skipInstall": {
"type": "boolean"
},
"tablePrefix": {
"type": "string"
},
"username": {
"form": true,
"title": "Username",
"type": "string"
}
},
"required": [
"domain"
],
"title": "YOURLS Configuration parameters",
"type": "object"
}
},
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | 015a756a00882ccc2f043f83769927a4780cacbb | 2022-04-28T00:14:31 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$defs": {
"image": {
"properties": {
"pullPolicy": {
"description": "Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'",
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"title": "Specify a imagePullPolicy",
"type": "string"
},
"pullSecrets": {
"description": "https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"title": "Optionally specify an array of imagePullSecrets",
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "Container image description",
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"httpHeaders": {
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"limits": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
}
},
"$schema": "https://json-schema.org/schema#",
"properties": {
"affinity": {
"type": "object"
},
"allowEmptyPassword": {
"type": "boolean"
},
"args": {
"type": "array"
},
"autoscaling": {
"properties": {
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"targetCPU": {
"type": "integer"
},
"targetMemory": {
"type": "integer"
}
},
"type": "object"
},
"clusterDomain": {
"type": "string"
},
"command": {
"type": "array"
},
"commonAnnotations": {
"type": "object"
},
"commonLabels": {
"type": "object"
},
"containerPorts": {
"properties": {
"http": {
"type": "integer"
},
"https": {
"type": "integer"
}
},
"type": "object"
},
"containerSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
},
"customLivenessProbe": {
"type": "object"
},
"customPostInitScripts": {
"type": "object"
},
"customReadinessProbe": {
"type": "object"
},
"diagnosticMode": {
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"externalDatabase": {
"description": "If MariaDB is disabled. Use this section to specify the external database details",
"form": true,
"properties": {
"database": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Name",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"host": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Host",
"type": "string"
},
"password": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Password",
"type": "string"
},
"port": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Port",
"type": "integer"
},
"user": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Username",
"type": "string"
}
},
"title": "External Database Details",
"type": "object"
},
"extraContainerPorts": {
"type": "array"
},
"extraDeploy": {
"type": "array"
},
"extraEnvVars": {
"type": "array"
},
"extraEnvVarsCM": {
"type": "string"
},
"extraEnvVarsSecret": {
"type": "string"
},
"extraVolumeMounts": {
"type": "array"
},
"extraVolumes": {
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"type": "array"
},
"imageRegistry": {
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"type": "object"
},
"hostAliases": {
"items": {
"properties": {
"hostnames": {
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"allOf": [
{
"$ref": "#/$defs/image"
},
{
"properties": {
"appPath": {
"default": "/var/www/html",
"title": "Specify app files path",
"type": "string"
},
"debug": {
"default": false,
"title": "Enable image debug mode",
"type": "boolean"
}
}
}
],
"title": "YOURLS container image"
},
"ingress": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": "string"
},
"enabled": {
"description": "Enable the ingress resource that allows you to access the YOURLS installation.",
"form": true,
"title": "Use a custom hostname",
"type": "boolean"
},
"extraHosts": {
"type": "array"
},
"extraPaths": {
"type": "array"
},
"extraTls": {
"type": "array"
},
"hostname": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Hostname",
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"type": "string"
},
"secrets": {
"type": "array"
},
"selfSigned": {
"type": "boolean"
},
"tls": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Create a TLS secret",
"type": "boolean"
}
},
"title": "Ingress Configuration",
"type": "object"
},
"initContainers": {
"type": "array"
},
"kubeVersion": {
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"default": true,
"description": "Deploy a MariaDB server to satisfy the application database",
"type": "boolean"
}
}
}
],
"description": "https://artifacthub.io/packages/helm/bitnami/mariadb",
"title": "MariaDB chart configuration"
},
"metrics": {
"properties": {
"enabled": {
"description": "Prometheus Exporter / Metrics",
"form": true,
"title": "Enable Metrics",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"service": {
"properties": {
"annotations": {
"properties": {
"prometheus.io/port": {
"type": "string"
},
"prometheus.io/scrape": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
}
},
"type": "object"
},
"serviceMonitor": {
"properties": {
"additionalLabels": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"honorLabels": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"namespace": {
"type": "string"
},
"relabellings": {
"type": "array"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nameOverride": {
"type": "string"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array"
}
},
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"type": "string"
},
"minAvailable": {
"type": "integer"
}
},
"type": "object"
},
"persistence": {
"description": "https://kubernetes.io/docs/user-guide/persistent-volumes/",
"properties": {
"accessMode": {
"type": "string"
},
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"existingClaim": {
"type": "string"
},
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"title": "Persistence Parameters",
"type": "object"
},
"podAffinityPreset": {
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"title": "Number of YOURLS replicas to deploy",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/resources"
},
"schedulerName": {
"description": "https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/",
"type": "string"
},
"service": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"clusterIP": {
"type": "string"
},
"externalTrafficPolicy": {
"type": "string"
},
"extraPorts": {
"type": "array"
},
"httpsPort": {
"type": "integer"
},
"httpsTargetPort": {
"type": "string"
},
"loadBalancerIP": {
"type": "string"
},
"loadBalancerSourceRanges": {
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"type": "string"
},
"https": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"type": {
"description": "Allowed values: \"ClusterIP\", \"NodePort\" and \"LoadBalancer\"",
"form": true,
"title": "Service Type",
"type": "string"
}
},
"title": "Service Configuration",
"type": "object"
},
"serviceAccountName": {
"type": "string"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"type": "array"
},
"updateStrategy": {
"description": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy",
"properties": {
"rollingUpdate": {
"type": "object"
},
"type": {
"enum": [
"Recreate",
"RollingUpdate"
],
"type": "string"
}
},
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Use an init container to set required folder permissions on the data volume before mounting it in the final destination",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"securityContext": {
"properties": {
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"form": true,
"properties": {
"domain": {
"examples": [
"exemple.com"
],
"form": true,
"title": "Domain name for YOURLS",
"type": "string"
},
"existingSecret": {
"description": "Must contain keys `username` and `password`. When it's set, the `yourls.password` and `yourls.password` parameters are ignored.",
"title": "Name of existing secret containing YOURLS credentials",
"type": "string"
},
"extraConfigContent": {
"type": "string"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password",
"type": "string"
},
"plugins": {
"description": "Not currently in use",
"type": "string"
},
"scheme": {
"default": "http",
"enum": [
"http",
"https"
],
"form": true,
"title": "HTTP Scheme for YOURLS",
"type": "string"
},
"skipInstall": {
"type": "boolean"
},
"tablePrefix": {
"type": "string"
},
"username": {
"form": true,
"title": "Username",
"type": "string"
}
},
"required": [
"domain"
],
"title": "YOURLS Configuration parameters",
"type": "object"
}
},
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | b57fb3a9c87033d4659c6cebd31ab8c7d76cd51e | 2022-04-28T11:25:45 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$defs": {
"image": {
"properties": {
"pullPolicy": {
"description": "Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'",
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"title": "Specify a imagePullPolicy",
"type": "string"
},
"pullSecrets": {
"description": "https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"title": "Optionally specify an array of imagePullSecrets",
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "Container image description",
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"httpHeaders": {
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"limits": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
}
},
"$schema": "https://json-schema.org/schema#",
"properties": {
"affinity": {
"type": "object"
},
"allowEmptyPassword": {
"type": "boolean"
},
"args": {
"type": "array"
},
"autoscaling": {
"properties": {
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"targetCPU": {
"type": "integer"
},
"targetMemory": {
"type": "integer"
}
},
"type": "object"
},
"clusterDomain": {
"type": "string"
},
"command": {
"type": "array"
},
"commonAnnotations": {
"type": "object"
},
"commonLabels": {
"type": "object"
},
"containerPorts": {
"properties": {
"http": {
"type": "integer"
},
"https": {
"type": "integer"
}
},
"type": "object"
},
"containerSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
},
"customLivenessProbe": {
"type": "object"
},
"customPostInitScripts": {
"type": "object"
},
"customReadinessProbe": {
"type": "object"
},
"diagnosticMode": {
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"externalDatabase": {
"description": "If MariaDB is disabled. Use this section to specify the external database details",
"form": true,
"properties": {
"database": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Name",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"host": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Host",
"type": "string"
},
"password": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Password",
"type": "string"
},
"port": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Port",
"type": "integer"
},
"user": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Username",
"type": "string"
}
},
"title": "External Database Details",
"type": "object"
},
"extraContainerPorts": {
"type": "array"
},
"extraDeploy": {
"type": "array"
},
"extraEnvVars": {
"type": "array"
},
"extraEnvVarsCM": {
"type": "string"
},
"extraEnvVarsSecret": {
"type": "string"
},
"extraVolumeMounts": {
"type": "array"
},
"extraVolumes": {
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"type": "array"
},
"imageRegistry": {
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"type": "object"
},
"hostAliases": {
"items": {
"properties": {
"hostnames": {
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"allOf": [
{
"$ref": "#/$defs/image"
},
{
"properties": {
"appPath": {
"default": "/var/www/html",
"title": "Specify app files path",
"type": "string"
},
"debug": {
"default": false,
"title": "Enable image debug mode",
"type": "boolean"
}
}
}
],
"title": "YOURLS container image"
},
"ingress": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": "string"
},
"enabled": {
"description": "Enable the ingress resource that allows you to access the YOURLS installation.",
"form": true,
"title": "Use a custom hostname",
"type": "boolean"
},
"extraHosts": {
"type": "array"
},
"extraPaths": {
"type": "array"
},
"extraTls": {
"type": "array"
},
"hostname": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Hostname",
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"type": "string"
},
"secrets": {
"type": "array"
},
"selfSigned": {
"type": "boolean"
},
"tls": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Create a TLS secret",
"type": "boolean"
}
},
"title": "Ingress Configuration",
"type": "object"
},
"initContainers": {
"type": "array"
},
"kubeVersion": {
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"default": true,
"description": "Deploy a MariaDB server to satisfy the application database",
"type": "boolean"
}
}
}
],
"description": "https://artifacthub.io/packages/helm/bitnami/mariadb",
"title": "MariaDB chart configuration"
},
"metrics": {
"properties": {
"enabled": {
"description": "Prometheus Exporter / Metrics",
"form": true,
"title": "Enable Metrics",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"service": {
"properties": {
"annotations": {
"properties": {
"prometheus.io/port": {
"type": "string"
},
"prometheus.io/scrape": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
}
},
"type": "object"
},
"serviceMonitor": {
"properties": {
"additionalLabels": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"honorLabels": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"namespace": {
"type": "string"
},
"relabellings": {
"type": "array"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nameOverride": {
"type": "string"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array"
}
},
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"type": "string"
},
"minAvailable": {
"type": "integer"
}
},
"type": "object"
},
"persistence": {
"description": "https://kubernetes.io/docs/user-guide/persistent-volumes/",
"properties": {
"accessMode": {
"type": "string"
},
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"existingClaim": {
"type": "string"
},
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"title": "Persistence Parameters",
"type": "object"
},
"podAffinityPreset": {
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"title": "Number of YOURLS replicas to deploy",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/resources"
},
"schedulerName": {
"description": "https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/",
"type": "string"
},
"service": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"clusterIP": {
"type": "string"
},
"externalTrafficPolicy": {
"type": "string"
},
"extraPorts": {
"type": "array"
},
"httpsPort": {
"type": "integer"
},
"httpsTargetPort": {
"type": "string"
},
"loadBalancerIP": {
"type": "string"
},
"loadBalancerSourceRanges": {
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"type": "string"
},
"https": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"type": {
"description": "Allowed values: \"ClusterIP\", \"NodePort\" and \"LoadBalancer\"",
"form": true,
"title": "Service Type",
"type": "string"
}
},
"title": "Service Configuration",
"type": "object"
},
"serviceAccountName": {
"type": "string"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"type": "array"
},
"updateStrategy": {
"description": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy",
"properties": {
"rollingUpdate": {
"type": "object"
},
"type": {
"enum": [
"Recreate",
"RollingUpdate"
],
"type": "string"
}
},
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Use an init container to set required folder permissions on the data volume before mounting it in the final destination",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"securityContext": {
"properties": {
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"form": true,
"properties": {
"domain": {
"examples": [
"exemple.com"
],
"form": true,
"title": "Domain name for YOURLS",
"type": "string"
},
"existingSecret": {
"description": "Must contain keys `username` and `password`. When it's set, the `yourls.password` and `yourls.password` parameters are ignored.",
"title": "Name of existing secret containing YOURLS credentials",
"type": "string"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password",
"type": "string"
},
"scheme": {
"default": "http",
"enum": [
"http",
"https"
],
"form": true,
"title": "HTTP Scheme for YOURLS",
"type": "string"
},
"skipInstall": {
"type": "boolean"
},
"tablePrefix": {
"type": "string"
},
"username": {
"form": true,
"title": "Username",
"type": "string"
}
},
"required": [
"domain"
],
"title": "YOURLS Configuration parameters",
"type": "object"
}
},
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | 4d40d93d34b4a22cf2932f9bd17374cc6619ca45 | 2021-11-05T02:24:38 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$defs": {
"image": {
"properties": {
"pullPolicy": {
"description": "Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'",
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"title": "Specify a imagePullPolicy",
"type": "string"
},
"pullSecrets": {
"description": "https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"title": "Optionally specify an array of imagePullSecrets",
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "Container image description",
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"httpHeaders": {
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"limits": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
}
},
"$schema": "https://json-schema.org/schema#",
"properties": {
"affinity": {
"type": "object"
},
"allowEmptyPassword": {
"type": "boolean"
},
"args": {
"type": "array"
},
"autoscaling": {
"properties": {
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"targetCPU": {
"type": "integer"
},
"targetMemory": {
"type": "integer"
}
},
"type": "object"
},
"clusterDomain": {
"type": "string"
},
"command": {
"type": "array"
},
"commonAnnotations": {
"type": "object"
},
"commonLabels": {
"type": "object"
},
"containerPorts": {
"properties": {
"http": {
"type": "integer"
},
"https": {
"type": "integer"
}
},
"type": "object"
},
"containerSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
},
"customLivenessProbe": {
"type": "object"
},
"customPostInitScripts": {
"type": "object"
},
"customReadinessProbe": {
"type": "object"
},
"diagnosticMode": {
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"externalDatabase": {
"description": "If MySQL is disabled. Use this section to specify the external database details",
"form": true,
"properties": {
"database": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Name",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"host": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Host",
"type": "string"
},
"password": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Password",
"type": "string"
},
"port": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Port",
"type": "integer"
},
"user": {
"form": true,
"hidden": "mysql/enabled",
"title": "Database Username",
"type": "string"
}
},
"title": "External Database Details",
"type": "object"
},
"extraContainerPorts": {
"type": "array"
},
"extraDeploy": {
"type": "array"
},
"extraEnvVars": {
"type": "array"
},
"extraEnvVarsCM": {
"type": "string"
},
"extraEnvVarsSecret": {
"type": "string"
},
"extraVolumeMounts": {
"type": "array"
},
"extraVolumes": {
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"type": "array"
},
"imageRegistry": {
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"type": "object"
},
"hostAliases": {
"items": {
"properties": {
"hostnames": {
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"allOf": [
{
"$ref": "#/$defs/image"
},
{
"properties": {
"appPath": {
"default": "/var/www/html",
"title": "Specify app files path",
"type": "string"
},
"debug": {
"default": false,
"title": "Enable image debug mode",
"type": "boolean"
}
}
}
],
"title": "YOURLS container image"
},
"ingress": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": "string"
},
"enabled": {
"description": "Enable the ingress resource that allows you to access the YOURLS installation.",
"form": true,
"title": "Use a custom hostname",
"type": "boolean"
},
"extraHosts": {
"type": "array"
},
"extraPaths": {
"type": "array"
},
"extraTls": {
"type": "array"
},
"hostname": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Hostname",
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"type": "string"
},
"secrets": {
"type": "array"
},
"selfSigned": {
"type": "boolean"
},
"tls": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Create a TLS secret",
"type": "boolean"
}
},
"title": "Ingress Configuration",
"type": "object"
},
"initContainers": {
"type": "array"
},
"kubeVersion": {
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"metrics": {
"properties": {
"enabled": {
"description": "Prometheus Exporter / Metrics",
"form": true,
"title": "Enable Metrics",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"service": {
"properties": {
"annotations": {
"properties": {
"prometheus.io/port": {
"type": "string"
},
"prometheus.io/scrape": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
}
},
"type": "object"
},
"serviceMonitor": {
"properties": {
"additionalLabels": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"honorLabels": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"namespace": {
"type": "string"
},
"relabellings": {
"type": "array"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"mysql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mysql/values.schema.json"
},
{
"properties": {
"enabled": {
"default": true,
"description": "Deploy a MySQL server to satisfy the application database",
"type": "boolean"
}
}
}
],
"description": "https://artifacthub.io/packages/helm/bitnami/mysql",
"title": "MySQL chart configuration"
},
"nameOverride": {
"type": "string"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array"
}
},
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"type": "string"
},
"minAvailable": {
"type": "integer"
}
},
"type": "object"
},
"persistence": {
"description": "https://kubernetes.io/docs/user-guide/persistent-volumes/",
"properties": {
"accessMode": {
"type": "string"
},
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"existingClaim": {
"type": "string"
},
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"title": "Persistence Parameters",
"type": "object"
},
"podAffinityPreset": {
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"title": "Number of YOURLS replicas to deploy",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/resources"
},
"schedulerName": {
"description": "https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/",
"type": "string"
},
"service": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"clusterIP": {
"type": "string"
},
"externalTrafficPolicy": {
"type": "string"
},
"extraPorts": {
"type": "array"
},
"httpsPort": {
"type": "integer"
},
"httpsTargetPort": {
"type": "string"
},
"loadBalancerIP": {
"type": "string"
},
"loadBalancerSourceRanges": {
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"type": "string"
},
"https": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"type": {
"description": "Allowed values: \"ClusterIP\", \"NodePort\" and \"LoadBalancer\"",
"form": true,
"title": "Service Type",
"type": "string"
}
},
"title": "Service Configuration",
"type": "object"
},
"serviceAccountName": {
"type": "string"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"type": "array"
},
"updateStrategy": {
"description": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy",
"properties": {
"rollingUpdate": {
"type": "object"
},
"type": {
"enum": [
"Recreate",
"RollingUpdate"
],
"type": "string"
}
},
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Use an init container to set required folder permissions on the data volume before mounting it in the final destination",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"securityContext": {
"properties": {
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"form": true,
"properties": {
"domain": {
"examples": [
"exemple.com"
],
"form": true,
"title": "Domain name for YOURLS",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"extraConfigContent": {
"type": "string"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password",
"type": "string"
},
"plugins": {
"description": "Not currently in use",
"type": "string"
},
"scheme": {
"default": "http",
"enum": [
"http",
"https"
],
"form": true,
"title": "HTTP Scheme for YOURLS",
"type": "string"
},
"skipInstall": {
"type": "boolean"
},
"tablePrefix": {
"type": "string"
},
"username": {
"form": true,
"title": "Username",
"type": "string"
}
},
"required": [
"domain"
],
"title": "YOURLS Configuration parameters",
"type": "object"
}
},
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | fccb1f3c2bda116b28a648c7d422386fe93a27f0 | 2021-07-17T12:19:46 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$schema": "https://json-schema.org/schema#",
"properties": {
"db": {
"description": "All of these values are only used when mysql.enabled is set to false",
"properties": {
"database": {
"default": "yourls",
"title": "Database name",
"type": "string"
},
"existingSecret": {
"default": "",
"title": "Database existing secret",
"type": "string"
},
"host": {
"default": "localhost:3306",
"title": "Database host",
"type": "string"
},
"password": {
"default": "",
"title": "Database password",
"type": "string"
},
"port": {
"default": "3306",
"title": "Database port",
"type": "integer"
},
"user": {
"default": "yourls",
"title": "Database user",
"type": "string"
}
},
"required": [
"database",
"host",
"password",
"port",
"user"
],
"title": "Database configuration",
"type": "object"
},
"extraEnv": {
"default": [],
"description": "Extra environment variables which will be saved in a release-specific secret or retrieved via valueFrom.",
"title": "Additional environment variables",
"type": "array"
},
"image": {
"description": "https://hub.docker.com/_/yourls?tab=tags",
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"title": "Image pull policy",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Secrets must be manually created in the namespace.",
"title": "Specify image pull secrets",
"type": "array"
},
"registry": {
"default": "docker.io",
"title": "YOURLS image registry",
"type": "string"
},
"repository": {
"default": "yourls",
"title": "YOURLS image name",
"type": "string"
},
"tag": {
"default": "{{ .Chart.AppVersion }}",
"title": "YOURLS image tag",
"type": "string"
}
},
"title": "YOURLS image version",
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"properties": {
"kubernetes.io/ingress.class": {
"default": "nginx",
"title": "Hub ingress class",
"type": "string"
}
},
"required": [
"kubernetes.io/ingress.class"
],
"title": "Hub ingress annotations",
"type": "object"
},
"enabled": {
"default": false,
"title": "Enable YOURLS ingress",
"type": "boolean"
},
"hosts": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingressrule-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress rules",
"type": "array"
},
"tls": {
"default": [],
"items": {
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingresstls-v1-networking-k8s-io",
"type": "object"
},
"title": "YOURLS ingress tls",
"type": "array"
}
},
"required": [
"annotations",
"enabled"
],
"type": "object"
},
"mysql": {
"default": {},
"description": "More information here: https://github.com/bitnami/charts/blob/master/bitnami/mysql/values.yaml",
"title": "MySQL chart configuration",
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"default": false,
"title": "Use persistent volume to store data",
"type": "boolean"
},
"size": {
"default": "10Gi",
"title": "Size of persistent volume claim",
"type": "string"
},
"storageClassName": {
"default": "",
"title": "Type of persistent volume claim",
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"replicaCount": {
"default": 1,
"title": "Number of app replicas",
"type": "integer"
},
"resources": {
"default": {},
"description": "More information here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#resourcerequirements-v1-core",
"title": "Hub pod resource requirements",
"type": "object"
},
"service": {
"properties": {
"httpsPort": {
"default": 443,
"title": "YOURLS service secure port",
"type": "integer"
},
"port": {
"default": 80,
"title": "YOURLS service port",
"type": "integer"
},
"type": {
"default": "LoadBalancer",
"title": "YOURLS service type",
"type": "string"
}
},
"required": [
"port",
"type"
],
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"properties": {
"password": {
"default": "",
"description": "Defaults to a random 10-character alphanumeric string if not set",
"title": "Application password",
"type": "string"
},
"passwordExistingSecret": {
"default": "",
"description": "If set, yourls.password is ignored",
"title": "Existing secret with application password",
"type": "string"
},
"site": {
"default": "http://yourls",
"description": "Short URLs site referring to the app, used to construct short URLs.",
"title": "Site of the app",
"type": "string"
},
"tablePrefix": {
"default": "yourls_",
"title": "Table prefix",
"type": "string"
},
"username": {
"default": "user",
"title": "User of the application",
"type": "string"
}
},
"type": "object"
}
},
"required": [],
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
YOURLS/charts | 3cf20c88807b6691dc114137bf057385abca4ea6 | 2022-08-27T20:07:00 | charts/yourls/values.schema.json | 17 | 2024-05-29T10:28:13.513286Z | {
"$defs": {
"image": {
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"description": "Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'",
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"title": "Specify a imagePullPolicy",
"type": "string"
},
"pullSecrets": {
"description": "https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"title": "Optionally specify an array of imagePullSecrets",
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "Container image description",
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"httpHeaders": {
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"limits": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
}
},
"$schema": "https://json-schema.org/schema#",
"properties": {
"affinity": {
"type": "object"
},
"allowEmptyPassword": {
"type": "boolean"
},
"args": {
"type": "array"
},
"autoscaling": {
"properties": {
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"targetCPU": {
"type": "integer"
},
"targetMemory": {
"type": "integer"
}
},
"type": "object"
},
"clusterDomain": {
"type": "string"
},
"command": {
"type": "array"
},
"commonAnnotations": {
"type": "object"
},
"commonLabels": {
"type": "object"
},
"containerPorts": {
"properties": {
"http": {
"type": "integer"
},
"https": {
"type": "integer"
}
},
"type": "object"
},
"containerSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
},
"customLivenessProbe": {
"type": "object"
},
"customPostInitScripts": {
"type": "object"
},
"customReadinessProbe": {
"type": "object"
},
"diagnosticMode": {
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"externalDatabase": {
"description": "If MariaDB is disabled. Use this section to specify the external database details",
"form": true,
"properties": {
"database": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Name",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"host": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Host",
"type": "string"
},
"password": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Password",
"type": "string"
},
"port": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Port",
"type": "integer"
},
"user": {
"form": true,
"hidden": "mariadb/enabled",
"title": "Database Username",
"type": "string"
}
},
"title": "External Database Details",
"type": "object"
},
"extraContainerPorts": {
"type": "array"
},
"extraDeploy": {
"type": "array"
},
"extraEnvVars": {
"type": "array"
},
"extraEnvVarsCM": {
"type": "string"
},
"extraEnvVarsSecret": {
"type": "string"
},
"extraVolumeMounts": {
"type": "array"
},
"extraVolumes": {
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"type": "array"
},
"imageRegistry": {
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"type": "object"
},
"hostAliases": {
"items": {
"properties": {
"hostnames": {
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"allOf": [
{
"$ref": "#/$defs/image"
},
{
"properties": {
"appPath": {
"default": "/var/www/html",
"title": "Specify app files path",
"type": "string"
},
"debug": {
"default": false,
"title": "Enable image debug mode",
"type": "boolean"
}
}
}
],
"title": "YOURLS container image"
},
"ingress": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": "string"
},
"enabled": {
"description": "Enable the ingress resource that allows you to access the YOURLS installation.",
"form": true,
"title": "Use a custom hostname",
"type": "boolean"
},
"extraHosts": {
"type": "array"
},
"extraPaths": {
"type": "array"
},
"extraTls": {
"type": "array"
},
"hostname": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Hostname",
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"type": "string"
},
"secrets": {
"type": "array"
},
"selfSigned": {
"type": "boolean"
},
"tls": {
"form": true,
"hidden": {
"path": "ingress/enabled",
"value": false
},
"title": "Create a TLS secret",
"type": "boolean"
}
},
"title": "Ingress Configuration",
"type": "object"
},
"initContainers": {
"type": "array"
},
"kubeVersion": {
"type": "string"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"default": true,
"description": "Deploy a MariaDB server to satisfy the application database",
"type": "boolean"
}
}
}
],
"description": "https://artifacthub.io/packages/helm/bitnami/mariadb",
"title": "MariaDB chart configuration"
},
"metrics": {
"properties": {
"enabled": {
"description": "Prometheus Exporter / Metrics",
"form": true,
"title": "Enable Metrics",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"service": {
"properties": {
"annotations": {
"properties": {
"prometheus.io/port": {
"type": "string"
},
"prometheus.io/scrape": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
}
},
"type": "object"
},
"serviceMonitor": {
"properties": {
"additionalLabels": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"honorLabels": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"namespace": {
"type": "string"
},
"relabellings": {
"type": "array"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nameOverride": {
"type": "string"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array"
}
},
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"type": "string"
},
"minAvailable": {
"type": "integer"
}
},
"type": "object"
},
"persistence": {
"description": "https://kubernetes.io/docs/user-guide/persistent-volumes/",
"properties": {
"accessMode": {
"type": "string"
},
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"existingClaim": {
"type": "string"
},
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
},
"storageClass": {
"type": "string"
}
},
"title": "Persistence Parameters",
"type": "object"
},
"podAffinityPreset": {
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"title": "Number of YOURLS replicas to deploy",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/resources"
},
"schedulerName": {
"description": "https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/",
"type": "string"
},
"service": {
"form": true,
"properties": {
"annotations": {
"type": "object"
},
"clusterIP": {
"type": "string"
},
"externalTrafficPolicy": {
"type": "string"
},
"extraPorts": {
"type": "array"
},
"httpsPort": {
"type": "integer"
},
"httpsTargetPort": {
"type": "string"
},
"loadBalancerIP": {
"type": "string"
},
"loadBalancerSourceRanges": {
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"type": "string"
},
"https": {
"type": "string"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"type": {
"description": "Allowed values: \"ClusterIP\", \"NodePort\" and \"LoadBalancer\"",
"form": true,
"title": "Service Type",
"type": "string"
}
},
"title": "Service Configuration",
"type": "object"
},
"serviceAccountName": {
"type": "string"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"type": "array"
},
"updateStrategy": {
"description": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy",
"properties": {
"rollingUpdate": {
"type": "object"
},
"type": {
"enum": [
"Recreate",
"RollingUpdate"
],
"type": "string"
}
},
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Use an init container to set required folder permissions on the data volume before mounting it in the final destination",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/image"
},
"resources": {
"$ref": "#/$defs/resources"
},
"securityContext": {
"properties": {
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"yourls": {
"description": "https://hub.docker.com/_/yourls",
"form": true,
"properties": {
"domain": {
"examples": [
"exemple.com"
],
"form": true,
"title": "Domain name for YOURLS",
"type": "string"
},
"existingSecret": {
"description": "Must contain keys `username` and `password`. When it's set, the `yourls.password` and `yourls.password` parameters are ignored.",
"title": "Name of existing secret containing YOURLS credentials",
"type": "string"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password",
"type": "string"
},
"scheme": {
"default": "http",
"enum": [
"http",
"https"
],
"form": true,
"title": "HTTP Scheme for YOURLS",
"type": "string"
},
"skipInstall": {
"type": "boolean"
},
"tablePrefix": {
"type": "string"
},
"username": {
"form": true,
"title": "Username",
"type": "string"
}
},
"required": [
"domain"
],
"title": "YOURLS Configuration parameters",
"type": "object"
}
},
"title": "YOURLS Chart JSON Schema",
"type": "object"
} | MIT | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/jsons/entitlements.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"entitlements"
],
"description": "This examples include entitlements on macOS, which require code signing.",
"icon": null,
"name": "Example with entitlements on macOS",
"platforms": {
"osx": {
"CFBundleDisplayName": "My Example with entitlements on macOS",
"CFBundleName": "Entitlements",
"LSEnvironment": {
"example_var": "example_value"
},
"entitlements": [
"com.apple.security.files.user-selected.read-write"
]
}
}
}
],
"menu_name": "Example with entitlements"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/jsons/sys-prefix.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys; print(sys.prefix)"
],
"description": "This will install to Windows and Linux with default options. MacOS has a custom option.",
"icon": null,
"name": "Sys.Prefix",
"platforms": {
"linux": {},
"osx": {
"CFBundleName": "Sys Prefix"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import os, sys; f = open(r'__WIN_OUTPUT_FILE__', 'w'); f.write(sys.prefix); f.close()"
],
"description": "Note how __WIN_OUTPUT_FILE__ is using raw-strings. Otherwise the backslashes are not properly escaped."
}
}
}
],
"menu_name": "Sys.Prefix"
} | BSD-3-Clause | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/jsons/example-3.invalid.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"python",
"-m",
"this"
],
"description": "This is invalid because platforms.<os> cannot be a boolean",
"icon": null,
"name": "Example",
"platforms": {
"win": false
}
}
],
"menu_name": "Example 2"
} | BSD-3-Clause | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/pkgs/package_1/menu.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"${CONDA_PREFIX:-N/A}"
],
"description": "This will echo environment variables for test purposes",
"icon": null,
"name": "A",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"cmd",
"/V:ON",
"/C",
"echo",
"!CONDA_PREFIX!"
],
"terminal": true
}
}
},
{
"activate": false,
"command": [
"echo",
"${CONDA_PREFIX:-N/A}"
],
"description": "This one does not preactivate the environment",
"icon": null,
"name": "B",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"cmd",
"/V:ON",
"/C",
"echo",
"!CONDA_PREFIX!"
]
}
}
}
],
"menu_name": "Package 1"
} | BSD-3-Clause | en |
conda/menuinst | e992e76e4508bb58f798d52320b22936237c7e2d | 2023-06-15T13:21:13 | tests/data/jsons/precommands.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"$TEST_VAR"
],
"description": "This examples run some logic before activation.",
"icon": null,
"name": "Precommands",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"echo",
"%TEST_VAR%>",
"__OUTPUT_FILE__"
],
"description": "A space is needed after the > redirection, but if it's added in the same argument, it will trigger extra quoting that will break the syntax.",
"precommand": "set \"TEST_VAR=rhododendron and bees\""
}
},
"precommand": "export TEST_VAR=\"rhododendron and bees\""
}
],
"menu_name": "Example with precommands"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/jsons/precommands.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"$TEST_VAR"
],
"description": "This examples run some logic before activation.",
"icon": null,
"name": "Precommands",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"echo",
"%TEST_VAR%>",
"__WIN_OUTPUT_FILE__"
],
"description": "A space is needed after the > redirection, but if it's added in the same argument, it will trigger extra quoting that will break the syntax.",
"precommand": "set \"TEST_VAR=rhododendron and bees\""
}
},
"precommand": "export TEST_VAR=\"rhododendron and bees\""
}
],
"menu_name": "Example with precommands"
} | BSD-3-Clause | en |
conda/menuinst | 5e4e8e7f78657369a702a794883140f283015078 | 2024-01-11T09:58:20 | tests/data/jsons/sys-prefix.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys; print(sys.prefix)"
],
"description": "This will install to Windows and Linux with default options. MacOS has a custom option.",
"icon": null,
"name": "Sys.Prefix",
"platforms": {
"linux": {},
"osx": {
"CFBundleName": "Sys Prefix"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import sys; f = open(r'__OUTPUT_FILE__', 'w'); f.write(sys.prefix); f.close()"
],
"description": "Note how __OUTPUT_FILE__ is using raw-strings. Otherwise the backslashes are not properly escaped."
}
}
}
],
"menu_name": "Sys.Prefix {{ DISTRIBUTION_NAME }}"
} | BSD-3-Clause | en |
conda/menuinst | 0aa4be1a0e535f3181a9d2f6c5250476b6a5934f | 2024-05-08T16:31:23 | tests/data/jsons/menu-name.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"A"
],
"description": "This will echo environment variables for test purposes",
"icon": null,
"name": {
"target_environment_is_base": "A",
"target_environment_is_not_base": "A_not_in_base"
},
"platforms": {
"linux": {},
"osx": {},
"win": {}
}
},
{
"command": [
"echo",
"B"
],
"description": "This will echo environment variables for test purposes",
"icon": null,
"name": "B",
"platforms": {
"linux": {},
"osx": {},
"win": {}
}
}
],
"menu_name": "Package"
} | BSD-3-Clause | en |
conda/menuinst | e992e76e4508bb58f798d52320b22936237c7e2d | 2023-06-15T13:21:13 | tests/data/jsons/file_types.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(sys.argv[1])"
],
"description": "Testing file type association",
"icon": null,
"name": "FileTypeAssociation",
"platforms": {
"linux": {
"MimeType": [
"application/x-menuinst"
],
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(r'%f')"
],
"glob_patterns": {
"application/x-menuinst": "*.menuinst"
}
},
"osx": {
"CFBundleDocumentTypes": [
{
"CFBundleTypeName": "org.conda.menuinst.filetype-example",
"CFBundleTypeRole": "Viewer",
"LSHandlerRank": "Default",
"LSItemContentTypes": [
"org.conda.menuinst.main-file-uti"
]
}
],
"UTExportedTypeDeclarations": [
{
"UTTypeConformsTo": [
"public.data",
"public.content"
],
"UTTypeIdentifier": "org.conda.menuinst.main-file-uti",
"UTTypeTagSpecification": {
"public.filename-extension": [
"menuinst"
]
}
}
],
"command": [
"bash",
"-c",
"nc -l 40257 > __OUTPUT_FILE__"
],
"event_handler": "for i in 1 2 3 4 5; do echo \"$*\" | nc 127.0.0.1 40257 && break || sleep 1; done"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(r'%1')"
],
"file_extensions": [
".menuinst"
]
}
}
}
],
"menu_name": "Example with file type association"
} | BSD-3-Clause | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/jsons/precommands.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"$TEST_VAR"
],
"description": "This examples run some logic before activation.",
"icon": null,
"name": "Precommands",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"echo",
"%TEST_VAR%>",
"__WIN_OUTPUT_FILE__"
],
"description": "A space is needed after the > redirection, but if it's added in the same argument, it will trigger extra quoting that will break the syntax.",
"precommand": "set \"TEST_VAR=rhododendron and bees\""
}
},
"precommand": "export TEST_VAR=\"rhododendron and bees\""
}
],
"menu_name": "Example with precommands"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/jsons/entitlements.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"entitlements"
],
"description": "This examples include entitlements on macOS, which require code signing.",
"icon": null,
"name": "Example with entitlements on macOS",
"platforms": {
"osx": {
"CFBundleDisplayName": "My Example with entitlements on macOS",
"CFBundleName": "Entitlements",
"LSEnvironment": {
"example_var": "example_value"
},
"entitlements": [
"com.apple.security.files.user-selected.read-write"
]
}
}
}
],
"menu_name": "Example with entitlements"
} | BSD-3-Clause | en |
conda/menuinst | 416eaf9c844912835f92eba87884847a7db763fb | 2024-05-15T21:44:12 | tests/data/jsons/windows-terminal.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"testcommand_a.exe"
],
"description": "Package A",
"icon": null,
"name": "A",
"platforms": {
"win": {
"desktop": false,
"quicklaunch": false,
"terminal_profile": "A Terminal"
}
}
},
{
"command": [
"testcommand_b.exe"
],
"description": "Package B",
"icon": null,
"name": "B",
"platforms": {
"win": {
"desktop": false,
"quicklaunch": false
}
}
}
],
"menu_name": "Package"
} | BSD-3-Clause | en |
conda/menuinst | db528854422d765d9423eb7c705e06b0c7ade905 | 2024-02-06T16:47:24 | tests/data/jsons/file_types_no_event_handler.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(sys.argv[1])"
],
"description": "Testing file type association without event handler",
"icon": null,
"name": "FileTypeAssociationNoEventHandler",
"platforms": {
"osx": {
"CFBundleDocumentTypes": [
{
"CFBundleTypeName": "org.conda.menuinst.filetype-example-no-event-handler",
"CFBundleTypeRole": "Viewer",
"LSHandlerRank": "Default",
"LSItemContentTypes": [
"org.conda.menuinst.main-file-util-no-event-handler"
]
}
],
"UTExportedTypeDeclarations": [
{
"UTTypeConformsTo": [
"public.data",
"public.content"
],
"UTTypeIdentifier": "org.conda.menuinst.main-file-util-no-event-handler",
"UTTypeTagSpecification": {
"public.filename-extension": [
"menuinst-no-event-handler"
]
}
}
],
"command": [
"bash",
"-c",
"nc -l 40258 > __OUTPUT_FILE__"
]
}
}
}
],
"menu_name": "Example with file type association and no event handler (macOS only)"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/pkgs/package_1/menu.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"echo",
"${CONDA_PREFIX:-N/A}"
],
"description": "This will echo environment variables for test purposes",
"icon": null,
"name": "A",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"cmd",
"/V:ON",
"/C",
"echo",
"!CONDA_PREFIX!"
],
"terminal": true
}
}
},
{
"activate": false,
"command": [
"echo",
"${CONDA_PREFIX:-N/A}"
],
"description": "This one does not preactivate the environment",
"icon": null,
"name": "B",
"platforms": {
"linux": {},
"osx": {},
"win": {
"command": [
"cmd",
"/V:ON",
"/C",
"echo",
"!CONDA_PREFIX!"
]
}
}
}
],
"menu_name": "Package 1"
} | BSD-3-Clause | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/jsons/sys-prefix.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys; print(sys.prefix)"
],
"description": "This will install to Windows and Linux with default options. MacOS has a custom option.",
"icon": null,
"name": "Sys.Prefix",
"platforms": {
"linux": {},
"osx": {
"CFBundleName": "Sys Prefix"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import os, sys; f = open(r'__WIN_OUTPUT_FILE__', 'w'); f.write(sys.prefix); f.close()"
],
"description": "Note how __WIN_OUTPUT_FILE__ is using raw-strings. Otherwise the backslashes are not properly escaped."
}
}
}
],
"menu_name": "Sys.Prefix"
} | BSD-3-Clause | en |
conda/menuinst | e992e76e4508bb58f798d52320b22936237c7e2d | 2023-06-15T13:21:13 | tests/data/jsons/sys-prefix.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys; print(sys.prefix)"
],
"description": "This will install to Windows and Linux with default options. MacOS has a custom option.",
"icon": null,
"name": "Sys.Prefix",
"platforms": {
"linux": {},
"osx": {
"CFBundleName": "Sys Prefix"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import sys; f = open(r'__OUTPUT_FILE__', 'w'); f.write(sys.prefix); f.close()"
],
"description": "Note how __OUTPUT_FILE__ is using raw-strings. Otherwise the backslashes are not properly escaped."
}
}
}
],
"menu_name": "Sys.Prefix"
} | BSD-3-Clause | en |
conda/menuinst | 2416e74aa55250151cfd09893511ea585d16da18 | 2024-05-10T09:18:26 | tests/data/jsons/file_types.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(sys.argv[1])"
],
"description": "Testing file type association",
"icon": null,
"name": "FileTypeAssociation",
"platforms": {
"linux": {
"MimeType": [
"application/x-menuinst"
],
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(r'%f')"
],
"glob_patterns": {
"application/x-menuinst": "*.menuinst"
}
},
"osx": {
"CFBundleDocumentTypes": [
{
"CFBundleTypeName": "org.conda.menuinst.filetype-example",
"CFBundleTypeRole": "Viewer",
"LSHandlerRank": "Default",
"LSItemContentTypes": [
"org.conda.menuinst.main-file-uti"
]
}
],
"UTExportedTypeDeclarations": [
{
"UTTypeConformsTo": [
"public.data",
"public.content"
],
"UTTypeIdentifier": "org.conda.menuinst.main-file-uti",
"UTTypeTagSpecification": {
"public.filename-extension": [
"menuinst"
]
}
}
],
"command": [
"bash",
"-c",
"nc -l 40257 > __OUTPUT_FILE__"
],
"event_handler": "for i in 1 2 3 4 5; do echo \"$*\" | nc 127.0.0.1 40257 && break || sleep 1; done"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(r'%1')"
],
"file_extensions": [
".menuinst"
],
"icon": "doesnotexistbutitsok.{{ ICON_EXT }}"
}
}
}
],
"menu_name": "Example with file type association"
} | BSD-3-Clause | en |
conda/menuinst | da8133f4e3b9c7b9aae404bb861a21df403655de | 2024-05-21T16:06:03 | tests/data/jsons/working-dir.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys; print(sys.prefix)"
],
"description": "This will install to Windows and Linux with default options. MacOS has a custom option.",
"icon": null,
"name": "Sys.Prefix",
"platforms": {
"linux": {
"working_dir": "${TMP}/working_dir_test"
},
"osx": {
"CFBundleName": "Sys Prefix",
"working_dir": "${TMPDIR}/working_dir_test"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import sys; f = open(r'__OUTPUT_FILE__', 'w'); f.write(sys.prefix); f.close()"
],
"description": "Note how __OUTPUT_FILE__ is using raw-strings. Otherwise the backslashes are not properly escaped.",
"working_dir": "%TEMP%/working_dir_test"
}
}
}
],
"menu_name": "Sys.Prefix {{ DISTRIBUTION_NAME }}"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/jsons/osx_symlinks.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ MENU_ITEM_LOCATION }}/Contents/Resources/python",
"-c",
"import sys; print(sys.executable)"
],
"description": "This examples include symlinks on macOS, which require code signing.",
"icon": null,
"name": "Example with symlinks on macOS",
"platforms": {
"osx": {
"link_in_bundle": {
"{{ PREFIX }}/bin/python": "{{ MENU_ITEM_LOCATION }}/Contents/Resources/python"
}
}
}
}
],
"menu_name": "Example with macOS symlinks"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/jsons/no-platforms.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"python",
"-m",
"this"
],
"description": "This won't install to any platform because the 'platforms' key is empty.",
"icon": null,
"name": "NoPlatforms",
"platforms": {}
}
],
"menu_name": "NoPlatforms"
} | BSD-3-Clause | en |
conda/menuinst | e992e76e4508bb58f798d52320b22936237c7e2d | 2023-06-15T13:21:13 | tests/data/jsons/url_protocols.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(sys.argv[1])"
],
"description": "Testing OS integrations with file types and custom URLs",
"icon": null,
"name": "CustomURLAssociation",
"platforms": {
"linux": {
"MimeType": [
"x-scheme-handler/menuinst"
],
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(r'%u')"
]
},
"osx": {
"CFBundleIdentifier": "org.conda.menuinst.url-protocol-example",
"CFBundleURLTypes": [
{
"CFBundleURLName": "my-protocol-handler.menuinst",
"CFBundleURLSchemes": [
"menuinst"
]
}
],
"command": [
"bash",
"-c",
"nc -l 40256 > __OUTPUT_FILE__"
],
"event_handler": "for i in 1 2 3 4 5; do echo \"$*\" | nc 127.0.0.1 40256 && break || sleep 1; done"
},
"win": {
"command": [
"{{ PYTHON }}",
"-c",
"import sys, pathlib as p; p.Path(r'__OUTPUT_FILE__').write_text(r'%1')"
],
"url_protocols": [
"menuinst"
]
}
}
}
],
"menu_name": "Example with file custom URL association"
} | BSD-3-Clause | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/jsons/osx_symlinks.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"{{ MENU_ITEM_LOCATION }}/Contents/Resources/python",
"-c",
"import sys; print(sys.executable)"
],
"description": "This examples include symlinks on macOS, which require code signing.",
"icon": null,
"name": "Example with symlinks on macOS",
"platforms": {
"osx": {
"link_in_bundle": {
"{{ PREFIX }}/bin/python": "{{ MENU_ITEM_LOCATION }}/Contents/Resources/python"
}
}
}
}
],
"menu_name": "Example with macOS symlinks"
} | BSD-3-Clause | en |
conda/menuinst | b0199ae47be39903b533b39406dfcd837ccbe5d4 | 2023-03-06T15:24:01 | tests/data/jsons/example-3.invalid.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"python",
"-m",
"this"
],
"description": "This is invalid because platforms.<os> cannot be a boolean",
"icon": null,
"name": "Example",
"platforms": {
"win": false
}
}
],
"menu_name": "Example 2"
} | BSD-3-Clause | en |
conda/menuinst | 81af647e223d5cd75e93ccafa44839c8cd53be50 | 2023-01-12T22:51:39 | tests/data/jsons/no-platforms.json | 32 | 2024-05-29T16:25:51.555443Z | {
"$id": "https://schemas.conda.io/menuinst-1.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"menu_items": [
{
"command": [
"python",
"-m",
"this"
],
"description": "This won't install to any platform because the 'platforms' key is empty.",
"icon": null,
"name": "NoPlatforms",
"platforms": {}
}
],
"menu_name": "NoPlatforms"
} | BSD-3-Clause | en |
ZxBing0066/playground-public | 005f09cce01baa6beb180620d0fbf5d932891ace | 2022-08-08T08:45:01 | json-schema/my-schema.json | 7 | 2024-05-27T05:37:34.91106Z | {
"$id": "my-schema",
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"name": {
"properties": {
"firstName": {
"description": "First name",
"type": "string"
},
"lastName": {
"description": "Last name",
"type": "string"
},
"middleName": {
"description": "Middle name",
"type": "string"
}
},
"type": "object"
}
},
"properties": {
"age": {
"title": "this is your age",
"type": "number"
},
"fullName": {
"$ref": "#/definitions/name",
"description": "Full name"
},
"name": {
"title": "this is your name",
"type": "string"
}
}
} | MIT | en |
thecorecity/cognitum | 308b67bd4fe50376dfa64449cfecedea410e08a8 | 2020-07-03T11:05:36 | lib/schemas/db.schema.json | 13 | 2024-05-28T05:32:33.682206Z | {
"$id": "https://files.thecore.city/schemas/cognitum/db.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "JSON schema for database configuration file.",
"properties": {
"$schema": {
"type": "string"
},
"dbtype": {
"default": "inmemory",
"description": "Choosing one of the available database types. \"inmemory\" option used for debugging only.",
"enum": [
"inmemory",
"mariadb"
],
"title": "Database type",
"type": "string"
},
"mariadb": {
"additionalProperties": false,
"description": "Connection settings for MariaDB option",
"properties": {
"database": {
"default": "cognitum",
"title": "Name of database",
"type": "string"
},
"host": {
"default": "localhost",
"title": "host address",
"type": "string"
},
"password": {
"default": "root",
"title": "Password used to connect to the database",
"type": "string"
},
"username": {
"default": "root",
"title": "Username used to connect to the database",
"type": "string"
}
},
"required": [
"host",
"database",
"username",
"password"
],
"title": "MariaDB",
"type": "object"
},
"pool": {
"additionalProperties": false,
"description": "Sequelize ORM connection pool configuration. Optional.",
"properties": {
"acquire": {
"default": 60000,
"description": "The maximum time, in milliseconds, that pool will try to get connection before throwing error",
"type": "number"
},
"evict": {
"default": 1000,
"description": "The time interval, in milliseconds, after which sequelize-pool will remove idle connections.",
"type": "number"
},
"idle": {
"default": 10000,
"description": "The maximum time, in milliseconds, that a connection can be idle before being released",
"type": "number"
},
"max": {
"default": 5,
"description": "Maximum number of connection in pool",
"type": "number"
},
"min": {
"default": 0,
"description": "Minimum number of connection in pool",
"type": "number"
}
},
"title": "Database connection pool",
"type": "object"
}
},
"required": [
"dbtype"
],
"title": "Database configuration file",
"type": "object"
} | Apache-2.0 | en |
thecorecity/cognitum | 744599658d09d329ca0a410587bf45d01ba9df33 | 2020-07-26T10:39:20 | lib/schemas/db.schema.json | 13 | 2024-05-28T05:32:33.682206Z | {
"$id": "https://files.thecore.city/schemas/cognitum/db.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "JSON schema for database configuration file.",
"properties": {
"$schema": {
"type": "string"
},
"dbtype": {
"default": "dev",
"description": "Choosing one of the available database types. \"dev\" option used for development only.",
"enum": [
"dev",
"mariadb"
],
"title": "Database type",
"type": "string"
},
"mariadb": {
"additionalProperties": false,
"description": "Connection settings for MariaDB option",
"properties": {
"database": {
"default": "cognitum",
"title": "Name of database",
"type": "string"
},
"host": {
"default": "localhost",
"title": "host address",
"type": "string"
},
"password": {
"default": "root",
"title": "Password used to connect to the database",
"type": "string"
},
"username": {
"default": "root",
"title": "Username used to connect to the database",
"type": "string"
}
},
"required": [
"host",
"database",
"username",
"password"
],
"title": "MariaDB",
"type": "object"
},
"pool": {
"additionalProperties": false,
"description": "Sequelize ORM connection pool configuration. Optional.",
"properties": {
"acquire": {
"default": 60000,
"description": "The maximum time, in milliseconds, that pool will try to get connection before throwing error",
"type": "number"
},
"evict": {
"default": 1000,
"description": "The time interval, in milliseconds, after which sequelize-pool will remove idle connections.",
"type": "number"
},
"idle": {
"default": 10000,
"description": "The maximum time, in milliseconds, that a connection can be idle before being released",
"type": "number"
},
"max": {
"default": 5,
"description": "Maximum number of connection in pool",
"type": "number"
},
"min": {
"default": 0,
"description": "Minimum number of connection in pool",
"type": "number"
}
},
"title": "Database connection pool",
"type": "object"
}
},
"required": [
"dbtype"
],
"title": "Database configuration file",
"type": "object"
} | Apache-2.0 | en |
skyrising/mc-versions | 7d62792d137e2fd845caedf4f0090d90c66a85d4 | 2023-01-29T21:48:27 | data/schemas/version_manifest.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"mojangVersion": {
"description": "A version used by Mojang (very lenient)",
"pattern": "^[0-9a-zA-Z _.~-]*$",
"type": "string"
},
"releaseType": {
"description": "A release type (e.g. release, snapshot, etc.)",
"examples": [
"release",
"snapshot",
"old_alpha",
"old_beta"
],
"pattern": "^[a-z_]+$",
"type": "string"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/version_manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$schema": {
"format": "uri",
"type": "string"
},
"additionalProperties": false,
"latest": {
"additionalProperties": false,
"patternProperties": {
"^[a-z_]+$": {
"$ref": "#/$defs/version"
}
},
"type": "object"
},
"versions": {
"items": {
"properties": {
"details": {
"format": "uri-reference",
"type": "string"
},
"id": {
"$ref": "#/$defs/mojangVersion"
},
"omniId": {
"$ref": "#/$defs/version"
},
"releaseTime": {
"description": "The time this version was released",
"format": "date-time",
"type": "string"
},
"time": {
"description": "The time at which the manifest referenced in `url` was generated",
"format": "date-time",
"type": "string"
},
"type": {
"$ref": "#/$defs/releaseType"
},
"url": {
"format": "uri-reference",
"type": "string"
}
},
"required": [
"id",
"omniId",
"type",
"releaseTime",
"details"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
skyrising/mc-versions | 5ea321df4fba1a3f8d5c2cc7ba5c8f456c9cd486 | 2022-01-18T00:28:13 | data/schemas/version_manifest.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"mojangVersion": {
"description": "A version used by Mojang (very lenient)",
"pattern": "^[0-9a-zA-Z _.~-]*$",
"type": "string"
},
"releaseType": {
"description": "A release type (e.g. release, snapshot, etc.)",
"examples": [
"release",
"snapshot",
"old_alpha",
"old_beta"
],
"pattern": "^[a-z_]+$",
"type": "string"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/version_manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"latest": {
"additionalProperties": false,
"patternProperties": {
"^[a-z_]+$": {
"$ref": "#/$defs/version"
}
},
"type": "object"
},
"versions": {
"additionalProperties": false,
"items": {
"properties": {
"details": {
"format": "uri-reference",
"type": "string"
},
"id": {
"$ref": "#/$defs/mojangVersion"
},
"omniId": {
"$ref": "#/$defs/version"
},
"releaseTime": {
"description": "The time this version was released",
"format": "date-time",
"type": "string"
},
"time": {
"description": "The time at which the manifest referenced in `url` was generated",
"format": "date-time",
"type": "string"
},
"type": {
"$ref": "#/$defs/releaseType"
},
"url": {
"deprecated": true,
"format": "uri-reference",
"type": "string"
}
},
"required": [
"id",
"omniId",
"type",
"releaseTime",
"details"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
skyrising/mc-versions | 9df725285b7e4a476fb478f88a0efd173da7586d | 2022-06-16T13:58:20 | data/schemas/version.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"downloadInfo": {
"additionalProperties": false,
"properties": {
"sha1": {
"$ref": "#/$defs/sha1"
},
"size": {
"minimum": 0,
"type": "integer"
},
"url": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"manifestInfo": {
"properties": {
"assetHash": {
"$ref": "#/$defs/sha1"
},
"assetIndex": {
"type": "string"
},
"downloads": {
"$ref": "#/$defs/sha1"
},
"downloadsId": {
"minimum": 1,
"type": "integer"
},
"hash": {
"$ref": "#/$defs/sha1"
},
"time": {
"format": "date-time",
"type": "string"
},
"type": {
"$ref": "#/$defs/releaseType"
},
"url": {
"format": "uri-reference",
"type": "string"
}
},
"type": "object"
},
"protocolVersion": {
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"classic",
"modern",
"netty",
"netty-snapshot"
]
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"type",
"version"
],
"type": "object"
},
"releaseType": {
"description": "A release type (e.g. release, snapshot, etc.)",
"examples": [
"release",
"snapshot",
"old_alpha",
"old_beta"
],
"pattern": "^[a-z_]+$",
"type": "string"
},
"semver": {
"description": "A version number in SemVer format (see https://semver.org/ for the specification)",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
"type": "string"
},
"sha1": {
"description": "The SHA-1 hash of a file",
"pattern": "^[0-9a-f]{40}$",
"type": "string"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
},
"worldFormat": {
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"alpha",
"region",
"anvil"
]
},
"version": {
"type": "integer"
}
},
"required": [
"format"
],
"type": "object"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/version.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"client": {
"description": "Whether `downloads` includes a client",
"type": "boolean"
},
"downloads": {
"additionalProperties": false,
"patternProperties": {
"^[a-z_]*$": {
"$ref": "#/$defs/downloadInfo"
}
}
},
"id": {
"$ref": "#/$defs/version"
},
"libraries": {
"items": {
"type": "string"
},
"type": "array"
},
"manifests": {
"items": {
"$ref": "#/$defs/manifestInfo"
},
"type": "array"
},
"next": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
},
"normalizedVersion": {
"$ref": "#/$defs/semver"
},
"previous": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
},
"protocol": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"classic",
"modern",
"netty",
"netty-snapshot"
]
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"type",
"version"
],
"type": "object"
},
{
"type": "null"
}
]
},
"releaseTarget": {
"$ref": "#/$defs/semver"
},
"releaseTime": {
"format": "date-time",
"type": "string"
},
"server": {
"description": "Whether `downloads` includes a server",
"type": "boolean"
},
"sharedMappings": {
"description": "Whether the obfuscation mappings for client and server are the same",
"type": "boolean"
},
"world": {
"$ref": "#/$defs/worldFormat"
}
},
"required": [
"id",
"client",
"server",
"downloads",
"normalizedVersion",
"previous",
"next",
"releaseTarget",
"releaseTime",
"protocol",
"world",
"libraries"
],
"type": "object"
} | MIT | en |
skyrising/mc-versions | 706cf3e28057c18b84bef7e1858ffde36b40558c | 2023-05-18T23:13:51 | data/schemas/version_manifest.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"releaseType": {
"description": "A release type (e.g. release, snapshot, etc.)",
"examples": [
"release",
"snapshot",
"old_alpha",
"old_beta"
],
"pattern": "^[a-z_]+$",
"type": "string"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/version_manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$schema": {
"format": "uri",
"type": "string"
},
"additionalProperties": false,
"latest": {
"additionalProperties": false,
"patternProperties": {
"^[a-z_]+$": {
"$ref": "#/$defs/version"
}
},
"type": "object"
},
"versions": {
"items": {
"properties": {
"details": {
"format": "uri-reference",
"type": "string"
},
"id": {
"$ref": "#/$defs/version"
},
"releaseTime": {
"description": "The time this version was released",
"format": "date-time",
"type": "string"
},
"time": {
"description": "The time at which the manifest referenced in `url` was generated",
"format": "date-time",
"type": "string"
},
"type": {
"$ref": "#/$defs/releaseType"
},
"url": {
"format": "uri-reference",
"type": "string"
}
},
"required": [
"id",
"omniId",
"type",
"releaseTime",
"details"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
skyrising/mc-versions | 5ea321df4fba1a3f8d5c2cc7ba5c8f456c9cd486 | 2022-01-18T00:28:13 | data/schemas/version.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"downloadInfo": {
"additionalProperties": false,
"properties": {
"sha1": {
"$ref": "#/$defs/sha1"
},
"size": {
"minimum": 0,
"type": "integer"
},
"url": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"manifestInfo": {
"properties": {
"assetHash": {
"$ref": "#/$defs/sha1"
},
"assetIndex": {
"type": "string"
},
"downloads": {
"$ref": "#/$defs/sha1"
},
"downloadsId": {
"minimum": 1,
"type": "integer"
},
"hash": {
"$ref": "#/$defs/sha1"
},
"time": {
"format": "date-time",
"type": "string"
},
"type": {
"$ref": "#/$defs/releaseType"
},
"url": {
"format": "uri-reference",
"type": "string"
}
},
"type": "object"
},
"protocolVersion": {
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"classic",
"modern",
"netty",
"netty-snapshot"
]
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"type",
"version"
],
"type": "object"
},
"releaseType": {
"description": "A release type (e.g. release, snapshot, etc.)",
"examples": [
"release",
"snapshot",
"old_alpha",
"old_beta"
],
"pattern": "^[a-z_]+$",
"type": "string"
},
"semver": {
"description": "A version number in SemVer format (see https://semver.org/ for the specification)",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
"type": "string"
},
"sha1": {
"description": "The SHA-1 hash of a file",
"pattern": "^[0-9a-f]{40}$",
"type": "string"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
},
"worldFormat": {
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"alpha",
"region",
"anvil"
]
},
"version": {
"type": "integer"
}
},
"required": [
"format"
],
"type": "object"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/version.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"client": {
"description": "Whether `downloads` includes a client",
"type": "boolean"
},
"downloads": {
"additionalProperties": false,
"patternProperties": {
"^[a-z_]*$": {
"$ref": "#/$defs/downloadInfo"
}
}
},
"id": {
"$ref": "#/$defs/version"
},
"manifests": {
"items": {
"$ref": "#/$defs/manifestInfo"
},
"type": "array"
},
"next": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
},
"normalizedVersion": {
"$ref": "#/$defs/semver"
},
"previous": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
},
"protocol": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"classic",
"modern",
"netty",
"netty-snapshot"
]
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"type",
"version"
],
"type": "object"
},
{
"type": "null"
}
]
},
"releaseTarget": {
"$ref": "#/$defs/semver"
},
"releaseTime": {
"format": "date-time",
"type": "string"
},
"server": {
"description": "Whether `downloads` includes a server",
"type": "boolean"
},
"sharedMappings": {
"description": "Whether the obfuscation mappings for client and server are the same",
"type": "boolean"
},
"world": {
"$ref": "#/$defs/worldFormat"
}
},
"required": [
"id",
"client",
"server",
"downloads",
"normalizedVersion",
"previous",
"next",
"releaseTarget",
"releaseTime",
"protocol",
"world"
],
"type": "object"
} | MIT | en |
skyrising/mc-versions | 8333445ef8877a7550fc1441ada590d9b60c0341 | 2022-01-19T17:30:23 | data/schemas/protocol.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"protocolVersion": {
"additionalProperties": false,
"properties": {
"clients": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
},
"servers": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"version",
"clients",
"servers"
],
"type": "object"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/protocol.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"format": "uri",
"type": "string"
},
"type": {
"enum": [
"classic",
"modern",
"netty",
"netty-snapshot"
]
},
"versions": {
"items": {
"$ref": "#/$defs/protocolVersion"
},
"type": "array"
}
},
"required": [
"type",
"versions"
],
"type": "object"
} | MIT | en |
skyrising/mc-versions | 8333445ef8877a7550fc1441ada590d9b60c0341 | 2022-01-19T17:30:23 | data/schemas/version_manifest.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"mojangVersion": {
"description": "A version used by Mojang (very lenient)",
"pattern": "^[0-9a-zA-Z _.~-]*$",
"type": "string"
},
"releaseType": {
"description": "A release type (e.g. release, snapshot, etc.)",
"examples": [
"release",
"snapshot",
"old_alpha",
"old_beta"
],
"pattern": "^[a-z_]+$",
"type": "string"
},
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/version_manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$schema": {
"format": "uri",
"type": "string"
},
"additionalProperties": false,
"latest": {
"additionalProperties": false,
"patternProperties": {
"^[a-z_]+$": {
"$ref": "#/$defs/version"
}
},
"type": "object"
},
"versions": {
"items": {
"properties": {
"details": {
"format": "uri-reference",
"type": "string"
},
"id": {
"$ref": "#/$defs/mojangVersion"
},
"omniId": {
"$ref": "#/$defs/version"
},
"releaseTime": {
"description": "The time this version was released",
"format": "date-time",
"type": "string"
},
"time": {
"description": "The time at which the manifest referenced in `url` was generated",
"format": "date-time",
"type": "string"
},
"type": {
"$ref": "#/$defs/releaseType"
},
"url": {
"deprecated": true,
"format": "uri-reference",
"type": "string"
}
},
"required": [
"id",
"omniId",
"type",
"releaseTime",
"details"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
skyrising/mc-versions | 8333445ef8877a7550fc1441ada590d9b60c0341 | 2022-01-19T17:30:23 | data/schemas/release_targets.json | 9 | 2024-05-28T04:04:58.481534Z | {
"$defs": {
"version": {
"description": "A version in the Omniarchive format",
"pattern": "^(((server-)?([abc]|inf?-|rd-|af-)?[0-9]+[.0-9]*)|[0-9]{2}w[0-9]{2}[a-z~])a?([_-][0-9a-z]+)*$",
"type": "string"
}
},
"$id": "https://skyrising.github.io/mc-versions/schemas/release_targets.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"patternProperties": {
"^[0-9]+(\\.[0-9]+){1,2}$": {
"items": {
"$ref": "#/$defs/version"
},
"type": "array"
}
},
"properties": {
"$schema": {
"format": "uri",
"type": "string"
}
},
"required": [
"type",
"versions"
],
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | cb4266c8ef8771f36d633b895079780d39a7db06 | 2023-04-28T08:15:00 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Context"
],
"title": "DbContext output path",
"type": "string"
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"required": [
"name"
],
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": "string"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": "string"
},
"root-namespace": {
"default": null,
"examples": [
null
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of a to a class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"required": [
"name"
],
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"views",
"stored-procedures",
"functions",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 087b41b42d7f20291cbcc06443f07f389180f737 | 2023-12-29T09:52:50 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"remove-defaultsql-from-bool-properties": false,
"remove-valuegeneratedonadd": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"generate-mermaid-diagram": {
"default": false,
"examples": [
false
],
"title": "Create a markdown file with a Mermaid ER diagram during scaffolding",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | ef19a8ffa7838665066e7820966eb1a6339d01b9 | 2023-04-23T18:37:12 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "The discover-multiple-stored-procedure-resultsets-preview Schema",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "The enable-on-configuring Schema",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "The remove-defaultsql-from-bool-properties Schema",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "The soft-delete-obsolete-files Schema",
"type": "boolean"
},
"type": {
"default": "",
"examples": [
"all"
],
"title": "The type Schema",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "The use-alternate-stored-procedure-resultset-discovery Schema",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "The use-data-annotations Schema",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "The use-database-names Schema",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "The use-inflector Schema",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "The use-legacy-inflector Schema",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "The use-many-to-many-entity Schema",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": false,
"examples": [
true
],
"title": "The use-nullable-reference-types Schema",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "The use-t4 Schema",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "The code-generation Schema",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
null
],
"title": "The output-dbcontext-path Schema",
"type": "null"
},
"output-path": {
"default": "",
"examples": [
"Models"
],
"title": "The output-path Schema",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "The split-dbcontext-preview Schema",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "The use-schema-folders-preview Schema",
"type": "boolean"
}
},
"required": [
"output-path",
"output-dbcontext-path",
"split-dbcontext-preview",
"use-schema-folders-preview"
],
"title": "The file-layout Schema",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The functions Schema",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "The dbcontext-name Schema",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "The dbcontext-namespace Schema",
"type": "null"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "The model-namespace Schema",
"type": "null"
}
},
"required": [
"dbcontext-name",
"dbcontext-namespace",
"model-namespace"
],
"title": "The names Schema",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "The preserve-casing-with-regex Schema",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "A Schema",
"type": "string"
},
"title": "The uncountable-words Schema",
"type": "array"
}
},
"required": [
"preserve-casing-with-regex",
"uncountable-words"
],
"title": "The replacements Schema",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"mapped-type": {
"default": "",
"examples": [
"Customer"
],
"title": "The mapped-type Schema",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The name Schema",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "The use-legacy-resultset-discovery Schema",
"type": "boolean"
}
},
"required": [
"name",
"use-legacy-resultset-discovery",
"mapped-type"
],
"title": "A Schema",
"type": "object"
},
"title": "The stored-procedures Schema",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "The exclude Schema",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]",
"[dbo].[Oldtable]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name",
"exclude"
],
"title": "A Schema",
"type": "object"
},
"title": "The tables Schema",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "The use-DateOnly-TimeOnly Schema",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "The use-HierarchyId Schema",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "The use-NodaTime Schema",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "The use-spatial Schema",
"type": "boolean"
}
},
"required": [
"use-DateOnly-TimeOnly",
"use-HierarchyId",
"use-spatial",
"use-NodaTime"
],
"title": "The type-mappings Schema",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The views Schema",
"type": "array"
}
},
"required": [
"tables",
"views",
"stored-procedures",
"functions",
"code-generation",
"names",
"file-layout",
"type-mappings",
"replacements"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 966b55355d9c15dfdbe6eb451492443704cb3008 | 2023-12-19T13:45:58 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"remove-defaultsql-from-bool-properties": false,
"remove-valuegeneratedonadd": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"remove-valuegeneratedonadd": {
"default": false,
"examples": [
false
],
"title": "Remove ValeGeneratedOnAdd() from entity configuration, useful with Oracle",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 1179c3185c9e6ae8c70b6ef131da5d5ebd751a3a | 2023-05-27T14:28:40 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | f9a056f8a14c0a76511c1d134572c0c989cf3b70 | 2023-05-05T13:02:03 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Context"
],
"title": "DbContext output path",
"type": "string"
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": "string"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": "string"
},
"root-namespace": {
"default": null,
"examples": [
null
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of a to a class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | a23f1a691796fd9739d8503e0f26c618a6e5a7dd | 2023-10-27T09:33:16 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | d3d3c24cfce90e117ed8b4e5356c4eddecbb0f9c | 2023-04-24T19:01:57 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Context"
],
"title": "DbContext output path",
"type": "string"
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"required": [
"name"
],
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": "string"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": "string"
},
"root-namespace": {
"default": null,
"examples": [
null
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of a to a class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"required": [
"name"
],
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"views",
"stored-procedures",
"functions",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 1ed0eb9e86cddba479c3c790ea1da80f2c0c06d6 | 2023-12-21T10:22:57 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"remove-defaultsql-from-bool-properties": false,
"remove-valuegeneratedonadd": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"remove-valuegeneratedonadd": {
"default": false,
"examples": [
false
],
"title": "Remove ValeGeneratedOnAdd() from entity configuration, useful with Oracle",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 72a9511f276236de5c06d94fe454ff45ad9cd71f | 2023-07-12T07:16:48 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": "all",
"title": "Global path to T4 templates",
"type": "string"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 5f77ce6c974b2d0fd1ea8f546c33c458ca57adef | 2024-01-19T08:25:47 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"refresh-object-lists": true,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"refresh-object-lists": true,
"remove-defaultsql-from-bool-properties": false,
"remove-valuegeneratedonadd": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"generate-mermaid-diagram": {
"default": false,
"examples": [
false
],
"title": "Create a markdown file with a Mermaid ER diagram during scaffolding",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"refresh-object-lists": {
"default": true,
"examples": [
false
],
"title": "Refresh the lists of objects (tables, views, stored procedures, functions) from the database in the config file during scaffolding",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 79fc482a06a729e4140db4be5a970e3438e5ebee | 2023-05-02T15:41:40 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Context"
],
"title": "DbContext output path",
"type": "string"
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"default": null,
"examples": [
true
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": "string"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": "string"
},
"root-namespace": {
"default": null,
"examples": [
null
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"default": null,
"examples": [
true
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of a to a class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"default": null,
"examples": [
true
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"default": null,
"examples": [
true
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 0d22712054ee760d2e9546b0a48f5110e0ac4ef5 | 2024-01-22T14:03:50 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"refresh-object-lists": true,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"excludedColumns": [
"Name",
"Email"
],
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"excludedColumns": [
"Name",
"Email"
],
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"refresh-object-lists": true,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"generate-mermaid-diagram": {
"default": false,
"examples": [
false
],
"title": "Create a markdown file with a Mermaid ER diagram during scaffolding",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"refresh-object-lists": {
"default": true,
"examples": [
false
],
"title": "Refresh the lists of objects (tables, views, stored procedures, functions) from the database in the config file during scaffolding",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"excludedColumns": {
"default": [],
"examples": [
[
"Name",
"Email"
]
],
"items": {
"examples": [
"Name",
"Email"
],
"title": "Column",
"type": "string"
},
"title": "Columns to Exclude from code generation",
"type": "array"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"excludedColumns": {
"default": [],
"examples": [
[
"Name",
"Email"
]
],
"items": {
"examples": [
"Name",
"Email"
],
"title": "Column",
"type": "string"
},
"title": "Columns to Exclude from code generation",
"type": "array"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | dd26bc06404276203a9baf4a4b2cda1f4c205a8f | 2023-04-24T10:26:02 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "The discover-multiple-stored-procedure-resultsets-preview Schema",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "The enable-on-configuring Schema",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "The remove-defaultsql-from-bool-properties Schema",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "The soft-delete-obsolete-files Schema",
"type": "boolean"
},
"type": {
"default": "",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "The type Schema",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "The use-alternate-stored-procedure-resultset-discovery Schema",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "The use-data-annotations Schema",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "The use-database-names Schema",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "The use-inflector Schema",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "The use-legacy-inflector Schema",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "The use-many-to-many-entity Schema",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": false,
"examples": [
true
],
"title": "The use-nullable-reference-types Schema",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "The use-t4 Schema",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "The code-generation Schema",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
null
],
"title": "The output-dbcontext-path Schema",
"type": "string"
},
"output-path": {
"default": "",
"examples": [
"Models"
],
"title": "The output-path Schema",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "The split-dbcontext-preview Schema",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "The use-schema-folders-preview Schema",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "The file-layout Schema",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The functions Schema",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "The dbcontext-name Schema",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "The dbcontext-namespace Schema",
"type": "string"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "The model-namespace Schema",
"type": "string"
},
"root-namespace": {
"default": null,
"examples": [
null
],
"title": "The root-namespace Schema",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "The names Schema",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "The preserve-casing-with-regex Schema",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "A Schema",
"type": "string"
},
"title": "The uncountable-words Schema",
"type": "array"
}
},
"title": "The replacements Schema",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "The mapped-type Schema",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The name Schema",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "The use-legacy-resultset-discovery Schema",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The stored-procedures Schema",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "The exclude Schema",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]",
"[dbo].[Oldtable]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The tables Schema",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "The use-DateOnly-TimeOnly Schema",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "The use-HierarchyId Schema",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "The use-NodaTime Schema",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "The use-spatial Schema",
"type": "boolean"
}
},
"title": "The type-mappings Schema",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The views Schema",
"type": "array"
}
},
"required": [
"tables",
"views",
"stored-procedures",
"functions",
"code-generation",
"names",
"file-layout"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | e340da548e4256f1f4b2975c3882b048d861820d | 2023-06-12T09:03:43 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 5e7c4764f2df026026e739acfe5c0e5cdf5f0e06 | 2023-04-24T14:57:25 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "The discover-multiple-stored-procedure-resultsets-preview Schema",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "The enable-on-configuring Schema",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "The remove-defaultsql-from-bool-properties Schema",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "The soft-delete-obsolete-files Schema",
"type": "boolean"
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "The type Schema",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "The use-alternate-stored-procedure-resultset-discovery Schema",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "The use-data-annotations Schema",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "The use-database-names Schema",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "The use-inflector Schema",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "The use-legacy-inflector Schema",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "The use-many-to-many-entity Schema",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": false,
"examples": [
true
],
"title": "The use-nullable-reference-types Schema",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "The use-t4 Schema",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "The code-generation Schema",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Context"
],
"title": "The output-dbcontext-path Schema",
"type": "string"
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "The output-path Schema",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "The split-dbcontext-preview Schema",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "The use-schema-folders-preview Schema",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "The file-layout Schema",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The functions Schema",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "The dbcontext-name Schema",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "The dbcontext-namespace Schema",
"type": "string"
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "The model-namespace Schema",
"type": "string"
},
"root-namespace": {
"default": null,
"examples": [
null
],
"title": "The root-namespace Schema",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "The names Schema",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "The preserve-casing-with-regex Schema",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "A Schema",
"type": "string"
},
"title": "The uncountable-words Schema",
"type": "array"
}
},
"title": "The replacements Schema",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "The mapped-type Schema",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The name Schema",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "The use-legacy-resultset-discovery Schema",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The stored-procedures Schema",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "The exclude Schema",
"type": "boolean"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]",
"[dbo].[Oldtable]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The tables Schema",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
false
],
"title": "The use-DateOnly-TimeOnly Schema",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
false
],
"title": "The use-HierarchyId Schema",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
false
],
"title": "The use-NodaTime Schema",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
false
],
"title": "The use-spatial Schema",
"type": "boolean"
}
},
"title": "The type-mappings Schema",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"name"
],
"title": "A Schema",
"type": "object"
},
"title": "The views Schema",
"type": "array"
}
},
"required": [
"tables",
"views",
"stored-procedures",
"functions",
"code-generation",
"names",
"file-layout"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 8bbce2ca1e1a9246e7191886a7c515458160dfba | 2023-10-14T15:42:21 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | e929024345cc5ac64586e029d4761d2fc7fdd8ff | 2023-07-16T07:11:02 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"discover-multiple-stored-procedure-resultsets-preview",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
ErikEJ/EFCorePowerTools | 0633263025f707ae04dda19abc88636cee1be48e | 2024-02-06T13:01:16 | samples/efcpt-schema.json | 2,015 | 2024-05-27T04:43:08.934514Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"code-generation": {
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"refresh-object-lists": true,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-nullable-reference-types": true,
"use-t4": false
},
"file-layout": {
"output-dbcontext-path": null,
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
},
"functions": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"names": {
"dbcontext-name": "NorthwindContext",
"dbcontext-namespace": null,
"model-namespace": null,
"root-namespace": "MyProject"
},
"replacements": {
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
},
"stored-procedures": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"tables": [
{
"name": "[dbo].[Categories]"
},
{
"excludedColumns": [
"Name",
"Email"
],
"name": "[dbo].[CustomerCustomerDemo]"
},
{
"exclude": true,
"name": "[dbo].[Oldtable]"
}
],
"type-mappings": {
"use-DateOnly-TimeOnly": false,
"use-HierarchyId": false,
"use-NodaTime": false,
"use-spatial": false
},
"views": [
{
"name": "[dbo].[Categories]"
},
{
"excludedColumns": [
"Name",
"Email"
],
"name": "[dbo].[CustomerCustomerDemo]"
}
]
}
],
"markdownDescription": "See a full feature guide in [the wiki](https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering)",
"properties": {
"code-generation": {
"default": {},
"examples": [
{
"discover-multiple-stored-procedure-resultsets-preview": false,
"enable-on-configuring": false,
"merge-dacpacs": false,
"refresh-object-lists": true,
"remove-defaultsql-from-bool-properties": false,
"soft-delete-obsolete-files": false,
"type": "all",
"use-alternate-stored-procedure-resultset-discovery": false,
"use-data-annotations": false,
"use-database-names": false,
"use-inflector": false,
"use-legacy-inflector": false,
"use-many-to-many-entity": false,
"use-no-navigations-preview": false,
"use-nullable-reference-types": true,
"use-t4": false
}
],
"properties": {
"discover-multiple-stored-procedure-resultsets-preview": {
"default": false,
"examples": [
false
],
"title": "Discover multiple result sets from SQL stored procedures (preview)",
"type": "boolean"
},
"enable-on-configuring": {
"default": false,
"examples": [
false
],
"title": "Add OnConfiguring method to the DbContext",
"type": "boolean"
},
"generate-mermaid-diagram": {
"default": false,
"examples": [
false
],
"title": "Create a markdown file with a Mermaid ER diagram during scaffolding",
"type": "boolean"
},
"merge-dacpacs": {
"default": false,
"examples": [
false
],
"title": "Merge .dacpac files (when using .dacpac references)",
"type": "boolean"
},
"refresh-object-lists": {
"default": true,
"examples": [
false
],
"title": "Refresh the lists of objects (tables, views, stored procedures, functions) from the database in the config file during scaffolding",
"type": "boolean"
},
"remove-defaultsql-from-bool-properties": {
"default": false,
"examples": [
false
],
"title": "Remove SQL default from bool columns to avoid them being bool?",
"type": "boolean"
},
"soft-delete-obsolete-files": {
"default": false,
"examples": [
false
],
"title": "Run Cleanup of obsolete files",
"type": "boolean"
},
"t4-template-path": {
"default": null,
"title": "Global path to T4 templates",
"type": [
"string",
"null"
]
},
"type": {
"default": "all",
"enum": [
"all",
"dbcontext",
"entities"
],
"examples": [
"all"
],
"title": "Type of files to generate",
"type": "string"
},
"use-alternate-stored-procedure-resultset-discovery": {
"default": false,
"examples": [
false
],
"title": "Use alternate result set discovery - use sp_describe_first_result_set to retrieve stored procedure result sets",
"type": "boolean"
},
"use-data-annotations": {
"default": false,
"examples": [
false
],
"title": "Use DataAnnotation attributes rather than the fluent API (as much as possible)",
"type": "boolean"
},
"use-database-names": {
"default": false,
"examples": [
false
],
"title": "Use table and column names from the database",
"type": "boolean"
},
"use-inflector": {
"default": false,
"examples": [
false
],
"title": "Pluralize or singularize generated names (entity class names singular and DbSet names plural)",
"type": "boolean"
},
"use-legacy-inflector": {
"default": false,
"examples": [
false
],
"title": "Use EF6 Pluralizer instead of Humanizer",
"type": "boolean"
},
"use-many-to-many-entity": {
"default": false,
"examples": [
false
],
"title": "Preserve a many to many entity instead of skipping it ",
"type": "boolean"
},
"use-no-navigations-preview": {
"default": false,
"examples": [
false
],
"title": "Remove all navigation properties from the generated code (preview)",
"type": "boolean"
},
"use-nullable-reference-types": {
"default": true,
"examples": [
true
],
"title": "Use nullable reference types",
"type": "boolean"
},
"use-prefix-navigation-naming": {
"default": true,
"examples": [
false
],
"title": "Use prefix based naming of navigations with EF Core 8 or later",
"type": "boolean"
},
"use-t4": {
"default": false,
"examples": [
false
],
"title": "Customize code using T4 templates",
"type": "boolean"
}
},
"required": [
"enable-on-configuring",
"type",
"use-database-names",
"use-data-annotations",
"use-nullable-reference-types",
"use-inflector",
"use-legacy-inflector",
"use-many-to-many-entity",
"use-t4",
"remove-defaultsql-from-bool-properties",
"soft-delete-obsolete-files",
"use-alternate-stored-procedure-resultset-discovery"
],
"title": "Options for code generation",
"type": "object"
},
"file-layout": {
"default": {},
"examples": [
{
"output-dbcontext-path": "Context",
"output-path": "Models",
"split-dbcontext-preview": false,
"use-schema-folders-preview": false,
"use-schema-namespaces-preview": false
}
],
"properties": {
"output-dbcontext-path": {
"default": null,
"examples": [
"Data"
],
"title": "DbContext output path",
"type": [
"string",
"null"
]
},
"output-path": {
"default": "Models",
"examples": [
"Models"
],
"title": "Output path",
"type": "string"
},
"split-dbcontext-preview": {
"default": false,
"examples": [
false
],
"title": "Split DbContext (preview)",
"type": "boolean"
},
"use-schema-folders-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema folders (preview)",
"type": "boolean"
},
"use-schema-namespaces-preview": {
"default": false,
"examples": [
false
],
"title": "Use schema namespaces (preview)",
"type": "boolean"
}
},
"required": [
"output-path"
],
"title": "Custom file layout options",
"type": "object"
},
"functions": {
"default": [],
"examples": [
[
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[FunctionA]"
},
{
"name": "[dbo].[FunctionB]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this function from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[FunctionA]",
"[dbo].[FunctionB]"
],
"title": "Name of function",
"type": "string"
}
},
"title": "Function",
"type": "object"
},
"title": "List of scalar and TVF functions discovered in the source database",
"type": "array"
},
"names": {
"default": {},
"examples": [
{
"dbcontext-name": "NorthwindContext",
"root-namespace": "MypProject"
}
],
"properties": {
"dbcontext-name": {
"default": "",
"examples": [
"NorthwindContext"
],
"title": "Name of DbContext class",
"type": "string"
},
"dbcontext-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of DbContext class",
"type": [
"string",
"null"
]
},
"model-namespace": {
"default": null,
"examples": [
null
],
"title": "Namespace of entities",
"type": [
"string",
"null"
]
},
"root-namespace": {
"examples": [
"MyProect"
],
"title": "Root namespace",
"type": "string"
}
},
"required": [
"dbcontext-name",
"root-namespace"
],
"title": "Custom class and namespace names",
"type": "object"
},
"replacements": {
"default": {},
"examples": [
{
"preserve-casing-with-regex": false,
"uncountable-words": [
"Status",
"Data"
]
}
],
"properties": {
"preserve-casing-with-regex": {
"default": false,
"examples": [
false
],
"title": "Preserve casing with regex when custom naming",
"type": "boolean"
},
"uncountable-words": {
"default": [],
"examples": [
[
"Status",
"Data"
]
],
"items": {
"examples": [
"Status",
"Data"
],
"title": "Word list",
"type": "string"
},
"title": "Uncountable (ignored) words for Humanizer",
"type": "array"
}
},
"title": "Custom naming options",
"type": "object"
},
"stored-procedures": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Alphabetical list of products]"
},
{
"mapped-type": "Customer",
"name": "[dbo].[Category Sales for 1997]",
"use-legacy-resultset-discovery": true
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this stored procedure from code generation",
"type": "boolean"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"mapped-type": {
"default": null,
"examples": [
"Customer"
],
"title": "Name of an entity class (DbSet) in your DbContext that maps the result of the stored procedure ",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Alphabetical list of products]",
"[dbo].[Category Sales for 1997]"
],
"title": "The stored procedure name",
"type": "string"
},
"use-legacy-resultset-discovery": {
"default": false,
"examples": [
true
],
"title": "Use sp_describe_first_result_set instead of SET FMTONLY for result set discovery",
"type": "boolean"
}
},
"title": "Stored procedure",
"type": "object"
},
"title": "List of stored procedures discovered in the source database",
"type": "array"
},
"tables": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "Oldtable"
}
],
"properties": {
"exclude": {
"default": null,
"examples": [
true
],
"title": "Set to true to exclude this table from code generation",
"type": "boolean"
},
"excludedColumns": {
"default": [],
"examples": [
[
"Name",
"Email"
]
],
"items": {
"examples": [
"Name",
"Email"
],
"title": "Column",
"type": "string"
},
"title": "Columns to Exclude from code generation",
"type": "array"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"Oldtable"
],
"title": "Full table name",
"type": "string"
}
},
"title": "Table",
"type": "object"
},
"title": "List of tables discovered in the source database",
"type": "array"
},
"type-mappings": {
"default": {},
"examples": [
{
"use-DateOnly-TimeOnly": true,
"use-HierarchyId": true,
"use-NodaTime": false,
"use-spatial": true
}
],
"properties": {
"use-DateOnly-TimeOnly": {
"default": false,
"examples": [
true
],
"title": "Map date and time to DateOnly/TimeOnly (mssql)",
"type": "boolean"
},
"use-HierarchyId": {
"default": false,
"examples": [
true
],
"title": "Map hierarchyId (mssql)",
"type": "boolean"
},
"use-NodaTime": {
"default": false,
"examples": [
true
],
"title": "Use NodaTime",
"type": "boolean"
},
"use-spatial": {
"default": false,
"examples": [
true
],
"title": "Map spatial columns",
"type": "boolean"
}
},
"title": "Optional type mappings",
"type": "object"
},
"views": {
"default": [],
"examples": [
[
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
]
],
"items": {
"examples": [
{
"name": "[dbo].[Categories]"
},
{
"exclude": true,
"name": "[dbo].[CustomerCustomerDemo]"
}
],
"properties": {
"exclude": {
"default": false,
"examples": [
true
],
"title": "Set to true to exclude this view from code generation",
"type": "boolean"
},
"excludedColumns": {
"default": [],
"examples": [
[
"Name",
"Email"
]
],
"items": {
"examples": [
"Name",
"Email"
],
"title": "Column",
"type": "string"
},
"title": "Columns to Exclude from code generation",
"type": "array"
},
"exclusionWildcard": {
"examples": [
"*"
],
"title": "Exclusion pattern with * symbol, use '*' to exclude all by default",
"type": "string"
},
"name": {
"examples": [
"[dbo].[Categories]",
"[dbo].[CustomerCustomerDemo]"
],
"title": "Full view name",
"type": "string"
}
},
"title": "View",
"type": "object"
},
"title": "List of views discovered in the source database",
"type": "array"
}
},
"required": [
"tables",
"code-generation",
"names",
"file-layout"
],
"title": "Configuration for EF Core Power Tools",
"type": "object"
} | MIT | en |
Subsets and Splits