From 5a16a7aaa0abd57993d0abbff1d48d1317bac43c Mon Sep 17 00:00:00 2001 From: Manuel Alejandro de Brito Fontes Date: Thu, 18 Jan 2018 13:30:29 -0200 Subject: [PATCH] Fix doc links (#1925) * Fix documentation links * Replace external-traffic annotation * Update awesome_bot docker image --- Makefile | 2 +- README.md | 2 +- docs/examples/rewrite/README.md | 4 ++-- docs/examples/static-ip/README.md | 4 ++-- docs/examples/static-ip/static-ip-svc.yaml | 3 +-- docs/troubleshooting.md | 2 +- docs/user-guide/configmap.md | 2 +- docs/user-guide/custom-errors.md | 2 +- internal/ingress/controller/config/config.go | 2 +- 9 files changed, 11 insertions(+), 12 deletions(-) diff --git a/Makefile b/Makefile index a3c969200b..e2970757d3 100644 --- a/Makefile +++ b/Makefile @@ -186,4 +186,4 @@ docker-push: all-push .PHONY: check_dead_links check_dead_links: - docker run -t -v $$PWD:/tmp rubygem/awesome_bot --allow-dupe --allow-redirect $(shell find $$PWD -name "*.md" -mindepth 1 -printf '%P\n' | grep -v vendor | grep -v Changelog.md) + docker run -t -v $$PWD:/tmp aledbf/awesome_bot:0.1 --allow-dupe --allow-redirect $(shell find $$PWD -mindepth 1 -name "*.md" -printf '%P\n' | grep -v vendor | grep -v Changelog.md) diff --git a/README.md b/README.md index df651f63ea..9c27d9890d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The GCE ingress controller was moved to [github.com/kubernetes/ingress-gce](http ## Description -This repository contains the NGINX controller built around the [Kubernetes Ingress resource](http://kubernetes.io/docs/user-guide/ingress/) that uses [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configmap/#understanding-configmaps) to store the NGINX configuration. +This repository contains the NGINX controller built around the [Kubernetes Ingress resource](http://kubernetes.io/docs/user-guide/ingress/) that uses [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#understanding-configmaps-and-pods) to store the NGINX configuration. Learn more about using Ingress on [k8s.io](http://kubernetes.io/docs/user-guide/ingress/) diff --git a/docs/examples/rewrite/README.md b/docs/examples/rewrite/README.md index a1812533ab..0e2acf1cfe 100644 --- a/docs/examples/rewrite/README.md +++ b/docs/examples/rewrite/README.md @@ -5,8 +5,8 @@ This example demonstrates how to use the Rewrite annotations ## Prerequisites You will need to make sure you Ingress targets exactly one Ingress -controller by specifying the [ingress.class annotation](/examples/PREREQUISITES.md#ingress-class), -and that you have an ingress controller [running](/examples/deployment) in your cluster. +controller by specifying the [ingress.class annotation](/README.md#annotation-ingressclass), +and that you have an ingress controller [running](/deploy/README.md) in your cluster. ## Deployment diff --git a/docs/examples/static-ip/README.md b/docs/examples/static-ip/README.md index 10d660e662..1213b82f67 100644 --- a/docs/examples/static-ip/README.md +++ b/docs/examples/static-ip/README.md @@ -6,8 +6,8 @@ This example demonstrates how to assign a static-ip to an Ingress on through the You need a [TLS cert](/examples/PREREQUISITES.md#tls-certificates) and a [test HTTP service](/examples/PREREQUISITES.md#test-http-service) for this example. You will also need to make sure your Ingress targets exactly one Ingress -controller by specifying the [ingress.class annotation](/examples/PREREQUISITES.md#ingress-class), -and that you have an ingress controller [running](/examples/deployment) in your cluster. +controller by specifying the [ingress.class annotation](/README.md#annotation-ingressclass), +and that you have an ingress controller [running](/deploy/README.md) in your cluster. ## Acquiring an IP diff --git a/docs/examples/static-ip/static-ip-svc.yaml b/docs/examples/static-ip/static-ip-svc.yaml index 57d02d1aca..27de0690de 100644 --- a/docs/examples/static-ip/static-ip-svc.yaml +++ b/docs/examples/static-ip/static-ip-svc.yaml @@ -3,11 +3,10 @@ apiVersion: v1 kind: Service metadata: name: nginx-ingress-lb - annotations: - service.beta.kubernetes.io/external-traffic: OnlyLocal labels: app: nginx-ingress-lb spec: + externalTrafficPolicy: Local type: LoadBalancer loadBalancerIP: 104.154.109.191 ports: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 1b40a7621f..4869cb1c1f 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,7 +1,7 @@ diff --git a/docs/user-guide/configmap.md b/docs/user-guide/configmap.md index 5ce07c26c5..9113570966 100644 --- a/docs/user-guide/configmap.md +++ b/docs/user-guide/configmap.md @@ -391,7 +391,7 @@ _References:_ Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy". _References:_ -- https://www.openssl.org/docs/manmaster/apps/dhparam.html +- https://wiki.openssl.org/index.php/Manual:Dhparam(1) - https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam - http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam diff --git a/docs/user-guide/custom-errors.md b/docs/user-guide/custom-errors.md index 197ff33ade..8e77e39927 100644 --- a/docs/user-guide/custom-errors.md +++ b/docs/user-guide/custom-errors.md @@ -8,7 +8,7 @@ Each request to the default backend includes two headers: **Important:** the custom backend must return the correct HTTP status code to be returned. NGINX do not changes the response from the custom default backend. -Using this two headers is possible to use a custom backend service like [this one](https://github.com/kubernetes/ingress-nginx/tree/master/examples/customization/custom-errors/nginx) that inspect each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](examples/customization/custom-errors/README.md) +Using this two headers is possible to use a custom backend service like [this one](https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages) that inspect each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-errors) NGINX sends additional headers that can be used to build custom response: diff --git a/internal/ingress/controller/config/config.go b/internal/ingress/controller/config/config.go index aa894bd711..116aca7604 100644 --- a/internal/ingress/controller/config/config.go +++ b/internal/ingress/controller/config/config.go @@ -286,7 +286,7 @@ type Configuration struct { SSLECDHCurve string `json:"ssl-ecdh-curve,omitempty"` // The secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy" - // https://www.openssl.org/docs/manmaster/apps/dhparam.html + // https://wiki.openssl.org/index.php/Manual:Dhparam(1) // https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam // http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam SSLDHParam string `json:"ssl-dh-param,omitempty"`