|
| 1 | +--- |
| 2 | +apiVersion: apiextensions.k8s.io/v1 |
| 3 | +kind: CustomResourceDefinition |
| 4 | +metadata: |
| 5 | + annotations: |
| 6 | + controller-gen.kubebuilder.io/version: v0.19.0 |
| 7 | + name: authenticationfilters.gateway.nginx.org |
| 8 | +spec: |
| 9 | + group: gateway.nginx.org |
| 10 | + names: |
| 11 | + categories: |
| 12 | + - nginx-gateway-fabric |
| 13 | + kind: AuthenticationFilter |
| 14 | + listKind: AuthenticationFilterList |
| 15 | + plural: authenticationfilters |
| 16 | + shortNames: |
| 17 | + - authfilter |
| 18 | + - authenticationfilter |
| 19 | + singular: authenticationfilter |
| 20 | + scope: Namespaced |
| 21 | + versions: |
| 22 | + - additionalPrinterColumns: |
| 23 | + - jsonPath: .metadata.creationTimestamp |
| 24 | + name: Age |
| 25 | + type: date |
| 26 | + name: v1alpha1 |
| 27 | + schema: |
| 28 | + openAPIV3Schema: |
| 29 | + description: |- |
| 30 | + AuthenticationFilter configures request authentication and is |
| 31 | + referenced by HTTPRoute or a GRPCRoute. Filters via ExtensionRef. |
| 32 | + properties: |
| 33 | + apiVersion: |
| 34 | + description: |- |
| 35 | + APIVersion defines the versioned schema of this representation of an object. |
| 36 | + Servers should convert recognized schemas to the latest internal value, and |
| 37 | + may reject unrecognized values. |
| 38 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 39 | + type: string |
| 40 | + kind: |
| 41 | + description: |- |
| 42 | + Kind is a string value representing the REST resource this object represents. |
| 43 | + Servers may infer this from the endpoint the client submits requests to. |
| 44 | + Cannot be updated. |
| 45 | + In CamelCase. |
| 46 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 47 | + type: string |
| 48 | + metadata: |
| 49 | + type: object |
| 50 | + spec: |
| 51 | + description: Spec defines the desired state of the AuthenticationFilter. |
| 52 | + properties: |
| 53 | + basic: |
| 54 | + description: |- |
| 55 | + Basic configures HTTP Basic Authentication. |
| 56 | + Required when Type == Basic. |
| 57 | + properties: |
| 58 | + onFailure: |
| 59 | + description: OnFailure customizes the 401 response for failed |
| 60 | + authentication. |
| 61 | + properties: |
| 62 | + bodyPolicy: |
| 63 | + default: Unauthorized |
| 64 | + description: |- |
| 65 | + Controls whether a default canned body is sent or an empty body. |
| 66 | + Default: Unauthorized. |
| 67 | + enum: |
| 68 | + - Unauthorized |
| 69 | + - Forbidden |
| 70 | + - Empty |
| 71 | + type: string |
| 72 | + scheme: |
| 73 | + default: Basic |
| 74 | + description: |- |
| 75 | + Challenge scheme. If omitted, inferred from filter Type (Basic|Bearer). |
| 76 | + Configures WWW-Authenticate header in error page location. |
| 77 | + enum: |
| 78 | + - Basic |
| 79 | + - Bearer |
| 80 | + type: string |
| 81 | + statusCode: |
| 82 | + default: 401 |
| 83 | + description: |- |
| 84 | + Allowed: 401, 403. |
| 85 | + Default: 401. |
| 86 | + format: int32 |
| 87 | + type: integer |
| 88 | + x-kubernetes-validations: |
| 89 | + - message: statusCode must be 401 or 403 |
| 90 | + rule: self in [401, 403] |
| 91 | + type: object |
| 92 | + realm: |
| 93 | + default: Restricted |
| 94 | + description: |- |
| 95 | + Realm used by NGINX `auth_basic` directive. |
| 96 | + https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic |
| 97 | + Also configures "realm="<realm_value>" in WWW-Authenticate header in error page location. |
| 98 | + type: string |
| 99 | + secretRef: |
| 100 | + description: SecretRef allows referencing a Secret in the same |
| 101 | + namespace |
| 102 | + properties: |
| 103 | + key: |
| 104 | + minLength: 1 |
| 105 | + type: string |
| 106 | + x-kubernetes-validations: |
| 107 | + - message: key must be non-empty |
| 108 | + rule: self != '' |
| 109 | + name: |
| 110 | + default: "" |
| 111 | + description: |- |
| 112 | + Name of the referent. |
| 113 | + This field is effectively required, but due to backwards compatibility is |
| 114 | + allowed to be empty. Instances of this type with an empty value here are |
| 115 | + almost certainly wrong. |
| 116 | + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 117 | + type: string |
| 118 | + required: |
| 119 | + - key |
| 120 | + type: object |
| 121 | + x-kubernetes-map-type: atomic |
| 122 | + required: |
| 123 | + - secretRef |
| 124 | + type: object |
| 125 | + type: |
| 126 | + default: Basic |
| 127 | + description: Type selects the authentication mechanism. |
| 128 | + enum: |
| 129 | + - Basic |
| 130 | + type: string |
| 131 | + required: |
| 132 | + - type |
| 133 | + type: object |
| 134 | + x-kubernetes-validations: |
| 135 | + - message: for type=Basic, spec.basic must be set |
| 136 | + rule: 'self.type == ''Basic'' ? self.basic != null : true' |
| 137 | + - message: when spec.basic is set, type must be 'Basic' |
| 138 | + rule: 'self.basic != null ? self.type == ''Basic'' : true' |
| 139 | + status: |
| 140 | + description: |- |
| 141 | + Status defines the state of the AuthenticationFilter, following the same |
| 142 | + pattern as SnippetsFilter: per-controller conditions with an Accepted condition. |
| 143 | + properties: |
| 144 | + controllers: |
| 145 | + description: |- |
| 146 | + Controllers is a list of Gateway API controllers that processed the AuthenticationFilter |
| 147 | + and the status of the AuthenticationFilter with respect to each controller. |
| 148 | + items: |
| 149 | + properties: |
| 150 | + conditions: |
| 151 | + description: Conditions describe the status of the SnippetsFilter. |
| 152 | + items: |
| 153 | + description: Condition contains details for one aspect of |
| 154 | + the current state of this API Resource. |
| 155 | + properties: |
| 156 | + lastTransitionTime: |
| 157 | + description: |- |
| 158 | + lastTransitionTime is the last time the condition transitioned from one status to another. |
| 159 | + This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
| 160 | + format: date-time |
| 161 | + type: string |
| 162 | + message: |
| 163 | + description: |- |
| 164 | + message is a human readable message indicating details about the transition. |
| 165 | + This may be an empty string. |
| 166 | + maxLength: 32768 |
| 167 | + type: string |
| 168 | + observedGeneration: |
| 169 | + description: |- |
| 170 | + observedGeneration represents the .metadata.generation that the condition was set based upon. |
| 171 | + For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date |
| 172 | + with respect to the current state of the instance. |
| 173 | + format: int64 |
| 174 | + minimum: 0 |
| 175 | + type: integer |
| 176 | + reason: |
| 177 | + description: |- |
| 178 | + reason contains a programmatic identifier indicating the reason for the condition's last transition. |
| 179 | + Producers of specific condition types may define expected values and meanings for this field, |
| 180 | + and whether the values are considered a guaranteed API. |
| 181 | + The value should be a CamelCase string. |
| 182 | + This field may not be empty. |
| 183 | + maxLength: 1024 |
| 184 | + minLength: 1 |
| 185 | + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ |
| 186 | + type: string |
| 187 | + status: |
| 188 | + description: status of the condition, one of True, False, |
| 189 | + Unknown. |
| 190 | + enum: |
| 191 | + - "True" |
| 192 | + - "False" |
| 193 | + - Unknown |
| 194 | + type: string |
| 195 | + type: |
| 196 | + description: type of condition in CamelCase or in foo.example.com/CamelCase. |
| 197 | + maxLength: 316 |
| 198 | + pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ |
| 199 | + type: string |
| 200 | + required: |
| 201 | + - lastTransitionTime |
| 202 | + - message |
| 203 | + - reason |
| 204 | + - status |
| 205 | + - type |
| 206 | + type: object |
| 207 | + maxItems: 8 |
| 208 | + minItems: 1 |
| 209 | + type: array |
| 210 | + x-kubernetes-list-map-keys: |
| 211 | + - type |
| 212 | + x-kubernetes-list-type: map |
| 213 | + controllerName: |
| 214 | + description: |- |
| 215 | + ControllerName is a domain/path string that indicates the name of the |
| 216 | + controller that wrote this status. This corresponds with the |
| 217 | + controllerName field on GatewayClass. |
| 218 | +
|
| 219 | + Example: "example.net/gateway-controller". |
| 220 | +
|
| 221 | + The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are |
| 222 | + valid Kubernetes names |
| 223 | + (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). |
| 224 | +
|
| 225 | + Controllers MUST populate this field when writing status. Controllers should ensure that |
| 226 | + entries to status populated with their ControllerName are cleaned up when they are no |
| 227 | + longer necessary. |
| 228 | + maxLength: 253 |
| 229 | + minLength: 1 |
| 230 | + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$ |
| 231 | + type: string |
| 232 | + required: |
| 233 | + - controllerName |
| 234 | + type: object |
| 235 | + maxItems: 16 |
| 236 | + type: array |
| 237 | + type: object |
| 238 | + required: |
| 239 | + - metadata |
| 240 | + - spec |
| 241 | + type: object |
| 242 | + served: true |
| 243 | + storage: true |
| 244 | + subresources: |
| 245 | + status: {} |
0 commit comments