Skip to content

Commit

Permalink
Fix doc links (#1925)
Browse files Browse the repository at this point in the history
* Fix documentation links
* Replace external-traffic annotation
* Update awesome_bot docker image
  • Loading branch information
aledbf authored Jan 18, 2018
1 parent b50cdc0 commit 5a16a7a
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/rewrite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/static-ip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 1 addition & 2 deletions docs/examples/static-ip/static-ip-svc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
-----------------NOTICE------------------------
This file is referenced in code as
https://github.com/kubernetes/ingress-ingress/blob/master/docs/troubleshooting.md
https://github.com/kubernetes/ingress-nginx/blob/master/docs/troubleshooting.md
Do not move it without providing redirects.
-----------------------------------------------
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/custom-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion internal/ingress/controller/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down

0 comments on commit 5a16a7a

Please sign in to comment.