Skip to content

Commit 801ea32

Browse files
authored
Docs: Fix links and formatting in user guide. (#13654)
Co-authored-by: marcel2012 <13705842+marcel2012@users.noreply.github.com>
1 parent 01d3d80 commit 801ea32

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
@@ -446,15 +446,15 @@ kind: Ingress
446446
metadata:
447447
annotations:
448448
nginx.ingress.kubernetes.io/server-snippet: |
449-
set $agentflag 0;
449+
set $agentflag 0;
450450
451-
if ($http_user_agent ~* "(Mobile)" ){
452-
set $agentflag 1;
453-
}
451+
if ($http_user_agent ~* "(Mobile)" ){
452+
set $agentflag 1;
453+
}
454454
455-
if ( $agentflag = 1 ) {
456-
return 301 https://m.example.com;
457-
}
455+
if ( $agentflag = 1 ) {
456+
return 301 https://m.example.com;
457+
}
458458
```
459459

460460
!!! attention
@@ -530,7 +530,7 @@ Additionally it is possible to set:
530530
```yaml
531531
nginx.ingress.kubernetes.io/auth-url: http://foo.com/external-auth
532532
nginx.ingress.kubernetes.io/auth-snippet: |
533-
proxy_set_header Foo-Header 42;
533+
proxy_set_header Foo-Header 42;
534534
```
535535
> 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
536536

@@ -879,8 +879,8 @@ nginx.ingress.kubernetes.io/modsecurity-transaction-id: "$request_id"
879879
You can also add your own set of modsecurity rules via a snippet:
880880
```yaml
881881
nginx.ingress.kubernetes.io/modsecurity-snippet: |
882-
SecRuleEngine On
883-
SecDebugLog /tmp/modsec_debug.log
882+
SecRuleEngine On
883+
SecDebugLog /tmp/modsec_debug.log
884884
```
885885

886886
Note: If you use both `enable-owasp-core-rules` and `modsecurity-snippet` annotations together, only the
@@ -891,13 +891,13 @@ statement:
891891
nginx 0.24.1 and below
892892
```yaml
893893
nginx.ingress.kubernetes.io/modsecurity-snippet: |
894-
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
895-
Include /etc/nginx/modsecurity/modsecurity.conf
894+
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
895+
Include /etc/nginx/modsecurity/modsecurity.conf
896896
```
897897
nginx 0.25.0 and above
898898
```yaml
899899
nginx.ingress.kubernetes.io/modsecurity-snippet: |
900-
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
900+
Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf
901901
```
902902

903903
### 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" | |
@@ -1039,10 +1039,11 @@ Specifies the port to use when uploading traces. _**default:**_ 4317
10391039

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

1042-
## opentelemetry-trust-incoming-span: "true"
1042+
## opentelemetry-trust-incoming-span
1043+
10431044
Enables or disables using spans from incoming requests as parent for created ones. _**default:**_ true
10441045

1045-
## otel-sampler-parent-based
1046+
## otel-sampler-parent-based
10461047

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

0 commit comments

Comments
 (0)