Fix names in documentation (#7940)
* 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
GitHub
parent
b615a6808d
commit
e9c297e74d
18 changed files with 84 additions and 84 deletions
|
|
@ -49,7 +49,7 @@ Annotations:
|
|||
Events:
|
||||
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
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ The `auth-url` and `auth-signin` annotations allow you to use an external
|
|||
authentication provider to protect your Ingress resources.
|
||||
|
||||
!!! 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
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
This example aims to demonstrate the use of an Init Container to adjust sysctl default values using `kubectl patch`
|
||||
|
||||
```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)"
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
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.
|
||||
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
|
||||
|
||||
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).
|
||||
3. Double-check your address and ports.
|
||||
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"`.
|
||||
|
||||
> 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.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ This example uses 2 different certificates to terminate SSL for 2 hostnames.
|
|||
|
||||
This should generate a segment like:
|
||||
```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 {
|
||||
listen 80;
|
||||
listen 443 ssl http2;
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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`.
|
||||
|
||||
First, create a loadbalancer Service and wait for it to acquire an IP
|
||||
|
||||
```console
|
||||
$ 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
|
||||
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
|
||||
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
|
||||
$ kubectl create -f nginx-ingress-controller.yaml
|
||||
deployment "nginx-ingress-controller" created
|
||||
$ kubectl create -f ingress-nginx-controller.yaml
|
||||
deployment "ingress-nginx-controller" created
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
```console
|
||||
$ kubectl create -f nginx-ingress.yaml
|
||||
ingress "nginx-ingress" created
|
||||
$ kubectl create -f ingress-nginx.yaml
|
||||
ingress "ingress-nginx" created
|
||||
|
||||
$ kubectl get ing ingress-nginx
|
||||
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
|
||||
CLIENT VALUES:
|
||||
|
|
@ -68,15 +68,15 @@ request_uri=http://104.154.109.191:8080/
|
|||
You can test retention by deleting the Ingress
|
||||
|
||||
```console
|
||||
$ kubectl delete ing nginx-ingress
|
||||
ingress "nginx-ingress" deleted
|
||||
$ kubectl delete ing ingress-nginx
|
||||
ingress "ingress-nginx" deleted
|
||||
|
||||
$ kubectl create -f nginx-ingress.yaml
|
||||
ingress "nginx-ingress" created
|
||||
$ kubectl create -f ingress-nginx.yaml
|
||||
ingress "ingress-nginx" created
|
||||
|
||||
$ kubectl get ing nginx-ingress
|
||||
$ kubectl get ing ingress-nginx
|
||||
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
|
||||
|
|
@ -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
|
||||
|
||||
```console
|
||||
$ kubectl patch svc nginx-ingress-lb -p '{"spec": {"loadBalancerIP": "104.154.109.191"}}'
|
||||
"nginx-ingress-lb" patched
|
||||
$ kubectl patch svc ingress-nginx-lb -p '{"spec": {"loadBalancerIP": "104.154.109.191"}}'
|
||||
"ingress-nginx-lb" patched
|
||||
```
|
||||
|
||||
and promote the IP to static (promotion works differently for cloudproviders,
|
||||
provided example is for GKE/GCE)
|
||||
`
|
||||
```console
|
||||
$ gcloud compute addresses create nginx-ingress-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].
|
||||
$ 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/ingress-nginx-lb].
|
||||
---
|
||||
address: 104.154.109.191
|
||||
creationTimestamp: '2017-01-31T16:34:50.089-08:00'
|
||||
description: ''
|
||||
id: '5208037144487826373'
|
||||
kind: compute#address
|
||||
name: nginx-ingress-lb
|
||||
name: ingress-nginx-lb
|
||||
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
|
||||
users:
|
||||
- us-central1/forwardingRules/a09f6913ae80e11e6a8c542010af0000
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: nginx-ingress-controller
|
||||
name: ingress-nginx-controller
|
||||
labels:
|
||||
app.kubernetes.io/name: ingress-nginx
|
||||
app.kubernetes.io/part-of: ingress-nginx
|
||||
|
|
@ -18,14 +18,14 @@ spec:
|
|||
app.kubernetes.io/part-of: ingress-nginx
|
||||
spec:
|
||||
# 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
|
||||
# like with kubeadm
|
||||
# hostNetwork: true
|
||||
terminationGracePeriodSeconds: 60
|
||||
containers:
|
||||
- image: quay.io/kubernetes-ingress-controller/nginx-ingress-controller:0.33.0
|
||||
name: nginx-ingress-controller
|
||||
- image: k8s.gcr.io/ingress-nginx/controller:v1.0.5
|
||||
name: controller
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /healthz
|
||||
|
|
@ -54,4 +54,4 @@ spec:
|
|||
fieldPath: metadata.namespace
|
||||
args:
|
||||
- /nginx-ingress-controller
|
||||
- --publish-service=$(POD_NAMESPACE)/nginx-ingress-lb
|
||||
- --publish-service=$(POD_NAMESPACE)/ingress-nginx-lb
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: nginx-ingress-lb
|
||||
name: ingress-nginx-lb
|
||||
labels:
|
||||
app.kubernetes.io/name: ingress-nginx
|
||||
app.kubernetes.io/part-of: ingress-nginx
|
||||
|
|
@ -18,6 +18,6 @@ spec:
|
|||
name: https
|
||||
targetPort: 443
|
||||
selector:
|
||||
# Selects nginx-ingress-controller pods
|
||||
# Selects ingress-nginx-controller pods
|
||||
app.kubernetes.io/name: ingress-nginx
|
||||
app.kubernetes.io/part-of: ingress-nginx
|
||||
|
|
|
|||
|
|
@ -65,10 +65,10 @@ Annotations:
|
|||
Events:
|
||||
FirstSeen LastSeen Count From SubObjectPath Type Reason Message
|
||||
--------- -------- ----- ---- ------------- -------- ------ -------
|
||||
7s 7s 1 {nginx-ingress-controller } Normal CREATE default/nginx-test
|
||||
7s 7s 1 {nginx-ingress-controller } Normal UPDATE default/nginx-test
|
||||
7s 7s 1 {nginx-ingress-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 } Normal CREATE default/nginx-test
|
||||
7s 7s 1 {ingress-nginx-controller } Normal UPDATE default/nginx-test
|
||||
7s 7s 1 {ingress-nginx-controller } Normal CREATE ip: 104.198.183.6
|
||||
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: (60) SSL certificate problem: self signed certificate
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue