kubernetes
/
ingress-nginx
mirror of https://github.com/kubernetes/ingress-nginx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Fix default config values and links. (#13737) 

Co-authored-by: marcel2012 <13705842+marcel2012@users.noreply.github.com>
This commit is contained in:
Marcel 2025-08-10 09:13:43 +02:00 committed by GitHub
parent 0f185955ae
commit 1e1824b34c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/kubectl-plugin.md
View File

@ -201,14 +201,12 @@ kubectl ingress-nginx conf -n ingress-nginx --host testaddr.local
```console ```console
$ kubectl ingress-nginx exec -i -n ingress-nginx -- ls /etc/nginx $ kubectl ingress-nginx exec -i -n ingress-nginx -- ls /etc/nginx
fastcgi_params fastcgi_params
geoip
lua lua
mime.types mime.types
modsecurity modsecurity
modules modules
nginx.conf nginx.conf
opentracing.json opentracing.json
opentelemetry.toml
owasp-modsecurity-crs owasp-modsecurity-crs
template template
``` ```

2
docs/user-guide/nginx-configuration/annotations.md
View File

@ -123,7 +123,7 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz
|[nginx.ingress.kubernetes.io/connection-proxy-header](#connection-proxy-header)|string| |[nginx.ingress.kubernetes.io/connection-proxy-header](#connection-proxy-header)|string|
|[nginx.ingress.kubernetes.io/enable-access-log](#enable-access-log)|"true" or "false"| |[nginx.ingress.kubernetes.io/enable-access-log](#enable-access-log)|"true" or "false"|
|[nginx.ingress.kubernetes.io/enable-opentelemetry](#enable-opentelemetry)|"true" or "false"| |[nginx.ingress.kubernetes.io/enable-opentelemetry](#enable-opentelemetry)|"true" or "false"|
|[nginx.ingress.kubernetes.io/opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-spans)|"true" or "false"| |[nginx.ingress.kubernetes.io/opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-span)|"true" or "false"|
|[nginx.ingress.kubernetes.io/use-regex](#use-regex)|bool| |[nginx.ingress.kubernetes.io/use-regex](#use-regex)|bool|
|[nginx.ingress.kubernetes.io/enable-modsecurity](#modsecurity)|bool| |[nginx.ingress.kubernetes.io/enable-modsecurity](#modsecurity)|bool|
|[nginx.ingress.kubernetes.io/enable-owasp-core-rules](#modsecurity)|bool| |[nginx.ingress.kubernetes.io/enable-owasp-core-rules](#modsecurity)|bool|

26
docs/user-guide/nginx-configuration/configmap.md
View File

@ -57,7 +57,7 @@ The following table shows a configuration option's name, type, and the default v
| [error-log-level](#error-log-level) | string | "notice" | | | [error-log-level](#error-log-level) | string | "notice" | |
| [http2-max-field-size](#http2-max-field-size) | string | "" | DEPRECATED in favour of [large_client_header_buffers](#large-client-header-buffers) | | [http2-max-field-size](#http2-max-field-size) | string | "" | DEPRECATED in favour of [large_client_header_buffers](#large-client-header-buffers) |
| [http2-max-header-size](#http2-max-header-size) | string | "" | DEPRECATED in favour of [large_client_header_buffers](#large-client-header-buffers) | | [http2-max-header-size](#http2-max-header-size) | string | "" | DEPRECATED in favour of [large_client_header_buffers](#large-client-header-buffers) |
| [http2-max-requests](#http2-max-requests) | int | 0 | DEPRECATED in favour of [keepalive_requests](#keepalive-requests) | | [http2-max-requests](#http2-max-requests) | int | 0 | DEPRECATED in favour of [keepalive_requests](#keep-alive-requests) |
| [http2-max-concurrent-streams](#http2-max-concurrent-streams) | int | 128 | | | [http2-max-concurrent-streams](#http2-max-concurrent-streams) | int | 128 | |
| [hsts](#hsts) | bool | "true" | | | [hsts](#hsts) | bool | "true" | |
| [hsts-include-subdomains](#hsts-include-subdomains) | bool | "true" | | | [hsts-include-subdomains](#hsts-include-subdomains) | bool | "true" | |
@ -115,7 +115,7 @@ The following table shows a configuration option's name, type, and the default v
| [worker-shutdown-timeout](#worker-shutdown-timeout) | string | "240s" | | | [worker-shutdown-timeout](#worker-shutdown-timeout) | string | "240s" | |
| [enable-serial-reloads](#enable-serial-reloads) | bool | "false" | | | [enable-serial-reloads](#enable-serial-reloads) | bool | "false" | |
| [load-balance](#load-balance) | string | "round_robin" | | | [load-balance](#load-balance) | string | "round_robin" | |
| [variables-hash-bucket-size](#variables-hash-bucket-size) | int | 128 | | | [variables-hash-bucket-size](#variables-hash-bucket-size) | int | 256 | |
| [variables-hash-max-size](#variables-hash-max-size) | int | 2048 | | | [variables-hash-max-size](#variables-hash-max-size) | int | 2048 | |
| [upstream-keepalive-connections](#upstream-keepalive-connections) | int | 320 | | | [upstream-keepalive-connections](#upstream-keepalive-connections) | int | 320 | |
| [upstream-keepalive-time](#upstream-keepalive-time) | string | "1h" | | | [upstream-keepalive-time](#upstream-keepalive-time) | string | "1h" | |
@ -158,15 +158,15 @@ The following table shows a configuration option's name, type, and the default v
| [enable-opentelemetry](#enable-opentelemetry) | bool | "false" | | | [enable-opentelemetry](#enable-opentelemetry) | bool | "false" | |
| [opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-span) | bool | "true" | | | [opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-span) | bool | "true" | |
| [opentelemetry-operation-name](#opentelemetry-operation-name) | string | "" | | | [opentelemetry-operation-name](#opentelemetry-operation-name) | string | "" | |
| [opentelemetry-config](#/etc/nginx/opentelemetry.toml) | string | "/etc/nginx/opentelemetry.toml" | | | [opentelemetry-config](#opentelemetry-config) | string | "/etc/ingress-controller/telemetry/opentelemetry.toml" | |
| [otlp-collector-host](#otlp-collector-host) | string | "" | | | [otlp-collector-host](#otlp-collector-host) | string | "" | |
| [otlp-collector-port](#otlp-collector-port) | int | 4317 | | | [otlp-collector-port](#otlp-collector-port) | int | 4317 | |
| [otel-max-queuesize](#otel-max-queuesize) | int | | | | [otel-max-queuesize](#otel-max-queuesize) | int | 2048 | |
| [otel-schedule-delay-millis](#otel-schedule-delay-millis) | int | | | | [otel-schedule-delay-millis](#otel-schedule-delay-millis) | int | 5000 | |
| [otel-max-export-batch-size](#otel-max-export-batch-size) | int | | | | [otel-max-export-batch-size](#otel-max-export-batch-size) | int | 512 | |
| [otel-service-name](#otel-service-name) | string | "nginx" | | | [otel-service-name](#otel-service-name) | string | "nginx" | |
| [otel-sampler](#otel-sampler) | string | "AlwaysOff" | | | [otel-sampler](#otel-sampler) | string | "AlwaysOn" | |
| [otel-sampler-parent-based](#otel-sampler-parent-based) | bool | "false" | | | [otel-sampler-parent-based](#otel-sampler-parent-based) | bool | "true" | |
| [otel-sampler-ratio](#otel-sampler-ratio) | float | 0.01 | | | [otel-sampler-ratio](#otel-sampler-ratio) | float | 0.01 | |
| [main-snippet](#main-snippet) | string | "" | | | [main-snippet](#main-snippet) | string | "" | |
| [http-snippet](#http-snippet) | string | "" | | | [http-snippet](#http-snippet) | string | "" | |
@ -222,7 +222,7 @@ The following table shows a configuration option's name, type, and the default v
| [default-type](#default-type) | string | "text/html" | | | [default-type](#default-type) | string | "text/html" | |
| [service-upstream](#service-upstream) | bool | "false" | | | [service-upstream](#service-upstream) | bool | "false" | |
| [ssl-reject-handshake](#ssl-reject-handshake) | bool | "false" | | | [ssl-reject-handshake](#ssl-reject-handshake) | bool | "false" | |
| [debug-connections](#debug-connections) | []string | "127.0.0.1,1.1.1.1/24" | | | [debug-connections](#debug-connections) | []string | "" | |
| [strict-validate-path-type](#strict-validate-path-type) | bool | "true" | | | [strict-validate-path-type](#strict-validate-path-type) | bool | "true" | |
| [grpc-buffer-size-kb](#grpc-buffer-size-kb) | int | 0 | | | [grpc-buffer-size-kb](#grpc-buffer-size-kb) | int | 0 | |
| [relative-redirects](#relative-redirects) | bool | false | | | [relative-redirects](#relative-redirects) | bool | false | |
@ -1027,6 +1027,10 @@ Specifies a custom name for the server span. _**default:**_ is empty
For example, set to "HTTP $request_method $uri". For example, set to "HTTP $request_method $uri".
## opentelemetry-config
Sets the opentelemetry config file. _**default:**_ /etc/ingress-controller/telemetry/opentelemetry.toml
## otlp-collector-host ## otlp-collector-host
Specifies the host to use when uploading traces. It must be a valid URL. Specifies the host to use when uploading traces. It must be a valid URL.
@ -1045,7 +1049,7 @@ Enables or disables using spans from incoming requests as parent for created one
## otel-sampler-parent-based ## otel-sampler-parent-based
Uses sampler implementation which by default will take a sample if parent Activity is sampled. _**default:**_ false Uses sampler implementation which by default will take a sample if parent Activity is sampled. _**default:**_ true
## otel-sampler-ratio ## otel-sampler-ratio
@ -1053,7 +1057,7 @@ Specifies sample rate for any traces created. _**default:**_ 0.01
## otel-sampler ## otel-sampler
Specifies the sampler to be used when sampling traces. The available samplers are: AlwaysOff, AlwaysOn, TraceIdRatioBased, remote. _**default:**_ AlwaysOff Specifies the sampler to be used when sampling traces. The available samplers are: AlwaysOff, AlwaysOn, TraceIdRatioBased, remote. _**default:**_ AlwaysOn
## main-snippet ## main-snippet

2
docs/user-guide/third-party-addons/opentelemetry.md
View File

@ -152,7 +152,7 @@ To install the example and collectors run:
kind: ConfigMap kind: ConfigMap
data: data:
enable-opentelemetry: "true" enable-opentelemetry: "true"
opentelemetry-config: "/etc/nginx/opentelemetry.toml" opentelemetry-config: "/etc/ingress-controller/telemetry/opentelemetry.toml"
opentelemetry-operation-name: "HTTP $request_method $service_name $uri" opentelemetry-operation-name: "HTTP $request_method $service_name $uri"
opentelemetry-trust-incoming-span: "true" opentelemetry-trust-incoming-span: "true"
otlp-collector-host: "otel-coll-collector.otel.svc" otlp-collector-host: "otel-coll-collector.otel.svc"

4
internal/ingress/controller/config/config.go
View File

@ -586,7 +586,7 @@ type Configuration struct {
GenerateRequestID bool `json:"generate-request-id,omitempty"` GenerateRequestID bool `json:"generate-request-id,omitempty"`
// Adds an X-Original-Uri header with the original request URI to the backend request // Adds an X-Original-Uri header with the original request URI to the backend request
// Default: true // Default: false
ProxyAddOriginalURIHeader bool `json:"proxy-add-original-uri-header"` ProxyAddOriginalURIHeader bool `json:"proxy-add-original-uri-header"`
// EnableOpentelemetry enables the nginx Opentelemetry extension // EnableOpentelemetry enables the nginx Opentelemetry extension
@ -594,7 +594,7 @@ type Configuration struct {
EnableOpentelemetry bool `json:"enable-opentelemetry"` EnableOpentelemetry bool `json:"enable-opentelemetry"`
// OpentelemetryConfig sets the opentelemetry config file // OpentelemetryConfig sets the opentelemetry config file
// Default: /etc/nginx/opentelemetry.toml // Default: /etc/ingress-controller/telemetry/opentelemetry.toml
OpentelemetryConfig string `json:"opentelemetry-config"` OpentelemetryConfig string `json:"opentelemetry-config"`
// OpentelemetryOperationName specifies a custom name for the server span // OpentelemetryOperationName specifies a custom name for the server span