get.porter.sh/porter@v1.3.0/pkg/schema/parameter-set.schema.json (about) 1 { 2 "$id": "https://porter.sh/schema/v1/parameter-set.schema.json", 3 "$schema": "http://json-schema.org/draft-07/schema#", 4 "definitions": { 5 "valueMapping": { 6 "description": "Defines the source for a value", 7 "type": "object", 8 "properties": { 9 "name": { 10 "description": "Name of the mapped value", 11 "type": "string" 12 }, 13 "source": { 14 "description": "Location where the value should be retrieved", 15 "type": "object", 16 "properties": { 17 "command": { 18 "description": "Command that should be executed on the host, using the output returned from the command as the value", 19 "type": "string" 20 }, 21 "env": { 22 "description": "Name of the environment variable on the host that contains the value", 23 "type": "string" 24 }, 25 "path": { 26 "description": "Path to a file on the host that contains the value", 27 "type": "string" 28 }, 29 "secret": { 30 "description": "Name of a secret in a secret store that contains the value", 31 "type": "string" 32 }, 33 "value": { 34 "description": "Hard-coded value", 35 "type": ["string", "number", "object", "array", "boolean"] 36 } 37 }, 38 "additionalProperties": true 39 } 40 }, 41 "additionalProperties": false, 42 "required": ["name", "source"] 43 } 44 }, 45 "properties": { 46 "name": { 47 "description": "The name of the parameter set.", 48 "type": "string" 49 }, 50 "namespace": { 51 "description": "The namespace in which the parameter set is defined.", 52 "type": "string" 53 }, 54 "created": { 55 "description": "The date created, as an ISO-8601 Extended Format date string, as specified in the ECMAScript standard", 56 "type": "string" 57 }, 58 "modified": { 59 "description": "The date modified, as an ISO-8601 Extended Format date string, as specified in the ECMAScript standard", 60 "type": "string" 61 }, 62 "labels": { 63 "description": "Set of labels associated with the parameter set.", 64 "type": "object", 65 "additionalProperties": { 66 "type": "string" 67 } 68 }, 69 "parameters": { 70 "description": "Mappings of parameter names to their source value", 71 "type": "array", 72 "items": { 73 "$ref": "#/definitions/valueMapping" 74 } 75 }, 76 "custom": { 77 "$comment": "reserved for custom extensions", 78 "type": "object", 79 "additionalProperties": true 80 }, 81 "schemaType": { 82 "description": "The resource type of the current document.", 83 "type": "string", 84 "default": "ParameterSet" 85 }, 86 "schemaVersion": { 87 "description": "Version of the parameter set schema to which this document adheres", 88 "type": "string", 89 "default": "1.1.0" 90 } 91 }, 92 "required": [ 93 "name", 94 "parameters", 95 "schemaVersion" 96 ], 97 "title": "Parameter Set json schema", 98 "type": "object", 99 "additionalProperties": false 100 }