Skip to content

Commit

Permalink
Remove the before NGINX Ingress Controller in some cases (#5274)
Browse files Browse the repository at this point in the history
Remove the before NGINX Ingress Controller in some cases (Where there is not a noun after mostly)
  • Loading branch information
j1m-ryan authored Mar 20, 2024
1 parent c126c7e commit 0aeb4a7
Show file tree
Hide file tree
Showing 28 changed files with 51 additions and 51 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,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
the NGINX Ingress Controller.
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
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing Guidelines

The following is a set of guidelines for contributing to the NGINX Ingress Controller. We really appreciate that you are
The following is a set of guidelines for contributing to NGINX Ingress Controller. We really appreciate that you are
considering contributing!

## Table Of Contents
Expand Down Expand Up @@ -29,7 +29,7 @@ Please reserve GitHub issues for feature requests and bugs rather than general q
## Getting Started

Follow our [Installation Guide](https://github.com/nginxinc/kubernetes-ingress/blob/main/docs/content/installation) to
get the NGINX Ingress Controller up and running.
get NGINX Ingress Controller up and running.

Read the [documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs) and
[configuration](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples) examples
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ In the case of NGINX, the Ingress Controller is deployed in a pod along with the
> All documentation should only be used with the latest stable release, indicated on [the releases
> page](https://github.com/nginxinc/kubernetes-ingress/releases) of the GitHub repository.
1. Install the NGINX Ingress Controller using the [Helm
1. Install NGINX Ingress Controller using the [Helm
chart](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) or the Kubernetes
[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-manifests/).
1. Configure load balancing for a simple web application:
Expand All @@ -126,7 +126,7 @@ The edge version is useful for experimenting with new features that are not yet
it, choose the *edge* version built from the [latest
commit](https://github.com/nginxinc/kubernetes-ingress/commits/main) from the main branch.

To use the NGINX Ingress Controller, you need to have access to:
To use NGINX Ingress Controller, you need to have access to:

- An NGINX Ingress Controller image.
- Installation manifests or a Helm chart.
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Supported Versions

We advise users to run the most recent release of the NGINX Ingress Controller, and we issue software updates to the
We advise users to run the most recent release of NGINX Ingress Controller, and we issue software updates to the
most recent release. We provide technical support for F5 customers who are using the most recent version of the NGINX
Ingress Controller, and any version released within two years of the current release.

Expand Down
2 changes: 1 addition & 1 deletion build/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ LABEL name="NGINX Ingress Controller" \
release="1" \
summary="The Ingress Controller is an application that runs in a cluster and configures an HTTP load balancer according to Ingress resources." \
description="The Ingress Controller is an application that runs in a cluster and configures an HTTP load balancer according to Ingress resources." \
io.k8s.description="The NGINX Ingress Controller is an application that runs in a cluster and configures an HTTP load balancer according to Ingress resources." \
io.k8s.description="NGINX Ingress Controller is an application that runs in a cluster and configures an HTTP load balancer according to Ingress resources." \
io.openshift.tags="nginx,ingress-controller,ingress,controller,kubernetes,openshift"

COPY --link --chown=101:0 LICENSE /licenses/
Expand Down
2 changes: 1 addition & 1 deletion charts/nginx-ingress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

This chart deploys the NGINX Ingress Controller in your Kubernetes cluster.
This chart deploys NGINX Ingress Controller in your Kubernetes cluster.

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Starting from Kubernetes 1.18, you can use the following new features:

## Restrictions

The NGINX Ingress Controller imposes the following restrictions on Ingress resources:
NGINX Ingress Controller imposes the following restrictions on Ingress resources:

- When defining an Ingress resource, the `host` field is required.
- 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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ The _Makefile_ includes several key variables. You have the option to either mod
|-----------------------------------------|---------------|
| _ARCH_ | Defines the architecture for the image and binary. The default is `amd64`, but you can also choose from `arm64`, `arm`, `ppc64le`, and `s390x`. |
| _PREFIX_ | Gives the image its name. The default is `nginx/nginx-ingress`. |
| _TAG_ | Adds a tag to the image. This is often the version of the NGINX Ingress Controller. |
| _TAG_ | Adds a tag to the image. This is often the version of NGINX Ingress Controller. |
| _DOCKER\_BUILD\_OPTIONS_ | Allows for additional [options](https://docs.docker.com/engine/reference/commandline/build/#options) during the `docker build` process, like `--pull`. |
| _TARGET_ | <p>Determines the build environment. NGINX Ingress Controller compiles locally in a Golang environment by default. Ensure the NGINX Ingress Controller repo resides in your `$GOPATH` if you select this option.</p><p>Alternatively, you can set `TARGET=container` to build using a Docker [Golang](https://hub.docker.com/_/golang/) container. To skip compiling the binary if you're on a specific tag or the latest `main` branch commit, set `TARGET=download`.</p> |
{{</bootstrap-table>}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ h2 {
- Alternatively, pull an NGINX Ingress Controller image with NGINX Plus and push it to your private registry by following the instructions from [here]({{< relref "installation/nic-images/pulling-ingress-controller-image" >}}).
- Alternatively, you can NGINX build an Ingress Controller image with NGINX Plus and push it to your private registry by following the instructions from [here]({{< relref "installation/building-nginx-ingress-controller.md" >}}).
- Update the `controller.image.repository` field of the `values-plus.yaml` accordingly.
- To use App Protect DoS, install the App Protect DoS Arbitrator [Helm Chart](https://github.com/nginxinc/nap-dos-arbitrator-helm-chart) in the same namespace as the NGINX Ingress Controller. If you install multiple NGINX Ingress Controllers in the same namespace, they will need to share the same Arbitrator because there can only be one Arbitrator in a single namespace.
- To use App Protect DoS, install the App Protect DoS Arbitrator [Helm Chart](https://github.com/nginxinc/nap-dos-arbitrator-helm-chart) in the same namespace as NGINX Ingress Controller. If you install multiple NGINX Ingress Controllers in the same namespace, they will need to share the same Arbitrator because there can only be one Arbitrator in a single namespace.

## CRDs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,4 @@ Then add a reference in the `DosProtectedResource` to the `APDosLogConf`:

## Global Configuration

The NGINX Ingress Controller has a set of global configuration parameters that align with those available in the NGINX App Protect DoS module. See [ConfigMap keys]({{< relref "configuration/global-configuration/configmap-resource.md#modules" >}}) for the complete list. The App Protect parameters use the `app-protect-dos*` prefix.
NGINX Ingress Controller has a set of global configuration parameters that align with those available in the NGINX App Protect DoS module. See [ConfigMap keys]({{< relref "configuration/global-configuration/configmap-resource.md#modules" >}}) for the complete list. The App Protect parameters use the `app-protect-dos*` prefix.
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ spec:
name: nginx-plus-ingress
```

The `imagePullSecrets` and `containers.image` lines represent the Kubernetes secret, as well as the registry and version of the NGINX Ingress Controller we are going to deploy.
The `imagePullSecrets` and `containers.image` lines represent the Kubernetes secret, as well as the registry and version of NGINX Ingress Controller we are going to deploy.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/logging-and-monitoring/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ docs: "DOCS-613"
---


The NGINX Ingress Controller exposes the logs of the Ingress Controller process (the process that generates NGINX configuration and reloads NGINX to apply it) and NGINX access and error logs. All logs are sent to the standard output and error of the Ingress Controller process. To view the logs, you can execute the `kubectl logs` command for an Ingress Controller pod. For example:
NGINX Ingress Controller exposes the logs of the Ingress Controller process (the process that generates NGINX configuration and reloads NGINX to apply it) and NGINX access and error logs. All logs are sent to the standard output and error of the Ingress Controller process. To view the logs, you can execute the `kubectl logs` command for an Ingress Controller pod. For example:

```
kubectl logs <nginx-ingress-pod> -n nginx-ingress
Expand Down
2 changes: 1 addition & 1 deletion docs/content/logging-and-monitoring/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If you're using *Helm* to install the Ingress Controller, to enable Prometheus m
### Using ServiceMonitor

When deploying with *Helm*, you can deploy a `Service` and `ServiceMonitor` resource using the `prometheus.service.*` and `prometheus.serviceMonitor.*` parameters.
When these resources are deployed, Prometheus metrics exposed by the NGINX Ingress Controller can be captured and enumerated using a `Prometheus` resource alongside a Prometheus Operator deployment.
When these resources are deployed, Prometheus metrics exposed by NGINX Ingress Controller can be captured and enumerated using a `Prometheus` resource alongside a Prometheus Operator deployment.

To view metrics captured this way, the following is required:
* The latest ServiceMonitor CRD from the [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator) repository:
Expand Down
6 changes: 3 additions & 3 deletions docs/content/overview/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ docs: "DOCS-612"

<br>

The NGINX Ingress Controller is an [Ingress Controller]({{< relref "glossary.md#ingress-controller">}}) implementation for NGINX and NGINX Plus that can load balance Websocket, gRPC, TCP and UDP applications. It supports standard [Ingress]({{< relref "glossary.md#ingress">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< relref "configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< relref "configuration/global-configuration/configmap-resource">}}) resource.
NGINX Ingress Controller is an [Ingress Controller]({{< relref "glossary.md#ingress-controller">}}) implementation for NGINX and NGINX Plus that can load balance Websocket, gRPC, TCP and UDP applications. It supports standard [Ingress]({{< relref "glossary.md#ingress">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< relref "configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< relref "configuration/global-configuration/configmap-resource">}}) resource.

The NGINX Ingress Controller supports the [VirtualServer and VirtualServerRoute resources]({{< relref "configuration/virtualserver-and-virtualserverroute-resources">}}) as alternatives to Ingress, enabling traffic splitting and advanced content-based routing. It also supports TCP, UDP and TLS Passthrough load balancing using [TransportServer resources]({{< relref "configuration/transportserver-resource">}}).
NGINX Ingress Controller supports the [VirtualServer and VirtualServerRoute resources]({{< relref "configuration/virtualserver-and-virtualserverroute-resources">}}) as alternatives to Ingress, enabling traffic splitting and advanced content-based routing. It also supports TCP, UDP and TLS Passthrough load balancing using [TransportServer resources]({{< relref "configuration/transportserver-resource">}}).

To learn more about the NGINX Ingress Controller, please read the [How NGINX Ingress Controller is Designed
To learn more about NGINX Ingress Controller, please read the [How NGINX Ingress Controller is Designed
]({{< relref "overview/design">}}) and [Extensibility with NGINX Plus]({{< relref "overview/nginx-plus">}}) pages.
4 changes: 2 additions & 2 deletions docs/content/overview/nginx-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:

<br>

The NGINX Ingress Controller works with [NGINX](https://nginx.org/) as well as [NGINX Plus](https://www.nginx.com/products/nginx/), a commercial closed source version of NGINX which has additional features and support from NGINX Inc. The NGINX Ingress Controller can leverage functionality from NGINX Plus to extend its base capabilities.
NGINX Ingress Controller works with [NGINX](https://nginx.org/) as well as [NGINX Plus](https://www.nginx.com/products/nginx/), a commercial closed source version of NGINX which has additional features and support from NGINX Inc. NGINX Ingress Controller can leverage functionality from NGINX Plus to extend its base capabilities.

## Additional features

Expand All @@ -28,6 +28,6 @@ For a comprehensive guide of NGINX Plus features available with custom resources

## Dynamic reconfiguration

The NGINX Ingress Controller updates the configuration of the load balancer to reflect changes every time the number of pods exposed through an Ingress resource changes. When using NGINX, the configuration file must be changed then reloaded.
NGINX Ingress Controller updates the configuration of the load balancer to reflect changes every time the number of pods exposed through an Ingress resource changes. When using NGINX, the configuration file must be changed then reloaded.

For NGINX Plus, its dynamic reconfiguration is utilized, updating NGINX Plus without reloading. This avoids the increase of memory usage caused by reloads (Particularly with large volumes of client requests) and when load balancing applications with long-lived connections (Such as those using WebSockets or handling file uploads, downloads or streaming).
2 changes: 1 addition & 1 deletion docs/content/overview/product-telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ These are the data points collected and reported by NGINX Ingress Controller:
- **Project Name** The name of the software, which will be labelled `NIC`.
- **Project Version** NGINX Ingress Controller version.
- **Project Architecture** The architecture of the kubernetes environment. (e.g. amd64, arm64, etc...)
- **Cluster ID** A unique identifier of the kubernetes cluster that the NGINX Ingress Controller is deployed to.
- **Cluster ID** A unique identifier of the kubernetes cluster that NGINX Ingress Controller is deployed to.
- **Cluster Version** The version of the Kubernetes cluster.
- **Cluster Platform** The platform that the kubernetes cluster is operating on. (e.g. eks, aks, etc...)
- **Cluster Node Count** The number of nodes in the cluster that NGINX Ingress Controller is deployed to.
Expand Down
Loading

0 comments on commit 0aeb4a7

Please sign in to comment.