Skip to content

Commit

Permalink
feat: Fix broken URLs from repository migration
Browse files Browse the repository at this point in the history
This commit fixes a number of URLs that broke during the repository
migration from the nginxinc to nginx organisation: some URLs were
erroneously updated, leading to 404 issues.

Besides direct URL fixes, some links were changed to internal references
instead of production URLs, which make link issues appear prominently as
a Hugo error instead of silently failing. Some metadata fixes are also
included in affected files.
  • Loading branch information
ADubhlaoich committed Jan 24, 2025
1 parent dd70806 commit b55340c
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 24 deletions.
6 changes: 4 additions & 2 deletions site/content/configuration/policy-resource.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Policy resources
toc: true
weight: 500
toc: true
type: how-to
product: NIC
docs: DOCS-596
---

Expand Down Expand Up @@ -593,7 +595,7 @@ NGINX Plus will pass the ID of an authenticated user to the backend in the HTTP

{{< note >}}

The feature is implemented using the [reference implementation](https://github.com/nginx/nginx-openid-connect/) of NGINX Plus as a relying party for OpenID Connect authentication.
The feature is implemented using the [reference implementation](https://github.com/nginxinc/nginx-openid-connect/) of NGINX Plus as a relying party for OpenID Connect authentication.

{{< /note >}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
docs: DOCS-583
doctypes:
- ''
title: Build NGINX Ingress Controller with NGINX App Protect DoS
toc: true
weight: 100
toc: true
type: how-to
product: NIC
docs: DOCS-583
---

This document explains how to build an image for NGINX Ingress Controller with NGINX App Protect DoS from source code.
This document explains how to build an image for F5 NGINX Ingress Controller with NGINX App Protect DoS from source code.

{{<call-out "tip" "Pre-built image alternatives" >}}If you'd rather not build your own NGINX Ingress Controller image, see the [pre-built image options](#pre-built-images) at the end of this guide.{{</call-out>}}

Expand Down Expand Up @@ -180,7 +180,7 @@ kubectl apply -f config/crd/bases/appprotectdos.f5.com_dosprotectedresources.yam

### Helm Chart

The App Protect DoS Arbitrator can be installed using the [NGINX App Protect DoS Helm Chart](https://github.com/nginx/nap-dos-arbitrator-helm-chart).
The App Protect DoS Arbitrator can be installed using the [NGINX App Protect DoS Helm Chart](https://github.com/nginxinc/nap-dos-arbitrator-helm-chart).
If you have the NGINX Helm Repository already added, you can install the App Protect DoS Arbitrator by running the following command:

```shell
Expand Down
21 changes: 10 additions & 11 deletions site/content/releases.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
description: NGINX Ingress Controller Release Notes.
docs: DOCS-616
doctypes:
- concept
title: Releases
toc: true
weight: 2100

toc: true
type: reference
product: NIC
docs: DOCS-616
---
## 4.0.0

Expand Down Expand Up @@ -348,7 +346,7 @@ versions: 1.25-1.30.
[Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress).
- For NGINX Plus, use the 3.5.2 images from the F5 Container registry,
the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE),
the [GCP Marketplace](https://console.cloud.google.com/marketplace/browse?filter=partner:F5,%20Inc.&filter=solution-type:k8s&filter=category:networking), the [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/nginx.nginx_ingress_premium),
the [GCP Marketplace](https://console.cloud.google.com/marketplace/browse?filter=partner:F5,%20Inc.&filter=solution-type:k8s&filter=category:networking), the [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/nginxinc.nginx_ingress_premium?tab=Overview),
or build your own image using the 3.5.2 source code
- For Helm, use version 1.2.2 of the chart.

Expand Down Expand Up @@ -1205,12 +1203,13 @@ We will provide technical support for NGINX Ingress Controller on any Kubernetes
17 May 2022

### <i class="fa-solid fa-upload"></i> Dependencies
the documentation here

- Update Go dependencies.

### <i class="fa-solid fa-bug-slash"></i> Fixes

- [2654](https://github.com/nginx/kubernetes-ingress/pull/2654) Sync changes from [nginx-openid-connect](https://github.com/nginx/nginx-openid-connect) repo, add zoneSyncLeeway field in policy. For more information on the fixes, see [52](https://github.com/nginx/nginx-openid-connect/pull/52).
- [2654](https://github.com/nginx/kubernetes-ingress/pull/2654) Sync changes from [nginx-openid-connect](https://github.com/nginxinc/nginx-openid-connect) repo, add zoneSyncLeeway field in policy. For more information on the fixes, see [pull request 52](https://github.com/nginxinc/nginx-openid-connect/pull/52).

### <i class="fa-solid fa-download"></i> Upgrade

Expand Down Expand Up @@ -1592,7 +1591,7 @@ We will provide technical support for NGINX Ingress Controller on any Kubernetes
### <i class="fa-solid fa-download"></i> Upgrade

- For NGINX, use the 1.12.1 image from our DockerHub: `nginx/nginx-ingress:1.12.1`, `nginx/nginx-ingress:1.12.1-alpine` or `nginx/nginx-ingress:1.12.1-ubi`
- For NGINX Plus, use the 1.12.1 image from the F5 Container Registry - see [the documentation here](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/)
- For NGINX Plus, use the 1.12.1 image from the F5 Container Registry - see [the documentation here]({{< ref "/installation/nic-images/get-registry-image.md">}})
- Alternatively, you can also build your own image using the 1.12.1 source code.
- For Helm, use version 0.10.1 of the chart.

Expand Down Expand Up @@ -1986,7 +1985,7 @@ For Kubernetes >= 1.18, when upgrading using the [manifests](https://docs.nginx.

### Notes

- When using Kubernetes >= 1.18, the `-use-ingress-class-only` command-line argument is now ignored, and the Ingress Controller will only process resources that belong to its class. See [IngressClass doc](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/#ingress-class) for more details.
- When using Kubernetes >= 1.18, the `-use-ingress-class-only` command-line argument is now ignored, and the Ingress Controller will only process resources that belong to its class. See [IngressClass doc]({{< ref "/installation/run-multiple-ingress-controllers.md#ingress-class" >}}) for more details.
- For Kubernetes >= 1.18, a dedicated IngressClass resource, which is configured by `controller.ingressClass`, is required per helm release. When upgrading or installing releases, ensure `controller.ingressClass` is not set to the name of the IngressClass of other releases or Ingress Controllers.

<hr>
Expand Down Expand Up @@ -2114,7 +2113,7 @@ Release 1.7.0 includes:
- Support for TCP, UDP, and TLS Passthrough load balancing with the new configuration resources: TransportServer and GlobalConfiguration. The resources allow users to deliver complex, non-HTTP-based applications from Kubernetes using NGINX Ingress Controller.
- Support for error pages in VirtualServer and VirtualServerRoute resources. A user can now specify custom error responses for errors returned by backend applications or generated by NGINX, such as a 502 response.
- Improved validation of VirtualServer and VirtualServerRoute resources. kubectl and the Kubernetes API server can now detect violations of the structure of VirtualServer/VirtualServerRoute resources and return an error.
- Support for an operator which manages the lifecycle of the Ingress Controller on Kubernetes or OpenShift. See the [NGINX Ingress Operator GitHub repo](https://github.com/nginx/nginx-ingress-operator).
- Support for an operator which manages the lifecycle of the Ingress Controller on Kubernetes or OpenShift. See the [NGINX Ingress Operator GitHub repo](https://github.com/nginxinc/nginx-ingress-operator).

See the [1.7.0 release announcement blog post](https://www.nginx.com/blog/announcing-nginx-ingress-controller-for-kubernetes-release-1-7-0/), which includes an overview of each feature.

Expand Down
11 changes: 6 additions & 5 deletions site/content/tutorials/oidc-custom-configuration.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
---
doctypes:
- concept
title: Customize OIDC Configuration with NGINX Ingress Controller
toc: true
weight: 1800
toc: true
type: how-to
product: NIC
docs: DOCS-000
---

The F5 NGINX Ingress Controller implements OpenID Connect (OIDC) using the NGINX OpenID Connect Reference implementation: [nginx-openid-connect](https://github.com/nginx/nginx-openid-connect).
The F5 NGINX Ingress Controller implements OpenID Connect (OIDC) using the NGINX OpenID Connect Reference implementation: [nginx-openid-connect](https://github.com/nginxinc/nginx-openid-connect).

This guide will walk through how to customize and configure this default implementation.

## Prerequisites

This guide assumes that you have an F5 NGINX Ingress Controller deployed. If not, please follow the installation steps using either the [Manifest](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) or [HELM](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/) approach.
This guide assumes that you have an F5 NGINX Ingress Controller deployed. If not, please follow the installation steps using either the [Manifest]({{< ref "/installation/installing-nic/installation-with-manifests.md" >}}) or [Helm]({{< ref "/installation/installing-nic/installation-with-helm.md" >}}) approach.

To customize the NGINX OpenID Connect Reference implementation, you will need to:

Expand Down

0 comments on commit b55340c

Please sign in to comment.