DevFW-CICD/ingress-nginx-helm
12
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix names in documentation (#7940)

Browse source 
* Fix names in documentation

This fixes the documentation to reflect the name change from
`nginx-ingress` to `ingress-nginx`.

Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>

* Revert accidental changelog update

Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
This commit is contained in:
Reinhard Nägele 2021-11-28 22:11:22 +01:00 committed by GitHub
parent b615a6808d
commit e9c297e74d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 84 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/deploy/index.md
View file

@ -288,7 +288,7 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/cont
### Checking ingress controller version ### Checking ingress controller version
Run `nginx-ingress-controller --version` within the pod, for instance with `kubectl exec`: Run `ingress-nginx-controller --version` within the pod, for instance with `kubectl exec`:
```console ```console
POD_NAMESPACE=ingress-nginx POD_NAMESPACE=ingress-nginx

30
docs/deploy/rbac.md
View file

@ -2,7 +2,7 @@
## Overview ## Overview
This example applies to nginx-ingress-controllers being deployed in an environment with RBAC enabled. This example applies to ingress-nginx-controllers being deployed in an environment with RBAC enabled.
Role Based Access Control is comprised of four layers: Role Based Access Control is comprised of four layers:
@ -11,25 +11,25 @@ Role Based Access Control is comprised of four layers:
3. `Role` - permissions assigned to a role that apply to a specific namespace 3. `Role` - permissions assigned to a role that apply to a specific namespace
4. `RoleBinding` - binding a Role to a specific account 4. `RoleBinding` - binding a Role to a specific account
In order for RBAC to be applied to an nginx-ingress-controller, that controller In order for RBAC to be applied to an ingress-nginx-controller, that controller
should be assigned to a `ServiceAccount`. That `ServiceAccount` should be should be assigned to a `ServiceAccount`. That `ServiceAccount` should be
bound to the `Role`s and `ClusterRole`s defined for the nginx-ingress-controller. bound to the `Role`s and `ClusterRole`s defined for the ingress-nginx-controller.
## Service Accounts created in this example ## Service Accounts created in this example
One ServiceAccount is created in this example, `nginx-ingress-serviceaccount`. One ServiceAccount is created in this example, `ingress-nginx`.
## Permissions Granted in this example ## Permissions Granted in this example
There are two sets of permissions defined in this example. Cluster-wide There are two sets of permissions defined in this example. Cluster-wide
permissions defined by the `ClusterRole` named `nginx-ingress-clusterrole`, and permissions defined by the `ClusterRole` named `ingress-nginx`, and
namespace specific permissions defined by the `Role` named `nginx-ingress-role`. namespace specific permissions defined by the `Role` named `ingress-nginx`.
### Cluster Permissions ### Cluster Permissions
These permissions are granted in order for the nginx-ingress-controller to be These permissions are granted in order for the ingress-nginx-controller to be
able to function as an ingress across the cluster. These permissions are able to function as an ingress across the cluster. These permissions are
granted to the ClusterRole named `nginx-ingress-clusterrole` granted to the ClusterRole named `ingress-nginx`
* `configmaps`, `endpoints`, `nodes`, `pods`, `secrets`: list, watch * `configmaps`, `endpoints`, `nodes`, `pods`, `secrets`: list, watch
* `nodes`: get * `nodes`: get
@ -39,13 +39,13 @@ granted to the ClusterRole named `nginx-ingress-clusterrole`
### Namespace Permissions ### Namespace Permissions
These permissions are granted specific to the nginx-ingress namespace. These These permissions are granted specific to the ingress-nginx namespace. These
permissions are granted to the Role named `nginx-ingress-role` permissions are granted to the Role named `ingress-nginx`
* `configmaps`, `pods`, `secrets`: get * `configmaps`, `pods`, `secrets`: get
* `endpoints`: get * `endpoints`: get
Furthermore to support leader-election, the nginx-ingress-controller needs to Furthermore to support leader-election, the ingress-nginx-controller needs to
have access to a `configmap` using the resourceName `ingress-controller-leader-nginx` have access to a `configmap` using the resourceName `ingress-controller-leader-nginx`
> Note that resourceNames can NOT be used to limit requests using the “create” > Note that resourceNames can NOT be used to limit requests using the “create”
@ -64,13 +64,13 @@ This resourceName is the concatenation of the `election-id` and the
* `resourceName` : `<election-id>-<ingress-class>` * `resourceName` : `<election-id>-<ingress-class>`
Please adapt accordingly if you overwrite either parameter when launching the Please adapt accordingly if you overwrite either parameter when launching the
nginx-ingress-controller. ingress-nginx-controller.
### Bindings ### Bindings
The ServiceAccount `nginx-ingress-serviceaccount` is bound to the Role The ServiceAccount `ingress-nginx` is bound to the Role
`nginx-ingress-role` and the ClusterRole `nginx-ingress-clusterrole`. `ingress-nginx` and the ClusterRole `ingress-nginx`.
The serviceAccountName associated with the containers in the deployment must The serviceAccountName associated with the containers in the deployment must
match the serviceAccount. The namespace references in the Deployment metadata, match the serviceAccount. The namespace references in the Deployment metadata,
container arguments, and POD_NAMESPACE should be in the nginx-ingress namespace. container arguments, and POD_NAMESPACE should be in the ingress-nginx namespace.

14
docs/deploy/upgrade.md
View file

@ -14,7 +14,7 @@ I.e. if your deployment resource looks like (partial example):
```yaml ```yaml
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-ingress-controller name: ingress-nginx-controller
namespace: ingress-nginx namespace: ingress-nginx
spec: spec:
replicas: 1 replicas: 1
@ -23,21 +23,21 @@ spec:
metadata: ... metadata: ...
spec: spec:
containers: containers:
- name: nginx-ingress-controller - name: ingress-nginx-controller
image: k8s.gcr.io/ingress-nginx/controller:v0.34.0@sha256:56633bd00dab33d92ba14c6e709126a762d54a75a6e72437adefeaaca0abb069 image: k8s.gcr.io/ingress-nginx/controller:v1.0.4@sha256:545cff00370f28363dad31e3b59a94ba377854d3a11f18988f5f9e56841ef9ef
args: ... args: ...
``` ```
simply change the `0.34.0` tag to the version you wish to upgrade to. simply change the `v1.0.4` tag to the version you wish to upgrade to.
The easiest way to do this is e.g. (do note you may need to change the name parameter according to your installation): The easiest way to do this is e.g. (do note you may need to change the name parameter according to your installation):
``` ```
kubectl set image deployment/nginx-ingress-controller \ kubectl set image deployment/ingress-nginx-controller \
nginx-ingress-controller=k8s.gcr.io/ingress-nginx/controller:v0.34.1@sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20 \ controller=k8s.gcr.io/ingress-nginx/controller:v1.0.5@sha256:55a1fcda5b7657c372515fe402c3e39ad93aa59f6e4378e82acd99912fe6028d \
-n ingress-nginx -n ingress-nginx
``` ```
For interactive editing, use `kubectl edit deployment nginx-ingress-controller -n ingress-nginx`. For interactive editing, use `kubectl edit deployment ingress-nginx-controller -n ingress-nginx`.
## With Helm ## With Helm

2
docs/examples/affinity/cookie/README.md
View file

@ -49,7 +49,7 @@ Annotations:
Events: Events:
FirstSeen LastSeen Count From SubObjectPath Type Reason Message FirstSeen LastSeen Count From SubObjectPath Type Reason Message
--------- -------- ----- ---- ------------- -------- ------ ------- --------- -------- ----- ---- ------------- -------- ------ -------
7s 7s 1 {nginx-ingress-controller } Normal CREATE default/nginx-test 7s 7s 1 {ingress-nginx-controller } Normal CREATE default/nginx-test
$ curl -I http://stickyingress.example.com $ curl -I http://stickyingress.example.com

2
docs/examples/auth/oauth-external-auth/README.md
View file

@ -6,7 +6,7 @@ The `auth-url` and `auth-signin` annotations allow you to use an external
authentication provider to protect your Ingress resources. authentication provider to protect your Ingress resources.
!!! Important !!! Important
This annotation requires `nginx-ingress-controller v0.9.0` or greater.) This annotation requires `ingress-nginx-controller v0.9.0` or greater.)
### Key Detail ### Key Detail

