8000 fix: Update f5-hugo version · nginx/kubernetes-ingress@68778c8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 68778c8

Browse files
ciarams87nginx-bot
ciarams87
and
nginx-bot
committed
fix: Update f5-hugo version
fix: Updates to f5-theme fix issues with raw html code tags in docs Update netlify.toml Add branch deploy config for release branch Auto-update theme, go.mod from gitlab.com/f5/nginx/controller/poc/f5-hugo. (#1842) Co-authored-by: Travis Martin <t.martin@f5.com> Merge branch 'staging' into add-kic-left-nav-toc Merge pull request #1848 from nginxinc/add-kic-left-nav-toc fix: Add left nav TOC to KIC docs (docs-1.12) fix: updated baseURL for prod and staging; 8000 fixes sitemap issues Merge pull request #1904 from nginxinc/fix-kic-sitemap-baseurl fix: updated baseURL for prod and staging; fixes sitemap issues fix: DOCOPS-122 fix broken links in KIC Merge pull request #1936 from nginxinc/DOCOPS-122b fix: DOCOPS-122 fix broken links in KIC and KIC-407 remove old TOCs fix: remove toc from globalconfiguration-resource Merge pull request #1937 from nginxinc/DOCOPS-122b KIC-407 remove old TOC (redundant) fix: DOCOPS-232 broken link Merge pull request #1938 from nginxinc/DOCOPS-232 Docops 232 - Broken link in App-protect configuration doc Add instructions for configuring MyF5 JWT as a docker registry secret (#1898) * Add instructions for configuring MyF5 JWT as a docker registry secret * PR feedback Co-authored-by: nginx-bot <68849795+nginx-bot@users.noreply.github.com>
1 parent 42a90e6 commit 68778c8

File tree

12 files changed

+46
-143
lines changed

12 files changed

+46
-143
lines changed

‎docs/config/production/config.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
baseURL = "/nginx-ingress-controller/"
1+
baseURL = "https://docs.nginx.com/nginx-ingress-controller/"
22
title = "NGINX Ingress Controller"
33
publishDir = "public/nginx-ingress-controller"
44
canonifyURLs = false

‎docs/config/staging/config.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
baseURL = "/nginx-ingress-controller/"
1+
baseURL = "https://docs-staging.nginx.com/nginx-ingress-controller/"
22
title = "STAGING -- NGINX Docs"
33
publishDir = "public/nginx-ingress-controller"
44
canonifyURLs = false

‎docs/content/app-protect/configuration.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To add any [App Protect policy](/nginx-app-protect/policy/#policy) to an Ingress
3636

3737
> **Note**: The relationship between the Policy JSON and the resource spec is 1:1. If you're defining your resources in YAML, as we do in our examples, you'll need to represent the policy as YAML. The fields must match those in the source JSON exactly in name and level.
3838
39-
For example, say you want to use the [DataGuard policy](/nginx-app-protect/policy/#data-guard) shown below:
39+
For example, say you want to use the [DataGuard policy](/nginx-app-protect/policy/#policy/data-guard) shown below:
4040

4141
```json
4242
{
@@ -107,7 +107,7 @@ To add the [App Protect log configurations](/nginx-app-protect/configuration/#se
107107

108108
> **Note**: The fields from the JSON must be presented in the YAML *exactly* the same, in name and level. The Ingress Controller will transform the YAML into a valid JSON App Protect log config.
109109

110-
For example, say you want to [log state changing requests](/nginx-app-protect/troubleshooting/#log-state-changing-requests) for your Ingress resources using App Protect. The App Protect log configuration looks like this:
110+
For example, say you want to [log state changing requests](/nginx-app-protect/configuration/#security-log-configuration-file) for your Ingress resources using App Protect. The App Protect log configuration looks like this:
111111

112112
```json
113113
{

‎docs/content/app-protect/installation.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ Take the steps below to create the Docker image that you'll use to deploy NGINX
6565

6666
Take the steps below to set up and deploy the NGINX Ingress Controller and App Protect module in your Kubernetes cluster.
6767

68-
1. [Configure role-based access control (RBAC)](/nginx-ingress-controller/installation/installation-with-manifests/#configure-rbac).
68+
1. [Configure role-based access control (RBAC)](/nginx-ingress-controller/installation/installation-with-manifests/#1-configure-rbac).
6969

7070
> **Important**: You must have an admin role to configure RBAC in your Kubernetes cluster.
7171

72-
2. [Create the common Kubernetes resources](/nginx-ingress-controller/installation/installation-with-manifests/#create-common-resources).
72+
2. [Create the common Kubernetes resources](/nginx-ingress-controller/installation/installation-with-manifests/#2-create-common-resources).
7373
3. Enable the App Protect module by adding the `enable-app-protect` [cli argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#cmdoption-enable-app-protect) to your Deployment or DaemonSet file.
74-
4. [Deploy the Ingress Controller](/nginx-ingress-controller/installation/installation-with-manifests/#deploy-the-ingress-controller).
74+
4. [Deploy the Ingress Controller](/nginx-ingress-controller/installation/installation-with-manifests/#3-deploy-the-ingress-controller).
7575

7676
For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect/configuration) and the [NGINX Ingress Controller with App Protect examples on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect).

‎docs/content/configuration/global-configuration/globalconfiguration-resource.md‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,6 @@ The resource supports configuring listeners for TCP and UDP load balancing. List
1414

1515
> **Feature Status**: The GlobalConfiguration resource is available as a preview feature: it is suitable for experimenting and testing; however, it must be used with caution in production environments. Additionally, while the feature is in preview, we might introduce some backward-incompatible changes to the resource specification in the next releases.
1616
17-
## Contents
18-
19-
- [GlobalConfiguration Resource](#globalconfiguration-resource)
20-
- [Contents](#contents)
21-
- [Prerequisites](#prerequisites)
22-
- [GlobalConfiguration Specification](#globalconfiguration-specification)
23-
- [Listener](#listener)
24-
- [Using GlobalConfiguration](#using-globalconfiguration)
25-
- [Validation](#validation)
26-
- [Structural Validation](#structural-validation)
27-
- [Comprehensive Validation](#comprehensive-validation)
28-
2917
## Prerequisites
3018

3119
When [installing](/nginx-ingress-controller/installation/installation-with-manifests) the Ingress Controller, you need to reference a GlobalConfiguration resource in the [`-global-configuration`](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments#cmdoption-global-configuration) command-line argument. The Ingress Controller only needs one GlobalConfiguration resource.

‎docs/content/configuration/ingress-resources/advanced-configuration-with-annotations.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -196,12 +196,12 @@ The table below summarizes the available annotations.
196196
197197
**Note**: The App Protect annotations only work if App Protect module is [installed](/nginx-ingress-controller/app-protect/installation/).
198198
199-
{{% table %}}
200-
|Annotation | ConfigMap Key | Description | Default | Example |
201-
| ---| ---| ---| ---| --- |
202-
|``appprotect.f5.com/app-protect-policy`` | N/A | The name of the App Protect Policy for the Ingress Resource. Format is ``namespace/name``. If no namespace is specified, the same namespace of the Ingress Resource is used. If not specified but ``appprotect.f5.com/app-protect-enable`` is true, a default policy id applied. If the referenced policy resource does not exist, or policy is invalid, this annotation will be ignored, and the default policy will be applied. | N/A | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
203-
|``appprotect.f5.com/app-protect-enable`` | N/A | Enable App Protect for the Ingress Resource. | ``False`` | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
204-
|``appprotect.f5.com/app-protect-security-log-enable`` | N/A | Enable the [security log](/nginx-app-protect/troubleshooting/#app-protect-security-log) for App Protect. | ``False`` | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
205-
|``appprotect.f5.com/app-protect-security-log`` | N/A | The App Protect log configuration for the Ingress Resource. Format is ``namespace/name``. If no namespace is specified, the same namespace as the Ingress Resource is used. If not specified the default is used which is: filter: ``illegal``, format: ``default``. Multiple configurations can be specified in a comma seperated list. Both log configurations and destinations list (see below) must be of equal length. Configs and destinations are paired by the list indices. | N/A | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
206-
|``appprotect.f5.com/app-protect-security-log-destination`` | N/A | The destination of the security log. For more information check the [DESTINATION argument](/nginx-app-protect/troubleshooting/#app-protect-security-log). Multiple destinations can be specified in a coma seperated list. Both log configurations and destinations list (see above) must be of equal length. Configs and destinations are paired by the list indices. | ``syslog:server=localhost:514`` | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
207-
{{% /table %}}
199+
{{% table %}}
200+
|Annotation | ConfigMap Key | Description | Default | Example |
201+
| ---| ---| ---| ---| --- |
202+
|``appprotect.f5.com/app-protect-policy`` | N/A | The name of the App Protect Policy for the Ingress Resource. Format is ``namespace/name``. If no namespace is specified, the same namespace of the Ingress Resource is used. If not specified but ``appprotect.f5.com/app-protect-enable`` is true, a default policy id applied. If the referenced policy resource does not exist, or policy is invalid, this annotation will be ignored, and the default policy will be applied. | N/A | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
203+
|``appprotect.f5.com/app-protect-enable`` | N/A | Enable App Protect for the Ingress Resource. | ``False`` | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
204+
|``appprotect.f5.com/app-protect-security-log-enable`` | N/A | Enable the [security log](/nginx-app-protect/troubleshooting/#app-protect-logging-overview) for App Protect. | ``False`` | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
205+
|``appprotect.f5.com/app-protect-security-log`` | N/A | The App Protect log configuration for the Ingress Resource. Format is ``namespace/name``. If no namespace is specified, the same namespace as the Ingress Resource is used. If not specified the default is used which is: filter: ``illegal``, format: ``default``. Multiple configurations can be specified in a comma seperated list. Both log configurations and destinations list (see below) must be of equal length. Configs and destinations are paired by the list indices. | N/A | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
206+
|``appprotect.f5.com/app-protect-security-log-destination`` | N/A | The destination of the security log. For more information check the [DESTINATION argument](/nginx-app-protect/troubleshooting/#app-protect-logging-overview). Multiple destinations can be specified in a coma separated list. Both log configurations and destinations list (see above) must be of equal length. Configs and destinations are paired by the list indices. | ``syslog:server=localhost:514`` | [Example for App Protect](https://github.com/nginxinc/kubernetes-ingress/tree/v1.12.0/examples/appprotect). |
207+
{{% /table %}}

‎docs/content/configuration/ingress-resources/basic-configuration.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ Starting from Kubernetes 1.18, you can use the following new features:
9797
- host: cafe.example.com
9898
. . .
9999
```
100-
When using this filed you need to create the `IngressClass` resource with the corresponding `name`. See Step 3 *Create an IngressClass resource* of the [Create Common Resources](/nginx-ingress-controller/installation/installation-with-manifests/#create-common-resources) section.
100+
When using this filed you need to create the `IngressClass` resource with the corresponding `name`. See Step 3 *Create an IngressClass resource* of the [Create Common Resources](/nginx-ingress-controller/installation/installation-with-manifests/#2-create-common-resources) section.
101101

102102
## Restrictions
103103

104104
The NGINX Ingress Controller imposes the following restrictions on Ingress resources:
105105
* When defining an Ingress resource, the `host` field is required.
106-
* The `host` value needs to be unique among all Ingress and VirtualServer resources unless the Ingress resource is a [mergeable minion](/nginx-ingress-controller/configuration/ingress-resources/cross-namespace-configuration/). See also [Handling Host Collisions](/nginx-ingress-controller/configuration/handling-host-collisions).
106+
* The `host` value needs to be unique among all Ingress and VirtualServer resources unless the Ingress resource is a [mergeable minion](/nginx-ingress-controller/configuration/ingress-resources/cross-namespace-configuration/). See also [Handling Host and Listener Collisions](/nginx-ingress-controller/configuration/handling-host-and-listener-collisions).
107107

108108
## Advanced Configuration
109109

‎docs/content/configuration/policy-resource.md‎

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,6 @@ The resource is implemented as a [Custom Resource](https://kubernetes.io/docs/co
1414

1515
This document is the reference documentation for the Policy resource. An example of a Policy for access control is available in our [GitHub repo](https://github.com/nginxinc/kubernetes-ingress/blob/v1.12.0/examples-of-custom-resources/access-control).
1616

17-
## Contents
18-
19-
- [Policy Resource](#policy-resource)
20-
- [Contents](#contents)
21-
- [Prerequisites](#prerequisites)
22-
- [Policy Specification](#policy-specification)
23-
- [AccessControl](#accesscontrol)
24-
- [AccessControl Merging Behavior](#accesscontrol-merging-behavior)
25-
- [RateLimit](#ratelimit)
26-
- [RateLimit Merging Behavior](#ratelimit-merging-behavior)
27-
- [JWT](#jwt)
28-
- [JWT Merging Behavior](#jwt-merging-behavior)
29-
- [IngressMTLS](#ingressmtls)
30-
- [IngressMTLS Merging Behavior](#ingressmtls-merging-behavior)
31-
- [EgressMTLS](#egressmtls)
32-
- [EgressMTLS Merging Behavior](#egressmtls-merging-behavior)
33-
- [OIDC](#oidc)
34-
- [Prerequisites](#prerequisites-1)
35-
- [Limitations](#limitations)
36-
- [OIDC Merging Behavior](#oidc-merging-behavior)
37-
- [Using Policy](#using-policy)
38-
- [WAF](#waf)
39-
- [WAF Merging Behavior](#waf-merging-behavior)
40-
- [Applying Policies](#applying-policies)
41-
- [Invalid Policies](#invalid-policies)
42-
- [Validation](#validation)
43-
- [Structural Validation](#structural-validation)
44-
- [Comprehensive Validation](#comprehensive-validation)
45-
4617
## Prerequisites
4718

4819
Policies work together with [VirtualServer and VirtualServerRoute resources](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/), which you need to create separately.
@@ -190,7 +161,7 @@ action:
190161
- name: alg
191162
value: ${jwt_header_alg}
192163
```
193-
We use the `requestHeaders` of the [Action.Proxy](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#action-proxy) to set the values of two headers that NGINX will pass to the upstream servers.
164+
We use the `requestHeaders` of the [Action.Proxy](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#actionproxy) to set the values of two headers that NGINX will pass to the upstream servers.
194165

195166
The value of the `${jwt_claim_user}` variable is the `user` claim of a JWT. For other claims, use `${jwt_claim_name}`, where `name` is the name of the claim. Note that nested claims and claims that include a period (`.`) are not supported. Similarly, use `${jwt_header_name}` where `name` is the name of a header. In our example, we use the `alg` header.
196167

@@ -230,8 +201,8 @@ ingressMTLS:
230201
```
231202

232203
A VirtualServer that references an IngressMTLS policy must:
233-
* Enable [TLS termination](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserver-tls).
234-
* Reference the policy in the VirtualServer [`spec`](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserver-specification). It is not allowed to reference an IngressMTLS policy in a [`route `](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserver-route) or in a VirtualServerRoute [`subroute`](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserverroute-subroute).
204+
* Enable [TLS termination](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualservertls).
205+
* Reference the policy in the VirtualServer [`spec`](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserver-specification). It is not allowed to reference an IngressMTLS policy in a [`route `](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserverroute) or in a VirtualServerRoute [`subroute`](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#virtualserverroutesubroute).
235206

236207
If the conditions above are not met, NGINX will send the `500` status code to clients.
237208

@@ -247,7 +218,7 @@ action:
247218
- name: client-cert
248219
value: ${ssl_client_escaped_cert} # client certificate in the PEM format (urlencoded)
249220
```
250-
We use the `requestHeaders` of the [Action.Proxy](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#action-proxy) to set the values of the two headers that NGINX will pass to the upstream servers. See the [list of embedded variables](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#variables) that are supported by the `ngx_http_ssl_module`, which you can use to pass the client certificate details.
221+
We use the `requestHeaders` of the [Action.Proxy](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#actionproxy) to set the values of the two headers that NGINX will pass to the upstream servers. See the [list of embedded variables](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#variables) that are supported by the `ngx_http_ssl_module`, which you can use to pass the client certificate details.
251222

252223
> Note: The feature is implemented using the NGINX [ngx_http_ssl_module](https://nginx.org/en/docs/http/ngx_http_ssl_module.html).
253224

@@ -409,7 +380,7 @@ waf:
409380
|Field | Description | Type | Required |
410381
| ---| ---| ---| --- |
411382
|``enable`` | Enables NGINX App Protect. | ``bool`` | Yes |
412-
|``apPolicy`` | The [App Protect policy](/nginx-ingress-controller/app-protect/configuration/#app-protect-policies/) of the WAF. Accepts an optional namespace. | ``string`` | No |
383+
|``apPolicy`` | The [App Protect policy](/nginx-ingress-controller/app-protect/configuration/#app-protect-policies) of the WAF. Accepts an optional namespace. | ``string`` | No |
413384
|``securityLog.enable`` | Enables security log. | ``bool`` | No |
414385
|``securityLog.apLogConf`` | The [App Protect log conf](/nginx-ingress-controller/app-protect/configuration/#app-protect-logs) resource. Accepts an optional namespace. | ``string`` | No |
415386
|``securityLog.logDest`` | The log destination for the security log. Accepted variables are ``syslog:server=<ip-address &#124; localhost>:<port>``, ``stderr``, ``<absolute path to file>``. Default is ``"syslog:server=127.0.0.1:514"``. | ``string`` | No |

0 commit comments

Comments
 (0)
0