|
| 1 | +apiVersion: apiextensions.k8s.io/v1 |
| 2 | +kind: CustomResourceDefinition |
| 3 | +metadata: |
| 4 | + name: nginxingresscontrollers.k8s.nginx.org |
| 5 | +spec: |
| 6 | + group: k8s.nginx.org |
| 7 | + names: |
| 8 | + kind: NginxIngressController |
| 9 | + listKind: NginxIngressControllerList |
| 10 | + plural: nginxingresscontrollers |
| 11 | + singular: nginxingresscontroller |
| 12 | + scope: Namespaced |
| 13 | + versions: |
| 14 | + - name: v1alpha1 |
| 15 | + schema: |
| 16 | + openAPIV3Schema: |
| 17 | + description: NginxIngressController is the Schema for the nginxingresscontrollers |
| 18 | + API |
| 19 | + properties: |
| 20 | + apiVersion: |
| 21 | + description: 'APIVersion defines the versioned schema of this representation |
| 22 | + of an object. Servers should convert recognized schemas to the latest |
| 23 | + internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' |
| 24 | + type: string |
| 25 | + kind: |
| 26 | + description: 'Kind is a string value representing the REST resource this |
| 27 | + object represents. Servers may infer this from the endpoint the client |
| 28 | + submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' |
| 29 | + type: string |
| 30 | + metadata: |
| 31 | + type: object |
| 32 | + spec: |
| 33 | + description: NginxIngressControllerSpec defines the desired state of NginxIngressController |
| 34 | + properties: |
| 35 | + appProtect: |
| 36 | + description: App Protect support configuration. Requires enableCRDs |
| 37 | + set to true. |
| 38 | + nullable: true |
| 39 | + properties: |
| 40 | + enable: |
| 41 | + description: Enable App Protect. |
| 42 | + type: boolean |
| 43 | + required: |
| 44 | + - enable |
| 45 | + type: object |
| 46 | + configMapData: |
| 47 | + additionalProperties: |
| 48 | + type: string |
| 49 | + description: Initial values of the Ingress Controller ConfigMap. Check |
| 50 | + https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/ |
| 51 | + for more information about possible values. |
| 52 | + nullable: true |
| 53 | + type: object |
| 54 | + defaultSecret: |
| 55 | + description: The TLS Secret for TLS termination of the default server. |
| 56 | + The format is namespace/name. If not specified, the operator will |
| 57 | + generate and deploy a TLS Secret with a self-signed certificate |
| 58 | + and key. |
| 59 | + type: string |
| 60 | + enableCRDs: |
| 61 | + description: Enables the use of NGINX Ingress Resource Definitions |
| 62 | + (VirtualServer and VirtualServerRoute). |
| 63 | + type: boolean |
| 64 | + enableLatencyMetrics: |
| 65 | + description: Bucketed response times from when NGINX establishes a |
| 66 | + connection to an upstream server to when the last byte of the response |
| 67 | + body is received by NGINX. **Note** The metric for the upstream |
| 68 | + isn't available until traffic is sent to the upstream. |
| 69 | + nullable: true |
| 70 | + type: boolean |
| 71 | + enableLeaderElection: |
| 72 | + description: Enables Leader election to avoid multiple replicas of |
| 73 | + the controller reporting the status of Ingress resources – only |
| 74 | + one replica will report status. |
| 75 | + type: boolean |
| 76 | + enableSnippets: |
| 77 | + description: Enable custom NGINX configuration snippets in VirtualServer |
| 78 | + and VirtualServerRoute resources. Requires enableCRDs set to true. |
| 79 | + type: boolean |
| 80 | + enableTLSPassthrough: |
| 81 | + description: Enable TLS Passthrough on port 443. Requires enableCRDs |
| 82 | + set to true. |
| 83 | + type: boolean |
| 84 | + globalConfiguration: |
| 85 | + description: The GlobalConfiguration resource for global configuration |
| 86 | + of the Ingress Controller. Format is namespace/name. Requires enableCRDs |
| 87 | + set to true. |
| 88 | + type: string |
| 89 | + healthStatus: |
| 90 | + description: Adds a new location to the default server. The location |
| 91 | + responds with the 200 status code for any request. Useful for external |
| 92 | + health-checking of the Ingress controller. |
| 93 | + nullable: true |
| 94 | + properties: |
| 95 | + enable: |
| 96 | + description: Enable the HealthStatus. |
| 97 | + type: boolean |
| 98 | + uri: |
| 99 | + description: URI of the location. Default is `/nginx-health`. |
| 100 | + type: string |
| 101 | + required: |
| 102 | + - enable |
| 103 | + type: object |
| 104 | + image: |
| 105 | + description: The image of the Ingress Controller. |
| 106 | + properties: |
| 107 | + pullPolicy: |
| 108 | + description: The ImagePullPolicy of the image. |
| 109 | + enum: |
| 110 | + - Never |
| 111 | + - Always |
| 112 | + - IfNotPresent |
| 113 | + type: string |
| 114 | + repository: |
| 115 | + description: The repository of the image. |
| 116 | + type: string |
| 117 | + tag: |
| 118 | + description: The tag (version) of the image. |
| 119 | + type: string |
| 120 | + required: |
| 121 | + - pullPolicy |
| 122 | + - repository |
| 123 | + - tag |
| 124 | + type: object |
| 125 | + ingressClass: |
| 126 | + description: A class of the Ingress controller. The Ingress controller |
| 127 | + only processes Ingress resources that belong to its class (in other |
| 128 | + words, have the annotation “kubernetes.io/ingress.class”). Additionally, |
| 129 | + the Ingress controller processes Ingress resources that do not have |
| 130 | + that annotation, which can be disabled by setting UseIngressClassOnly |
| 131 | + to true. Default is `nginx`. |
| 132 | + type: string |
| 133 | + logLevel: |
| 134 | + description: Log level for V logs. Format is 0 - 3 |
| 135 | + maximum: 3 |
| 136 | + minimum: 0 |
| 137 | + type: integer |
| 138 | + nginxDebug: |
| 139 | + description: 'Enable debugging for NGINX. Uses the nginx-debug binary. |
| 140 | + Requires ‘error-log-level: debug’ in the ConfigMapData.' |
| 141 | + type: boolean |
| 142 | + nginxPlus: |
| 143 | + description: Deploys the Ingress Controller for NGINX Plus. The default |
| 144 | + is false meaning the Ingress Controller will be deployed for NGINX |
| 145 | + OSS. |
| 146 | + type: boolean |
| 147 | + nginxReloadTimeout: |
| 148 | + description: Timeout in milliseconds which the Ingress Controller |
| 149 | + will wait for a successful NGINX reload after a change or at the |
| 150 | + initial start. |
| 151 | + type: integer |
| 152 | + nginxStatus: |
| 153 | + description: NGINX stub_status, or the NGINX Plus API. |
| 154 | + nullable: true |
| 155 | + properties: |
| 156 | + allowCidrs: |
| 157 | + description: Whitelist IPv4 IP/CIDR blocks to allow access to |
| 158 | + NGINX stub_status or the NGINX Plus API. Separate multiple IP/CIDR |
| 159 | + by commas. (default “127.0.0.1”) |
| 160 | + type: string |
| 161 | + enable: |
| 162 | + description: Enable the NginxStatus. |
| 163 | + type: boolean |
| 164 | + port: |
| 165 | + description: Set the port where the NGINX stub_status or the NGINX |
| 166 | + Plus API is exposed. Default is 8080. Format is 1023 - 65535 |
| 167 | + maximum: 65535 |
| 168 | + minimum: 1023 |
| 169 | + nullable: true |
| 170 | + type: integer |
| 171 | + required: |
| 172 | + - enable |
| 173 | + type: object |
| 174 | + prometheus: |
| 175 | + description: NGINX or NGINX Plus metrics in the Prometheus format. |
| 176 | + nullable: true |
| 177 | + properties: |
| 178 | + enable: |
| 179 | + description: Enable Prometheus metrics. |
| 180 | + type: boolean |
| 181 | + port: |
| 182 | + description: Sets the port where the Prometheus metrics are exposed. |
| 183 | + Default is 9113. Format is 1023 - 65535 |
| 184 | + maximum: 65535 |
| 185 | + minimum: 1023 |
| 186 | + nullable: true |
| 187 | + type: integer |
| 188 | + required: |
| 189 | + - enable |
| 190 | + type: object |
| 191 | + replicas: |
| 192 | + description: The number of replicas of the Ingress Controller pod. |
| 193 | + The default is 1. Only applies if the type is set to deployment. |
| 194 | + format: int32 |
| 195 | + type: integer |
| 196 | + reportIngressStatus: |
| 197 | + description: Update the address field in the status of Ingresses resources. |
| 198 | + nullable: true |
| 199 | + properties: |
| 200 | + enable: |
| 201 | + description: Enable the ReportIngressStatus. |
| 202 | + type: boolean |
| 203 | + externalService: |
| 204 | + description: 'Specifies the name of the service with the type |
| 205 | + LoadBalancer through which the Ingress controller pods are exposed |
| 206 | + externally. The external address of the service is used when |
| 207 | + reporting the status of Ingress resources. Note: Only if ServiceType |
| 208 | + is different than LoadBalancer.' |
| 209 | + type: string |
| 210 | + required: |
| 211 | + - enable |
| 212 | + type: object |
| 213 | + serviceType: |
| 214 | + description: 'The type of the Service for the Ingress Controller. |
| 215 | + Valid Service types are: NodePort and LoadBalancer.' |
| 216 | + enum: |
| 217 | + - NodePort |
| 218 | + - LoadBalancer |
| 219 | + type: string |
| 220 | + type: |
| 221 | + description: The type of the Ingress Controller installation - deployment |
| 222 | + or daemonset. |
| 223 | + enum: |
| 224 | + - deployment |
| 225 | + - daemonset |
| 226 | + type: string |
| 227 | + useIngressClassOnly: |
| 228 | + description: Ignore Ingress resources without the “kubernetes.io/ingress.class” |
| 229 | + annotation. |
| 230 | + type: boolean |
| 231 | + watchNamespace: |
| 232 | + description: Namespace to watch for Ingress resources. By default |
| 233 | + the Ingress controller watches all namespaces. |
| 234 | + type: string |
| 235 | + wildcardTLS: |
| 236 | + description: A Secret with a TLS certificate and key for TLS termination |
| 237 | + of every Ingress host for which TLS termination is enabled but the |
| 238 | + Secret is not specified. If the argument is not set, for such Ingress |
| 239 | + hosts NGINX will break any attempt to establish a TLS connection. |
| 240 | + If the argument is set, but the Ingress controller is not able to |
| 241 | + fetch the Secret from Kubernetes API, the Ingress Controller will |
| 242 | + fail to start. Format is namespace/name. |
| 243 | + type: string |
| 244 | + required: |
| 245 | + - enableCRDs |
| 246 | + - image |
| 247 | + - serviceType |
| 248 | + - type |
| 249 | + type: object |
| 250 | + status: |
| 251 | + description: NginxIngressControllerStatus defines the observed state of |
| 252 | + NginxIngressController |
| 253 | + properties: |
| 254 | + deployed: |
| 255 | + description: Deployed is true if the Operator has finished the deployment |
| 256 | + of the NginxIngressController. |
| 257 | + type: boolean |
| 258 | + required: |
| 259 | + - deployed |
| 260 | + type: object |
| 261 | + type: object |
| 262 | + served: true |
| 263 | + storage: true |
| 264 | + subresources: |
| 265 | + status: {} |
0 commit comments