2
docs/examples/customization/sysctl/README.md
View file

@ -3,7 +3,7 @@
This example aims to demonstrate the use of an Init Container to adjust sysctl default values using `kubectl patch` This example aims to demonstrate the use of an Init Container to adjust sysctl default values using `kubectl patch`
```console ```console
kubectl patch deployment -n ingress-nginx nginx-ingress-controller \ kubectl patch deployment -n ingress-nginx ingress-nginx-controller \
--patch="$(curl https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/customization/sysctl/patch.json)" --patch="$(curl https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/customization/sysctl/patch.json)"
``` ```

6
docs/examples/grpc/README.md
View file

@ -6,7 +6,7 @@ This example demonstrates how to route traffic to a gRPC service through the ngi
1. You have a kubernetes cluster running. 1. You have a kubernetes cluster running.
2. You have a domain name such as `example.com` that is configured to route traffic to the ingress controller. 2. You have a domain name such as `example.com` that is configured to route traffic to the ingress controller.
3. You have the nginx-ingress controller installed as per docs. 3. You have the ingress-nginx-controller installed as per docs.
4. You have a backend application running a gRPC server and listening for TCP traffic. If you want, you can use <https://github.com/grpc/grpc-go/blob/91e0aeb192456225adf27966d04ada4cf8599915/examples/features/reflection/server/main.go> as an example. 4. You have a backend application running a gRPC server and listening for TCP traffic. If you want, you can use <https://github.com/grpc/grpc-go/blob/91e0aeb192456225adf27966d04ada4cf8599915/examples/features/reflection/server/main.go> as an example.
5. You're also responsible for provisioning an SSL certificate for the ingress. So you need to have a valid SSL certificate, deployed as a Kubernetes secret of type tls, in the same namespace as the gRPC application. 5. You're also responsible for provisioning an SSL certificate for the ingress. So you need to have a valid SSL certificate, deployed as a Kubernetes secret of type tls, in the same namespace as the gRPC application.
@ -151,7 +151,7 @@ This example demonstrates how to route traffic to a gRPC service through the ngi
### Debugging Hints ### Debugging Hints
1. Obviously, watch the logs on your app. 1. Obviously, watch the logs on your app.
2. Watch the logs for the nginx-ingress-controller (increasing verbosity as 2. Watch the logs for the ingress-nginx-controller (increasing verbosity as
needed). needed).
3. Double-check your address and ports. 3. Double-check your address and ports.
4. Set the `GODEBUG=http2debug=2` environment variable to get detailed http/2 4. Set the `GODEBUG=http2debug=2` environment variable to get detailed http/2
@ -173,4 +173,4 @@ This example demonstrates how to route traffic to a gRPC service through the ngi
Values for the timeouts must be specified as e.g. `"1200s"`. Values for the timeouts must be specified as e.g. `"1200s"`.
> On the most recent versions of nginx-ingress, changing these timeouts requires using the `nginx.ingress.kubernetes.io/server-snippet` annotation. There are plans for future releases to allow using the Kubernetes annotations to define each timeout separately. > On the most recent versions of ingress-nginx, changing these timeouts requires using the `nginx.ingress.kubernetes.io/server-snippet` annotation. There are plans for future releases to allow using the Kubernetes annotations to define each timeout separately.

