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
WillAbides/bindown
c9383e778e9249b14c6618a88ec934ace19af0bc
2023-05-11T19:28:35
internal/bindown/bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "description": { "description": "A description of the dependency. Informational only.", "type": "string" }, "homepage": { "description": "The homepage for this dependency. Informational only.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template.\nOverrides in the dependency and its template are concatenated with the template's overrides coming first.\nVars and substitutions are both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/Dependency", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
8e6659dca8c57a614eb384536c83c416489b8b16
2023-05-11T18:55:50
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "description": { "description": "A description of this dependency", "type": "string" }, "homepage": { "description": "The homepage for this dependency", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template.\nOverrides in the dependency and its template are concatenated with the template's overrides coming first.\nVars and substitutions are both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/Dependency", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
10e8088a36b0861e56ecace93e0b81e21914bea8
2020-04-13T15:20:50
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "override": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "matcher": { "additionalProperties": false, "description": "Describes which systems this override applies to", "properties": { "arch": { "description": "List of architectures to match. When left empty, all architectures match.", "examples": [ [ "386", "amd64", "arm", "arm64" ] ], "items": { "type": "string" }, "type": "array" }, "os": { "description": "List of operating systems to match. When left empty, all operating systems match.", "examples": [ [ "windows", "darwin", "linux" ] ], "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/definitions/override" }, "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatinated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "type": "string" }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "required": [ "matcher" ], "type": "object" } }, "properties": { "dependencies": { "additionalProperties": { "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/definitions/override" }, "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatinated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "type": "string" }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "type": "object" }, "description": "Dependencies available for bindown to install.", "type": "object" }, "templates": { "additionalProperties": { "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/definitions/override" }, "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatinated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "type": "string" }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "type": "object" }, "description": "Templates that can be used by dependencies in this file.", "type": "object" }, "url_checksums": { "additionalProperties": { "type": "string" }, "description": "Checksums of downloaded files.", "type": "object" } }, "title": "bindown configuration file", "type": "object" }
MIT
en
WillAbides/bindown
31cc778e91cefab86d0ff92ecd7c25071ca985b4
2023-05-14T19:07:14
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "description": { "description": "A description of the dependency. Informational only.", "type": "string" }, "homepage": { "description": "The homepage for this dependency. Informational only.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Value is the name of a template in the templates section of this config.\nAny unset fields in this dependency will be set by values from the template. Overrides in the dependency\nand its template are concatenated with the template's overrides coming first. Vars and substitutions\nare both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/Overrideable", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" }, "Overrideable": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
35b37f9a1cbb5ae2cc85fa4e17c20f6a576b08ca
2020-04-17T22:29:45
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "dependency": { "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/definitions/override" }, "type": "array" }, "required_vars": { "additionalItems": { "type": "string" }, "description": "A list of variables that must be present for an install to succeed", "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "systems": { "additionalItems": { "type": "string" }, "description": "List of systems this dependency is known to support", "type": "array" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatinated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "type": "object" }, "override": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/definitions/dependency", "description": "Values to override the parent dependency" }, "matcher": { "additionalProperties": false, "description": "Describes which systems this override applies to", "properties": { "arch": { "description": "List of architectures to match. When left empty, all architectures match.", "examples": [ [ "386", "amd64", "arm", "arm64" ] ], "items": { "type": "string" }, "type": "array" }, "os": { "description": "List of operating systems to match. When left empty, all operating systems match.", "examples": [ [ "windows", "darwin", "linux" ] ], "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "properties": { "cache": { "default": "./.bindown", "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where the configuration file resides. cache paths should always use / as a delimiter even on Windows or other operating systems where the native delimiter isn't /.\n", "type": "string" }, "dependencies": { "additionalProperties": { "$ref": "#/definitions/dependency" }, "description": "Dependencies available for bindown to install.", "type": "object" }, "install_directory": { "default": "./bin", "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file resides. install_directory paths should always use / as a delimiter even on Windows or other operating systems where the native delimiter isn't /.\n", "type": "string" }, "systems": { "additionalItems": { "type": "string" }, "description": "list of systems dependencies should support", "type": "array" }, "template_sources": { "additionalProperties": { "type": "string" }, "description": "Upstream sources for templates.", "type": "object" }, "templates": { "additionalProperties": { "$ref": "#/definitions/dependency" }, "description": "Templates that can be used by dependencies in this file.", "type": "object" }, "url_checksums": { "additionalProperties": { "type": "string" }, "description": "Checksums of downloaded files.", "type": "object" } }, "title": "bindown configuration file", "type": "object" }
MIT
en
WillAbides/bindown
93ef3a30b9a8cef0995aca10c414a65988d1267e
2020-04-13T21:10:27
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "dependency": { "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/definitions/override" }, "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatinated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "type": "object" }, "override": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/definitions/dependency", "description": "Values to override the parent dependency" }, "matcher": { "additionalProperties": false, "description": "Describes which systems this override applies to", "properties": { "arch": { "description": "List of architectures to match. When left empty, all architectures match.", "examples": [ [ "386", "amd64", "arm", "arm64" ] ], "items": { "type": "string" }, "type": "array" }, "os": { "description": "List of operating systems to match. When left empty, all operating systems match.", "examples": [ [ "windows", "darwin", "linux" ] ], "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "properties": { "dependencies": { "additionalProperties": { "$ref": "#/definitions/dependency" }, "description": "Dependencies available for bindown to install.", "type": "object" }, "templates": { "additionalProperties": { "$ref": "#/definitions/dependency" }, "description": "Templates that can be used by dependencies in this file.", "type": "object" }, "url_checksums": { "additionalProperties": { "type": "string" }, "description": "Checksums of downloaded files.", "type": "object" } }, "title": "bindown configuration file", "type": "object" }
MIT
en
WillAbides/bindown
df2dd0d38992f37c2e2d11815eef903c27796e7c
2023-03-26T16:55:34
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "dependency": { "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/override" }, "type": "array" }, "required_vars": { "additionalItems": { "type": "string" }, "description": "A list of variables that must be present for an install to succeed", "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "systems": { "additionalItems": { "type": "string" }, "description": "List of systems this dependency is known to support", "type": "array" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatenated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "type": "object" }, "override": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/dependency", "description": "Values to override the parent dependency" }, "matcher": { "additionalProperties": { "description": "List of values to match. Any matching value will match. If a value can be interpreted as a SemVer, it will be treated as such.", "items": { "type": "string" }, "type": "array" }, "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.", "examples": [ { "archivepathsuffix": [ ".zip" ], "os": [ "darwin", "linux" ], "version": [ ">=1.0.0 <2.0.0" ] } ], "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "cache": { "default": "./.bindown", "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where the configuration file resides. cache paths should always use / as a delimiter even on Windows or other operating systems where the native delimiter isn't /.\n", "type": "string" }, "dependencies": { "additionalProperties": { "$ref": "#/$defs/dependency" }, "description": "Dependencies available for bindown to install.", "type": "object" }, "install_directory": { "default": "./bin", "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file resides. install_directory paths should always use / as a delimiter even on Windows or other operating systems where the native delimiter isn't /.\n", "type": "string" }, "systems": { "additionalItems": { "type": "string" }, "description": "list of systems dependencies should support", "type": "array" }, "template_sources": { "additionalProperties": { "type": "string" }, "description": "Upstream sources for templates.", "type": "object" }, "templates": { "additionalProperties": { "$ref": "#/$defs/dependency" }, "description": "Templates that can be used by dependencies in this file.", "type": "object" }, "trust_cache": { "default": false, "description": "If true, bindown will trust the contents of the cache and not recheck checksums or verify that the files in the cache are the same as the files that were downloaded.\n", "type": "boolean" }, "url_checksums": { "additionalProperties": { "type": "string" }, "description": "Checksums of downloaded files.", "type": "object" } }, "title": "bindown configuration file", "type": "object" }
MIT
en
WillAbides/bindown
1a4bfff88a51ccb3728987f676d77d7dcc705031
2023-05-03T21:45:40
internal/bindown/bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template.\nOverrides in the dependency and its template are concatenated with the template's overrides coming first.\nVars and substitutions are both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/Dependency", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
8e6659dca8c57a614eb384536c83c416489b8b16
2023-05-11T18:55:50
internal/bindown/bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "description": { "description": "A description of this dependency", "type": "string" }, "homepage": { "description": "The homepage for this dependency", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template.\nOverrides in the dependency and its template are concatenated with the template's overrides coming first.\nVars and substitutions are both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/Dependency", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
1cab76b3bec42e86adb515fe594191680edb906f
2023-05-14T19:04:34
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "description": { "description": "A description of the dependency. Informational only.", "type": "string" }, "homepage": { "description": "The homepage for this dependency. Informational only.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Value is the name of a template in the templates section of this config.\nAny unset fields in this dependency will be set by values from the template. Overrides in the dependency\nand its template are concatenated with the template's overrides coming first. Vars and substitutions\nare both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/OverrideDependency", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" }, "OverrideDependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
030ba759a701632db8301211fc8d118cea240f6a
2023-05-29T22:09:06
internal/bindown/bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$defs": { "Dependency": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "description": { "description": "A description of the dependency. Informational only.", "type": "string" }, "homepage": { "description": "The homepage for this dependency. Informational only.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "required_vars": { "description": "A list of variables that must be present for an install to succeed", "items": { "type": "string" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "systems": { "description": "List of systems this dependency supports. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template": { "description": "A template for this dependency. Value is the name of a template in the templates section of this config.\nAny unset fields in this dependency will be set by values from the template. Overrides in the dependency\nand its template are concatenated with the template's overrides coming first. Vars and substitutions\nare both combined with the dependency's value taking precedence.", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "DependencyOverride": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/$defs/Overrideable", "description": "Values to override the parent dependency" }, "matcher": { "description": "Limits the override to configurations matching all of the matchers. Keys may be \"os\", \"arch\" or any variable name.\nValues are an array of values to match. Any matching value will match. If a value can be interpreted as a\nsemantic version it will be treated as such.", "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" }, "Overrideable": { "additionalProperties": false, "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/$defs/DependencyOverride" }, "type": "array" }, "substitutions": { "description": "Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is\na map of substitutions. { \"os\": { \"linux\": \"Linux\", \"darwin\": \"MacOS\" } } is an example of a substitution that\nwill update the os variable.", "patternProperties": { ".*": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\n\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating\nsystem and architecture as defined by go's GOOS and GOARCH variables. I should document what those are\nsomewhere.\n\nYou can reference a variable using golang template syntax. For example, you could have a url set to\n`https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var\n'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download\n`https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "cache": { "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where\nthe configuration file resides. cache paths should always use / as a delimiter even on Windows or other\noperating systems where the native delimiter isn't /.", "type": "string" }, "dependencies": { "description": "Dependencies available for bindown to install.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "install_dir": { "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file\nresides. install_directory paths should always use / as a delimiter even on Windows or other operating systems\nwhere the native delimiter isn't /.", "type": "string" }, "systems": { "description": "List of systems supported by this config. Systems are in the form of os/architecture.", "items": { "type": "string" }, "type": "array" }, "template_sources": { "description": "Upstream sources for templates.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "templates": { "description": "Templates that can be used by dependencies in this file.", "patternProperties": { ".*": { "$ref": "#/$defs/Dependency" } }, "type": "object" }, "url_checksums": { "description": "Checksums of downloaded files.", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "type": "object" }
MIT
en
WillAbides/bindown
228b0c19a992dd44e3a9291455418efd4f22880c
2020-04-14T17:39:30
bindown.schema.json
12
2024-05-29T15:01:34.101274Z
{ "$id": "https://willabides.github.io/bindown/bindown.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "dependency": { "properties": { "archive_path": { "description": "The path in the downloaded archive where the binary is located. Default is ./<bin>", "type": "string" }, "bin": { "description": "The name of the binary to be installed. Default is the name of the dependency.", "type": "string" }, "link": { "description": "Whether to create a symlink to the bin instead of copying it.", "type": "boolean" }, "overrides": { "additionalItems": false, "description": "Overrides allows you to override values depending on the os and architecture of the target system.", "items": { "$ref": "#/definitions/override" }, "type": "array" }, "substitutions": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Substitutions will substitute values from vars.", "examples": [ { "arch": { "386": "i386", "amd64": "x86_64" }, "os": { "darwin": "Darwin", "linux": "Linux", "windows": "Windows" } } ], "type": "object" }, "template": { "description": "A template for this dependency. Any unset fields in this dependency will be set by values from the template. Overrides in the dependency and its template are concatinated with the template's overrides coming first. Vars and substitutions are both combined with the dependency's value taking precedence.\n", "type": "string" }, "url": { "description": "The url to download a dependency from.", "type": "string" }, "vars": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "description": "A list of variables that can be used in 'url', 'archive_path' and 'bin'.\nTwo variables are always added based on the current environment: 'os' and 'arch'. Those are the operating system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are somewhere.\nYou can reference a variable using golang template syntax. For example, you could have a url set to `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`. If you define the var 'version: 1.2.3' and run bindown on a 64 bit Linux system, it will download `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.\n", "type": "object" } }, "type": "object" }, "override": { "additionalProperties": false, "properties": { "dependency": { "$ref": "#/definitions/dependency", "description": "Values to override the parent dependency" }, "matcher": { "additionalProperties": false, "description": "Describes which systems this override applies to", "properties": { "arch": { "description": "List of architectures to match. When left empty, all architectures match.", "examples": [ [ "386", "amd64", "arm", "arm64" ] ], "items": { "type": "string" }, "type": "array" }, "os": { "description": "List of operating systems to match. When left empty, all operating systems match.", "examples": [ [ "windows", "darwin", "linux" ] ], "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "matcher", "dependency" ], "type": "object" } }, "properties": { "cache": { "default": "./.bindown", "description": "The directory where bindown will cache downloads and extracted files. This is relative to the directory where the configuration file resides. cache paths should always use / as a delimiter even on Windows or other operating systems where the native delimiter isn't /.\n", "type": "string" }, "dependencies": { "additionalProperties": { "$ref": "#/definitions/dependency" }, "description": "Dependencies available for bindown to install.", "type": "object" }, "install_directory": { "default": "./bin", "description": "The directory that bindown installs files to. This is relative to the directory where the configuration file resides. install_directory paths should always use / as a delimiter even on Windows or other operating systems where the native delimiter isn't /.\n", "type": "string" }, "templates": { "additionalProperties": { "$ref": "#/definitions/dependency" }, "description": "Templates that can be used by dependencies in this file.", "type": "object" }, "url_checksums": { "additionalProperties": { "type": "string" }, "description": "Checksums of downloaded files.", "type": "object" } }, "title": "bindown configuration file", "type": "object" }
MIT
en
apetrynet/pyfdl
012d74db1dbfd30a24b00a60f77e8ce4227f343e
2024-01-05T10:29:23
src/pyfdl/schema/v1.0/ascfdl.schema.json
7
2024-05-27T06:59:39.196842Z
{ "$defs": { "dimensions_float": { "additionalProperties": false, "properties": { "height": { "exclusiveMinimum": 0, "type": "number" }, "width": { "exclusiveMinimum": 0, "type": "number" } }, "required": [ "width", "height" ] }, "dimensions_int": { "additionalProperties": false, "properties": { "height": { "exclusiveMinimum": 0, "type": "integer" }, "width": { "exclusiveMinimum": 0, "type": "integer" } }, "required": [ "width", "height" ] }, "fdl_id": { "maxLength": 32, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "fdl_id_framing_decision": { "maxLength": 65, "minLength": 3, "pattern": "^[A-Za-z0-9_]+-[A-Za-z0-9_]+$", "type": "string" }, "point_float": { "additionalProperties": false, "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ] } }, "$id": "https://theasc.com/society/ascmitc/asc-framing-decision-list.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "ASC Framing Decision List", "properties": { "canvas_templates": { "items": { "additionalProperties": false, "properties": { "alignment_method_horizontal": { "default": "center", "enum": [ "left", "center", "right" ], "type": "string" }, "alignment_method_vertical": { "default": "center", "enum": [ "top", "center", "bottom" ], "type": "string" }, "fit_method": { "enum": [ "width", "height", "fit_all", "fill" ], "type": "string" }, "fit_source": { "enum": [ "framing_decision.dimensions", "framing_decision.protection_dimensions", "canvas.dimensions", "canvas.effective_dimensions" ], "type": "string" }, "id": { "$ref": "#/$defs/fdl_id" }, "label": { "type": "string" }, "maximum_dimensions": { "$ref": "#/$defs/dimensions_int" }, "pad_to_maximum": { "default": false, "type": "boolean" }, "preserve_from_source_canvas": { "default": "none", "enum": [ "none", "framing_decision.dimensions", "framing_decision.protection_dimensions", "canvas.dimensions", "canvas.effective_dimensions" ], "type": "string" }, "round": { "additionalProperties": false, "properties": { "even": { "default": "even", "enum": [ "whole", "even" ], "type": "string" }, "mode": { "default": "up", "enum": [ "up", "down", "round" ], "type": "string" } }, "required": [ "even", "mode" ], "type": "object" }, "target_anamorphic_squeeze": { "exclusiveMinimum": 0, "type": "number" }, "target_dimensions": { "$ref": "#/$defs/dimensions_int" } }, "required": [ "id", "target_dimensions", "target_anamorphic_squeeze", "fit_source", "fit_method" ], "type": "object" }, "type": "array" }, "contexts": { "items": { "additionalProperties": false, "properties": { "canvases": { "items": { "additionalProperties": false, "dependentRequired": { "effective_dimensions": [ "effective_anchor_point" ] }, "properties": { "anamorphic_squeeze": { "default": 1.0, "exclusiveMinimum": 0, "type": "number" }, "dimensions": { "$ref": "#/$defs/dimensions_int" }, "effective_anchor_point": { "$ref": "#/$defs/point_float" }, "effective_dimensions": { "$ref": "#/$defs/dimensions_int" }, "framing_decisions": { "items": { "additionalProperties": false, "dependentRequired": { "protection_dimensions": [ "protection_anchor_point" ] }, "properties": { "anchor_point": { "$ref": "#/$defs/point_float" }, "dimensions": { "$ref": "#/$defs/dimensions_float" }, "framing_intent_id": { "$ref": "#/$defs/fdl_id" }, "id": { "$ref": "#/$defs/fdl_id_framing_decision" }, "label": { "type": "string" }, "protection_anchor_point": { "$ref": "#/$defs/point_float" }, "protection_dimensions": { "$ref": "#/$defs/dimensions_float" } }, "required": [ "id", "framing_intent_id", "dimensions", "anchor_point" ], "type": "object" }, "type": "array" }, "id": { "$ref": "#/$defs/fdl_id" }, "label": { "type": "string" }, "photosite_dimensions": { "$ref": "#/$defs/dimensions_int" }, "physical_dimensions": { "$ref": "#/$defs/dimensions_float" }, "source_canvas_id": { "$ref": "#/$defs/fdl_id" } }, "required": [ "id", "source_canvas_id", "dimensions" ], "type": "object" }, "type": "array" }, "context_creator": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "default_framing_intent": { "$ref": "#/$defs/fdl_id" }, "fdl_creator": { "type": "string" }, "framing_intents": { "items": { "additionalProperties": false, "properties": { "aspect_ratio": { "$ref": "#/$defs/dimensions_int" }, "id": { "$ref": "#/$defs/fdl_id" }, "label": { "type": "string" }, "protection": { "default": 0, "minimum": 0, "type": "number" } }, "required": [ "id", "aspect_ratio" ], "type": "object" }, "type": "array" }, "uuid": { "format": "uuid", "type": "string" }, "version": { "additionalProperties": false, "properties": { "major": { "const": 1, "type": "integer" }, "minor": { "const": 0, "type": "integer" } }, "required": [ "major", "minor" ], "type": "object" } }, "required": [ "uuid", "version" ], "title": "ASC Framing Decision List", "type": "object" }
Apache-2.0
en
apetrynet/pyfdl
012d74db1dbfd30a24b00a60f77e8ce4227f343e
2024-01-05T10:29:23
src/pyfdl/schema/v0.1/ascfdl.schema.json
7
2024-05-27T06:59:39.196842Z
{ "$defs": { "dimensions_float": { "additionalProperties": false, "properties": { "height": { "exclusiveMinimum": 0, "type": "number" }, "width": { "exclusiveMinimum": 0, "type": "number" } }, "required": [ "width", "height" ] }, "dimensions_int": { "additionalProperties": false, "properties": { "height": { "exclusiveMinimum": 0, "type": "integer" }, "width": { "exclusiveMinimum": 0, "type": "integer" } }, "required": [ "width", "height" ] }, "fdl_id": { "maxLength": 32, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "fdl_id_framing_decision": { "maxLength": 65, "minLength": 3, "pattern": "^[A-Za-z0-9_]+-[A-Za-z0-9_]+$", "type": "string" }, "point_float": { "additionalProperties": false, "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ] } }, "$id": "https://theasc.com/society/ascmitc/asc-framing-decision-list.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "ASC Framing Decision List", "properties": { "canvas_templates": { "items": { "additionalProperties": false, "properties": { "alignment_method_horizontal": { "default": "center", "enum": [ "left", "center", "right" ], "type": "string" }, "alignment_method_vertical": { "default": "center", "enum": [ "top", "center", "bottom" ], "type": "string" }, "fit_method": { "enum": [ "width", "height", "fit_all", "fill" ], "type": "string" }, "fit_source": { "enum": [ "framing_decision.dimensions", "framing_decision.protection_dimensions", "canvas.dimensions", "canvas.effective_dimensions" ], "type": "string" }, "id": { "$ref": "#/$defs/fdl_id" }, "label": { "type": "string" }, "maximum_dimensions": { "$ref": "#/$defs/dimensions_int" }, "pad_to_maximum": { "default": false, "type": "boolean" }, "preserve_from_source_canvas": { "default": "none", "enum": [ "none", "framing_decision.dimensions", "framing_decision.protection_dimensions", "canvas.dimensions", "canvas.effective_dimensions" ], "type": "string" }, "round": { "additionalProperties": false, "properties": { "even": { "default": "even", "enum": [ "whole", "even" ], "type": "string" }, "mode": { "default": "up", "enum": [ "up", "down", "round" ], "type": "string" } }, "required": [ "even", "mode" ], "type": "object" }, "target_anamorphic_squeeze": { "exclusiveMinimum": 0, "type": "number" }, "target_dimensions": { "$ref": "#/$defs/dimensions_int" } }, "required": [ "id", "target_dimensions", "target_anamorphic_squeeze", "fit_source", "fit_method" ], "type": "object" }, "type": "array" }, "contexts": { "items": { "additionalProperties": false, "properties": { "canvases": { "items": { "additionalProperties": false, "dependentRequired": { "effective_dimensions": [ "effective_anchor_point" ] }, "properties": { "anamorphic_squeeze": { "default": 1.0, "exclusiveMinimum": 0, "type": "number" }, "dimensions": { "$ref": "#/$defs/dimensions_int" }, "effective_anchor_point": { "$ref": "#/$defs/point_float" }, "effective_dimensions": { "$ref": "#/$defs/dimensions_int" }, "framing_decisions": { "items": { "additionalProperties": false, "dependentRequired": { "protection_dimensions": [ "protection_anchor_point" ] }, "properties": { "anchor_point": { "$ref": "#/$defs/point_float" }, "dimensions": { "$ref": "#/$defs/dimensions_float" }, "framing_intent_id": { "$ref": "#/$defs/fdl_id" }, "id": { "$ref": "#/$defs/fdl_id_framing_decision" }, "label": { "type": "string" }, "protection_anchor_point": { "$ref": "#/$defs/point_float" }, "protection_dimensions": { "$ref": "#/$defs/dimensions_float" } }, "required": [ "id", "framing_intent_id", "dimensions", "anchor_point" ], "type": "object" }, "type": "array" }, "id": { "$ref": "#/$defs/fdl_id" }, "label": { "type": "string" }, "photosite_dimensions": { "$ref": "#/$defs/dimensions_int" }, "physical_dimensions": { "$ref": "#/$defs/dimensions_float" }, "source_canvas_id": { "$ref": "#/$defs/fdl_id" } }, "required": [ "id", "source_canvas_id", "dimensions" ], "type": "object" }, "type": "array" }, "context_creator": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "default_framing_intent": { "$ref": "#/$defs/fdl_id" }, "fdl_creator": { "type": "string" }, "framing_intents": { "items": { "additionalProperties": false, "properties": { "aspect_ratio": { "$ref": "#/$defs/dimensions_int" }, "id": { "$ref": "#/$defs/fdl_id" }, "label": { "type": "string" }, "protection": { "default": 0, "minimum": 0, "type": "number" } }, "required": [ "id", "aspect_ratio" ], "type": "object" }, "type": "array" }, "uuid": { "format": "uuid", "type": "string" }, "version": { "additionalProperties": false, "properties": { "major": { "const": 0, "type": "integer" }, "minor": { "const": 1, "type": "integer" } }, "required": [ "major", "minor" ], "type": "object" } }, "required": [ "uuid", "version" ], "title": "ASC Framing Decision List", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
484b6e0ba49e5f755c999221d5eea5749a92251e
2023-12-19T16:11:42
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.0" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.0" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.0" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.0", "examples": [ "3.4.0" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
7685ae9b758f7befbcd3a486f39539837a818856
2024-02-16T10:01:05
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableTelemetryReporting": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.2", "examples": [ "3.4.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
fe6759b7d6f0e77e2f8de6bc74f48661c59354f1
2024-02-07T09:46:16
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableTelemetryReporting": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.2", "examples": [ "3.4.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
08e30860e6df0c582a88c6e2c116f79f1724567d
2024-05-09T13:21:45
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.1" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.1" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableWeightChangesDynamicReload": { "default": false, "examples": [ false ], "title": "Enables weight changes without reloading for NGINX Plus", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.5.1", "examples": [ "3.5.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "telemetryReporting": { "default": {}, "properties": { "enable": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" } }, "required": [], "title": "Configure telemetry reporting options", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
7ae73994f647cfeebaff636cb4359cfd866d657f
2024-03-19T15:09:39
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableWeightChangesDynamicReload": { "default": false, "examples": [ false ], "title": "Enables weight changes without reloading for NGINX Plus", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.3", "examples": [ "3.4.3" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "telemetryReporting": { "default": {}, "properties": { "enable": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" } }, "required": [], "title": "Configure telemetry reporting options", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
7a4e57977c622433abd1206c32a09c7049b365d2
2023-12-07T12:43:22
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.3.2", "examples": [ "3.3.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
0f770195c1c61807ee02740718e82d93bfff3aff
2024-03-13T12:56:04
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableTelemetryReporting": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.3", "examples": [ "3.4.3" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
533ef48d81b3a7e7a534863bf7aba30a5c1bd080
2024-05-03T11:19:49
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.0" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.0" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableWeightChangesDynamicReload": { "default": false, "examples": [ false ], "title": "Enables weight changes without reloading for NGINX Plus", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.0" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.5.0", "examples": [ "3.5.0" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "telemetryReporting": { "default": {}, "properties": { "enable": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" } }, "required": [], "title": "Configure telemetry reporting options", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "file://./charts/nginx-ingress/v1.29.2/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
f876663e38c4b63dfba196a32965f52777ed2721
2024-02-19T16:31:12
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableTelemetryReporting": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.2", "examples": [ "3.4.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
01a9a52985867b5e874392f18a2219318808a624
2024-01-24T14:39:15
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.2", "examples": [ "3.4.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
9dcd4cceddf690308668da4a4c7370f795e63fd9
2023-09-26T22:39:26
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enablePreviewPolicies": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enablePreviewPolicies": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enablePreviewPolicies": { "default": false, "examples": [ false ], "title": "The enablePreviewPolicies", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "2.3.1", "examples": [ "2.3.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
bd29988c05045d2de3ab8b74674695134a508c60
2023-12-12T15:57:18
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.3.2", "examples": [ "3.3.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.28.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
aad4fc9ced4d118e19d480f151e22a1d536044db
2023-10-12T10:21:34
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enablePreviewPolicies": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enablePreviewPolicies": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enablePreviewPolicies": { "default": false, "examples": [ false ], "title": "The enablePreviewPolicies", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "2.3.1", "examples": [ "2.3.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
b056696c4605731412e0bfdea72f0df124bd909b
2023-11-20T18:25:30
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.3.2", "examples": [ "3.3.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
74d3aec2e7f692a802f01074e13eaadb621e3025
2023-11-01T14:13:10
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "2.3.1", "examples": [ "2.3.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
7f31dacfff2543bd833ccdc34fb7bb937f5308b2
2024-03-14T15:02:57
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.3", "examples": [ "3.4.3" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "telemetryReporting": { "default": {}, "properties": { "enable": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" } }, "required": [], "title": "Configure telemetry reporting options", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
4ca9feabf34cd05a000c10e860766c6a9ef2fcfc
2023-11-15T09:29:18
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "2.3.1", "examples": [ "2.3.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
601f471f9c61a69a2e6beb9d0188b400579903ad
2023-12-01T14:38:27
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.3.2" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.3.2", "examples": [ "3.3.2" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
6508fcec222f2a194f16cab6bd017acba7afacb1
2024-02-20T09:54:01
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableTelemetryReporting": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.4.3" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.4.3", "examples": [ "3.4.3" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
7fcee3de87f3f64d3f3c534e7fe94dd8fc3242da
2023-11-20T11:52:46
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "2.3.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "2.3.1", "examples": [ "2.3.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.27.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
bef5b8dcdb88b14c7271f99e5e5bc07fc488f8fd
2024-04-02T14:13:59
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.0" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.0" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableWeightChangesDynamicReload": { "default": false, "examples": [ false ], "title": "Enables weight changes without reloading for NGINX Plus", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.0" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.5.0", "examples": [ "3.5.0" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "telemetryReporting": { "default": {}, "properties": { "enable": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" } }, "required": [], "title": "Configure telemetry reporting options", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
nginxinc/kubernetes-ingress
1e8e309cd523f38dc0f03c9ec349430c9121e24f
2024-05-09T15:49:53
charts/nginx-ingress/values.schema.json
4,548
2024-05-28T13:42:57.224635Z
{ "$schema": "https://json-schema.org/draft/2019-09/schema", "default": {}, "examples": [ { "controller": { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.1" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podDisruptionBudget": { "annotations": {}, "enabled": false, "minAvailable": 0, "minUnavailable": 0 }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "setAsDefaultIngress": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } }, "nginxServiceMesh": { "enable": false, "enableEgress": false }, "prometheus": { "create": true, "port": 9113, "scheme": "http", "secret": "", "service": { "create": false, "labels": {} }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} } }, "rbac": { "create": true }, "serviceInsight": { "create": true, "port": 9114, "scheme": "http", "secret": "" } } ], "properties": { "controller": { "default": {}, "examples": [ { "affinity": {}, "appprotect": { "enable": false, "logLevel": "fatal" }, "appprotectdos": { "debug": false, "enable": false, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 }, "config": { "annotations": {}, "entries": {}, "name": "" }, "customConfigMap": "", "customPorts": [], "defaultHTTPListenerPort": 80, "defaultHTTPSListenerPort": 443, "defaultTLS": { "cert": "", "key": "", "secret": "" }, "disableIPV6": false, "enableCertManager": false, "enableCustomResources": true, "enableExternalDNS": false, "enableLatencyMetrics": false, "enableOIDC": false, "enableSnippets": false, "enableTLSPassthrough": false, "env": [], "extraContainers": [], "globalConfiguration": { "create": false, "spec": {} }, "healthStatus": false, "healthStatusURI": "/nginx-health", "hostNetwork": false, "image": { "digest": "", "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.1" }, "includeYear": false, "ingressClass": "nginx", "initContainerResources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "initContainerSecurityContext": {}, "initContainers": [], "kind": "deployment", "lifecycle": {}, "logLevel": 1, "minReadySeconds": 0, "name": "", "nginxDebug": false, "nginxReloadTimeout": 60000, "nginxStatus": { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 }, "nginxplus": false, "nodeSelector": {}, "pod": { "annotations": {}, "extraLabels": {} }, "podSecurityContext": { "seccompProfile": { "type": "RuntimeDefault" } }, "priorityClassName": "", "readOnlyRootFilesystem": false, "readyStatus": { "enable": true, "initialDelaySeconds": 0, "port": 8081 }, "replicaCount": 1, "reportIngressStatus": { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" }, "resources": { "requests": { "cpu": "100m", "memory": "128Mi" } }, "securityContext": {}, "service": { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "type": "LoadBalancer" }, "serviceAccount": { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" }, "serviceMonitor": { "create": false, "endpoints": {}, "labels": {}, "selectorMatchLabels": {} }, "setAsDefaultIngress": false, "shareProcessNamespace": false, "strategy": {}, "terminationGracePeriodSeconds": 30, "tlsPassthroughPort": 443, "tolerations": [], "topologySpreadConstraints": {}, "volumeMounts": [], "volumes": [], "watchNamespace": "", "wildcardTLS": { "cert": "", "key": "", "secret": "" } } ], "properties": { "affinity": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity", "default": {}, "title": "The affinity Schema", "type": "object" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "appprotect": { "default": {}, "examples": [ { "enable": true, "logLevel": "fatal" } ], "properties": { "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect WAF module in the Ingress Controller", "type": "boolean" }, "logLevel": { "default": "", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ], "examples": [ "fatal", "error", "warn", "info", "debug", "trace" ], "title": "The logLevel for App Protect WAF", "type": "string" } }, "required": [ "enable" ], "title": "The App Protect WAF Schema", "type": "object" }, "appprotectdos": { "default": {}, "examples": [ { "debug": false, "enable": true, "maxDaemons": 0, "maxWorkers": 0, "memory": 0 } ], "properties": { "debug": { "default": false, "examples": [ false, true ], "title": "debugging for App Protect DoS", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Enable the App Protect DoS module in the Ingress Controller", "type": "boolean" }, "maxDaemons": { "default": 0, "examples": [ 0 ], "title": "Max number of ADMD instances", "type": "integer" }, "maxWorkers": { "default": 0, "examples": [ 0 ], "title": "Max number of nginx processes to support", "type": "integer" }, "memory": { "default": 0, "examples": [ 0 ], "title": "RAM memory size to consume in MB", "type": "integer" } }, "required": [ "enable" ], "title": "The App Protect DoS Schema", "type": "object" }, "config": { "default": {}, "examples": [ { "annotations": {}, "entries": {}, "name": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "entries": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The entries Schema", "type": "object" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The config Schema", "type": "object" }, "containerPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/containerPort" } }, "title": "The containerPort Schema", "type": "object" }, "customConfigMap": { "default": "", "examples": [ "" ], "title": "The customConfigMap Schema", "type": "string" }, "customPorts": { "default": [], "examples": [ [ { "containerPort": 80, "name": "http", "protocol": "TCP" }, { "containerPort": 443, "name": "https", "protocol": "TCP" } ] ], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort", "type": "object" }, "title": "The customPorts to expose on the NGINX Ingress Controller pod", "type": "array" }, "debug": { "default": {}, "examples": [ { "continue": "fatal", "enable": true } ], "properties": { "continue": { "default": true, "examples": [ false, true ], "title": "Starts Delve with --continue which means that IC will not wait for a debugger attach to start", "type": "boolean" }, "enable": { "default": false, "examples": [ false, true ], "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "boolean" } }, "title": "Runs the container with Delve, expects a version of the IC container with dlv as the entrypoint", "type": "object" }, "defaultHTTPListenerPort": { "default": 80, "examples": [ 80 ], "title": "The defaultHTTPListenerPort", "type": "integer" }, "defaultHTTPSListenerPort": { "default": 443, "examples": [ 443 ], "title": "The defaultHTTPSListenerPort", "type": "integer" }, "defaultTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The defaultTLS Schema", "type": "object" }, "disableIPV6": { "default": false, "examples": [ false ], "title": "The disableIPV6", "type": "boolean" }, "dnsPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy" }, { "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ] } ], "type": "string" }, "enableCertManager": { "default": false, "examples": [ false ], "title": "The enableCertManager", "type": "boolean" }, "enableCustomResources": { "default": false, "examples": [ true ], "title": "The enableCustomResources", "type": "boolean" }, "enableExternalDNS": { "default": false, "examples": [ false ], "title": "The enableExternalDNS", "type": "boolean" }, "enableLatencyMetrics": { "default": false, "examples": [ false ], "title": "The enableLatencyMetrics", "type": "boolean" }, "enableOIDC": { "default": false, "examples": [ false ], "title": "The enableOIDC", "type": "boolean" }, "enableSSLDynamicReload": { "default": true, "examples": [ true ], "title": "Enable dynamic certificate reloads for NGINX Plus", "type": "boolean" }, "enableSnippets": { "default": false, "examples": [ false ], "title": "The enableSnippets", "type": "boolean" }, "enableTLSPassthrough": { "default": false, "examples": [ false ], "title": "The enableTLSPassthrough", "type": "boolean" }, "enableWeightChangesDynamicReload": { "default": false, "examples": [ false ], "title": "Enables weight changes without reloading for NGINX Plus", "type": "boolean" }, "env": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar", "type": "object" }, "title": "The env Schema", "type": "array" }, "extraContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The extraContainers Schema", "type": "array" }, "globalConfiguration": { "default": {}, "examples": [ { "create": false, "spec": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create Schema", "type": "boolean" }, "spec": { "default": {}, "examples": [ {} ], "properties": { "listeners": { "default": [], "items": { "default": {}, "properties": { "name": { "default": "", "examples": [ "dns-tcp" ], "title": "The name", "type": "string" }, "port": { "default": 0, "examples": [ 5353 ], "title": "The port", "type": "integer" }, "protocol": { "default": "", "examples": [ "TCP" ], "title": "The protocol", "type": "string" } }, "type": "object" }, "title": "The listeners Schema", "type": "array" } }, "required": [], "title": "The spec Schema", "type": "object" } }, "required": [ "create", "spec" ], "title": "The globalConfiguration Schema", "type": "object" }, "healthStatus": { "default": false, "examples": [ false ], "title": "The healthStatus", "type": "boolean" }, "healthStatusURI": { "default": "/nginx-health", "examples": [ "/nginx-health" ], "format": "uri-reference", "title": "The healthStatusURI Schema", "type": "string" }, "hostNetwork": { "default": false, "examples": [ false, true ], "title": "The hostNetwork Schema", "type": "boolean" }, "hostPort": { "additionalProperties": false, "default": {}, "patternProperties": { "^.*$": { "anyOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort/properties/hostPort" }, { "type": "boolean" } ] } }, "title": "The hostPort Schema", "type": "object" }, "image": { "default": {}, "examples": [ { "pullPolicy": "IfNotPresent", "repository": "nginx/nginx-ingress", "tag": "3.5.1" } ], "properties": { "digest": { "default": "", "examples": [ "sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572" ], "title": "The digest of the Ingress Controller image", "type": "string" }, "pullPolicy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy" }, { "enum": [ "Always", "IfNotPresent", "Never" ] } ], "default": "IfNotPresent", "examples": [ "Always", "IfNotPresent", "Never" ], "title": "The pullPolicy for the Ingress Controller image", "type": "string" }, "repository": { "default": "nginx/nginx-ingress", "examples": [ "nginx/nginx-ingress" ], "title": "The repository of the Ingress Controller", "type": "string" }, "tag": { "default": "3.5.1", "examples": [ "3.5.1" ], "title": "The tag of the Ingress Controller image", "type": "string" } }, "required": [ "repository" ], "title": "The image Schema", "type": "object" }, "includeYear": { "default": false, "examples": [ false ], "title": "The includeYear", "type": "boolean" }, "ingressClass": { "default": {}, "properties": { "create": { "default": true, "examples": [ true ], "title": "The create", "type": "boolean" }, "name": { "default": "", "examples": [ "nginx" ], "title": "The ingressClass name", "type": "string" }, "setAsDefaultIngress": { "default": false, "examples": [ false ], "title": "The setAsDefaultIngress", "type": "boolean" } }, "required": [], "title": "The ingressClass", "type": "object" }, "initContainerResources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "initContainerSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The initContainerSecurityContext Schema", "type": "object" }, "initContainers": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container", "type": "object" }, "title": "The initContainers Schema", "type": "array" }, "kind": { "default": "", "enum": [ "deployment", "daemonset" ], "examples": [ "deployment", "daemonset" ], "title": "The kind of the Ingress Controller", "type": "string" }, "lifecycle": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle", "default": {}, "title": "The lifecycle Schema", "type": "object" }, "logLevel": { "default": 1, "enum": [ 0, 1, 2, 3 ], "examples": [ 1 ], "title": "The logLevel of the Ingress Controller", "type": "integer" }, "minReadySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds", "default": 0, "title": "The minReadySeconds Schema", "type": "integer" }, "name": { "default": "", "examples": [ "controller" ], "title": "The name of the Ingress Controller", "type": "string" }, "nginxDebug": { "default": false, "examples": [ false, true ], "title": "Enables debugging for NGINX", "type": "boolean" }, "nginxReloadTimeout": { "default": 0, "examples": [ 60000 ], "title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start", "type": "integer" }, "nginxStatus": { "default": {}, "examples": [ { "allowCidrs": "127.0.0.1", "enable": true, "port": 8080 } ], "properties": { "allowCidrs": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "The allowCidrs", "type": "string" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "port": { "default": 8080, "examples": [ 8080 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The nginxStatus Schema", "type": "object" }, "nginxplus": { "default": false, "examples": [ false, true ], "title": "Deploys the Ingress Controller for NGINX Plus", "type": "boolean" }, "nodeSelector": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector", "default": {}, "title": "The nodeSelector Schema", "type": "object" }, "pod": { "default": {}, "examples": [ { "annotations": {}, "extraLabels": {} } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "extraLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The extraLabels Schema", "type": "object" } }, "required": [], "title": "The pod Schema", "type": "object" }, "podDisruptionBudget": { "default": {}, "examples": [ { "enable": true, "minAvailable": 1 }, { "enable": true, "maxUnavailable": 1 } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enabled": { "type": "boolean" }, "maxUnavailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable" }, "minAvailable": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable" } }, "required": [ "enabled" ], "title": "The podDisruptionBudget Schema", "type": "object" }, "podSecurityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSecurityContext", "default": {}, "title": "The podSecurityContext Schema", "type": "object" }, "priorityClassName": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName", "default": "", "title": "The priorityClassName", "type": "string" }, "readOnlyRootFilesystem": { "default": false, "examples": [ false ], "title": "The readOnlyRootFilesystem", "type": "boolean" }, "readyStatus": { "default": {}, "examples": [ { "enable": true, "initialDelaySeconds": 0, "port": 8081 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "initialDelaySeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds", "default": 0, "type": "integer" }, "port": { "default": 0, "examples": [ 8081 ], "title": "The port", "type": "integer" } }, "required": [], "title": "The readyStatus", "type": "object" }, "replicaCount": { "default": 1, "examples": [ 1 ], "title": "The replicaCount", "type": "integer" }, "reportIngressStatus": { "default": {}, "examples": [ { "annotations": {}, "enable": true, "enableLeaderElection": true, "externalService": "", "ingressLink": "", "leaderElectionLockName": "" } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "enableLeaderElection": { "default": false, "examples": [ true ], "title": "The enableLeaderElection", "type": "boolean" }, "externalService": { "default": "", "examples": [ "" ], "title": "The externalService", "type": "string" }, "ingressLink": { "default": "", "examples": [ "" ], "title": "The ingressLink", "type": "string" }, "leaderElectionLockName": { "default": "", "examples": [ "" ], "title": "The leaderElectionLockName", "type": "string" } }, "required": [ "enable" ], "title": "The reportIngressStatus Schema", "type": "object" }, "resources": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements", "default": {}, "title": "The resources Schema", "type": "object" }, "securityContext": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext", "default": {}, "title": "The securityContext Schema", "type": "object" }, "selectorLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorLabels Schema", "type": "object" }, "service": { "default": {}, "examples": [ { "allocateLoadBalancerNodePorts": false, "annotations": {}, "create": true, "customPorts": [], "externalIPs": [], "externalTrafficPolicy": "Local", "extraLabels": {}, "httpPort": { "enable": true, "port": 80, "targetPort": 80 }, "httpsPort": { "enable": true, "port": 443, "targetPort": 443 }, "ipFamilies": [], "ipFamilyPolicy": "", "loadBalancerIP": "", "loadBalancerSourceRanges": [], "name": "", "type": "LoadBalancer" } ], "properties": { "allocateLoadBalancerNodePorts": { "default": false, "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts", "title": "The allocateLoadBalancerNodePorts Schema", "type": "boolean" }, "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations", "type": "object" }, "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "customPorts": { "default": [], "items": { "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort", "type": "object" }, "title": "The customPorts", "type": "array" }, "externalIPs": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs", "default": [], "title": "The externalIPs", "type": "array" }, "externalTrafficPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy", "default": "", "title": "The externalTrafficPolicy", "type": "string" }, "extraLabels": { "default": {}, "examples": [ {} ], "properties": {}, "required": [], "title": "The extraLabels", "type": "object" }, "httpPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 80, "targetPort": 80 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 80 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 80 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpPort", "type": "object" }, "httpsPort": { "default": {}, "examples": [ { "enable": true, "nodePort": "", "port": 443, "targetPort": 443 } ], "properties": { "enable": { "default": false, "examples": [ true ], "title": "The enable", "type": "boolean" }, "nodePort": { "default": 0, "examples": [ 443 ], "title": "The nodePort", "type": "integer" }, "port": { "default": 0, "examples": [ 443 ], "title": "The port", "type": "integer" }, "targetPort": { "default": 0, "examples": [ 443 ], "title": "The targetPort", "type": "integer" } }, "required": [], "title": "The httpsPort", "type": "object" }, "ipFamilies": { "default": [], "ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies", "title": "The ipFamilies Schema", "type": "array" }, "ipFamilyPolicy": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy", "default": "", "examples": [ "" ], "title": "The ipFamilyPolicy Schema", "type": "string" }, "loadBalancerIP": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP", "default": "", "title": "The loadBalancerIP", "type": "string" }, "loadBalancerSourceRanges": { "default": [], "examples": [ [] ], "items": {}, "title": "The loadBalancerSourceRanges", "type": "array" }, "type": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type", "default": "", "title": "The type", "type": "string" } }, "required": [], "title": "The service Schema", "type": "object" }, "serviceAccount": { "default": {}, "examples": [ { "imagePullSecretName": "", "imagePullSecretsNames": [], "name": "" } ], "oneOf": [ { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "minItems": 1 } }, "required": [ "imagePullSecretsNames" ] }, { "properties": { "imagePullSecretName": { "minLength": 1 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName" ] }, { "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } }, "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, { "not": { "required": [ "imagePullSecretName", "imagePullSecretsNames" ] }, "properties": { "imagePullSecretName": { "maxLength": 0 }, "imagePullSecretsNames": { "maxItems": 0 } } } ], "properties": { "annotations": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations", "default": {}, "title": "The annotations Schema", "type": "object" }, "imagePullSecretName": { "default": "", "examples": [ "" ], "title": "The imagePullSecretName", "type": "string" }, "imagePullSecretsNames": { "default": [], "examples": [ [] ], "title": "The imagePullSecretName list", "type": "array" }, "name": { "default": "", "examples": [ "" ], "title": "The name Schema", "type": "string" } }, "required": [], "title": "The serviceAccount Schema", "type": "object" }, "shareProcessNamespace": { "default": false, "examples": [ false, true ], "title": "Enables sharing of the process namespace between pods within the Ingress Controller", "type": "boolean" }, "strategy": { "allOf": [ { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy" }, { "properties": { "type": { "enum": [ "Recreate", "RollingUpdate", "OnDelete" ], "type": "string" } } } ], "default": {}, "title": "The strategy Schema", "type": "object" }, "telemetryReporting": { "default": {}, "properties": { "enable": { "default": true, "examples": [ true ], "title": "Enable telemetry reporting", "type": "boolean" } }, "required": [], "title": "Configure telemetry reporting options", "type": "object" }, "terminationGracePeriodSeconds": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds", "default": 30, "title": "The terminationGracePeriodSeconds Schema", "type": "integer" }, "tlsPassthroughPort": { "default": 443, "examples": [ 443 ], "title": "The tlsPassthroughPort", "type": "integer" }, "tolerations": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration", "type": "object" }, "title": "The tolerations Schema", "type": "array" }, "topologySpreadConstraints": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints", "default": {}, "title": "The topologySpreadConstraints Schema", "type": "object" }, "volumeMounts": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount", "type": "object" }, "title": "The volumeMounts Schema", "type": "array" }, "volumes": { "default": [], "items": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume", "type": "object" }, "title": "The volumes Schema", "type": "array" }, "watchNamespace": { "default": "", "examples": [ "" ], "title": "The watchNamespace", "type": "string" }, "watchSecretNamespace": { "default": "", "examples": [ "" ], "title": "The watchSecretNamespace", "type": "string" }, "wildcardTLS": { "default": {}, "examples": [], "properties": { "cert": { "default": "", "examples": [ "" ], "title": "The cert Schema", "type": "string" }, "key": { "default": "", "examples": [ "" ], "title": "The key Schema", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret Schema", "type": "string" } }, "required": [], "title": "The wildcardTLS Schema", "type": "object" } }, "required": [ "name", "kind", "image" ], "title": "The Ingress Controller Helm Schema", "type": "object" }, "nginxAgent": { "default": { "enable": false }, "properties": { "customConfigMap": { "default": "", "examples": [ "my-custom-configmap" ], "title": "The name of a custom ConfigMap to use instead of the one provided by default", "type": "string" }, "enable": { "default": false, "examples": [ false ], "title": "Enable NGINX Agent", "type": "boolean" }, "instanceGroup": { "default": "", "examples": [ "my-instance-group" ], "title": "Set the --instance-group argument for NGINX Agent", "type": "string" }, "instanceManager": { "default": {}, "examples": [], "properties": { "grpcPort": { "default": 443, "examples": [ 443 ], "title": "Port for connecting to NGINX Instance Manager", "type": "integer" }, "host": { "examples": [ "nim.example.com" ], "title": "FQDN or IP for connecting to NGINX Instance Manager", "type": "string" }, "sni": { "default": "", "examples": [ "nim.example.com" ], "title": "Server Name Indication for NGINX Instance Manager", "type": "string" }, "tls": { "default": {}, "properties": { "caSecret": { "default": "", "title": "nginx.org/ca secret for verification of Instance Manager TLS", "type": "string" }, "enable": { "default": "true", "title": "enable TLS for NGINX Instance Manager connection", "type": "boolean" }, "secret": { "default": "", "title": "kubernetes.io/tls secret with a TLS certificate and key for using mTLS between NGINX Agent and NGINX Instance Manager", "type": "string" }, "skipVerify": { "default": "false", "title": "skip certificate verification", "type": "boolean" } }, "title": "TLS configuration for connection between NGINX Agent and NGINX Instance Manager", "type": "object" } }, "required": [ "host" ], "title": "Configuration for the connection to NGINX Instance Manager", "type": "object" }, "logLevel": { "default": "info", "enum": [ "panic", "fatal", "error", "info", "debug", "trace" ], "examples": [ "error" ], "title": "Log level for NGINX Agent", "type": "string" }, "napMonitoring": { "default": {}, "properties": { "collectorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for collector. Will contain log lines and parsed log lines", "type": "integer" }, "processorBufferSize": { "default": 50000, "examples": [ 50000 ], "title": "Buffer size for processor. Will contain log lines and parsed log lines", "type": "integer" } }, "title": "NGINX App Protect Monitoring config", "type": "object" }, "syslog": { "default": { "host": "127.0.0.1", "port": 1514 }, "properties": { "host": { "default": "127.0.0.1", "examples": [ "127.0.0.1" ], "title": "Address for NGINX Agent to run syslog listener", "type": "string" }, "port": { "default": 1514, "examples": [ 1514 ], "title": "Port for NGINX Agent to run syslog listener", "type": "integer" } }, "title": "Syslog listener which NGINX Agent uses to accept messages from App Protect WAF", "type": "object" } }, "required": [ "enable" ], "title": "Configuration for NGINX Agent.", "type": "object" }, "nginxServiceMesh": { "default": {}, "examples": [ { "enable": false, "enableEgress": false } ], "properties": { "enable": { "default": false, "examples": [ false ], "title": "The enable", "type": "boolean" }, "enableEgress": { "default": false, "examples": [ false ], "title": "The enableEgress", "type": "boolean" } }, "required": [ "enable" ], "title": "The nginxServiceMesh Schema", "type": "object" }, "prometheus": { "default": {}, "examples": [ { "create": true, "port": 9113, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9113, "examples": [ 9113 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" }, "service": { "default": {}, "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" } }, "type": "object" }, "serviceMonitor": { "default": {}, "examples": [ { "create": false, "endpoints": [], "labels": {}, "selectorMatchLabels": {} } ], "properties": { "create": { "default": false, "examples": [ false ], "title": "The create", "type": "boolean" }, "endpoints": { "default": [], "items": {}, "required": [], "title": "The endpoints", "type": "array" }, "labels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels", "default": {}, "title": "The labels Schema", "type": "object" }, "selectorMatchLabels": { "$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.29.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels", "default": {}, "title": "The selectorMatchLabels Schema", "type": "object" } }, "required": [], "title": "The serviceMonitor Schema", "type": "object" } }, "required": [ "create" ], "title": "The prometheus Schema", "type": "object" }, "rbac": { "default": {}, "examples": [ { "create": true } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create Schema", "type": "boolean" } }, "required": [ "create" ], "title": "The rbac Schema", "type": "object" }, "serviceInsight": { "default": {}, "examples": [ { "create": true, "port": 9114, "scheme": "http", "secret": "" } ], "properties": { "create": { "default": false, "examples": [ true ], "title": "The create", "type": "boolean" }, "port": { "default": 9114, "examples": [ 9114 ], "title": "The port", "type": "integer" }, "scheme": { "default": "http", "examples": [ "http" ], "title": "The scheme", "type": "string" }, "secret": { "default": "", "examples": [ "" ], "title": "The secret", "type": "string" } }, "required": [ "create" ], "title": "The Service Insight Schema", "type": "object" } }, "required": [ "controller", "rbac", "prometheus", "serviceInsight", "nginxServiceMesh" ], "title": "Root Schema", "type": "object" }
Apache-2.0
en
miob-miob/treeGarden
d6bea16a8cd472ecb3828fd31360dec07631ca0b
2022-11-14T23:37:27
docs/mk_docs_material.json
5
2024-05-29T15:55:13.828573Z
{ "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "markdownDescription": "Configuration", "properties": { "INHERIT": { "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance", "pattern": "\\.yml$", "title": "Inherit from configuration" }, "copyright": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#copyright-notice", "title": "Copyright, used in footer", "type": "string" }, "dev_addr": { "default": "127.0.0.1:8000", "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#dev_addr", "title": "Development IP Address", "type": "string" }, "docs_dir": { "default": "docs", "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#docs_dir", "title": "Directory containing the Markdown sources", "type": "string" }, "edit_uri": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#edit-button", "title": "Path from repository root to directory containing Markdown", "type": "string" }, "extra": { "$ref": "schema/extra.json" }, "extra_css": { "items": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css", "pattern": "\\.css($|\\?)", "title": "Path to CSS file" }, "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css", "minItems": 1, "title": "Additional CSS files to include", "type": "array", "uniqueItems": true }, "extra_javascript": { "items": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript", "pattern": "\\.js($|\\?)", "title": "Path to JavaScript file" }, "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript", "minItems": 1, "title": "Additional JavaScript files to include", "type": "array", "uniqueItems": true }, "extra_templates": { "items": { "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates", "pattern": "\\.html$", "title": "Path to HTML file" }, "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates", "minItems": 1, "title": "Additional HTML files to include", "type": "array", "uniqueItems": true }, "markdown_extensions": { "$ref": "schema/extensions.json" }, "nav": { "$ref": "schema/nav.json" }, "plugins": { "$ref": "schema/plugins.json" }, "remote_branch": { "default": "gh-pages", "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#remote_branch", "title": "Remote branch to deploy to", "type": "string" }, "remote_name": { "default": "origin", "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#remote_name", "title": "Remote origin to deploy to", "type": "string" }, "repo_name": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-name", "title": "Repository name, used in header", "type": "string" }, "repo_url": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository", "title": "Repository URL", "type": "string" }, "site_author": { "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_author", "title": "Site author, used in document head", "type": "string" }, "site_description": { "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_description", "title": "Site description, used in document head and in social cards", "type": "string" }, "site_dir": { "default": "site", "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_dir", "title": "Directory containing the HTML output", "type": "string" }, "site_name": { "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_name", "title": "Site name, used in header, title and drawer", "type": "string" }, "site_url": { "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_url", "title": "Site URL", "type": "string" }, "strict": { "default": false, "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#strict", "title": "Strict mode", "type": "boolean" }, "theme": { "$ref": "schema/theme.json" }, "use_directory_urls": { "default": false, "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#use_directory_urls", "title": "Pages are located in their own directories", "type": "boolean" } }, "title": "Material for MkDocs", "type": "object" }
MIT
en
molsonkiko/JsonToolsNppPlugin
ec1f54b6e7aa85eec8c7594df58d8a7e08b0e3ee
2023-03-16T04:26:13
schemasToFnamePatterns_SCHEMA.json
64
2024-05-27T05:33:15.974001Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "patternProperties": { ".+": { "items": { "type": "string" }, "minItems": 1, "type": "array" }, "^$": false }, "properties": {}, "required": [], "type": "object" }
Apache-2.0
fr
building-energy/sap2012
c7a338bbb078ae20c68a9bed3a1cb57d0d209c57
2023-07-14T06:21:22
sap2012/SAP_input_schema/rdSAP_2012_input_schema.json
10
2024-05-28T03:44:03.512904Z
{ "$defs": { "building_part": { "properties": { "above_the_building_part": { "description": "Whether the highest floor has [see options]. For a park home select pitched or flat as appropriate.", "enum": [ "pitched roof (slates or tiles), access to loft", "pitched roof (slates or tiles), no access", "pitched roof, sloping ceiling", "pitched roof (thatched)", "flat roof", "same dwelling above", "another dwelling above" ], "title": "Above the building part" }, "age_band": { "description": "According to S2", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L" ], "title": "Age band" }, "alternative_wall": { "description": "For any building part with an alternative wall.", "oneOf": [ { "const": "not applicable" }, { "properties": { "is_sheltered_wall": { "description": "Sheltered wall apples only to the building part of a flat or maisonette that is adjacent to an unheated corridor or stairwell. If sheltered its area is calculated from the shelter length and not specified separately.", "enum": [ "yes", "no" ], "title": "Is sheltered wall" }, "net_area_of_alternative_wall": { "description": "", "minimum": 0, "title": "Net area of alternative wall", "type": "number" }, "wall_construction": { "$ref": "#/$defs/wall_construction" }, "wall_dry_lined_or_lath_and_plaster": { "$ref": "#/$defs/wall_dry_lined_or_lath_and_plaster" }, "wall_insulation_thickness": { "$ref": "#/$defs/wall_insulation_thickness" }, "wall_insulation_type": { "$ref": "#/$defs/wall_insulation_type" }, "wall_thickness": { "$ref": "#/$defs/wall_thickness" }, "wall_u_value": { "$ref": "#/$defs/wall_u_value" } }, "required": [ "wall_construction", "wall_thickness", "wall_insulation_type", "wall_insulation_thickness", "wall_u_value", "wall_dry_lined_or_lath_and_plaster", "net_area_of_alternative_wall", "is_sheltered_wall" ], "type": "object" } ], "title": "Alternative wall" }, "below_the_building_part": { "description": "Whether the lowest floor is/has [see options]. A partially heated space below applies when it is above non-domestic premises. An unheated space below applies when it is above a space not used for habitation. If above more than one type, it is classified according to the largest floor area concerned.", "enum": [ "ground floor", "above partially / intermittently heated space (commerical premises)", "above unheated space", "to external air", "same dwelling below", "another dwelling below" ], "title": "Below the building part" }, "dimensions": { "description": "For each storey from lowest occupied floor up to lowest occupied + 6. For rooms-in-roof, measure floor area only, inside the dwelling.", "properties": { "lowest_occupied_floor": { "$ref": "#/$defs/dimensions", "description": "", "title": "Lowest occupied floor", "type": "object" }, "lowest_occupied_floor_plus_1": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 1" }, "lowest_occupied_floor_plus_2": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 2" }, "lowest_occupied_floor_plus_3": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 3" }, "lowest_occupied_floor_plus_4": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 4" }, "lowest_occupied_floor_plus_5": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 5" }, "lowest_occupied_floor_plus_6": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 6" } }, "required": [ "lowest_occupied_floor", "lowest_occupied_floor_plus_1", "lowest_occupied_floor_plus_2", "lowest_occupied_floor_plus_3", "lowest_occupied_floor_plus_4", "lowest_occupied_floor_plus_5", "lowest_occupied_floor_plus_6" ], "title": "Dimensions", "type": "object" }, "flat_roof_insulation_thickness": { "description": "Only if roof insulation is `flat roof insulation`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Flat roof insulation thickness" }, "floor_construction": { "description": "For the lowest floor of the building part. Not if another dwelling or other premises below.", "enum": [ "unknown", "solid", "suspended timber", "suspended, not timber" ], "title": "Floor construction" }, "floor_insulation": { "description": "Not if another dwelling or other premises below. There must be evidence for retrofit insulation.", "enum": [ "unknown", "as built", "retrofitted" ], "title": "Floor insulation" }, "floor_insulation_thickness": { "description": "Only if floor insulation is retrofitted. Applies to ground floors and exposed upper floors. `Insulation thickness` and `U-value` are mutually exclusive.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "50mm", "100 mm", "150 mm" ] } ], "title": "Floor insulation thickness" }, "floor_u_value": { "description": "Value in W/m2K. `Insulation thickness` and `U-value` are mutually exclusive.", "oneOf": [ { "const": "not appliable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Floor U-value" }, "party_wall_construction": { "description": "Except for detached properties there must be at least one building part with a party wall. `not applicable` applies to a detached property and to building parts of other properties not adjoining a party wall.", "enum": [ "solid masonry, timber frame or system built", "masonry cavity unfilled", "masonry cavity filled", "not applicable", "unable to determine" ], "title": "Party wall construction" }, "rafter_insulation_thickness": { "description": "Only if roof insulation is `at rafters`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Rafter insulation thickness" }, "roof_insulation": { "description": "If not same or another dwelling above. `None` does not apply to a flat roof or a pitched roof with sloping ceiling. There must be evidence for joist, rafter, flat roof or sloping ceiling insulation, toherwise it is `unknown`. `At rafters` can appy to a thatched roof.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "none", "at joists", "at rafters", "flat roof insulation", "sloping ceiling insulation", "unknown" ] } ], "title": "Roof insulation" }, "roof_insulation_thickness": { "description": "loft space [OR?] pitched roof with insulation at joists, applies to roof or parts of roof without roof room. Only for roof insulation at joist level and where can be accessed. If none or unknown this is recorded via the preceding item.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "12 mm", "15 mm", "50 mm", "75 mm", "100 mm", "150 mm", "200 mm", "250 mm", "270 mm", "300 mm", "350 mm", "400+ mm" ] } ], "title": "Roof insulation thickness" }, "roof_room_age_band": { "description": "According to S2", "oneOf": [ { "const": "not applicable" }, { "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L" ] } ], "title": "Room roof age band" }, "roof_room_area_and_u_value_details": { "description": "Up to 2 of each of these. Only where these details are collected; if so they supercede roof room insulation and roof room insulation thickness.", "oneOf": [ { "const": "not applicable" }, { "properties": { "roof_room_1": { "description": "", "properties": { "flat_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Flat ceiling" }, "gable_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Gable wall" }, "sloping_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Sloping ceiling" }, "stud_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Stud wall" } }, "required": [ "flat_ceiling", "sloping_ceiling", "stud_wall", "gable_wall" ], "title": "Roof room 1", "type": "object" }, "roof_room_2": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "flat_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Flat ceiling" }, "gable_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Gable wall" }, "sloping_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Sloping ceiling" }, "stud_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Stud wall" } }, "required": [ "flat_ceiling", "sloping_ceiling", "stud_wall", "gable_wall" ], "type": "object" } ], "title": "Roof room 2" } }, "required": [ "roof_room_1", "roof_room_2" ], "type": "object" } ], "title": "Roof room area and u_value details" }, "roof_room_insulation": { "description": "Only when there is a roof room in the building part concerned. There must be evidence for insulation of flat ceiling or all elements, toherwise it is `as built` or `unknown`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "flat ceiling only", "all elements" ] } ], "title": "Roof room insulation" }, "roof_room_insulation_thickness_flat_part": { "description": "On flat part of roof of roof room. Only if roof room insulation is `flat ceiling only` or `all elements`. `not applicable` is for the case of (documentary) evidence of insulation of all elements, but it is a vaulted ceiling with no flat part.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Roof room insulation thickness flat part" }, "roof_room_insulation_thickness_other_parts": { "description": "Other parts of roof room. Only if roof room insulation is `all elements`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Roof room insulation thickness other parts" }, "roof_rooms_connected": { "description": "Whether the roof rooms are connected to or are adjacent to antoher building part of the same dwelling. An adjacent part can be another roof room or a normal storey.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Roof rooms connected" }, "roof_u_value": { "description": "Value in W/m2K. `Insulation thickness` (loft, rafter or flat roof) and `U-value` are mutually exclusive alternatives.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Roof U-value" }, "sloping_ceiling_insulation_thickness": { "description": "Only if roof insulation is `sloping ceiling insulation`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Sloping ceiling insulation thickness" }, "wall_construction": { "$ref": "#/$defs/wall_construction" }, "wall_dry_lined_or_lath_and_plaster": { "$ref": "#/$defs/wall_dry_lined_or_lath_and_plaster" }, "wall_insulation_thickness": { "$ref": "#/$defs/wall_insulation_thickness" }, "wall_insulation_type": { "$ref": "#/$defs/wall_insulation_type" }, "wall_thickness": { "$ref": "#/$defs/wall_thickness" }, "wall_u_value": { "$ref": "#/$defs/wall_u_value" } }, "required": [ "age_band", "below_the_building_part", "above_the_building_part", "dimensions", "floor_construction", "floor_insulation", "floor_insulation_thickness", "floor_u_value", "wall_construction", "wall_thickness", "wall_insulation_type", "wall_insulation_thickness", "wall_u_value", "wall_dry_lined_or_lath_and_plaster", "alternative_wall", "party_wall_construction", "roof_insulation", "roof_insulation_thickness", "rafter_insulation_thickness", "flat_roof_insulation_thickness", "sloping_ceiling_insulation_thickness", "roof_U_value", "roof_room_age_band", "roof_rooms_connected", "roof_room_insulation", "roof_room_insulation_thickness_flat_part", "roof_room_insulation_thickness_other_parts", "roof_room_area_and_u_value_details" ], "type": "object" }, "dimensions": { "properties": { "area": { "description": "", "exclusiveMinimum": 0, "title": "Area", "type": "number" }, "average_room_height": { "description": "", "exclusiveMinimum": 0, "title": "Average room height", "type": "number" }, "exposed_perimieter": { "description": "", "minimum": 0, "title": "Exposed perimiter", "type": "number" }, "party_wall_length": { "description": "", "minimum": 0, "title": "Party wall length", "type": "number" } }, "required": [ "area", "average_room_height", "exposed_perimieter", "party_wall_length" ], "type": "object" }, "heating_controls": { "properties": { "compensating_controller": { "description": "", "enum": [ "yes", "no", "not applicable" ], "title": "Compensating controller" }, "item": { "oneOf": [ { "const": "unknown" }, { "type": "string" } ], "title": "Item from table 4e accroding to main system type." }, "product_index_number": { "description": "Product index number of controller if applicable.", "oneOf": [ { "const": "not applicable" }, { "type": "string" } ], "title": "Product index number" } }, "required": [ "item", "compensating_controller", "product_index_number" ], "type": "object" }, "heating_system": { "properties": { "central_heating_pump_age": { "description": "For wet systems. `unknown` if the pump cannot be located.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "2012 or earlier", "2013 or later", "unknown" ] } ], "title": "Central heating pump age" }, "design_flow_temperature": { "description": "Design flow temperature of heat generator. Applicable to heat pumps and condensing boilers. `unknown` unless documentary evidence is available giving the design flow temperature. Option `<=45C and over 35C` not available for heat pumps from SAP tables.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "over 45C", "<= 45C and over 35C", "<= 35C" ] } ], "title": "Design flow temperature" }, "fan_flued": { "description": "Not if from database. For gas boilers 1998 or later, [the] whether or not fan-flued.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Fan flued" }, "flue_type": { "description": "Applies to boilers, micro-CHP and warm-air systems. For fires and roomheaters use normal flue type indicated in Table 4a.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "open", "room-sealed" ] } ], "title": "Flue type" }, "fuel": { "description": "Fuel for heating. If `none`, the calcuation is done for portable electric heaters with no controls.", "enum": [ "none", "..." ], "title": "Fuel" }, "heat_emitter_type": { "description": "For gas and oil boilers, for heat pumps to water and for electric CPSUs. If underfloor downstairs and radiators upstairs, select `radiators`. `fan coil units` for heat pumps only.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "radiators", "underfloor", "fan coil units" ] } ], "title": "Heat emitter type" }, "ignition_type": { "description": "Not if from database. For gas boilers 1998 or later.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "auto-ignition", "permenant pilot light" ] } ], "title": "Ignition type" }, "mcs_installation": { "description": "For heat pumps. `yes` only if documentary evidence is available.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "MCS installation" }, "product_index_number": { "description": "Product index number whenever possible for boilers, micro-CHP, heat pumps, warm air systems, storage heaters, otherwise system (marked `rd`) from Table 4a or 4b. If product can be identified, its characteristics are obtained via the database. Storage heaters (high heat retention types only): index number of each heater.", "oneOf": [ { "const": "unknown" }, { "type": "string" }, { "$comment": "For storage heaters (high heat retention types only)", "items": { "oneOf": [ { "const": "unknown" }, { "type": "string" } ] }, "type": "array" } ], "title": "Product index number" } }, "required": [ "fuel", "product_index_number", "flue_type", "ignition_type", "fan_flued", "heat_emitter_type", "central_heating_pump_age", "mcs_installation", "design_flow_temperature" ], "type": "object" }, "pv_array": { "properties": { "orientation": { "description": "If not horizontal.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "S", "SE", "E", "NE", "N", "NW", "W", "SW" ] } ], "title": "orientation" }, "overshading": { "description": "", "enum": [ "very little", "modest", "significant", "heavy" ], "title": "Overshading" }, "size": { "description": "Size in kWp.", "exclusiveMinimum": 0, "title": "Size", "type": "number" }, "tilt": { "description": "", "enum": [ "horizontal", "30 deg", "45 deg", "60 deg", "vertical" ], "title": "Tilt" } }, "required": [ "size", "tilt", "orientation", "overshading" ], "type": "object" }, "roof_room_area_and_u_value_details": { "properties": { "area": { "description": "", "exclusiveMinimum": 0, "title": "Area", "type": "number" }, "u_value": { "description": "", "exclusiveMinimum": 0, "title": "U-value", "type": "number" } }, "type": "object" }, "wall_construction": { "description": "`park home wall` is the only option for a park home.", "enum": [ "stone (granite or shinstone)", "stone (sandstone or limestone)", "solid brick", "cob", "cavity", "timber frame", "park home wall", "system build (i.e. an other)" ], "title": "Wall construction" }, "wall_dry_lined_or_lath_and_plaster": { "description": "Only for uninsulated stone, solid brick or cavity walls in age bands A to E.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Wall dry-lined or lath and plaster" }, "wall_insulation_thickness": { "description": "Only if wall insulation is external, internal or cavity (filled or unfilled) plus external or internal.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "50 mm", "100 mm", "150 mm", "200 mm" ] } ], "title": "Wall insulation thickness" }, "wall_insulation_type": { "description": "External, cavity or internal insulation to be indicated only if added subsequent to original construction and evidence exists. If it has only the insulation that was part of the original construction it is `as built`.", "enum": [ "as built", "external", "filled cavity", "internal", "cavity plus external", "cavity plus internal", "unknown" ], "title": "Wall insulation type" }, "wall_thickness": { "description": "Wall thickness in mm (or unknown if it cannot be measured. Where thickness varies for the same construction use the average of the measured values.", "minimum": 0, "title": "Wall thickness", "type": "number" }, "wall_u_value": { "description": "Value in W/m2K. Can be given where known for any wall. `Insulation thickness` and `U-value` are mutually exclusive.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Wall U-value" }, "window": { "properties": { "area": { "description": "Including frame", "exclusiveMinimum": 0, "title": "Area", "type": "number" }, "glazing_type": { "description": "", "enum": [ "single glazing", "double glazing pre year 2002 in England & Wales", "double glazing pre year 2003 in Scotland", "double glazing pre year 2006 in Northern Ireland", "double glazing during or post year 2002 in England & Wales", "double glazing during or post year 2003 in Scotland", "double glazing during or post year 2006 in Northern Ireland", "double glazing unknown date", "secondary glazing", "triple glazing", "double, known U-value", "triple, known U-value" ], "title": "Glazing type" }, "location": { "description": "", "enum": [ "mian_dwelling", "extension_1", "extension_2", "extension_3", "extension_4" ], "title": "Location" }, "orientation": { "description": "", "enum": [ "S", "SE", "E", "NE", "N", "NW", "W", "SW", "horizontal" ], "title": "Orientation" }, "pvc_window_frames": { "description": "To be included when the glazing type is `double glazing pre year 2002 in England & Wales`, `double glazing pre year 2003 in Scotland`, `double glazing pre year 2006 in Northern Ireland` or `double glazing unknown date`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "PVC window frames" }, "pvc_window_glazing_gap": { "description": "To be included if PVC window frames", "oneOf": [ { "const": "not applicable" }, { "enum": [ "6 mm", "12 mm", "16 mm or more" ] } ], "title": "PVC window glazing gap" }, "window_data_source": { "description": "Manufacturer or BFRC", "oneOf": [ { "const": "not applicable" }, { "type": "string" } ], "title": "Window data source" }, "window_g-value": { "description": "Value to 2 d.p. Only when glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "type": "number" } ], "title": "Window g-value" }, "window_or_roof_window": { "description": "", "enum": [ "window", "roof window" ], "title": "Window or roof window" }, "window_u_value": { "description": "Value in W/m2K. Only when glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Window U-value" } }, "required": [ "location", "window_or_roof_window", "area", "glazing_type", "pvc_window_frames", "pvc_window_glazing_gap", "orientation", "window_u_value", "window_g_value", "window_data_source" ], "type": "object" } }, "$id": "", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "JSON schema for an input file for rdSAP 2012 calculations", "properties": { "building_parts": { "properties": { "extension_1": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "extension_2": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "extension_3": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "extension_4": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "main_dwelling": { "$ref": "#/$defs/building_part" } }, "required": [ "main_dwelling", "extension_1", "extension_2", "extension_3", "extension_4" ], "type": "object" }, "whole_dwelling": { "properties": { "built_form_and_detachment": { "description": "Classification according to S1. Detachment does not need to be recorded for flats/maisonettes, provided that internal dimensions are being used. ", "oneOf": [ { "const": "not applicable" }, { "enum": [ "detached", "semi-detached", "mid-terrace", "end-terrace", "enclosed mid-terrace", "enclosed end-terrace" ] } ], "title": "Built form and detachment" }, "community_heating_system": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "fuel": { "description": "Required if index number is `unknown`. Fuel used by comunity system. If fuel cannot be ascertained, assume mains gas.", "oneOf": [ { "const": "not appliable" }, { "enum": [ "mains gas", "..." ] } ], "title": "Fuel" }, "heat_generator_type": { "description": "Required if index number is `unknown`.", "oneOf": [ { "const": "not appliable" }, { "enum": [ "boilers", "CHP and boilers", "heat pump" ] } ], "title": "Heat generator type" }, "index_number": { "description": "index number of community heat network if known", "oneOf": [ { "const": "unknown" }, { "type": "string" } ], "title": "Index number" } }, "required": [ "index_number", "fuel", "heat_generator_type" ], "type": "object" } ], "title": "Community heating system" }, "conservatory": { "description": "", "enum": [ "no conservatory", "separated, no fixed heaters", "separated, fixed heaters", "not separated" ], "title": "Conservatory" }, "conservatory_details": { "description": "Non-separated conservatory only.", "oneOf": [ { "const": "not applicable" }, { "description": "See section 3.3.3.", "properties": { "double_glazed": { "description": "", "enum": [ "yes", "no" ], "title": "Double glazed" }, "floor_area": { "description": "", "exclusiveMinimum": 0, "title": "Floor area", "type": "number" }, "glazed_perimeter": { "description": "", "minimum": 0, "title": "Glazed perimeter", "type": "number" }, "height": { "description": "Number of half storeys of the main dwelling.", "exclusiveMinimum": 0, "title": "Height", "type": "integer" }, "type": { "const": "not separated", "description": "", "title": "Type" } }, "required": [ "type", "floor_area", "glazed_perimeter", "double_glazed", "height" ], "type": "object" } ], "title": "Conservatory details" }, "country": { "description": "", "enum": [ "England & Wales", "Scotland", "Northern Ireland" ], "title": "Country" }, "dimension_type": { "description": "Measured_internally_or_externally. Applies to areas and perimiters. Room heights always measured internally within the room. See S3.", "enum": [ "measured_internally", "measured_externally" ], "title": "Dimension type" }, "draught_proofing": { "description": "Percentage of all windows and doors that are draught proofed.", "maximum": 100, "minimum": 0, "title": "Draught proofing", "type": "number" }, "dwelling_type": { "description": "", "enum": [ "house", "bungalow", "flat", "maisonette", "park home" ], "title": "Dwelling type" }, "electricity_meter": { "description": "See S12", "enum": [ "dual", "single", "18-hour", "24-hour", "unknown" ], "title": "Electricity meter" }, "fireplaces": { "description": "Number of open fireplaces", "minimum": 0, "title": "Fireplaces", "type": "integer" }, "flats_and_maisonettes_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "floor_level_relative_to_the_lowest_level_of_the_building": { "description": "0 for ground floor. This is the lowest floor level if property has more than one storey. If there is a basement, the basement is level 0 and the other floors from 1 upwards.", "minimum": 0, "title": "Floor level relative to the lowest level of the building", "type": "number" }, "heat_loss_corridor": { "description": "", "enum": [ "no corridor", "heated corridor", "unheated corridor" ], "title": "Heat loss corridor" }, "length_of_sheltered_wall": { "description": "If unheated corridor, length of sheltered wall. The length of wall between the flat and corridor. If a flat or maisonette is sheltered on more than on storey this is the total of the sheltered lengths on each storey.", "minimum": 0, "title": "Length of sheltered wall", "type": "number" }, "property_position": { "description": "This is used for the description of the dwelling type on the EPC (eg. `Top-floor flat`).", "enum": [ "basement", "ground floor", "mid floor", "top floor" ], "title": "Property position" } }, "required": [ "heat_loss_corridor", "length_of_sheltered_wall", "floor_level_relative_to_the_lowest_level_of_the_building", "property_position" ], "type": "object" } ], "title": "Flats and maisonettes details" }, "flue_gas_heat_recovery": { "description": "", "enum": [ "yes", "no" ], "title": "Flue gas heat recovery" }, "flue_gas_heat_recovery_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "product_index_number": { "$comment": "... or should the type be `number` or `integer`??", "description": "Only if located in database.", "title": "Product index number", "type": "string" } }, "required": [ "product_index_number" ], "type": "object" } ], "title": "Flue gas heat recovery details" }, "insulated_door_u_value": { "description": "Where there are insulated doors. Value in W/m2K. Average for the insulated external doors (where applicable).", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Insulated door U-value" }, "main_heating_controls": { "$ref": "#/$defs/heating_controls", "description": "", "title": "Main heating controls" }, "main_heating_system": { "description": "", "oneOf": [ { "const": "none" }, { "$ref": "#/$defs/heating_system" } ], "title": "Main heating system" }, "mains_gas_available": { "description": "Yes means that there is a gas meter or a gas-burning appliance (e.g. a cooker) in the dwelling. A closed-off gas pipe does not count. Where a boiler is present attached to a heating system (not in a box), and the mains gas meter has been removed for security reasons, enter a gas boiler as the main form of heating and indicate that mains gas is present. Can be relevant to improvemnt recommendations.", "enum": [ "yes", "no" ], "title": "Mains gas available" }, "mechanical_ventilation": { "description": "Applies to whole house ventilation system only. Otherwise natural ventilation is assumed. Intermittent extract fans (kitched and bathrooms) are not a mechanical ventilation system for SAP calculations, but continuously running extract fans in wet rooms are treated as mechanical ventilation.", "enum": [ "yes", "no" ], "title": "Mechanical ventilation" }, "mechanical_ventilation_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "type": { "description": "", "enum": [ "extract-only", "balanced" ], "title": "Type" } }, "required": [ "type" ], "type": "object" } ], "title": "Mechanical ventilation details" }, "number_of_extensions": { "maximum": 4, "minimum": 0, "title": "Number of extensions", "type": "integer" }, "number_of_external_doors": { "description": "Doors to a heated access corridor are not included in the door count.", "minimum": 0, "title": "Number of external doors", "type": "integer" }, "number_of_habitable_rooms": { "description": "Total as defined in S9.1, inclusive of main property and any extension.", "minimum": 0, "title": "Number of habitable rooms", "type": "integer" }, "number_of_heated_habitable_rooms": { "description": "Total as defined in S9.1, inclusive of main prooerty and any extension. A heated room is one with a fixed heat emitter in the room.", "minimum": 0, "title": "Number of heated habitable rooms", "type": "integer" }, "number_of_insulated_external_doors": { "description": "Only if their U-value is known.", "minimum": 0, "title": "Number of insulated external doors", "type": "integer" }, "number_of_rooms_with_bath_and_or_shower": { "description": "These items are always collected, to enable a recommendation for waste water heat recovery.", "minimum": 0, "title": "Number of rooms with bath and/or shower", "type": "integer" }, "number_of_rooms_with_mixer_shower_and_bath": { "description": "These items are always collected, to enable a recommendation for waste water heat recovery.", "minimum": 0, "title": "Number of rooms with mixer shower and bath", "type": "integer" }, "number_of_rooms_with_mixer_shower_and_no_bath": { "description": "These items are always collected, to enable a recommendation for waste water heat recovery.", "minimum": 0, "title": "Number of rooms with mixer shower and no bath", "type": "integer" }, "photovoltaic_array": { "description": "", "enum": [ "yes", "no" ], "title": "Photovoltaic array" }, "photovoltaic_array_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "description": "a)", "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" }, "percentage_of_external_roof_area": { "description": "% of external roof area with PVs", "maximum": 100, "minimum": 0, "title": "Percentage of external roof area", "type": "number" } }, "required": [ "percentage_of_external_roof_area", "connected_to_dwellings_electricity_meter" ], "type": "object" }, { "description": "b) to be used when the information on kWp is available. In this case up to 3 PV arrays can be specified.", "properties": { "pv_array_1": { "allOf": [ { "$ref": "#/$defs/pv_array" }, { "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" } }, "required": [ "connected_to_dwellings_electricity_meter" ], "type": "object" } ] }, "pv_array_2": { "oneOf": [ { "const": "not applicable" }, { "allOf": [ { "$ref": "#/$defs/pv_array" }, { "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" } }, "required": [ "connected_to_dwellings_electricity_meter" ], "type": "object" } ] } ] }, "pv_array_3": { "oneOf": [ { "const": "not applicable" }, { "allOf": [ { "$ref": "#/$defs/pv_array" }, { "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" } }, "required": [ "connected_to_dwellings_electricity_meter" ], "type": "object" } ] } ] } }, "required": [ "pv_array_1", "pv_array_2", "pv_array_3" ], "type": "object" } ], "title": "Photovoltaic array details" }, "pv_for_flue_gas_heat_recovery": { "description": "Only for systems with a PV powered immersion.", "enum": [ "yes", "no" ], "title": "PV for flue gas heat recovery" }, "pv_for_flue_gas_heat_recovery_details": { "description": "Only for systems with a PV powered immersion.", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/pv_array" } ], "title": "PV for flue gas heat recovery details" }, "region": { "description": "One of those in SAP2012 Table U1. Derived from the postcode of the property.", "enum": [ "Thames", "South East England", "Southern England", "South West England", "Severn Wales / Severn England", "Midlands", "West Pennines Wales / West Pennines England", "north West England / South West Scotland", "Borders Scotland / Borders England", "North East England", "East Pennines", "East Anglia", "Wales", "West Scotland", "East Scotland", "North East Scotland", "Highland", "Western Isles", "Orkney", "Shetland", "Northern Ireland" ], "title": "Region" }, "second_main_heating_controls": { "$ref": "#/$defs/heating_controls", "description": "", "title": "Second main heating controls" }, "second_main_heating_system": { "description": "System 1 is that heating the living area. If there is a boiler providing DHW only, assign it as the 2nd main system with a space heating percentage of zero", "oneOf": [ { "const": "not applicable" }, { "allOf": [ { "$ref": "#/$defs/heating_system" }, { "properties": { "percentage_of_heated_floor_area": { "description": "The percentage of the heated floor area served by the second system. Estimate percentage to nearest 10%.", "maximum": 100, "minimum": 0, "title": "Percentage of heated floor area", "type": "integer" } }, "required": [ "percentage_of_heated_floor_area" ], "type": "object" } ] } ], "title": "Second main heating systme" }, "secondary_heating_systems": { "description": "`none` if no secondary heating system.", "oneOf": [ { "const": "none" }, { "properties": { "fuel": { "description": "", "enum": [ "..." ], "title": "Fuel" }, "system": { "description": "System from room heater section of Table 4a.", "enum": [ "..." ], "title": "System" } }, "required": [ "fuel", "system" ], "type": "object" } ], "title": "Secondary heating system" }, "solar_collector_details": { "description": "Only if solar panel present and solar water heating details known. Documentary evidence is required to enter collector values.", "oneOf": [ { "const": "not applicable" }, { "properties": { "collector_2nd_order_heat_loss_coefficient": { "description": "", "maximum": 1, "minimum": 0, "title": "Collector 2nd order heat loss coefficient", "type": "number" }, "collector_aperture_area": { "description": "", "exclusiveMinimum": 0, "title": "Collector aperture area", "type": "number" }, "collector_linear_heat_loss_coefficient": { "description": "", "maximum": 1, "minimum": 0, "title": "Collector linear heat loss coefficient", "type": "number" }, "collector_type": { "description": "", "enum": [ "evacuated tube", "flat plate", "unglazed" ], "title": "Collector type" }, "collector_zero_loss_efficiency": { "description": "", "maximum": 1, "minimum": 0, "title": "Collector zero loss efficiency", "type": "number" } }, "required": [ "collector_aperture_area", "collector_type", "collector_zero_loss_efficiency", "collector_linear_heat_loss_coefficient", "collector_2nd_order_heat_loss_coefficient" ], "type": "object" } ], "title": "Solar collector details" }, "solar_collector_details_known": { "description": "", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Solar collector details known" }, "solar_store_details": { "description": "Only if solar panel present and solar water heating details known and solar collector details known.", "oneOf": [ { "const": "not applicable" }, { "properties": { "combined_solar_store": { "description": "", "enum": [ "yes", "no" ], "title": "Combined solar store" }, "dedicated_solar_volume": { "description": "", "minimum": 0, "title": "Dedicated solar volume", "type": "number" }, "total_hot_water_store_volume": { "description": "", "minimum": 0, "title": "Total hot water store volume", "type": "number" } }, "required": [ "combined_solar_store", "total_hot_water_store_volume", "dedicated_solar_volume" ], "type": "object" } ], "title": "Solar store details" }, "solar_store_details_known": { "description": "", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Solar store details known" }, "solar_water_heating": { "description": "Solar panel", "enum": [ "yes", "no" ], "title": "Solar water heating" }, "solar_water_heating_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "orientation": { "description": "If not horizontal.", "enum": [ "Not applicable", "S", "SE", "E", "NE", "N", "NW", "W", "SW" ], "title": "orientation" }, "overshading": { "description": "", "enum": [ "very little", "modest", "significant", "heavy" ], "title": "Overshading" }, "solar_water_pump": { "description": "", "enum": [ "electrically powered", "solar powered", "unknown" ], "title": "Solar water pump" }, "tilt": { "description": "", "enum": [ "horizontal", "30 deg", "45 deg", "60 deg", "vertical" ], "title": "Tilt" }, "types_of_showers": { "$comment": "should this be an array??", "description": "`electric only` where the ware is heated as the shower runs. If the shower is supplied from a hot-water cylinder it is classified as non-electric even though the cylinder is electrically heated.", "enum": [ "non-electric only", "electric only", "both electric and non-electric", "no shower" ], "title": "Type(s) of showers" } }, "required": [ "tilt", "orientation", "overshading", "solar_water_pump", "types_of_showers" ], "type": "object" } ], "title": "Solar water heating details" }, "solar_water_heating_details_known": { "description": "If yes, then details", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Solar water heating details known" }, "space_coooling_system_present": { "description": "", "enum": [ "yes", "no" ], "title": "Space cooling system present" }, "swimming_pool": { "description": "A swimming pool is not included in the dataset. Count the room containing the swimming pool as a habitable room and add addendum 4 (see S15).", "enum": [ "yes", "no" ], "title": "Swimming pool" }, "tenure": { "description": "", "enum": [ "owner-occupied", "rented (social)", "rented (private)", "unknown" ], "title": "Tenure" }, "terrain": { "description": "Used to generate wind turbine recommendation where appropriate - data item must always be collected.", "enum": [ "dense urban", "low rise urban or suburban", "rural" ], "title": "Terrain" }, "total_number_of_fixed_lighting_outlets": { "description": "Where there are 4 or more downlighters / ceiling lights divide the bulb count by 2. Include fixed under-cupboard kitchen strip lights.", "minimum": 0, "title": "Total number of fixed lighting outlets", "type": "integer" }, "total_number_of_low_energy_fixed_lighting_outlets": { "description": "LEDs are considered as low energy lights. Where there are 4 or more downlighters / ceiling lights divide the bulb count by 2. Include fixed under-cupboard kitchen strip lights.", "minimum": 0, "title": "Total number of low energy fixed lighting outlets", "type": "integer" }, "transaction_type": { "description": "Non-marketed sale include right-to-buy.", "enum": [ "marketed sale", "non-marketed sale", "rental", "stock condition survey", "assessment for Green Deal", "following Green Deal", "FIT application", "RHI application", "ECO assessment", "none of the above" ], "title": "Transaction type" }, "waste_water_heat_recovery": { "description": "", "enum": [ "none", "instantaneous", "storage" ], "title": "Waste water heat recovery" }, "waste_water_heat_recovery_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "description": "If instantaneous type present. if located in database. Number of rooms with bath and/or shower includes rooms with only an electric shower. If two showers found in a room, count as one. Only mixer showers count for instantaneous waste water heat recovery. Mixer shower means a dhower where the hot water is provided by a boiler (combi or regular), heat pump or immersion heater. A mixer shower attached to bath taps is recorded as a mixer shower only if there is a permenant bracket over the bath at least 1.5m above the plughole and there is a shower curtain or screen.", "properties": { "number_of_mixer_showers_with_system_1_in_rooms_with_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 1 in rooms with bath", "type": "integer" }, "number_of_mixer_showers_with_system_1_in_rooms_without_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 1 in rooms without bath", "type": "integer" }, "number_of_mixer_showers_with_system_2_in_rooms_with_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 2 in rooms with bath", "type": "integer" }, "number_of_mixer_showers_with_system_2_in_rooms_without_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 2 in rooms without bath", "type": "integer" }, "number_of_systems": { "description": "", "maximum": 2, "minimum": 1, "title": "Number of systems", "type": "integer" }, "system_1_product_index_number": { "description": "", "title": "System 1 product index number", "type": "string" }, "system_2_product_index_number": { "description": "", "title": "System 2 product index number", "type": "string" } }, "required": [ "number_of_systems", "system_1_product_index_number", "number_of_mixer_showers_with_system_1_in_rooms_with_bath", "number_of_mixer_showers_with_system_1_in_rooms_without_bath", "system_2_product_index_number", "number_of_mixer_showers_with_system_2_in_rooms_with_bath", "number_of_mixer_showers_with_system_2_in_rooms_without_bath" ], "type": "object" }, { "description": "If storage type present. if located in database.", "properties": { "number_of_showers_and_bath_routed_through_WWHRS": { "description": "", "minimum": 0, "title": "Number of showers and bath routed through WWHRS", "type": "integer" }, "product_index_number": { "description": "", "title": "Product Index Number", "type": "string" }, "total_showers_and_bath": { "description": "", "minimum": 0, "title": "Total shower and bath", "type": "integer" } }, "type": "object" } ], "title": "Waste water heat recovery details" }, "water_heating": { "description": "", "properties": { "cylinder_insulation_thickness": { "description": "", "enum": [ "not applicable", "0 mm", "12 mm", "25 mm", "38 mm", "50 mm", "80 mm", "120 mm", "160 mm" ], "title": "Cylinder insulation thickness" }, "cylinder_insulation_type": { "description": "unless no access", "oneOf": [ { "const": "no access" }, { "enum": [ "none", "loose jacket", "factory applied" ] } ], "title": "Cylinder insulation type" }, "cylinder_size": { "description": "Separate thermal store (hot-water only or integrated) treated as if it were a cylinder.", "enum": [ "no cylinder", "no access", "normal (up to 130 litres", "medium (131-170 litres)", "large (> 170litres)" ], "title": "Cylinder size" }, "cylinderstat": { "description": "Unless no access.", "enum": [ "no access", "yes", "no" ], "title": "Cylinderstat" }, "fuel": { "description": "Fuel also needed if not from main system.", "oneOf": [ { "const": "from main system" }, { "enum": [ "..." ] } ], "title": "Fuel" }, "single_or_dual": { "description": "If immersion, whether single or dual.", "enum": [ "not applicable", "single", "dual" ], "title": "single_or_dual" }, "system": { "description": "If no system, the calculation is done for an electric immersion, see text below table S17.", "enum": [ "from main heating system", "from 2nd main system", "from secondary system", "... [any other water heater marked `rd` in hot-water only section of Table 4a] ...", "no DHW system present" ], "title": "System" } }, "required": [ "system", "fuel", "cylinder_size", "cylinder_insulation_type", "cylinder_insulation_thickness", "single_or_dual", "cylinderstat" ], "title": "Water heating", "type": "object" }, "wind_tubine": { "description": "", "enum": [ "yes", "no" ], "title": "Wind turbine" }, "wind_turbine_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "height_above_ridge": { "description": "", "exclusiveMinimum": 0, "title": "Height above ridge", "type": "number" }, "number_of_turbines": { "description": "", "exclusiveMinimum": 0, "title": "Number of turbines", "type": "integer" }, "rotor_diameter": { "description": "", "exclusiveMinimum": 0, "title": "Rotor diameter", "type": "number" } }, "required": [ "number_of_turbines", "rotor_diameter", "height_above_ridge" ], "type": "object" } ], "title": "Wind turbine details" }, "wind_turbine_details_known": { "description": "Only if wind turbine is present.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Wind turbine details known" }, "window_area": { "description": "Of the dwelling only, not including any conservatory. `typical` refers to normal construction for the property type and age band concerned. If assessed as much more or much less than typical the area of each window should be measured.", "enum": [ "typical", "less than typical", "much less than typical", "more than typical", "much more than typical" ], "title": "Window area" }, "window_details": { "description": "If window area is `typical`, `less than typical` or `more than typical`.", "oneOf": [ { "const": "not applicable" }, { "properties": { "multiple_glazing_type": { "description": "", "enum": [ "double glazing pre year 2002 in England & Wales", "double glazing pre year 2003 in Scotland", "double glazing pre year 2006 in Northern Ireland", "double glazing during or post year 2002 in England & Wales", "double glazing during or post year 2003 in Scotland", "double glazing during or post year 2006 in Northern Ireland", "double glazing unknown date", "secondary glazing", "triple glazing", "double, known U-value", "triple, known U-value" ], "title": "Multiple glazing type" }, "proportion_with_multiple_glazing": { "description": "As percentage.", "title": "Proportion with multiple glazing", "type": "number" }, "pvc_window_frames": { "description": "To be included when the multiple glazing type is `double glazing pre year 2002 in England & Wales`, `double glazing pre year 2003 in Scotland`, `double glazing pre year 2006 in Northern Ireland` or `double glazing unknown date`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "PVC window frames" }, "pvc_window_glazing_gap": { "description": "To be included if PVC window frames", "oneOf": [ { "const": "not applicable" }, { "enum": [ "6 mm", "12 mm", "16 mm or more" ] } ], "title": "PVC window glazing gap" }, "window_data_source": { "description": "Manufacturer or BFRC", "oneOf": [ { "const": "not applicable" }, { "type": "string" } ], "title": "Window data source" }, "window_g_value": { "description": "Value to 2 d.p. Only when multiple glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "type": "number" } ], "title": "Window g-value" }, "window_u_value": { "description": "Value in W/m2K. Only when multiple glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Window U-value" } }, "required": [ "proportion_with_multiple_glazing", "multiple_glazing_type", "pvc_window_frames", "pvc_window_glazing_gap", "window_u_value", "window_g_value", "window_data_source" ], "type": "object" } ], "title": "Window details" }, "windows": { "description": "If window area is much less or much more than typical. For each window. This option can also be used if more than one type of multiple glazing.", "oneOf": [ { "const": "Not applicable" }, { "items": { "$ref": "#/$defs/window" }, "type": "array" } ], "title": "Windows" } }, "required": [ "country", "region", "transaction_type", "dwelling_type", "built_form_and_detachment", "number_of_habitable_rooms", "number_of_heated_habitable_rooms", "dimension_type", "conservatory", "conservatory_details", "flats_and_maisonettes_details", "number_of_extensions", "number_of_external_doors", "number_of_insulated_external_doors", "insulated_door_u_value", "window_area", "window_details", "windows", "draught_proofing", "fireplaces", "main_heating_system", "second_main_heating_system", "community_heating_system", "main_heating_controls", "second_main_heating_controls", "secondary_heating_systems", "water_heating", "solar_water_heating", "solar_water_heating_details_known", "solar_water_heating_details", "solar_collector_details_known", "solar_collector_details", "solar_store_details_known", "solar_store_details", "flue_gas_heat_recovery", "flue_gas_heat_recovery_details", "pv_for_flue_gas_heat_recovery", "pv_for_flue_gas_heat_recovery_details", "number_of_rooms_with_bath_and_or_shower", "number_of_rooms_with_mixer_shower_and_no_bath", "number_of_rooms_with_mixer_shower_and_bath", "waste_water_heat_recovery", "waste_water_heat_recovery_details", "space_coooling_system_present", "mechanical_ventilation", "mechanical_ventilation_details", "electricity_meter", "mains_gas_available", "photovoltaic_array", "photovoltaic_array_details", "terrain", "wind_tubine", "wind_turbine_details_known", "wind_turbine_details", "total_number_of_fixed_lighting_outlets", "total_number_of_low_energy_fixed_lighting_outlets", "swimming_pool" ], "type": "object" } }, "required": [ "whole_dwelling", "building_parts" ], "title": "rdSAP_2012_input_schema", "type": "object" }
MIT
en
building-energy/sap2012
9f7e74c352dc42880e910e6780d63609f19d33ad
2023-07-14T06:23:41
sap2012/SAP_input_schema/rdSAP_2012_input_schema.json
10
2024-05-28T03:44:03.512904Z
{ "$defs": { "building_part": { "properties": { "above_the_building_part": { "description": "Whether the highest floor has [see options]. For a park home select pitched or flat as appropriate.", "enum": [ "pitched roof (slates or tiles), access to loft", "pitched roof (slates or tiles), no access", "pitched roof, sloping ceiling", "pitched roof (thatched)", "flat roof", "same dwelling above", "another dwelling above" ], "title": "Above the building part" }, "age_band": { "description": "According to S2", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L" ], "title": "Age band" }, "alternative_wall": { "description": "For any building part with an alternative wall.", "oneOf": [ { "const": "not applicable" }, { "properties": { "is_sheltered_wall": { "description": "Sheltered wall apples only to the building part of a flat or maisonette that is adjacent to an unheated corridor or stairwell. If sheltered its area is calculated from the shelter length and not specified separately.", "enum": [ "yes", "no" ], "title": "Is sheltered wall" }, "net_area_of_alternative_wall": { "description": "", "minimum": 0, "title": "Net area of alternative wall", "type": "number" }, "wall_construction": { "$ref": "#/$defs/wall_construction" }, "wall_dry_lined_or_lath_and_plaster": { "$ref": "#/$defs/wall_dry_lined_or_lath_and_plaster" }, "wall_insulation_thickness": { "$ref": "#/$defs/wall_insulation_thickness" }, "wall_insulation_type": { "$ref": "#/$defs/wall_insulation_type" }, "wall_thickness": { "$ref": "#/$defs/wall_thickness" }, "wall_u_value": { "$ref": "#/$defs/wall_u_value" } }, "required": [ "wall_construction", "wall_thickness", "wall_insulation_type", "wall_insulation_thickness", "wall_u_value", "wall_dry_lined_or_lath_and_plaster", "net_area_of_alternative_wall", "is_sheltered_wall" ], "type": "object" } ], "title": "Alternative wall" }, "below_the_building_part": { "description": "Whether the lowest floor is/has [see options]. A partially heated space below applies when it is above non-domestic premises. An unheated space below applies when it is above a space not used for habitation. If above more than one type, it is classified according to the largest floor area concerned.", "enum": [ "ground floor", "above partially / intermittently heated space (commerical premises)", "above unheated space", "to external air", "same dwelling below", "another dwelling below" ], "title": "Below the building part" }, "dimensions": { "description": "For each storey from lowest occupied floor up to lowest occupied + 6. For rooms-in-roof, measure floor area only, inside the dwelling.", "properties": { "lowest_occupied_floor": { "$ref": "#/$defs/dimensions", "description": "", "title": "Lowest occupied floor", "type": "object" }, "lowest_occupied_floor_plus_1": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 1" }, "lowest_occupied_floor_plus_2": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 2" }, "lowest_occupied_floor_plus_3": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 3" }, "lowest_occupied_floor_plus_4": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 4" }, "lowest_occupied_floor_plus_5": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 5" }, "lowest_occupied_floor_plus_6": { "description": "", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/dimensions" } ], "title": "Lowest occupied floor + 6" } }, "required": [ "lowest_occupied_floor", "lowest_occupied_floor_plus_1", "lowest_occupied_floor_plus_2", "lowest_occupied_floor_plus_3", "lowest_occupied_floor_plus_4", "lowest_occupied_floor_plus_5", "lowest_occupied_floor_plus_6" ], "title": "Dimensions", "type": "object" }, "flat_roof_insulation_thickness": { "description": "Only if roof insulation is `flat roof insulation`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Flat roof insulation thickness" }, "floor_construction": { "description": "For the lowest floor of the building part. Not if another dwelling or other premises below.", "enum": [ "unknown", "solid", "suspended timber", "suspended, not timber" ], "title": "Floor construction" }, "floor_insulation": { "description": "Not if another dwelling or other premises below. There must be evidence for retrofit insulation.", "enum": [ "unknown", "as built", "retrofitted" ], "title": "Floor insulation" }, "floor_insulation_thickness": { "description": "Only if floor insulation is retrofitted. Applies to ground floors and exposed upper floors. `Insulation thickness` and `U-value` are mutually exclusive.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "50mm", "100 mm", "150 mm" ] } ], "title": "Floor insulation thickness" }, "floor_u_value": { "description": "Value in W/m2K. `Insulation thickness` and `U-value` are mutually exclusive.", "oneOf": [ { "const": "not appliable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Floor U-value" }, "party_wall_construction": { "description": "Except for detached properties there must be at least one building part with a party wall. `not applicable` applies to a detached property and to building parts of other properties not adjoining a party wall.", "enum": [ "solid masonry, timber frame or system built", "masonry cavity unfilled", "masonry cavity filled", "not applicable", "unable to determine" ], "title": "Party wall construction" }, "rafter_insulation_thickness": { "description": "Only if roof insulation is `at rafters`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Rafter insulation thickness" }, "roof_insulation": { "description": "If not same or another dwelling above. `None` does not apply to a flat roof or a pitched roof with sloping ceiling. There must be evidence for joist, rafter, flat roof or sloping ceiling insulation, toherwise it is `unknown`. `At rafters` can appy to a thatched roof.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "none", "at joists", "at rafters", "flat roof insulation", "sloping ceiling insulation", "unknown" ] } ], "title": "Roof insulation" }, "roof_insulation_thickness": { "description": "loft space [OR?] pitched roof with insulation at joists, applies to roof or parts of roof without roof room. Only for roof insulation at joist level and where can be accessed. If none or unknown this is recorded via the preceding item.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "12 mm", "15 mm", "50 mm", "75 mm", "100 mm", "150 mm", "200 mm", "250 mm", "270 mm", "300 mm", "350 mm", "400+ mm" ] } ], "title": "Roof insulation thickness" }, "roof_room_age_band": { "description": "According to S2", "oneOf": [ { "const": "not applicable" }, { "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L" ] } ], "title": "Room roof age band" }, "roof_room_area_and_u_value_details": { "description": "Up to 2 of each of these. Only where these details are collected; if so they supercede roof room insulation and roof room insulation thickness.", "oneOf": [ { "const": "not applicable" }, { "properties": { "roof_room_1": { "description": "", "properties": { "flat_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Flat ceiling" }, "gable_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Gable wall" }, "sloping_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Sloping ceiling" }, "stud_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Stud wall" } }, "required": [ "flat_ceiling", "sloping_ceiling", "stud_wall", "gable_wall" ], "title": "Roof room 1", "type": "object" }, "roof_room_2": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "flat_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Flat ceiling" }, "gable_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Gable wall" }, "sloping_ceiling": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Sloping ceiling" }, "stud_wall": { "$ref": "#/$defs/roof_room_area_and_u_value_details", "description": "", "title": "Stud wall" } }, "required": [ "flat_ceiling", "sloping_ceiling", "stud_wall", "gable_wall" ], "type": "object" } ], "title": "Roof room 2" } }, "required": [ "roof_room_1", "roof_room_2" ], "type": "object" } ], "title": "Roof room area and u_value details" }, "roof_room_insulation": { "description": "Only when there is a roof room in the building part concerned. There must be evidence for insulation of flat ceiling or all elements, toherwise it is `as built` or `unknown`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "flat ceiling only", "all elements" ] } ], "title": "Roof room insulation" }, "roof_room_insulation_thickness_flat_part": { "description": "On flat part of roof of roof room. Only if roof room insulation is `flat ceiling only` or `all elements`. `not applicable` is for the case of (documentary) evidence of insulation of all elements, but it is a vaulted ceiling with no flat part.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Roof room insulation thickness flat part" }, "roof_room_insulation_thickness_other_parts": { "description": "Other parts of roof room. Only if roof room insulation is `all elements`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Roof room insulation thickness other parts" }, "roof_rooms_connected": { "description": "Whether the roof rooms are connected to or are adjacent to antoher building part of the same dwelling. An adjacent part can be another roof room or a normal storey.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Roof rooms connected" }, "roof_u_value": { "description": "Value in W/m2K. `Insulation thickness` (loft, rafter or flat roof) and `U-value` are mutually exclusive alternatives.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Roof U-value" }, "sloping_ceiling_insulation_thickness": { "description": "Only if roof insulation is `sloping ceiling insulation`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "as built", "50 mm", "100 mm", "150 mm or more" ] } ], "title": "Sloping ceiling insulation thickness" }, "wall_construction": { "$ref": "#/$defs/wall_construction" }, "wall_dry_lined_or_lath_and_plaster": { "$ref": "#/$defs/wall_dry_lined_or_lath_and_plaster" }, "wall_insulation_thickness": { "$ref": "#/$defs/wall_insulation_thickness" }, "wall_insulation_type": { "$ref": "#/$defs/wall_insulation_type" }, "wall_thickness": { "$ref": "#/$defs/wall_thickness" }, "wall_u_value": { "$ref": "#/$defs/wall_u_value" } }, "required": [ "age_band", "below_the_building_part", "above_the_building_part", "dimensions", "floor_construction", "floor_insulation", "floor_insulation_thickness", "floor_u_value", "wall_construction", "wall_thickness", "wall_insulation_type", "wall_insulation_thickness", "wall_u_value", "wall_dry_lined_or_lath_and_plaster", "alternative_wall", "party_wall_construction", "roof_insulation", "roof_insulation_thickness", "rafter_insulation_thickness", "flat_roof_insulation_thickness", "sloping_ceiling_insulation_thickness", "roof_U_value", "roof_room_age_band", "roof_rooms_connected", "roof_room_insulation", "roof_room_insulation_thickness_flat_part", "roof_room_insulation_thickness_other_parts", "roof_room_area_and_u_value_details" ], "type": "object" }, "dimensions": { "properties": { "area": { "description": "", "exclusiveMinimum": 0, "title": "Area", "type": "number" }, "average_room_height": { "description": "", "exclusiveMinimum": 0, "title": "Average room height", "type": "number" }, "exposed_perimieter": { "description": "", "minimum": 0, "title": "Exposed perimiter", "type": "number" }, "party_wall_length": { "description": "", "minimum": 0, "title": "Party wall length", "type": "number" } }, "required": [ "area", "average_room_height", "exposed_perimieter", "party_wall_length" ], "type": "object" }, "heating_controls": { "properties": { "compensating_controller": { "description": "", "enum": [ "yes", "no", "not applicable" ], "title": "Compensating controller" }, "item": { "oneOf": [ { "const": "unknown" }, { "type": "string" } ], "title": "Item from table 4e accroding to main system type." }, "product_index_number": { "description": "Product index number of controller if applicable.", "oneOf": [ { "const": "not applicable" }, { "type": "string" } ], "title": "Product index number" } }, "required": [ "item", "compensating_controller", "product_index_number" ], "type": "object" }, "heating_system": { "properties": { "central_heating_pump_age": { "description": "For wet systems. `unknown` if the pump cannot be located.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "2012 or earlier", "2013 or later", "unknown" ] } ], "title": "Central heating pump age" }, "design_flow_temperature": { "description": "Design flow temperature of heat generator. Applicable to heat pumps and condensing boilers. `unknown` unless documentary evidence is available giving the design flow temperature. Option `<=45C and over 35C` not available for heat pumps from SAP tables.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "over 45C", "<= 45C and over 35C", "<= 35C" ] } ], "title": "Design flow temperature" }, "fan_flued": { "description": "Not if from database. For gas boilers 1998 or later, [the] whether or not fan-flued.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Fan flued" }, "flue_type": { "description": "Applies to boilers, micro-CHP and warm-air systems. For fires and roomheaters use normal flue type indicated in Table 4a.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "open", "room-sealed" ] } ], "title": "Flue type" }, "fuel": { "description": "Fuel for heating. If `none`, the calcuation is done for portable electric heaters with no controls.", "enum": [ "none", "..." ], "title": "Fuel" }, "heat_emitter_type": { "description": "For gas and oil boilers, for heat pumps to water and for electric CPSUs. If underfloor downstairs and radiators upstairs, select `radiators`. `fan coil units` for heat pumps only.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "radiators", "underfloor", "fan coil units" ] } ], "title": "Heat emitter type" }, "ignition_type": { "description": "Not if from database. For gas boilers 1998 or later.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "auto-ignition", "permenant pilot light" ] } ], "title": "Ignition type" }, "mcs_installation": { "description": "For heat pumps. `yes` only if documentary evidence is available.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "MCS installation" }, "product_index_number": { "description": "Product index number whenever possible for boilers, micro-CHP, heat pumps, warm air systems, storage heaters, otherwise system (marked `rd`) from Table 4a or 4b. If product can be identified, its characteristics are obtained via the database. Storage heaters (high heat retention types only): index number of each heater.", "oneOf": [ { "const": "unknown" }, { "type": "string" }, { "$comment": "For storage heaters (high heat retention types only)", "items": { "oneOf": [ { "const": "unknown" }, { "type": "string" } ] }, "type": "array" } ], "title": "Product index number" } }, "required": [ "fuel", "product_index_number", "flue_type", "ignition_type", "fan_flued", "heat_emitter_type", "central_heating_pump_age", "mcs_installation", "design_flow_temperature" ], "type": "object" }, "pv_array": { "properties": { "orientation": { "description": "If not horizontal.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "S", "SE", "E", "NE", "N", "NW", "W", "SW" ] } ], "title": "orientation" }, "overshading": { "description": "", "enum": [ "very little", "modest", "significant", "heavy" ], "title": "Overshading" }, "size": { "description": "Size in kWp.", "exclusiveMinimum": 0, "title": "Size", "type": "number" }, "tilt": { "description": "", "enum": [ "horizontal", "30 deg", "45 deg", "60 deg", "vertical" ], "title": "Tilt" } }, "required": [ "size", "tilt", "orientation", "overshading" ], "type": "object" }, "roof_room_area_and_u_value_details": { "properties": { "area": { "description": "", "exclusiveMinimum": 0, "title": "Area", "type": "number" }, "u_value": { "description": "", "exclusiveMinimum": 0, "title": "U-value", "type": "number" } }, "type": "object" }, "wall_construction": { "description": "`park home wall` is the only option for a park home.", "enum": [ "stone (granite or shinstone)", "stone (sandstone or limestone)", "solid brick", "cob", "cavity", "timber frame", "park home wall", "system build (i.e. an other)" ], "title": "Wall construction" }, "wall_dry_lined_or_lath_and_plaster": { "description": "Only for uninsulated stone, solid brick or cavity walls in age bands A to E.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Wall dry-lined or lath and plaster" }, "wall_insulation_thickness": { "description": "Only if wall insulation is external, internal or cavity (filled or unfilled) plus external or internal.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "unknown", "50 mm", "100 mm", "150 mm", "200 mm" ] } ], "title": "Wall insulation thickness" }, "wall_insulation_type": { "description": "External, cavity or internal insulation to be indicated only if added subsequent to original construction and evidence exists. If it has only the insulation that was part of the original construction it is `as built`.", "enum": [ "as built", "external", "filled cavity", "internal", "cavity plus external", "cavity plus internal", "unknown" ], "title": "Wall insulation type" }, "wall_thickness": { "description": "Wall thickness in mm (or unknown if it cannot be measured. Where thickness varies for the same construction use the average of the measured values.", "minimum": 0, "title": "Wall thickness", "type": "number" }, "wall_u_value": { "description": "Value in W/m2K. Can be given where known for any wall. `Insulation thickness` and `U-value` are mutually exclusive.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Wall U-value" }, "window": { "properties": { "area": { "description": "Including frame", "exclusiveMinimum": 0, "title": "Area", "type": "number" }, "glazing_type": { "description": "", "enum": [ "single glazing", "double glazing pre year 2002 in England & Wales", "double glazing pre year 2003 in Scotland", "double glazing pre year 2006 in Northern Ireland", "double glazing during or post year 2002 in England & Wales", "double glazing during or post year 2003 in Scotland", "double glazing during or post year 2006 in Northern Ireland", "double glazing unknown date", "secondary glazing", "triple glazing", "double, known U-value", "triple, known U-value" ], "title": "Glazing type" }, "location": { "description": "", "enum": [ "mian_dwelling", "extension_1", "extension_2", "extension_3", "extension_4" ], "title": "Location" }, "orientation": { "description": "", "enum": [ "S", "SE", "E", "NE", "N", "NW", "W", "SW", "horizontal" ], "title": "Orientation" }, "pvc_window_frames": { "description": "To be included when the glazing type is `double glazing pre year 2002 in England & Wales`, `double glazing pre year 2003 in Scotland`, `double glazing pre year 2006 in Northern Ireland` or `double glazing unknown date`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "PVC window frames" }, "pvc_window_glazing_gap": { "description": "To be included if PVC window frames", "oneOf": [ { "const": "not applicable" }, { "enum": [ "6 mm", "12 mm", "16 mm or more" ] } ], "title": "PVC window glazing gap" }, "window_data_source": { "description": "Manufacturer or BFRC", "oneOf": [ { "const": "not applicable" }, { "type": "string" } ], "title": "Window data source" }, "window_g-value": { "description": "Value to 2 d.p. Only when glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "type": "number" } ], "title": "Window g-value" }, "window_or_roof_window": { "description": "", "enum": [ "window", "roof window" ], "title": "Window or roof window" }, "window_u_value": { "description": "Value in W/m2K. Only when glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Window U-value" } }, "required": [ "location", "window_or_roof_window", "area", "glazing_type", "pvc_window_frames", "pvc_window_glazing_gap", "orientation", "window_u_value", "window_g_value", "window_data_source" ], "type": "object" } }, "$id": "https://raw.githubusercontent.com/building-energy/sap2012/master/sap2012/SAP_input_schema/rdSAP_2012_input_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "JSON schema for an input file for rdSAP 2012 calculations", "properties": { "building_parts": { "properties": { "extension_1": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "extension_2": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "extension_3": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "extension_4": { "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/building_part" } ] }, "main_dwelling": { "$ref": "#/$defs/building_part" } }, "required": [ "main_dwelling", "extension_1", "extension_2", "extension_3", "extension_4" ], "type": "object" }, "whole_dwelling": { "properties": { "built_form_and_detachment": { "description": "Classification according to S1. Detachment does not need to be recorded for flats/maisonettes, provided that internal dimensions are being used. ", "oneOf": [ { "const": "not applicable" }, { "enum": [ "detached", "semi-detached", "mid-terrace", "end-terrace", "enclosed mid-terrace", "enclosed end-terrace" ] } ], "title": "Built form and detachment" }, "community_heating_system": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "fuel": { "description": "Required if index number is `unknown`. Fuel used by comunity system. If fuel cannot be ascertained, assume mains gas.", "oneOf": [ { "const": "not appliable" }, { "enum": [ "mains gas", "..." ] } ], "title": "Fuel" }, "heat_generator_type": { "description": "Required if index number is `unknown`.", "oneOf": [ { "const": "not appliable" }, { "enum": [ "boilers", "CHP and boilers", "heat pump" ] } ], "title": "Heat generator type" }, "index_number": { "description": "index number of community heat network if known", "oneOf": [ { "const": "unknown" }, { "type": "string" } ], "title": "Index number" } }, "required": [ "index_number", "fuel", "heat_generator_type" ], "type": "object" } ], "title": "Community heating system" }, "conservatory": { "description": "", "enum": [ "no conservatory", "separated, no fixed heaters", "separated, fixed heaters", "not separated" ], "title": "Conservatory" }, "conservatory_details": { "description": "Non-separated conservatory only.", "oneOf": [ { "const": "not applicable" }, { "description": "See section 3.3.3.", "properties": { "double_glazed": { "description": "", "enum": [ "yes", "no" ], "title": "Double glazed" }, "floor_area": { "description": "", "exclusiveMinimum": 0, "title": "Floor area", "type": "number" }, "glazed_perimeter": { "description": "", "minimum": 0, "title": "Glazed perimeter", "type": "number" }, "height": { "description": "Number of half storeys of the main dwelling.", "exclusiveMinimum": 0, "title": "Height", "type": "integer" }, "type": { "const": "not separated", "description": "", "title": "Type" } }, "required": [ "type", "floor_area", "glazed_perimeter", "double_glazed", "height" ], "type": "object" } ], "title": "Conservatory details" }, "country": { "description": "", "enum": [ "England & Wales", "Scotland", "Northern Ireland" ], "title": "Country" }, "dimension_type": { "description": "Measured_internally_or_externally. Applies to areas and perimiters. Room heights always measured internally within the room. See S3.", "enum": [ "measured_internally", "measured_externally" ], "title": "Dimension type" }, "draught_proofing": { "description": "Percentage of all windows and doors that are draught proofed.", "maximum": 100, "minimum": 0, "title": "Draught proofing", "type": "number" }, "dwelling_type": { "description": "", "enum": [ "house", "bungalow", "flat", "maisonette", "park home" ], "title": "Dwelling type" }, "electricity_meter": { "description": "See S12", "enum": [ "dual", "single", "18-hour", "24-hour", "unknown" ], "title": "Electricity meter" }, "fireplaces": { "description": "Number of open fireplaces", "minimum": 0, "title": "Fireplaces", "type": "integer" }, "flats_and_maisonettes_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "floor_level_relative_to_the_lowest_level_of_the_building": { "description": "0 for ground floor. This is the lowest floor level if property has more than one storey. If there is a basement, the basement is level 0 and the other floors from 1 upwards.", "minimum": 0, "title": "Floor level relative to the lowest level of the building", "type": "number" }, "heat_loss_corridor": { "description": "", "enum": [ "no corridor", "heated corridor", "unheated corridor" ], "title": "Heat loss corridor" }, "length_of_sheltered_wall": { "description": "If unheated corridor, length of sheltered wall. The length of wall between the flat and corridor. If a flat or maisonette is sheltered on more than on storey this is the total of the sheltered lengths on each storey.", "minimum": 0, "title": "Length of sheltered wall", "type": "number" }, "property_position": { "description": "This is used for the description of the dwelling type on the EPC (eg. `Top-floor flat`).", "enum": [ "basement", "ground floor", "mid floor", "top floor" ], "title": "Property position" } }, "required": [ "heat_loss_corridor", "length_of_sheltered_wall", "floor_level_relative_to_the_lowest_level_of_the_building", "property_position" ], "type": "object" } ], "title": "Flats and maisonettes details" }, "flue_gas_heat_recovery": { "description": "", "enum": [ "yes", "no" ], "title": "Flue gas heat recovery" }, "flue_gas_heat_recovery_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "product_index_number": { "$comment": "... or should the type be `number` or `integer`??", "description": "Only if located in database.", "title": "Product index number", "type": "string" } }, "required": [ "product_index_number" ], "type": "object" } ], "title": "Flue gas heat recovery details" }, "insulated_door_u_value": { "description": "Where there are insulated doors. Value in W/m2K. Average for the insulated external doors (where applicable).", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Insulated door U-value" }, "main_heating_controls": { "$ref": "#/$defs/heating_controls", "description": "", "title": "Main heating controls" }, "main_heating_system": { "description": "", "oneOf": [ { "const": "none" }, { "$ref": "#/$defs/heating_system" } ], "title": "Main heating system" }, "mains_gas_available": { "description": "Yes means that there is a gas meter or a gas-burning appliance (e.g. a cooker) in the dwelling. A closed-off gas pipe does not count. Where a boiler is present attached to a heating system (not in a box), and the mains gas meter has been removed for security reasons, enter a gas boiler as the main form of heating and indicate that mains gas is present. Can be relevant to improvemnt recommendations.", "enum": [ "yes", "no" ], "title": "Mains gas available" }, "mechanical_ventilation": { "description": "Applies to whole house ventilation system only. Otherwise natural ventilation is assumed. Intermittent extract fans (kitched and bathrooms) are not a mechanical ventilation system for SAP calculations, but continuously running extract fans in wet rooms are treated as mechanical ventilation.", "enum": [ "yes", "no" ], "title": "Mechanical ventilation" }, "mechanical_ventilation_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "type": { "description": "", "enum": [ "extract-only", "balanced" ], "title": "Type" } }, "required": [ "type" ], "type": "object" } ], "title": "Mechanical ventilation details" }, "number_of_extensions": { "maximum": 4, "minimum": 0, "title": "Number of extensions", "type": "integer" }, "number_of_external_doors": { "description": "Doors to a heated access corridor are not included in the door count.", "minimum": 0, "title": "Number of external doors", "type": "integer" }, "number_of_habitable_rooms": { "description": "Total as defined in S9.1, inclusive of main property and any extension.", "minimum": 0, "title": "Number of habitable rooms", "type": "integer" }, "number_of_heated_habitable_rooms": { "description": "Total as defined in S9.1, inclusive of main prooerty and any extension. A heated room is one with a fixed heat emitter in the room.", "minimum": 0, "title": "Number of heated habitable rooms", "type": "integer" }, "number_of_insulated_external_doors": { "description": "Only if their U-value is known.", "minimum": 0, "title": "Number of insulated external doors", "type": "integer" }, "number_of_rooms_with_bath_and_or_shower": { "description": "These items are always collected, to enable a recommendation for waste water heat recovery.", "minimum": 0, "title": "Number of rooms with bath and/or shower", "type": "integer" }, "number_of_rooms_with_mixer_shower_and_bath": { "description": "These items are always collected, to enable a recommendation for waste water heat recovery.", "minimum": 0, "title": "Number of rooms with mixer shower and bath", "type": "integer" }, "number_of_rooms_with_mixer_shower_and_no_bath": { "description": "These items are always collected, to enable a recommendation for waste water heat recovery.", "minimum": 0, "title": "Number of rooms with mixer shower and no bath", "type": "integer" }, "photovoltaic_array": { "description": "", "enum": [ "yes", "no" ], "title": "Photovoltaic array" }, "photovoltaic_array_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "description": "a)", "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" }, "percentage_of_external_roof_area": { "description": "% of external roof area with PVs", "maximum": 100, "minimum": 0, "title": "Percentage of external roof area", "type": "number" } }, "required": [ "percentage_of_external_roof_area", "connected_to_dwellings_electricity_meter" ], "type": "object" }, { "description": "b) to be used when the information on kWp is available. In this case up to 3 PV arrays can be specified.", "properties": { "pv_array_1": { "allOf": [ { "$ref": "#/$defs/pv_array" }, { "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" } }, "required": [ "connected_to_dwellings_electricity_meter" ], "type": "object" } ] }, "pv_array_2": { "oneOf": [ { "const": "not applicable" }, { "allOf": [ { "$ref": "#/$defs/pv_array" }, { "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" } }, "required": [ "connected_to_dwellings_electricity_meter" ], "type": "object" } ] } ] }, "pv_array_3": { "oneOf": [ { "const": "not applicable" }, { "allOf": [ { "$ref": "#/$defs/pv_array" }, { "properties": { "connected_to_dwellings_electricity_meter": { "description": "A convention will define what to do when the situation is not immediately obvious.", "enum": [ "yes", "no" ], "title": "Connected to dwelling's electricity meter" } }, "required": [ "connected_to_dwellings_electricity_meter" ], "type": "object" } ] } ] } }, "required": [ "pv_array_1", "pv_array_2", "pv_array_3" ], "type": "object" } ], "title": "Photovoltaic array details" }, "pv_for_flue_gas_heat_recovery": { "description": "Only for systems with a PV powered immersion.", "enum": [ "yes", "no" ], "title": "PV for flue gas heat recovery" }, "pv_for_flue_gas_heat_recovery_details": { "description": "Only for systems with a PV powered immersion.", "oneOf": [ { "const": "not applicable" }, { "$ref": "#/$defs/pv_array" } ], "title": "PV for flue gas heat recovery details" }, "region": { "description": "One of those in SAP2012 Table U1. Derived from the postcode of the property.", "enum": [ "Thames", "South East England", "Southern England", "South West England", "Severn Wales / Severn England", "Midlands", "West Pennines Wales / West Pennines England", "north West England / South West Scotland", "Borders Scotland / Borders England", "North East England", "East Pennines", "East Anglia", "Wales", "West Scotland", "East Scotland", "North East Scotland", "Highland", "Western Isles", "Orkney", "Shetland", "Northern Ireland" ], "title": "Region" }, "second_main_heating_controls": { "$ref": "#/$defs/heating_controls", "description": "", "title": "Second main heating controls" }, "second_main_heating_system": { "description": "System 1 is that heating the living area. If there is a boiler providing DHW only, assign it as the 2nd main system with a space heating percentage of zero", "oneOf": [ { "const": "not applicable" }, { "allOf": [ { "$ref": "#/$defs/heating_system" }, { "properties": { "percentage_of_heated_floor_area": { "description": "The percentage of the heated floor area served by the second system. Estimate percentage to nearest 10%.", "maximum": 100, "minimum": 0, "title": "Percentage of heated floor area", "type": "integer" } }, "required": [ "percentage_of_heated_floor_area" ], "type": "object" } ] } ], "title": "Second main heating systme" }, "secondary_heating_systems": { "description": "`none` if no secondary heating system.", "oneOf": [ { "const": "none" }, { "properties": { "fuel": { "description": "", "enum": [ "..." ], "title": "Fuel" }, "system": { "description": "System from room heater section of Table 4a.", "enum": [ "..." ], "title": "System" } }, "required": [ "fuel", "system" ], "type": "object" } ], "title": "Secondary heating system" }, "solar_collector_details": { "description": "Only if solar panel present and solar water heating details known. Documentary evidence is required to enter collector values.", "oneOf": [ { "const": "not applicable" }, { "properties": { "collector_2nd_order_heat_loss_coefficient": { "description": "", "maximum": 1, "minimum": 0, "title": "Collector 2nd order heat loss coefficient", "type": "number" }, "collector_aperture_area": { "description": "", "exclusiveMinimum": 0, "title": "Collector aperture area", "type": "number" }, "collector_linear_heat_loss_coefficient": { "description": "", "maximum": 1, "minimum": 0, "title": "Collector linear heat loss coefficient", "type": "number" }, "collector_type": { "description": "", "enum": [ "evacuated tube", "flat plate", "unglazed" ], "title": "Collector type" }, "collector_zero_loss_efficiency": { "description": "", "maximum": 1, "minimum": 0, "title": "Collector zero loss efficiency", "type": "number" } }, "required": [ "collector_aperture_area", "collector_type", "collector_zero_loss_efficiency", "collector_linear_heat_loss_coefficient", "collector_2nd_order_heat_loss_coefficient" ], "type": "object" } ], "title": "Solar collector details" }, "solar_collector_details_known": { "description": "", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Solar collector details known" }, "solar_store_details": { "description": "Only if solar panel present and solar water heating details known and solar collector details known.", "oneOf": [ { "const": "not applicable" }, { "properties": { "combined_solar_store": { "description": "", "enum": [ "yes", "no" ], "title": "Combined solar store" }, "dedicated_solar_volume": { "description": "", "minimum": 0, "title": "Dedicated solar volume", "type": "number" }, "total_hot_water_store_volume": { "description": "", "minimum": 0, "title": "Total hot water store volume", "type": "number" } }, "required": [ "combined_solar_store", "total_hot_water_store_volume", "dedicated_solar_volume" ], "type": "object" } ], "title": "Solar store details" }, "solar_store_details_known": { "description": "", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Solar store details known" }, "solar_water_heating": { "description": "Solar panel", "enum": [ "yes", "no" ], "title": "Solar water heating" }, "solar_water_heating_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "orientation": { "description": "If not horizontal.", "enum": [ "Not applicable", "S", "SE", "E", "NE", "N", "NW", "W", "SW" ], "title": "orientation" }, "overshading": { "description": "", "enum": [ "very little", "modest", "significant", "heavy" ], "title": "Overshading" }, "solar_water_pump": { "description": "", "enum": [ "electrically powered", "solar powered", "unknown" ], "title": "Solar water pump" }, "tilt": { "description": "", "enum": [ "horizontal", "30 deg", "45 deg", "60 deg", "vertical" ], "title": "Tilt" }, "types_of_showers": { "$comment": "should this be an array??", "description": "`electric only` where the ware is heated as the shower runs. If the shower is supplied from a hot-water cylinder it is classified as non-electric even though the cylinder is electrically heated.", "enum": [ "non-electric only", "electric only", "both electric and non-electric", "no shower" ], "title": "Type(s) of showers" } }, "required": [ "tilt", "orientation", "overshading", "solar_water_pump", "types_of_showers" ], "type": "object" } ], "title": "Solar water heating details" }, "solar_water_heating_details_known": { "description": "If yes, then details", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Solar water heating details known" }, "space_coooling_system_present": { "description": "", "enum": [ "yes", "no" ], "title": "Space cooling system present" }, "swimming_pool": { "description": "A swimming pool is not included in the dataset. Count the room containing the swimming pool as a habitable room and add addendum 4 (see S15).", "enum": [ "yes", "no" ], "title": "Swimming pool" }, "tenure": { "description": "", "enum": [ "owner-occupied", "rented (social)", "rented (private)", "unknown" ], "title": "Tenure" }, "terrain": { "description": "Used to generate wind turbine recommendation where appropriate - data item must always be collected.", "enum": [ "dense urban", "low rise urban or suburban", "rural" ], "title": "Terrain" }, "total_number_of_fixed_lighting_outlets": { "description": "Where there are 4 or more downlighters / ceiling lights divide the bulb count by 2. Include fixed under-cupboard kitchen strip lights.", "minimum": 0, "title": "Total number of fixed lighting outlets", "type": "integer" }, "total_number_of_low_energy_fixed_lighting_outlets": { "description": "LEDs are considered as low energy lights. Where there are 4 or more downlighters / ceiling lights divide the bulb count by 2. Include fixed under-cupboard kitchen strip lights.", "minimum": 0, "title": "Total number of low energy fixed lighting outlets", "type": "integer" }, "transaction_type": { "description": "Non-marketed sale include right-to-buy.", "enum": [ "marketed sale", "non-marketed sale", "rental", "stock condition survey", "assessment for Green Deal", "following Green Deal", "FIT application", "RHI application", "ECO assessment", "none of the above" ], "title": "Transaction type" }, "waste_water_heat_recovery": { "description": "", "enum": [ "none", "instantaneous", "storage" ], "title": "Waste water heat recovery" }, "waste_water_heat_recovery_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "description": "If instantaneous type present. if located in database. Number of rooms with bath and/or shower includes rooms with only an electric shower. If two showers found in a room, count as one. Only mixer showers count for instantaneous waste water heat recovery. Mixer shower means a dhower where the hot water is provided by a boiler (combi or regular), heat pump or immersion heater. A mixer shower attached to bath taps is recorded as a mixer shower only if there is a permenant bracket over the bath at least 1.5m above the plughole and there is a shower curtain or screen.", "properties": { "number_of_mixer_showers_with_system_1_in_rooms_with_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 1 in rooms with bath", "type": "integer" }, "number_of_mixer_showers_with_system_1_in_rooms_without_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 1 in rooms without bath", "type": "integer" }, "number_of_mixer_showers_with_system_2_in_rooms_with_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 2 in rooms with bath", "type": "integer" }, "number_of_mixer_showers_with_system_2_in_rooms_without_bath": { "description": "", "minimum": 0, "title": "Number of mixer showers with system 2 in rooms without bath", "type": "integer" }, "number_of_systems": { "description": "", "maximum": 2, "minimum": 1, "title": "Number of systems", "type": "integer" }, "system_1_product_index_number": { "description": "", "title": "System 1 product index number", "type": "string" }, "system_2_product_index_number": { "description": "", "title": "System 2 product index number", "type": "string" } }, "required": [ "number_of_systems", "system_1_product_index_number", "number_of_mixer_showers_with_system_1_in_rooms_with_bath", "number_of_mixer_showers_with_system_1_in_rooms_without_bath", "system_2_product_index_number", "number_of_mixer_showers_with_system_2_in_rooms_with_bath", "number_of_mixer_showers_with_system_2_in_rooms_without_bath" ], "type": "object" }, { "description": "If storage type present. if located in database.", "properties": { "number_of_showers_and_bath_routed_through_WWHRS": { "description": "", "minimum": 0, "title": "Number of showers and bath routed through WWHRS", "type": "integer" }, "product_index_number": { "description": "", "title": "Product Index Number", "type": "string" }, "total_showers_and_bath": { "description": "", "minimum": 0, "title": "Total shower and bath", "type": "integer" } }, "type": "object" } ], "title": "Waste water heat recovery details" }, "water_heating": { "description": "", "properties": { "cylinder_insulation_thickness": { "description": "", "enum": [ "not applicable", "0 mm", "12 mm", "25 mm", "38 mm", "50 mm", "80 mm", "120 mm", "160 mm" ], "title": "Cylinder insulation thickness" }, "cylinder_insulation_type": { "description": "unless no access", "oneOf": [ { "const": "no access" }, { "enum": [ "none", "loose jacket", "factory applied" ] } ], "title": "Cylinder insulation type" }, "cylinder_size": { "description": "Separate thermal store (hot-water only or integrated) treated as if it were a cylinder.", "enum": [ "no cylinder", "no access", "normal (up to 130 litres", "medium (131-170 litres)", "large (> 170litres)" ], "title": "Cylinder size" }, "cylinderstat": { "description": "Unless no access.", "enum": [ "no access", "yes", "no" ], "title": "Cylinderstat" }, "fuel": { "description": "Fuel also needed if not from main system.", "oneOf": [ { "const": "from main system" }, { "enum": [ "..." ] } ], "title": "Fuel" }, "single_or_dual": { "description": "If immersion, whether single or dual.", "enum": [ "not applicable", "single", "dual" ], "title": "single_or_dual" }, "system": { "description": "If no system, the calculation is done for an electric immersion, see text below table S17.", "enum": [ "from main heating system", "from 2nd main system", "from secondary system", "... [any other water heater marked `rd` in hot-water only section of Table 4a] ...", "no DHW system present" ], "title": "System" } }, "required": [ "system", "fuel", "cylinder_size", "cylinder_insulation_type", "cylinder_insulation_thickness", "single_or_dual", "cylinderstat" ], "title": "Water heating", "type": "object" }, "wind_tubine": { "description": "", "enum": [ "yes", "no" ], "title": "Wind turbine" }, "wind_turbine_details": { "description": "", "oneOf": [ { "const": "not applicable" }, { "properties": { "height_above_ridge": { "description": "", "exclusiveMinimum": 0, "title": "Height above ridge", "type": "number" }, "number_of_turbines": { "description": "", "exclusiveMinimum": 0, "title": "Number of turbines", "type": "integer" }, "rotor_diameter": { "description": "", "exclusiveMinimum": 0, "title": "Rotor diameter", "type": "number" } }, "required": [ "number_of_turbines", "rotor_diameter", "height_above_ridge" ], "type": "object" } ], "title": "Wind turbine details" }, "wind_turbine_details_known": { "description": "Only if wind turbine is present.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "Wind turbine details known" }, "window_area": { "description": "Of the dwelling only, not including any conservatory. `typical` refers to normal construction for the property type and age band concerned. If assessed as much more or much less than typical the area of each window should be measured.", "enum": [ "typical", "less than typical", "much less than typical", "more than typical", "much more than typical" ], "title": "Window area" }, "window_details": { "description": "If window area is `typical`, `less than typical` or `more than typical`.", "oneOf": [ { "const": "not applicable" }, { "properties": { "multiple_glazing_type": { "description": "", "enum": [ "double glazing pre year 2002 in England & Wales", "double glazing pre year 2003 in Scotland", "double glazing pre year 2006 in Northern Ireland", "double glazing during or post year 2002 in England & Wales", "double glazing during or post year 2003 in Scotland", "double glazing during or post year 2006 in Northern Ireland", "double glazing unknown date", "secondary glazing", "triple glazing", "double, known U-value", "triple, known U-value" ], "title": "Multiple glazing type" }, "proportion_with_multiple_glazing": { "description": "As percentage.", "title": "Proportion with multiple glazing", "type": "number" }, "pvc_window_frames": { "description": "To be included when the multiple glazing type is `double glazing pre year 2002 in England & Wales`, `double glazing pre year 2003 in Scotland`, `double glazing pre year 2006 in Northern Ireland` or `double glazing unknown date`.", "oneOf": [ { "const": "not applicable" }, { "enum": [ "yes", "no" ] } ], "title": "PVC window frames" }, "pvc_window_glazing_gap": { "description": "To be included if PVC window frames", "oneOf": [ { "const": "not applicable" }, { "enum": [ "6 mm", "12 mm", "16 mm or more" ] } ], "title": "PVC window glazing gap" }, "window_data_source": { "description": "Manufacturer or BFRC", "oneOf": [ { "const": "not applicable" }, { "type": "string" } ], "title": "Window data source" }, "window_g_value": { "description": "Value to 2 d.p. Only when multiple glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "type": "number" } ], "title": "Window g-value" }, "window_u_value": { "description": "Value in W/m2K. Only when multiple glazing type is double or triple with known U-value.", "oneOf": [ { "const": "not applicable" }, { "exclusiveMinimum": 0, "type": "number" } ], "title": "Window U-value" } }, "required": [ "proportion_with_multiple_glazing", "multiple_glazing_type", "pvc_window_frames", "pvc_window_glazing_gap", "window_u_value", "window_g_value", "window_data_source" ], "type": "object" } ], "title": "Window details" }, "windows": { "description": "If window area is much less or much more than typical. For each window. This option can also be used if more than one type of multiple glazing.", "oneOf": [ { "const": "Not applicable" }, { "items": { "$ref": "#/$defs/window" }, "type": "array" } ], "title": "Windows" } }, "required": [ "country", "region", "transaction_type", "dwelling_type", "built_form_and_detachment", "number_of_habitable_rooms", "number_of_heated_habitable_rooms", "dimension_type", "conservatory", "conservatory_details", "flats_and_maisonettes_details", "number_of_extensions", "number_of_external_doors", "number_of_insulated_external_doors", "insulated_door_u_value", "window_area", "window_details", "windows", "draught_proofing", "fireplaces", "main_heating_system", "second_main_heating_system", "community_heating_system", "main_heating_controls", "second_main_heating_controls", "secondary_heating_systems", "water_heating", "solar_water_heating", "solar_water_heating_details_known", "solar_water_heating_details", "solar_collector_details_known", "solar_collector_details", "solar_store_details_known", "solar_store_details", "flue_gas_heat_recovery", "flue_gas_heat_recovery_details", "pv_for_flue_gas_heat_recovery", "pv_for_flue_gas_heat_recovery_details", "number_of_rooms_with_bath_and_or_shower", "number_of_rooms_with_mixer_shower_and_no_bath", "number_of_rooms_with_mixer_shower_and_bath", "waste_water_heat_recovery", "waste_water_heat_recovery_details", "space_coooling_system_present", "mechanical_ventilation", "mechanical_ventilation_details", "electricity_meter", "mains_gas_available", "photovoltaic_array", "photovoltaic_array_details", "terrain", "wind_tubine", "wind_turbine_details_known", "wind_turbine_details", "total_number_of_fixed_lighting_outlets", "total_number_of_low_energy_fixed_lighting_outlets", "swimming_pool" ], "type": "object" } }, "required": [ "whole_dwelling", "building_parts" ], "title": "rdSAP_2012_input_schema", "type": "object" }
MIT
en
Ostorlab/oxo
9b5e6c340185e4cf5a805c89771cc6f61ae6dd09
2024-02-16T11:20:22
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "accepted_agents": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the accepted agents, if no value is specified, means all agents are accepted." }, "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "depth_processing_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the in_selectors that the agent should listen to." }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts." }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
36419eb8fe2f3e498eeb0ca4700106bffaf8dfd4
2022-12-12T12:03:03
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "description": "[Optional] - Array of strings of kernel capabilities to add to the default set for the container.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
cc3f177174fe17638ae7ed5f7277ac6ff818f9a3
2022-02-09T16:43:44
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
08df5172b80ac3c971584d5c7b569eb611663bcf
2022-04-26T10:13:53
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
c473aefb2a8dc8d2392a698f21f58dd6bc62deed
2024-02-23T13:39:18
src/ostorlab/agent/schema/target_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "androidAabFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" } }, "type": "object" }, "androidApkFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" } }, "type": "object" }, "androidStoreType": { "description": "[Optional] - Android store asset.", "properties": { "package_name": { "description": "[Required] - Package name of the app.", "type": "string" } }, "type": "object" }, "domainType": { "description": "[Optional] - Domain name asset.", "properties": { "name": { "description": "[Required] - Domain name.", "type": "string" } }, "type": "object" }, "iosFileType": { "description": "[Optional] - Ios app file asset.", "properties": { "paths": { "description": "[Required] - Ios app file path.", "type": "string" } }, "type": "object" }, "iosStoreType": { "description": "[Optional] - Ios app Store asset.", "properties": { "bundle_id": { "description": "[Required] - App bundle id.", "type": "string" } }, "type": "object" }, "ipType": { "description": "[Optional] - Ip asset.", "properties": { "host": { "description": "[Required] - The ip host.", "type": "string" }, "mask": { "description": "[Optional] - Network mask.", "type": "number" } }, "type": "object" }, "linkType": { "description": "[Optional] - Link asset.", "properties": { "method": { "description": "[Required] - Target method.", "type": "string" }, "path": { "description": "[Optional] - Link's path.", "type": "string" }, "port": { "description": "[Optional] - Target's port.", "type": "number" }, "url": { "description": "[Required] - url link type.", "type": "string" } }, "type": "object" } }, "description": "Target Group json-specification : A full description of fields of a target group definition yaml file.", "properties": { "assets": { "description": "[Required] - List of dictionary-like objects explaining the targets belonging to the current target group.", "properties": { "androidAabFile": { "items": { "$ref": "#/CustomTypes/androidAabFileType" }, "type": "array" }, "androidApkFile": { "items": { "$ref": "#/CustomTypes/androidApkFileType" }, "type": "array" }, "androidStore": { "items": { "$ref": "#/CustomTypes/androidStoreType" }, "type": "array" }, "domain": { "items": { "$ref": "#/CustomTypes/domainType" }, "type": "array" }, "iosFile": { "items": { "$ref": "#/CustomTypes/iosFileType" }, "type": "array" }, "iosStore": { "items": { "$ref": "#/CustomTypes/iosStoreType" }, "type": "array" }, "ip": { "items": { "$ref": "#/CustomTypes/ipType" }, "type": "array" }, "link": { "items": { "$ref": "#/CustomTypes/linkType" }, "type": "array" } }, "type": "object" }, "description": { "description": "[Required] - Description of the target group.", "type": "string" }, "kind": { "description": "[Required] - Only expected value : targetGroup.", "enum": [ "targetGroup" ], "type": "string" }, "name": { "description": "[Optional] - Target group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "assets" ], "title": "Target Group Schema" }
Apache-2.0
en
Ostorlab/oxo
b6126632b2793d457de72a90b3dc76c6fe362fd3
2022-04-26T10:15:28
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
ccbe4cb2e5eaff6d0fbb853630cffbfa63dd66e8
2024-02-23T16:32:28
src/ostorlab/agent/schema/target_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "androidAabFileType": { "description": "[Optional] - Android aab file asset.", "properties": { "path": { "description": "[Optional] - Android aab file path.", "type": "string" }, "url": { "description": "[Optional] - Android aab file link.", "type": "string" } }, "type": "object" }, "androidApkFileType": { "description": "[Optional] - Android apk file asset.", "properties": { "path": { "description": "[Optional] - Android apk file path.", "type": "string" }, "url": { "description": "[Optional] - Android apk file link.", "type": "string" } }, "type": "object" }, "androidStoreType": { "description": "[Optional] - Android store asset.", "properties": { "package_name": { "description": "[Required] - Package name of the android app.", "type": "string" } }, "type": "object" }, "domainType": { "description": "[Optional] - Domain name asset.", "properties": { "name": { "description": "[Required] - Domain name.", "type": "string" } }, "type": "object" }, "iosFileType": { "description": "[Optional] - Ios app file asset.", "properties": { "paths": { "description": "[Optional] - Ios app file path.", "type": "string" }, "url": { "description": "[Optional] - Ios app file link.", "type": "string" } }, "type": "object" }, "iosStoreType": { "description": "[Optional] - Ios app Store asset.", "properties": { "bundle_id": { "description": "[Required] - App bundle id.", "type": "string" } }, "type": "object" }, "ipType": { "description": "[Optional] - Ip asset.", "properties": { "host": { "description": "[Required] - The ip host.", "type": "string" }, "mask": { "description": "[Optional] - Network mask.", "type": "number" } }, "type": "object" }, "linkType": { "description": "[Optional] - Link asset.", "properties": { "method": { "description": "[Required] - Target method.", "type": "string" }, "path": { "description": "[Optional] - Link's path.", "type": "string" }, "port": { "description": "[Optional] - Target's port.", "type": "number" }, "url": { "description": "[Required] - url link type.", "type": "string" } }, "type": "object" } }, "description": "Target Group json-specification : A full description of fields of a target group definition yaml file.", "properties": { "assets": { "description": "[Required] - List of dictionary-like objects explaining the targets belonging to the current target group.", "properties": { "androidAabFile": { "items": { "$ref": "#/CustomTypes/androidAabFileType" }, "type": "array" }, "androidApkFile": { "items": { "$ref": "#/CustomTypes/androidApkFileType" }, "type": "array" }, "androidStore": { "items": { "$ref": "#/CustomTypes/androidStoreType" }, "type": "array" }, "domain": { "items": { "$ref": "#/CustomTypes/domainType" }, "type": "array" }, "iosFile": { "items": { "$ref": "#/CustomTypes/iosFileType" }, "type": "array" }, "iosStore": { "items": { "$ref": "#/CustomTypes/iosStoreType" }, "type": "array" }, "ip": { "items": { "$ref": "#/CustomTypes/ipType" }, "type": "array" }, "link": { "items": { "$ref": "#/CustomTypes/linkType" }, "type": "array" } }, "type": "object" }, "description": { "description": "[Required] - Description of the target group.", "type": "string" }, "kind": { "description": "[Required] - Only expected value : targetGroup.", "enum": [ "targetGroup" ], "type": "string" }, "name": { "description": "[Optional] - Target group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "assets" ], "title": "Target Group Schema" }
Apache-2.0
en
Ostorlab/oxo
d485d26cfac34ed4558f1fef2951d9bde5a72bef
2022-09-02T14:14:21
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "service_name": { "description": "[Optional] - Docker service name to use.", "type": "string" }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
68bf1e3e4aa66fc42e9e0d56c39123c8b85fcea1
2022-04-18T14:48:24
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
7efd7e0747dbc36fc24f5a543aa99578e15dfb39
2022-02-09T17:21:55
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
5fb533b9a8230b01fc3e878e5b3851c2bc8e9663
2022-12-23T16:17:39
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the default set for the container." }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "service_name": { "description": "[Optional] - Docker service name to use.", "type": "string" }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
bc7d315c39cb92fb12a7ddd33d80d7ee2f5919aa
2022-02-09T16:26:31
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent group argument.", "type": "string" }, "name": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Value of the agent group argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Text fully describing the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
5fb533b9a8230b01fc3e878e5b3851c2bc8e9663
2022-12-23T16:17:39
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
8aebc8159dda667674b43d2abba4cf7d6788b906
2021-12-30T09:00:31
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "default_value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" }, "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" } }, "type": "object" }, "type": "array" }, "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "maxLength": 2048, "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "portmap": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "properties": { "port_dst": { "description": "Destination port.", "type": "number" }, "port_src": { "description": "Source port.", "type": "number" } }, "type": "object" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
bb9b4c8f9babdfc5beeca808d2ed2e9f8d5668fc
2022-02-11T13:39:39
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
5e617611c7d73ac71946fc3fef07c821f237f47b
2022-01-28T10:31:29
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent group argument.", "type": "string" }, "name": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Value of the agent group argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Optional] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port maping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent group." }, "description": { "description": "[Required] - Text fully describing the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent group, e.g., none, any, on-failure.", "enum": [ "on-failure", "none", "any" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent group." } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
a9f4f2e5ac877e2a6cfff2e70ad6c8290f0e52e9
2022-02-10T10:42:43
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
5f141ef2fb385176c20aa90dd6e5abb4076dbfac
2022-01-03T12:11:47
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent group argument.", "type": "string" }, "name": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Value of the agent group argument.", "type": "string" } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Optional] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port maping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent group." }, "description": { "description": "[Required] - Text fully describing the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent group, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent group." } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
5f141ef2fb385176c20aa90dd6e5abb4076dbfac
2022-01-03T12:11:47
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "default_value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" }, "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
cde418aa322cd7ea9fe8a98675dd46bd9c4891d5
2022-01-28T10:29:50
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
5622c48206de6c825006f2070fc27b9fc59337d6
2024-02-20T18:28:26
src/ostorlab/agent/schema/target_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "androidAabFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" }, "sbom": { "$ref": "#/CustomTypes/sbomType", "description": "[Optional] - Package name of the app." } }, "type": "object" }, "androidApkFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" }, "sbom": { "$ref": "#/CustomTypes/sbomType", "description": "[Optional] - Package name of the app." } }, "type": "object" }, "androidStoreType": { "description": "[Optional] - Android store asset.", "properties": { "package_name": { "description": "[Required] - Package name of the app.", "type": "string" }, "sbom": { "$ref": "#/CustomTypes/sbomType", "description": "[Optional] - Package name of the app." } }, "type": "object" }, "domainType": { "description": "[Optional] - Domain name asset.", "properties": { "name": { "description": "[Required] - Domain name.", "type": "string" } }, "type": "object" }, "iosFileType": { "description": "[Optional] - Ios app file asset.", "properties": { "paths": { "description": "[Required] - Ios app file path.", "type": "string" }, "sbom": { "$ref": "#/CustomTypes/sbomType", "description": "[Optional] - Package name of the app." } }, "type": "object" }, "iosStoreType": { "description": "[Optional] - Ios app Store asset.", "properties": { "bundle_id": { "description": "[Required] - App bundle id.", "type": "string" }, "sbom": { "$ref": "#/CustomTypes/sbomType", "description": "[Optional] - Package name of the app." } }, "type": "object" }, "ipType": { "description": "[Optional] - Ip asset.", "properties": { "host": { "description": "[Required] - The ip host.", "type": "string" }, "mask": { "description": "[Optional] - Network mask.", "type": "number" } }, "type": "object" }, "linkType": { "description": "[Optional] - Link asset.", "properties": { "method": { "description": "[Required] - Target method.", "type": "string" }, "path": { "description": "[Optional] - Link's path.", "type": "string" }, "port": { "description": "[Optional] - Target's port.", "type": "number" }, "url": { "description": "[Required] - url linktype.", "type": "string" } }, "type": "object" }, "sbomType": { "description": "[Optional] - A list of paths for sbom files.", "items": { "type": "string" }, "type": "array" } }, "description": "Target Group json-specification : A full description of fields of a target group definition yaml file.", "properties": { "assets": { "description": "[Required] - List of dictionary-like objects explaining the targets belonging to the current target group.", "properties": { "androidAabFile": { "items": { "$ref": "#/CustomTypes/androidAabFileType" }, "type": "array" }, "androidApkFile": { "items": { "$ref": "#/CustomTypes/androidApkFileType" }, "type": "array" }, "androidStore": { "items": { "$ref": "#/CustomTypes/androidStoreType" }, "type": "array" }, "domain": { "items": { "$ref": "#/CustomTypes/domainType" }, "type": "array" }, "iosFile": { "items": { "$ref": "#/CustomTypes/iosFileType" }, "type": "array" }, "iosStore": { "items": { "$ref": "#/CustomTypes/iosStoreType" }, "type": "array" }, "ip": { "items": { "$ref": "#/CustomTypes/ipType" }, "type": "array" }, "link": { "items": { "$ref": "#/CustomTypes/linkType" }, "type": "array" } }, "type": "object" }, "description": { "description": "[Required] - Description of the target group.", "type": "string" }, "kind": { "description": "[Required] - Only expected value : targetGroup.", "enum": [ "targetGroup" ], "type": "string" }, "name": { "description": "[Optional] - Target group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "name", "assets" ], "title": "Target Group Schema" }
Apache-2.0
en
Ostorlab/oxo
73c325140cc7a0b2623f5dee2efca8788ec1d3ae
2022-02-09T16:25:44
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
910e31f1a3fcd1a9c454771000014df0ae625fd2
2024-02-21T10:56:22
src/ostorlab/agent/schema/target_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "androidAabFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" } }, "type": "object" }, "androidApkFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" } }, "type": "object" }, "androidStoreType": { "description": "[Optional] - Android store asset.", "properties": { "package_name": { "description": "[Required] - Package name of the app.", "type": "string" } }, "type": "object" }, "domainType": { "description": "[Optional] - Domain name asset.", "properties": { "name": { "description": "[Required] - Domain name.", "type": "string" } }, "type": "object" }, "iosFileType": { "description": "[Optional] - Ios app file asset.", "properties": { "paths": { "description": "[Required] - Ios app file path.", "type": "string" } }, "type": "object" }, "iosStoreType": { "description": "[Optional] - Ios app Store asset.", "properties": { "bundle_id": { "description": "[Required] - App bundle id.", "type": "string" }, "sbom": { "$ref": "#/CustomTypes/sbomType", "description": "[Optional] - Package name of the app." } }, "type": "object" }, "ipType": { "description": "[Optional] - Ip asset.", "properties": { "host": { "description": "[Required] - The ip host.", "type": "string" }, "mask": { "description": "[Optional] - Network mask.", "type": "number" } }, "type": "object" }, "linkType": { "description": "[Optional] - Link asset.", "properties": { "method": { "description": "[Required] - Target method.", "type": "string" }, "path": { "description": "[Optional] - Link's path.", "type": "string" }, "port": { "description": "[Optional] - Target's port.", "type": "number" }, "url": { "description": "[Required] - url linktype.", "type": "string" } }, "type": "object" }, "sbomType": { "description": "[Optional] - A list of paths for sbom files.", "items": { "type": "string" }, "type": "array" } }, "description": "Target Group json-specification : A full description of fields of a target group definition yaml file.", "properties": { "assets": { "description": "[Required] - List of dictionary-like objects explaining the targets belonging to the current target group.", "properties": { "androidAabFile": { "items": { "$ref": "#/CustomTypes/androidAabFileType" }, "type": "array" }, "androidApkFile": { "items": { "$ref": "#/CustomTypes/androidApkFileType" }, "type": "array" }, "androidStore": { "items": { "$ref": "#/CustomTypes/androidStoreType" }, "type": "array" }, "domain": { "items": { "$ref": "#/CustomTypes/domainType" }, "type": "array" }, "iosFile": { "items": { "$ref": "#/CustomTypes/iosFileType" }, "type": "array" }, "iosStore": { "items": { "$ref": "#/CustomTypes/iosStoreType" }, "type": "array" }, "ip": { "items": { "$ref": "#/CustomTypes/ipType" }, "type": "array" }, "link": { "items": { "$ref": "#/CustomTypes/linkType" }, "type": "array" }, "sbom": { "$ref": "#/CustomTypes/sbomType" } }, "type": "object" }, "description": { "description": "[Required] - Description of the target group.", "type": "string" }, "kind": { "description": "[Required] - Only expected value : targetGroup.", "enum": [ "targetGroup" ], "type": "string" }, "name": { "description": "[Optional] - Target group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "name", "assets" ], "title": "Target Group Schema" }
Apache-2.0
en
Ostorlab/oxo
08df5172b80ac3c971584d5c7b569eb611663bcf
2022-04-26T10:13:53
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
3addf0cf1099834f2d8221520e4f50a11e712986
2021-12-26T21:26:53
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "default_value": { "contentEncoding": "base64", "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" }, "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" } }, "type": "object" }, "type": "array" }, "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "Required - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "Required : Array of strings explaning the input selectors of the agent." }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "Required - Agent full Name", "maxLength": 2048, "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "Required : Array of strings explaning the output selectors of the agent." }, "portmap": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "properties": { "port_dst": { "description": "Destination port.", "type": "number" }, "port_src": { "description": "Source port.", "type": "number" } }, "type": "object" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
d485d26cfac34ed4558f1fef2951d9bde5a72bef
2022-09-02T14:14:21
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
5a9399ea8c6544a420df90e0e3d1eed6846e9050
2023-11-29T09:15:31
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "depth_processing_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
36419eb8fe2f3e498eeb0ca4700106bffaf8dfd4
2022-12-12T12:03:03
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the default set for the container." }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "service_name": { "description": "[Optional] - Docker service name to use.", "type": "string" }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
cca71948a64a23c21b762a9254f301f790976992
2022-03-08T11:38:51
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
3d3f9a4aeccf7c5dd474f93ed10e66fc29019c71
2022-01-12T14:49:26
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
59dd9a2edee1e0d439bb8fb0a81997e44ad3c629
2022-01-25T13:47:27
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
6d08269f7b4db9a2689e889f32bd3f3527ff1b75
2022-03-07T14:16:23
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
4cebcab8b14592d60992343df34346cf280e9fe0
2022-03-07T15:32:52
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
f5033587819e744e5c5ae30db81b2d46780d7578
2022-02-10T10:43:16
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
e590882d3eb679705e8070ae8552b2d4c543c23f
2024-02-15T10:19:26
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "accepted_agents": { "description": "[Optional] - Array of strings of the accepted agents, if no value is specified, means all agents are accepted.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "depth_processing_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
0e3d11c5223f7b1767ddec4f8642742b75baf182
2022-06-04T21:59:38
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "service_name": { "description": "[Optional] - Docker service name to use.", "type": "string" }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
Ostorlab/oxo
af3cfbbe1820584566fabf60654a6c497668489c
2024-02-22T15:23:55
src/ostorlab/agent/schema/target_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "androidAabFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" } }, "type": "object" }, "androidApkFileType": { "description": "[Optional] - Android app file asset.", "properties": { "path": { "description": "[Required] - Android app file path.", "type": "string" } }, "type": "object" }, "androidStoreType": { "description": "[Optional] - Android store asset.", "properties": { "package_name": { "description": "[Required] - Package name of the app.", "type": "string" } }, "type": "object" }, "domainType": { "description": "[Optional] - Domain name asset.", "properties": { "name": { "description": "[Required] - Domain name.", "type": "string" } }, "type": "object" }, "iosFileType": { "description": "[Optional] - Ios app file asset.", "properties": { "paths": { "description": "[Required] - Ios app file path.", "type": "string" } }, "type": "object" }, "iosStoreType": { "description": "[Optional] - Ios app Store asset.", "properties": { "bundle_id": { "description": "[Required] - App bundle id.", "type": "string" } }, "type": "object" }, "ipType": { "description": "[Optional] - Ip asset.", "properties": { "host": { "description": "[Required] - The ip host.", "type": "string" }, "mask": { "description": "[Optional] - Network mask.", "type": "number" } }, "type": "object" }, "linkType": { "description": "[Optional] - Link asset.", "properties": { "method": { "description": "[Required] - Target method.", "type": "string" }, "path": { "description": "[Optional] - Link's path.", "type": "string" }, "port": { "description": "[Optional] - Target's port.", "type": "number" }, "url": { "description": "[Required] - url linktype.", "type": "string" } }, "type": "object" } }, "description": "Target Group json-specification : A full description of fields of a target group definition yaml file.", "properties": { "assets": { "description": "[Required] - List of dictionary-like objects explaining the targets belonging to the current target group.", "properties": { "androidAabFile": { "items": { "$ref": "#/CustomTypes/androidAabFileType" }, "type": "array" }, "androidApkFile": { "items": { "$ref": "#/CustomTypes/androidApkFileType" }, "type": "array" }, "androidStore": { "items": { "$ref": "#/CustomTypes/androidStoreType" }, "type": "array" }, "domain": { "items": { "$ref": "#/CustomTypes/domainType" }, "type": "array" }, "iosFile": { "items": { "$ref": "#/CustomTypes/iosFileType" }, "type": "array" }, "iosStore": { "items": { "$ref": "#/CustomTypes/iosStoreType" }, "type": "array" }, "ip": { "items": { "$ref": "#/CustomTypes/ipType" }, "type": "array" }, "link": { "items": { "$ref": "#/CustomTypes/linkType" }, "type": "array" } }, "type": "object" }, "description": { "description": "[Required] - Description of the target group.", "type": "string" }, "kind": { "description": "[Required] - Only expected value : targetGroup.", "enum": [ "targetGroup" ], "type": "string" }, "name": { "description": "[Optional] - Target group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "name", "assets" ], "title": "Target Group Schema" }
Apache-2.0
en
Ostorlab/oxo
24c8eb4e570cab266d655071b05620a6fe9192a9
2022-03-03T13:40:35
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Replicas of the agent, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
522f047cb98598c75649988b3bd2a170a6cb4367
2022-04-24T22:56:42
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
126d9eceb02383b156a60450d448a539cd35c4e1
2022-02-09T07:11:30
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Agent kind.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
126d9eceb02383b156a60450d448a539cd35c4e1
2022-02-09T07:11:30
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent group argument.", "type": "string" }, "name": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Value of the agent group argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent group." }, "description": { "description": "[Required] - Text fully describing the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent group, e.g., none, any, on-failure.", "enum": [ "on-failure", "none", "any" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent group." } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
666acaf236cceac43064ea534476d4e38a924ef3
2024-02-15T13:17:22
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "accepted_agents": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the accepted agents, if no value is specified, means all agents are accepted." }, "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "depth_processing_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts." }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
9920892ca0b5f9cbf6048994894ec40d4e05f8d1
2021-12-27T12:47:22
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "default_value": { "contentEncoding": "base64", "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" }, "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" } }, "type": "object" }, "type": "array" }, "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "maxLength": 2048, "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "portmap": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "properties": { "port_dst": { "description": "Destination port.", "type": "number" }, "port_src": { "description": "Source port.", "type": "number" } }, "type": "object" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
6d08269f7b4db9a2689e889f32bd3f3527ff1b75
2022-03-07T14:16:23
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
792df203f56fa78fbaa28028bbf7aa2791f62787
2022-01-25T13:54:24
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent group argument.", "type": "string" }, "name": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Value of the agent group argument.", "type": "string" } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Optional] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port maping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent group." }, "description": { "description": "[Required] - Text fully describing the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent group, e.g., none, any, on-failure.", "enum": [ "on-failure", "none", "any" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent group." } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
a3cbe91bd4c77ddd82c8bca754ec86eaaea9baeb
2022-03-03T14:42:09
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean" ] } }, "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "enum": [ "AgentGroup" ], "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
3970cb97853345761851df0a6ec75d7f3a27476d
2024-02-15T16:14:57
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "accepted_agents": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the accepted agents, if no value is specified, means all agents are accepted." }, "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "depth_processing_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "extended_in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the additional selectors that the agent can receive." }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts." }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
ca1fbfe7accfef203ea1cfa2f820eeb30172e988
2021-12-28T15:22:04
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "default_value": { "description": "[Optional] - Default value of the agent argument as a binary object.", "type": "string" }, "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" } }, "type": "object" }, "type": "array" }, "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent." }, "description": { "description": "[Required] - Text fully describing the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the input selectors of the agent." }, "license": { "description": "[Optional] - Agent license", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name", "maxLength": 2048, "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaning the output selectors of the agent." }, "portmap": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "properties": { "port_dst": { "description": "Destination port.", "type": "number" }, "port_src": { "description": "Source port.", "type": "number" } }, "type": "object" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "source": { "description": "[Optional] - URL to the agent repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent, respection semantic versionning : major.minor.release.", "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ], "title": "Agent Schema" }
Apache-2.0
en
Ostorlab/oxo
054a9d3bbf9e6bd3eec6498c4cec03c11771009f
2022-12-12T13:45:58
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
e04005351ef4a7971a345c9ee2f30443b552bfbb
2021-12-29T15:01:35
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agentGroupArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent group arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent group argument.", "type": "string" }, "name": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "Name of the agent group argument.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Value of the agent group argument.", "type": "string" } }, "type": "object" }, "type": "array" }, "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "description": "[Optional] - List of the agent arguments.", "type": "array" }, "items": { "type": "object" }, "name": { "description": "[Optional] - Name of the agent.", "type": "string" } }, "type": "object" }, "type": "array" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaning the constraints of the agent group." }, "description": { "description": "[Required] - Text fully describing the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Full name of the agent group.", "maxLength": 2048, "type": "string" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent group, e.g., run_once, always_restart.", "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent group." } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
e87dff6710e123819c4d5274c2e420823c4446ea
2024-02-23T13:42:09
src/ostorlab/agent/schema/target_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "androidAabFileType": { "description": "[Optional] - Android aab file asset.", "properties": { "path": { "description": "[Required] - Android aab file path.", "type": "string" } }, "type": "object" }, "androidApkFileType": { "description": "[Optional] - Android apk file asset.", "properties": { "path": { "description": "[Required] - Android apk file path.", "type": "string" } }, "type": "object" }, "androidStoreType": { "description": "[Optional] - Android store asset.", "properties": { "package_name": { "description": "[Required] - Package name of the android app.", "type": "string" } }, "type": "object" }, "domainType": { "description": "[Optional] - Domain name asset.", "properties": { "name": { "description": "[Required] - Domain name.", "type": "string" } }, "type": "object" }, "iosFileType": { "description": "[Optional] - Ios app file asset.", "properties": { "paths": { "description": "[Required] - Ios app file path.", "type": "string" } }, "type": "object" }, "iosStoreType": { "description": "[Optional] - Ios app Store asset.", "properties": { "bundle_id": { "description": "[Required] - App bundle id.", "type": "string" } }, "type": "object" }, "ipType": { "description": "[Optional] - Ip asset.", "properties": { "host": { "description": "[Required] - The ip host.", "type": "string" }, "mask": { "description": "[Optional] - Network mask.", "type": "number" } }, "type": "object" }, "linkType": { "description": "[Optional] - Link asset.", "properties": { "method": { "description": "[Required] - Target method.", "type": "string" }, "path": { "description": "[Optional] - Link's path.", "type": "string" }, "port": { "description": "[Optional] - Target's port.", "type": "number" }, "url": { "description": "[Required] - url link type.", "type": "string" } }, "type": "object" } }, "description": "Target Group json-specification : A full description of fields of a target group definition yaml file.", "properties": { "assets": { "description": "[Required] - List of dictionary-like objects explaining the targets belonging to the current target group.", "properties": { "androidAabFile": { "items": { "$ref": "#/CustomTypes/androidAabFileType" }, "type": "array" }, "androidApkFile": { "items": { "$ref": "#/CustomTypes/androidApkFileType" }, "type": "array" }, "androidStore": { "items": { "$ref": "#/CustomTypes/androidStoreType" }, "type": "array" }, "domain": { "items": { "$ref": "#/CustomTypes/domainType" }, "type": "array" }, "iosFile": { "items": { "$ref": "#/CustomTypes/iosFileType" }, "type": "array" }, "iosStore": { "items": { "$ref": "#/CustomTypes/iosStoreType" }, "type": "array" }, "ip": { "items": { "$ref": "#/CustomTypes/ipType" }, "type": "array" }, "link": { "items": { "$ref": "#/CustomTypes/linkType" }, "type": "array" } }, "type": "object" }, "description": { "description": "[Required] - Description of the target group.", "type": "string" }, "kind": { "description": "[Required] - Only expected value : targetGroup.", "enum": [ "targetGroup" ], "type": "string" }, "name": { "description": "[Optional] - Target group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "assets" ], "title": "Target Group Schema" }
Apache-2.0
en
Ostorlab/oxo
ad88e8bbf3d73997247695c025904b5667560aa9
2024-02-15T16:18:28
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "accepted_agents": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the accepted agents, if no value is specified, means all agents are accepted." }, "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "depth_processing_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "extended_in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the additional selectors that the agent should listen to." }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts." }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
d6369d47c0c1399a903e24148a823efba313e8e6
2023-11-28T15:31:23
src/ostorlab/agent/schema/agent_group_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agentgrp_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "agentArgument": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent Group json-specification : A full description of fields of an agent group definition yaml file.", "properties": { "agents": { "description": "[Required] - List of dictionary-like objects explaining the agents belonging to the current agent group.", "items": { "description": "Dictionary-like object of the agent.", "properties": { "args": { "default": [], "description": "[Optional] - List of the agent arguments.", "items": { "$ref": "#/CustomTypes/agentArgument" }, "type": "array" }, "caps": { "description": "[Optional] - Array of strings of kernel capabilities to add to the agent container instance (e.g CAP_NET_ADMIN)", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "key": { "description": "[Required] - Key of the agent of the form agent/<organisation prefix>/<agent name>.", "type": "string" }, "mounts": { "description": "[Optional] - Array of strings of the mounts of the agent, this will override default mounts.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "port_mapping": { "description": "[Optional] - List of the agent port mapping.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "processing_depth_limit": { "description": "[Optional] - Count of how deep the processing of a message can go through the agents, if no value is specified, means no limit.", "type": "number" }, "replicas": { "default": 1, "description": "[Optional] - Count of replicas of the agent instances, default value is 1.", "type": "number" }, "version": { "description": "[Optional] - Version of the agent, can either be an exact version like 1.2.3 or a regular expression to match against a version range like 1\\..*.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "description": { "description": "[Required] - Description of the agent group.", "type": "string" }, "image": { "description": "[Optional] - Path to the agent group image.", "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "kind": { "description": "[Required] - Only expected value : AgentGroup.", "enum": [ "AgentGroup" ], "type": "string" }, "name": { "description": "[Optional] - Agent group full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" } }, "required": [ "kind", "description", "agents" ], "title": "Agent Group Schema" }
Apache-2.0
en
Ostorlab/oxo
d58a446d8ee5f48a2b7142678d30711cf9247a03
2021-12-24T10:25:21
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "CustomTypes": { "ArrayOfStrings": { "items": { "maxLength": 4096, "type": "string" }, "type": "array" } }, "properties": { "agenArgument": { "properties": { "default_value": { "contentEncoding": "base64", "type": "string" }, "description": { "type": "string" }, "name": { "maxLength": 2048, "type": "string" }, "type": { "maxLength": 2048, "type": "string" } }, "type": "object" }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings" }, "description": { "type": "string" }, "durability": { "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings" }, "license": { "maxLength": 1024, "type": "string" }, "mem_limit": { "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings" }, "name": { "maxLength": 2048, "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings" }, "portmap": { "properties": { "port_dst": { "type": "number" }, "port_src": { "type": "number" } }, "type": "object" }, "restart_policy": { "enum": [ "run_once", "always_restart" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings" }, "source": { "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "maxLength": 512, "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+)$", "type": "string" } }, "required": [ "name", "description", "in_selectors", "out_selectors" ] }
Apache-2.0
en
Ostorlab/oxo
8f95dcdc355582a45892db612ed0dc04671f6e23
2022-12-23T15:46:44
src/ostorlab/agent/schema/agent_schema.json
392
2024-05-27T08:35:18.897635Z
{ "$id": "https://ostorlab.co/agent_schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "CustomTypes": { "ArrayOfStrings": { "description": "An array of strings custom type.", "items": { "maxLength": 4096, "type": "string" }, "type": "array" }, "Path": { "description": "A path-like custom type.", "maxLength": 4096, "pattern": "((?:[^/]*/)*)(.*)", "type": "string" }, "agentPortMapping": { "description": "[Optional] - Array of dictionary-like objects, defining the port mapping.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "dest_port": { "description": "Destination port.", "type": "number" }, "src_port": { "description": "Source port.", "type": "number" } }, "type": "object" }, "type": "array" } }, "description": "Agent json-specification : A full description of fields of an agent definition yaml file.", "properties": { "agent_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent code or executable" }, "agent_runner": { "description": "[Optional] - How to start the agent.", "type": "string" }, "args": { "description": "[Optional] - Array of dictionary-like objects, defining the agent arguments.", "items": { "description": "Dictionary-like object of the argument.", "properties": { "description": { "description": "[Optional] - Description of the agent argument.", "type": "string" }, "name": { "description": "[Required] - Name of the agent argument.", "maxLength": 2048, "type": "string" }, "type": { "description": "[Required] - Type of the agent argument : respecting the jsonschema types.", "maxLength": 2048, "type": "string" }, "value": { "description": "[Optional] - Default value of the agent argument.", "type": [ "string", "number", "boolean", "array", "object" ] } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" }, "caps": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of kernel capabilities to add to the default set for the container." }, "constraints": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the constraints of the agent." }, "cyclic_processing_limit": { "description": "[Optional] - Count of how often the processing of a message can go through the same agent, if no value is specified, means no limit.", "type": "number" }, "description": { "description": "[Required] - Description of the agent.", "type": "string" }, "docker_build_root": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to be used in as a context root to build the agent." }, "docker_file_path": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the Dockerfile of the agent." }, "durability": { "description": "[Optional] - Durability of the agent, e.g., temporary, development, published.", "enum": [ "temporary", "development", "published" ], "maxLength": 1024, "type": "string" }, "image": { "$ref": "#/CustomTypes/Path", "description": "[Optional] - Path to the agent image." }, "in_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the input selectors of the agent." }, "kind": { "description": "[Required] - Only expected value : Agent.", "enum": [ "Agent" ], "type": "string" }, "license": { "description": "[Optional] - Source license.", "maxLength": 1024, "type": "string" }, "mem_limit": { "description": "[Optional] - Maximum memory that can be used by the agent in bytes.", "type": "number" }, "mounts": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings of the mounts of the agent." }, "name": { "description": "[Required] - Agent full Name, accept lower case ascii, number and _, - characters.", "maxLength": 512, "pattern": "^[a-z0-9_\\-]+$", "type": "string" }, "out_selectors": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Required] : Array of strings explaining the output selectors of the agent." }, "port_mapping": { "description": "[Optional] - Dictionary-like object, mapping a source port to a destination port.", "items": { "$ref": "#/CustomTypes/agentPortMapping" }, "type": "array" }, "restart_policy": { "description": "[Optional] - Restart policy of the agent, e.g., none, any, on-failure.", "enum": [ "any", "on-failure", "none" ], "maxLength": 1024, "type": "string" }, "restrictions": { "$ref": "#/CustomTypes/ArrayOfStrings", "description": "[Optional] - Array of strings explaining the restrictions of the agent." }, "service_name": { "description": "[Optional] - Docker service name to use.", "type": "string" }, "source": { "description": "[Optional] - URL to the agent source repository.", "format": "uri", "maxLength": 4096, "pattern": "^https?://", "type": "string" }, "version": { "description": "[Optional] - Version of the agent respecting the semantic versioning format : major.minor.release.", "maxLength": 512, "type": "string" } }, "required": [ "name", "kind", "in_selectors", "out_selectors" ], "title": "Agent Schema", "type": "object" }
Apache-2.0
en
alan-turing-institute/sqlsynthgen
c9f54640e0a448d87281ca1658ccdcc2fc804e13
2023-08-23T16:31:34
sqlsynthgen/json_schemas/config_schema.json
10
2024-05-27T06:54:16.009255Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A SQLSynthGen configuration YAML file", "properties": { "max-unique-constraint-tries": { "description": "todo.", "type": "integer" }, "row_generators_module": { "description": "The name of a local Python module of row generators (excluding .py).", "type": "string" }, "src-stats": { "description": "An array of source statistics queries.", "items": { "additionalProperties": false, "properties": { "delta": { "description": "The differential privacy delta value for the DP query.", "type": "number" }, "dp-query": { "description": "A SmartNoise SQL query.", "type": "string" }, "epsilon": { "description": "The differential privacy epsilon value for the DP query.", "type": "number" }, "name": { "description": "A name for the query, which will be used in the stats file.", "type": "string" }, "query": { "description": "A SQL query.", "type": "string" }, "snsql-metadata": { "description": "See https://docs.smartnoise.org/sql/metadata.html#yaml-format.", "patternProperties": { "^(?!(max_ids|row_privacy|sample_max_ids|censor_dims|clamp_counts|clamp_columns|use_dpsu)).*$": { "additionalProperties": false, "properties": { "lower": { "type": "number" }, "missing_value": {}, "nullable": { "type": "boolean" }, "private_id": { "type": "boolean" }, "sensitivity": { "type": "number" }, "type": { "type": "string" }, "upper": { "type": "number" } }, "required": [ "type" ], "type": "object" } }, "properties": { "censor_dims": { "type": "boolean" }, "clamp_columns": { "type": "boolean" }, "clamp_counts": { "type": "boolean" }, "max_ids": { "type": "integer" }, "row_privacy": { "type": "boolean" }, "sample_max_ids": { "type": "boolean" }, "use_dpsu": { "type": "boolean" } }, "type": "object" } }, "required": [ "name", "query" ] }, "type": "array" }, "story_generators": { "description": "An array of story generators.", "items": { "additionalProperties": false, "properties": { "args": { "description": "Positional arguments to pass to the story generator.", "type": "array" }, "kwargs": { "description": "Keyword arguments to pass to the story generator.", "type": "object" }, "name": { "description": "The full name of a story generator (e.g. my_story_generators.short_story).", "type": "string" }, "num_stories_per_pass": { "description": "todo", "type": "integer" } }, "required": [ "name", "num_stories_per_pass" ], "type": "object" }, "type": "array" }, "story_generators_module": { "description": "The name of a local Python module of story generators (excluding .py).", "type": "string" }, "tables": { "description": "Table configurations.", "patternProperties": { ".*": { "additionalProperties": false, "description": "A table configuration.", "properties": { "num_rows_per_pass": { "description": "The number of rows to generate per pass.", "type": "integer" }, "row_generators": { "description": "An array of row generators to create column values.", "items": { "properties": { "args": { "description": "Positional arguments to pass to the function.", "type": "array" }, "columns_assigned": { "description": "One or more columns to assign the return value to.", "items": { "type": "string" }, "type": [ "array", "string" ] }, "kwargs": { "description": "Keyword arguments to pass to the function.", "type": "object" }, "name": { "description": "The name of a (built-in or custom) function (e.g. max or my_row_generators.my_gen).", "type": "string" } }, "required": [ "name", "columns_assigned" ], "type": "object" }, "type": "array" }, "vocabulary_table": { "description": "Whether to export the table data.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "use-asyncio": { "description": "Run source-statistics queries using asyncpg.", "type": "boolean" } }, "title": "SQLSynthGen Config", "type": [ "object" ] }
MIT
en
alan-turing-institute/sqlsynthgen
959c52667791fe9b8a0b24e6e2387b66d46e1727
2023-06-02T14:57:46
sqlsynthgen/json_schemas/config_schema.json
10
2024-05-27T06:54:16.009255Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A SQLSynthGen configuration YAML file", "properties": { "row_generators_module": { "type": "string" }, "smartnoise-sql": { "patternProperties": { ".*": { "patternProperties": { ".*": { "patternProperties": { "^(?!censor_dims).*$": { "properties": { "name": { "type": "string" }, "private_id": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" } }, "properties": { "censor_dims": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "src-stats": { "items": { "properties": { "delta": { "type": "number" }, "epsilon": { "type": "number" }, "name": { "type": "string" }, "query": { "type": "string" } } }, "type": "array" }, "story_generators": { "items": { "additionalProperties": false, "properties": { "args": { "type": [ "array", "null" ] }, "kwargs": { "type": [ "object", "null" ] }, "name": { "type": "string" }, "num_stories_per_pass": { "type": "integer" } }, "type": "object" }, "type": "array" }, "story_generators_module": { "type": "string" }, "tables": { "patternProperties": { ".*": { "additionalProperties": false, "properties": { "num_rows_per_pass": { "type": "integer" }, "row_generators": { "items": { "properties": { "args": { "type": [ "array", "null" ] }, "columns_assigned": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "kwargs": { "type": [ "object", "null" ] }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "vocabulary_table": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "title": "SQLSynthGen Config", "type": [ "object" ] }
MIT
en
alan-turing-institute/sqlsynthgen
42ffcd55a12bca75e92ee22adec496db99f4b61e
2023-06-02T12:30:13
sqlsynthgen/json_schemas/config_schema.json
10
2024-05-27T06:54:16.009255Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A SQLSynthGen configuration YAML file", "properties": { "row_generators_module": { "type": "string" }, "smartnoise-sql": { "patternProperties": { ".*": { "patternProperties": { ".*": { "patternProperties": { "^(?!censor_dims).*$": { "properties": { "name": { "type": "string" }, "private_id": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" } }, "properties": { "censor_dims": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "src-stats": { "items": { "properties": { "delta": { "type": "number" }, "epsilon": { "type": "number" }, "name": { "type": "string" }, "query": { "type": "string" } } }, "type": "array" }, "story_generators": { "items": { "additionalProperties": false, "properties": { "args": { "type": "object" }, "name": { "type": "string" }, "num_stories_per_pass": { "type": "integer" } }, "type": "object" }, "type": "array" }, "story_generators_module": { "type": "string" }, "tables": { "patternProperties": { ".*": { "additionalProperties": false, "properties": { "num_rows_per_pass": { "type": "integer" }, "row_generators": { "items": { "properties": { "args": { "type": [ "array", "null" ] }, "columns_assigned": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "kwargs": { "type": [ "object", "null" ] }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "vocabulary_table": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "title": "SQLSynthGen Config", "type": [ "object" ] }
MIT
en
alan-turing-institute/sqlsynthgen
e20acbc65cc9069fb9a7c19efa62f46a33fbd3c7
2023-07-19T14:35:17
sqlsynthgen/json_schemas/config_schema.json
10
2024-05-27T06:54:16.009255Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A SQLSynthGen configuration YAML file", "properties": { "max-unique-constraint-tries": { "type": "integer" }, "row_generators_module": { "type": "string" }, "smartnoise-sql": { "patternProperties": { ".*": { "patternProperties": { ".*": { "patternProperties": { "^(?!censor_dims).*$": { "properties": { "name": { "type": "string" }, "private_id": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" } }, "properties": { "censor_dims": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "src-stats": { "items": { "properties": { "delta": { "type": "number" }, "epsilon": { "type": "number" }, "name": { "type": "string" }, "query": { "type": "string" }, "use-smartnoise-sql": { "type": "boolean" } } }, "type": "array" }, "story_generators": { "items": { "additionalProperties": false, "properties": { "args": { "type": "array" }, "kwargs": { "type": "object" }, "name": { "type": "string" }, "num_stories_per_pass": { "type": "integer" } }, "type": "object" }, "type": "array" }, "story_generators_module": { "type": "string" }, "tables": { "patternProperties": { ".*": { "additionalProperties": false, "properties": { "num_rows_per_pass": { "type": "integer" }, "row_generators": { "items": { "properties": { "args": { "type": "array" }, "columns_assigned": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "kwargs": { "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "vocabulary_table": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "use-asyncio": { "type": "boolean" } }, "title": "SQLSynthGen Config", "type": [ "object" ] }
MIT
en
alan-turing-institute/sqlsynthgen
c31f24bf875b349c19f8b310594d8202cd2ad62c
2023-05-30T09:07:27
sqlsynthgen/json_schemas/config_schema.json
10
2024-05-27T06:54:16.009255Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A SQLSynthGen configuration YAML file", "properties": { "row_generators_module": { "type": "string" }, "smartnoise-sql": { "patternProperties": { ".*": { "patternProperties": { ".*": { "patternProperties": { "^(?!censor_dims).*$": { "properties": { "name": { "type": "string" }, "private_id": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" } }, "properties": { "censor_dims": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "src-stats": { "items": { "properties": { "delta": { "type": "number" }, "epsilon": { "type": "number" }, "name": { "type": "string" }, "query": { "type": "string" } } }, "type": "array" }, "story_generators": { "items": { "additionalProperties": false, "properties": { "args": { "type": "object" }, "name": { "type": "string" }, "num_stories_per_pass": { "type": "integer" } }, "type": "object" }, "type": "array" }, "story_generators_module": { "type": "string" }, "tables": { "patternProperties": { ".*": { "additionalProperties": false, "properties": { "num_rows_per_pass": { "type": "integer" }, "row_generators": { "items": { "properties": { "args": { "type": [ "object", "null" ] }, "columns_assigned": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "vocabulary_table": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "title": "SQLSynthGen Config", "type": [ "object" ] }
MIT
en