Skip to content

Commit 614c2fe

Browse files
Docs: Fix links and formatting in user guide. (#13662)
Co-authored-by: marcel2012 <[email protected]>
1 parent 8bbdd34 commit 614c2fe

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

docs/user-guide/basic-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Basic usage - host based routing
1+
# Basic usage - host based routing
22

33
ingress-nginx can be used for many use cases, inside various cloud providers and supports a lot of configurations. In this section you can find a common usage scenario where a single load balancer powered by ingress-nginx will route traffic to 2 different HTTP backend services based on the host name.
44

docs/user-guide/nginx-configuration/annotations.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -445,15 +445,15 @@ kind: Ingress
445445
metadata:
446446
annotations:
447447
nginx.ingress.kubernetes.io/server-snippet: |
448-
set $agentflag 0;
448+
set $agentflag 0;
449449
450-
if ($http_user_agent ~* "(Mobile)" ){
451-
set $agentflag 1;
452-
}
450+
if ($http_user_agent ~* "(Mobile)" ){
451+
set $agentflag 1;
452+
}
453453
454-
if ( $agentflag = 1 ) {
455-
return 301 https://m.example.com;
456-
}
454+
if ( $agentflag = 1 ) {
455+
return 301 https://m.example.com;
456+
}
457457
```
458458

459459
!!! attention
@@ -529,7 +529,7 @@ Additionally it is possible to set:
529529
```yaml
530530
nginx.ingress.kubernetes.io/auth-url: http://foo.com/external-auth
531531
nginx.ingress.kubernetes.io/auth-snippet: |
532-
proxy_set_header Foo-Header 42;
532+
proxy_set_header Foo-Header 42;
533533
```
534534
> Note: `nginx.ingress.kubernetes.io/auth-snippet` is an optional annotation. However, it may only be used in conjunction with `nginx.ingress.kubernetes.io/auth-url` and will be ignored if `nginx.ingress.kubernetes.io/auth-url` is not set
535535

@@ -866,8 +866,8 @@ nginx.ingress.kubernetes.io/modsecurity-transaction-id: "$request_id"
866866
You can also add your own set of modsecurity rules via a snippet:
867867
```yaml
868868
nginx.ingress.kubernetes.io/modsecurity-snippet: |
869-
SecRuleEngine On
870-
SecDebugLog /tmp/modsec_debug.log
869+
SecRuleEngine On
870+
SecDebugLog /tmp/modsec_debug.log
871871
```
872872

873873
Note: If you use both `enable-owasp-core-rules` and `modsecurity-snippet` annotations together, only the
@@ -878,13 +878,13 @@ statement:
878878
nginx 0.24.1 and below
879879
```yaml
880880
nginx.ingress.kubernetes.io/modsecurity-snippet: |
881-
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
882-
Include /etc/nginx/modsecurity/modsecurity.conf
881+
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
882+
Include /etc/nginx/modsecurity/modsecurity.conf
883883
```
884884
nginx 0.25.0 and above
885885
```yaml
886886
nginx.ingress.kubernetes.io/modsecurity-snippet: |
887-
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
887+
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
888888
```
889889

890890
### Backend Protocol

docs/user-guide/nginx-configuration/configmap.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The following table shows a configuration option's name, type, and the default v
7373
| [enable-multi-accept](#enable-multi-accept) | bool | "true" | |
7474
| [max-worker-connections](#max-worker-connections) | int | 16384 | |
7575
| [max-worker-open-files](#max-worker-open-files) | int | 0 | |
76-
| [map-hash-bucket-size](#max-hash-bucket-size) | int | 64 | |
76+
| [map-hash-bucket-size](#map-hash-bucket-size) | int | 64 | |
7777
| [nginx-status-ipv4-whitelist](#nginx-status-ipv4-whitelist) | []string | "127.0.0.1" | |
7878
| [nginx-status-ipv6-whitelist](#nginx-status-ipv6-whitelist) | []string | "::1" | |
7979
| [proxy-real-ip-cidr](#proxy-real-ip-cidr) | []string | "0.0.0.0/0" | |
@@ -1032,10 +1032,11 @@ Specifies the port to use when uploading traces. _**default:**_ 4317
10321032

10331033
Specifies the service name to use for any traces created. _**default:**_ nginx
10341034

1035-
## opentelemetry-trust-incoming-span: "true"
1035+
## opentelemetry-trust-incoming-span
1036+
10361037
Enables or disables using spans from incoming requests as parent for created ones. _**default:**_ true
10371038

1038-
## otel-sampler-parent-based
1039+
## otel-sampler-parent-based
10391040

10401041
Uses sampler implementation which by default will take a sample if parent Activity is sampled. _**default:**_ false
10411042

0 commit comments

Comments
 (0)