2
docs/examples/multi-tls/README.md
View file

@ -8,7 +8,7 @@ This example uses 2 different certificates to terminate SSL for 2 hostnames.
This should generate a segment like: This should generate a segment like:
```console ```console
$ kubectl exec -it nginx-ingress-controller-6vwd1 -- cat /etc/nginx/nginx.conf | grep "foo.bar.com" -B 7 -A 35 $ kubectl exec -it ingress-nginx-controller-6vwd1 -- cat /etc/nginx/nginx.conf | grep "foo.bar.com" -B 7 -A 35
server { server {
listen 80; listen 80;
listen 443 ssl http2; listen 443 ssl http2;

44
docs/examples/static-ip/README.md
View file

@ -16,27 +16,27 @@ by default nginx Ingresses will only get static IPs if your cloudprovider
supports static IP assignments to nodes. On GKE/GCE for example, even though supports static IP assignments to nodes. On GKE/GCE for example, even though
nodes get static IPs, the IPs are not retained across upgrade. nodes get static IPs, the IPs are not retained across upgrade.
To acquire a static IP for the nginx ingress controller, simply put it To acquire a static IP for the ingress-nginx-controller, simply put it
behind a Service of `Type=LoadBalancer`. behind a Service of `Type=LoadBalancer`.
First, create a loadbalancer Service and wait for it to acquire an IP First, create a loadbalancer Service and wait for it to acquire an IP
```console ```console
$ kubectl create -f static-ip-svc.yaml $ kubectl create -f static-ip-svc.yaml
service "nginx-ingress-lb" created service "ingress-nginx-lb" created
$ kubectl get svc nginx-ingress-lb $ kubectl get svc ingress-nginx-lb
NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
nginx-ingress-lb 10.0.138.113 104.154.109.191 80:31457/TCP,443:32240/TCP 15m ingress-nginx-lb 10.0.138.113 104.154.109.191 80:31457/TCP,443:32240/TCP 15m
``` ```
then, update the ingress controller so it adopts the static IP of the Service then, update the ingress controller so it adopts the static IP of the Service
by passing the `--publish-service` flag (the example yaml used in the next step by passing the `--publish-service` flag (the example yaml used in the next step
already has it set to "nginx-ingress-lb"). already has it set to "ingress-nginx-lb").
```console ```console
$ kubectl create -f nginx-ingress-controller.yaml $ kubectl create -f ingress-nginx-controller.yaml
deployment "nginx-ingress-controller" created deployment "ingress-nginx-controller" created
``` ```
## Assigning the IP to an Ingress ## Assigning the IP to an Ingress
@ -45,12 +45,12 @@ From here on every Ingress created with the `ingress.class` annotation set to
`nginx` will get the IP allocated in the previous step `nginx` will get the IP allocated in the previous step
```console ```console
$ kubectl create -f nginx-ingress.yaml $ kubectl create -f ingress-nginx.yaml
ingress "nginx-ingress" created ingress "ingress-nginx" created
$ kubectl get ing ingress-nginx $ kubectl get ing ingress-nginx
NAME HOSTS ADDRESS PORTS AGE NAME HOSTS ADDRESS PORTS AGE
nginx-ingress * 104.154.109.191 80, 443 13m ingress-nginx * 104.154.109.191 80, 443 13m
$ curl 104.154.109.191 -kL $ curl 104.154.109.191 -kL
CLIENT VALUES: CLIENT VALUES:
@ -68,15 +68,15 @@ request_uri=http://104.154.109.191:8080/
You can test retention by deleting the Ingress You can test retention by deleting the Ingress
```console ```console
$ kubectl delete ing nginx-ingress $ kubectl delete ing ingress-nginx
ingress "nginx-ingress" deleted ingress "ingress-nginx" deleted
$ kubectl create -f nginx-ingress.yaml $ kubectl create -f ingress-nginx.yaml
ingress "nginx-ingress" created ingress "ingress-nginx" created
$ kubectl get ing nginx-ingress $ kubectl get ing ingress-nginx
NAME HOSTS ADDRESS PORTS AGE NAME HOSTS ADDRESS PORTS AGE
nginx-ingress * 104.154.109.191 80, 443 13m ingress-nginx * 104.154.109.191 80, 443 13m
``` ```
> Note that unlike the GCE Ingress, the same loadbalancer IP is shared amongst all > Note that unlike the GCE Ingress, the same loadbalancer IP is shared amongst all
@ -88,25 +88,25 @@ nginx-ingress * 104.154.109.191 80, 443 13m
To promote the allocated IP to static, you can update the Service manifest To promote the allocated IP to static, you can update the Service manifest
```console ```console
$ kubectl patch svc nginx-ingress-lb -p '{"spec": {"loadBalancerIP": "104.154.109.191"}}' $ kubectl patch svc ingress-nginx-lb -p '{"spec": {"loadBalancerIP": "104.154.109.191"}}'
"nginx-ingress-lb" patched "ingress-nginx-lb" patched
``` ```
and promote the IP to static (promotion works differently for cloudproviders, and promote the IP to static (promotion works differently for cloudproviders,
provided example is for GKE/GCE) provided example is for GKE/GCE)
` `
```console ```console
$ gcloud compute addresses create nginx-ingress-lb --addresses 104.154.109.191 --region us-central1 $ gcloud compute addresses create ingress-nginx-lb --addresses 104.154.109.191 --region us-central1
Created [https://www.googleapis.com/compute/v1/projects/kubernetesdev/regions/us-central1/addresses/nginx-ingress-lb]. Created [https://www.googleapis.com/compute/v1/projects/kubernetesdev/regions/us-central1/addresses/ingress-nginx-lb].
--- ---
address: 104.154.109.191 address: 104.154.109.191
creationTimestamp: '2017-01-31T16:34:50.089-08:00' creationTimestamp: '2017-01-31T16:34:50.089-08:00'
description: '' description: ''
id: '5208037144487826373' id: '5208037144487826373'
kind: compute#address kind: compute#address
name: nginx-ingress-lb name: ingress-nginx-lb
region: us-central1 region: us-central1
selfLink: https://www.googleapis.com/compute/v1/projects/kubernetesdev/regions/us-central1/addresses/nginx-ingress-lb selfLink: https://www.googleapis.com/compute/v1/projects/kubernetesdev/regions/us-central1/addresses/ingress-nginx-lb
status: IN_USE status: IN_USE
users: users:
- us-central1/forwardingRules/a09f6913ae80e11e6a8c542010af0000 - us-central1/forwardingRules/a09f6913ae80e11e6a8c542010af0000

10
docs/examples/static-ip/nginx-ingress-controller.yaml
View file

@ -1,7 +1,7 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-ingress-controller name: ingress-nginx-controller
labels: labels:
app.kubernetes.io/name: ingress-nginx app.kubernetes.io/name: ingress-nginx
app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/part-of: ingress-nginx
@ -18,14 +18,14 @@ spec:
app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/part-of: ingress-nginx
spec: spec:
# hostNetwork makes it possible to use ipv6 and to preserve the source IP correctly regardless of docker configuration # hostNetwork makes it possible to use ipv6 and to preserve the source IP correctly regardless of docker configuration
# however, it is not a hard dependency of the nginx-ingress-controller itself and it may cause issues if port 10254 already is taken on the host # however, it is not a hard dependency of the ingress-nginx-controller itself and it may cause issues if port 10254 already is taken on the host
# that said, since hostPort is broken on CNI (https://github.com/kubernetes/kubernetes/issues/31307) we have to use hostNetwork where CNI is used # that said, since hostPort is broken on CNI (https://github.com/kubernetes/kubernetes/issues/31307) we have to use hostNetwork where CNI is used
# like with kubeadm # like with kubeadm
# hostNetwork: true # hostNetwork: true
terminationGracePeriodSeconds: 60 terminationGracePeriodSeconds: 60
containers: containers:
- image: quay.io/kubernetes-ingress-controller/nginx-ingress-controller:0.33.0 - image: k8s.gcr.io/ingress-nginx/controller:v1.0.5
name: nginx-ingress-controller name: controller
readinessProbe: readinessProbe:
httpGet: httpGet:
path: /healthz path: /healthz
@ -54,4 +54,4 @@ spec:
fieldPath: metadata.namespace fieldPath: metadata.namespace
args: args:
- /nginx-ingress-controller - /nginx-ingress-controller
- --publish-service=$(POD_NAMESPACE)/nginx-ingress-lb - --publish-service=$(POD_NAMESPACE)/ingress-nginx-lb

4
docs/examples/static-ip/static-ip-svc.yaml
View file

@ -2,7 +2,7 @@
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-ingress-lb name: ingress-nginx-lb
labels: labels:
app.kubernetes.io/name: ingress-nginx app.kubernetes.io/name: ingress-nginx
app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/part-of: ingress-nginx
@ -18,6 +18,6 @@ spec:
name: https name: https
targetPort: 443 targetPort: 443
selector: selector:
# Selects nginx-ingress-controller pods # Selects ingress-nginx-controller pods
app.kubernetes.io/name: ingress-nginx app.kubernetes.io/name: ingress-nginx
app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/part-of: ingress-nginx

8
docs/examples/tls-termination/README.md
View file

@ -65,10 +65,10 @@ Annotations:
Events: Events:
FirstSeen LastSeen Count From SubObjectPath Type Reason Message FirstSeen LastSeen Count From SubObjectPath Type Reason Message
--------- -------- ----- ---- ------------- -------- ------ ------- --------- -------- ----- ---- ------------- -------- ------ -------
7s 7s 1 {nginx-ingress-controller } Normal CREATE default/nginx-test 7s 7s 1 {ingress-nginx-controller } Normal CREATE default/nginx-test
7s 7s 1 {nginx-ingress-controller } Normal UPDATE default/nginx-test 7s 7s 1 {ingress-nginx-controller } Normal UPDATE default/nginx-test
7s 7s 1 {nginx-ingress-controller } Normal CREATE ip: 104.198.183.6 7s 7s 1 {ingress-nginx-controller } Normal CREATE ip: 104.198.183.6
7s 7s 1 {nginx-ingress-controller } Warning MAPPING Ingress rule 'default/nginx-test' contains no path definition. Assuming / 7s 7s 1 {ingress-nginx-controller } Warning MAPPING Ingress rule 'default/nginx-test' contains no path definition. Assuming /
$ curl 104.198.183.6 -L $ curl 104.198.183.6 -L
curl: (60) SSL certificate problem: self signed certificate curl: (60) SSL certificate problem: self signed certificate

8
docs/kubectl-plugin.md
View file

@ -68,7 +68,7 @@ Use "ingress-nginx [command] --help" for more information about a command.
## Common Flags ## Common Flags
- Every subcommand supports the basic `kubectl` configuration flags like `--namespace`, `--context`, `--client-key` and so on. - Every subcommand supports the basic `kubectl` configuration flags like `--namespace`, `--context`, `--client-key` and so on.
- Subcommands that act on a particular `ingress-nginx` pod (`backends`, `certs`, `conf`, `exec`, `general`, `logs`, `ssh`), support the `--deployment <deployment>` and `--pod <pod>` flags to select either a pod from a deployment with the given name, or a pod with the given name. The `--deployment` flag defaults to `nginx-ingress-controller`. - Subcommands that act on a particular `ingress-nginx` pod (`backends`, `certs`, `conf`, `exec`, `general`, `logs`, `ssh`), support the `--deployment <deployment>` and `--pod <pod>` flags to select either a pod from a deployment with the given name, or a pod with the given name. The `--deployment` flag defaults to `ingress-nginx-controller`.
- Subcommands that inspect resources (`ingresses`, `lint`) support the `--all-namespaces` flag, which causes them to inspect resources in every namespace. - Subcommands that inspect resources (`ingresses`, `lint`) support the `--all-namespaces` flag, which causes them to inspect resources in every namespace.
## Subcommands ## Subcommands
@ -263,7 +263,7 @@ Checking ingresses...
https://github.com/kubernetes/ingress-nginx/issues/3174 https://github.com/kubernetes/ingress-nginx/issues/3174
Checking deployments... Checking deployments...
✗ namespace2/nginx-ingress-controller ✗ namespace2/ingress-nginx-controller
- Uses removed config flag --sort-backends - Uses removed config flag --sort-backends
Lint added for version 0.22.0 Lint added for version 0.22.0
https://github.com/kubernetes/ingress-nginx/issues/3655 https://github.com/kubernetes/ingress-nginx/issues/3655
@ -283,7 +283,7 @@ Checking ingresses...
https://github.com/kubernetes/ingress-nginx/issues/3743 https://github.com/kubernetes/ingress-nginx/issues/3743
Checking deployments... Checking deployments...
✗ namespace2/nginx-ingress-controller ✗ namespace2/ingress-nginx-controller
- Uses removed config flag --enable-dynamic-certificates - Uses removed config flag --enable-dynamic-certificates
Lint added for version 0.24.0 Lint added for version 0.24.0
https://github.com/kubernetes/ingress-nginx/issues/3808 https://github.com/kubernetes/ingress-nginx/issues/3808
@ -318,5 +318,5 @@ I0405 16:53:46.193913 7 event.go:209] Event(v1.ObjectReference{Kind:"Confi
```console ```console
$ kubectl ingress-nginx ssh -n ingress-nginx $ kubectl ingress-nginx ssh -n ingress-nginx
www-data@nginx-ingress-controller-7cbf77c976-wx5pn:/etc/nginx$ www-data@ingress-nginx-controller-7cbf77c976-wx5pn:/etc/nginx$
``` ```

22
docs/troubleshooting.md
View file

@ -37,8 +37,8 @@ Annotations:
Events: Events:
Type Reason Age From Message Type Reason Age From Message
---- ------ ---- ---- ------- ---- ------ ---- ---- -------
Normal CREATE 1m nginx-ingress-controller Ingress default/cafe-ingress Normal CREATE 1m ingress-nginx-controller Ingress default/cafe-ingress
Normal UPDATE 58s nginx-ingress-controller Ingress default/cafe-ingress Normal UPDATE 58s ingress-nginx-controller Ingress default/cafe-ingress
``` ```
Check the Ingress Controller Logs Check the Ingress Controller Logs
@ -46,9 +46,9 @@ Check the Ingress Controller Logs
```console ```console
$ kubectl get pods -n <namespace-of-ingress-controller> $ kubectl get pods -n <namespace-of-ingress-controller>
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
nginx-ingress-controller-67956bf89d-fv58j 1/1 Running 0 1m ingress-nginx-controller-67956bf89d-fv58j 1/1 Running 0 1m
$ kubectl logs -n <namespace> nginx-ingress-controller-67956bf89d-fv58j $ kubectl logs -n <namespace> ingress-nginx-controller-67956bf89d-fv58j
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
NGINX Ingress controller NGINX Ingress controller
Release: 0.14.0 Release: 0.14.0
@ -63,9 +63,9 @@ Check the Nginx Configuration
```console ```console
$ kubectl get pods -n <namespace-of-ingress-controller> $ kubectl get pods -n <namespace-of-ingress-controller>
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
nginx-ingress-controller-67956bf89d-fv58j 1/1 Running 0 1m ingress-nginx-controller-67956bf89d-fv58j 1/1 Running 0 1m
$ kubectl exec -it -n <namespace-of-ingress-controller> nginx-ingress-controller-67956bf89d-fv58j -- cat /etc/nginx/nginx.conf $ kubectl exec -it -n <namespace-of-ingress-controller> ingress-nginx-controller-67956bf89d-fv58j -- cat /etc/nginx/nginx.conf
daemon off; daemon off;
worker_processes 2; worker_processes 2;
pid /run/nginx.pid; pid /run/nginx.pid;
@ -102,9 +102,9 @@ the deployment.
$ kubectl get deploy -n <namespace-of-ingress-controller> $ kubectl get deploy -n <namespace-of-ingress-controller>
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
default-http-backend 1 1 1 1 35m default-http-backend 1 1 1 1 35m
nginx-ingress-controller 1 1 1 1 35m ingress-nginx-controller 1 1 1 1 35m
$ kubectl edit deploy -n <namespace-of-ingress-controller> nginx-ingress-controller $ kubectl edit deploy -n <namespace-of-ingress-controller> ingress-nginx-controller
# Add --v=X to "- args", where X is an integer # Add --v=X to "- args", where X is an integer
``` ```
@ -254,9 +254,9 @@ $ ssh user@workerIP
2. Obtain the Docker Container Running nginx 2. Obtain the Docker Container Running nginx
```console ```console
$ docker ps | grep nginx-ingress-controller $ docker ps | grep ingress-nginx-controller
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d9e1d243156a quay.io/kubernetes-ingress-controller/nginx-ingress-controller "/usr/bin/dumb-init …" 19 minutes ago Up 19 minutes k8s_nginx-ingress-controller_nginx-ingress-controller-67956bf89d-mqxzt_kube-system_079f31ec-aa37-11e8-ad39-080027a227db_0 d9e1d243156a k8s.gcr.io/ingress-nginx/controller "/usr/bin/dumb-init …" 19 minutes ago Up 19 minutes k8s_ingress-nginx-controller_ingress-nginx-controller-67956bf89d-mqxzt_kube-system_079f31ec-aa37-11e8-ad39-080027a227db_0
``` ```
3. Exec into the container 3. Exec into the container
@ -277,7 +277,7 @@ $ nginx -V 2>&1 | grep -- '--with-debug'
$ ps -ef $ ps -ef
UID PID PPID C STIME TTY TIME CMD UID PID PPID C STIME TTY TIME CMD
root 1 0 0 20:23 ? 00:00:00 /usr/bin/dumb-init /nginx-ingres root 1 0 0 20:23 ? 00:00:00 /usr/bin/dumb-init /nginx-ingres
root 5 1 0 20:23 ? 00:00:05 /nginx-ingress-controller --defa root 5 1 0 20:23 ? 00:00:05 /ingress-nginx-controller --defa
root 21 5 0 20:23 ? 00:00:00 nginx: master process /usr/sbin/ root 21 5 0 20:23 ? 00:00:00 nginx: master process /usr/sbin/
nobody 106 21 0 20:23 ? 00:00:00 nginx: worker process nobody 106 21 0 20:23 ? 00:00:00 nginx: worker process
nobody 107 21 0 20:23 ? 00:00:00 nginx: worker process nobody 107 21 0 20:23 ? 00:00:00 nginx: worker process

2
docs/user-guide/cli-arguments.md
View file

@ -2,7 +2,7 @@
The following command line arguments are accepted by the Ingress controller executable. The following command line arguments are accepted by the Ingress controller executable.
They are set in the container spec of the `nginx-ingress-controller` Deployment manifest They are set in the container spec of the `ingress-nginx-controller` Deployment manifest
| Argument | Description | | Argument | Description |
|----------|-------------| |----------|-------------|

2
docs/user-guide/convert_arguments_to_doc.py
View file

@ -15,7 +15,7 @@
# limitations under the License. # limitations under the License.
""" """
Convert the output of `nginx-ingress-controller --help` to Convert the output of `ingress-nginx-controller --help` to
a Markdown table. a Markdown table.
""" """

4
docs/user-guide/multiple-ingress.md
View file

@ -16,7 +16,7 @@ spec:
template: template:
spec: spec:
containers: containers:
- name: nginx-ingress-internal-controller - name: ingress-nginx-internal-controller
args: args:
- /nginx-ingress-controller - /nginx-ingress-controller
- '--controller-class=k8s.io/internal-ingress-nginx' - '--controller-class=k8s.io/internal-ingress-nginx'
@ -98,7 +98,7 @@ spec:
template: template:
spec: spec:
containers: containers:
- name: nginx-ingress-internal-controller - name: ingress-nginx-internal-controller
args: args:
- /nginx-ingress-controller - /nginx-ingress-controller
- --ingress-class=internal-nginx - --ingress-class=internal-nginx

4
docs/user-guide/tls.md
View file

@ -123,7 +123,7 @@ spec:
To provide the most secure baseline configuration possible, To provide the most secure baseline configuration possible,
nginx-ingress defaults to using TLS 1.2 and 1.3 only, with a [secure set of TLS ciphers][ssl-ciphers]. ingress-nginx defaults to using TLS 1.2 and 1.3 only, with a [secure set of TLS ciphers][ssl-ciphers].
### Legacy TLS ### Legacy TLS
@ -131,7 +131,7 @@ The default configuration, though secure, does not support some older browsers a
For instance, TLS 1.1+ is only enabled by default from Android 5.0 on. At the time of writing, For instance, TLS 1.1+ is only enabled by default from Android 5.0 on. At the time of writing,
May 2018, [approximately 15% of Android devices](https://developer.android.com/about/dashboards/#Platform) May 2018, [approximately 15% of Android devices](https://developer.android.com/about/dashboards/#Platform)
are not compatible with nginx-ingress's default configuration. are not compatible with ingress-nginx's default configuration.
To change this default behavior, use a [ConfigMap][ConfigMap]. To change this default behavior, use a [ConfigMap][ConfigMap].