Ingress-NGINX Config Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/ingressNginx/properties/controller/properties/config
Configure the Ingress-NGINX controller.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Ingress-NGINX Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| annotationsRiskLevel | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| useProxyProtocol | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
annotationsRiskLevel¶
Configure the accepted risk level of annotations on Ingress resources.
Note
See the upstream documentation for reference.
annotationsRiskLevel
-
is optional
-
Type:
string(Ingress-NGINX Annotations Risk Level) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Ingress-NGINX Annotations Risk Level)
CONSTRAINTS:
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"Critical" |
|
"High" |
|
"Medium" |
|
"Low" |
DEFAULTS:
The default value is:
"Critical"
useProxyProtocol¶
useProxyProtocol
-
is optional
-
Type:
boolean(Ingress-NGINX PROXY Protocol) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Ingress-NGINX PROXY Protocol)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main