Skip to content

Commit eff5e8d

Browse files
committed
Fix docs
1 parent 728d9ee commit eff5e8d

File tree

5 files changed

+15
-14
lines changed

5 files changed

+15
-14
lines changed

deployments/helm-chart/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ This chart deploys the NGINX Ingress controller in your Kubernetes cluster.
5454
1. Clone the Ingress controller repo:
5555
```console
5656
$ git clone https://github.com/nginxinc/kubernetes-ingress/
57-
$ git checkout v1.6.1
5857
```
5958
2. Change your working directory to /deployments/helm-chart:
6059
```console
6160
$ cd kubernetes-ingress/deployments/helm-chart
61+
$ git checkout v1.6.2
6262
```
6363
3. To install the chart with the release name my-release (my-release is the name that you choose):
6464

docs-web/configuration/ingress-resources/basic-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ spec:
2727
2828
Here is a breakdown of what this Ingress resource definition means:
2929
* The `metadata.name` field defines the name of the resource `cafe‑ingress`.
30-
* In the `spec.tsl` field we set up SSL/TLS termination:
30+
* In the `spec.tls` field we set up SSL/TLS termination:
3131
* In the `secretName`, we reference a secret resource by its name, `cafe‑secret`. This resource contains the SSL/TLS certificate and key and it must be deployed prior to the Ingress resource.
3232
* In the `hosts` field, we apply the certificate and key to our `cafe.example.com` host.
3333
* In the `spec.rules` field, we define a host with domain name `cafe.example.com`.

docs-web/installation/building-ingress-controller-image.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Building Ingress Controller Image
1+
# Building the Ingress Controller Image
22

3-
This document explains how to build an Ingress Controller image. Note that for NGINX, we provide the image though [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress-controller/). For NGINX Plus, you need to build the image.
3+
This document explains how to build an Ingress Controller image. Note that for NGINX, we provide the image though [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/). For NGINX Plus, you need to build the image.
44

55
## Prerequisites
66

@@ -22,7 +22,8 @@ We build the image using the make utility and the provided `Makefile`. Let’s c
2222
1. Clone the Ingress controller repo:
2323
```
2424
$ git clone https://github.com/nginxinc/kubernetes-ingress/
25-
$ git checkout v1.6.1
25+
$ cd kubernetes-ingress
26+
$ git checkout v1.6.2
2627
```
2728
2829
1. Build the image:
@@ -32,7 +33,7 @@ We build the image using the make utility and the provided `Makefile`. Let’s c
3233
$ make PREFIX=myregistry.example.com/nginx-ingress
3334
```
3435
`myregistry.example.com/nginx-ingress` defines the repo in your private registry where the image will be pushed. Substitute that value with the repo in your private registry.
35-
36+
3637
As the result, the image **myregistry.example.com/nginx-ingress:1.6.0** is built and pushed to the registry. Note that the tag `1.6.0` comes from the `VERSION` variable, defined in the Makefile.
3738
3839
* For NGINX Plus, first, make sure that the certificate (`nginx-repo.crt`) and the key (`nginx-repo.key`) of your license are located in the root of the project:
@@ -46,7 +47,7 @@ We build the image using the make utility and the provided `Makefile`. Let’s c
4647
$ make DOCKERFILE=DockerfileForPlus PREFIX=myregistry.example.com/nginx-plus-ingress
4748
```
4849
`myregistry.example.com/nginx-plus-ingress` defines the repo in your private registry where the image will be pushed. Substitute that value with the repo in your private registry.
49-
50+
5051
As the result, the image **myregistry.example.com/nginx-plus-ingress:1.6.0** is built and pushed to the registry. Note that the tag `1.6.0` comes from the `VERSION` variable, defined in the Makefile.
5152
5253
Next you will find the details about available Makefile targets and variables.

docs-web/installation/installation-with-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ This document describes how to install the NGINX Ingress Controller in your Kube
5252
1. Clone the Ingress controller repo:
5353
```console
5454
$ git clone https://github.com/nginxinc/kubernetes-ingress/
55-
$ git checkout v1.6.1
5655
```
5756
2. Change your working directory to /deployments/helm-chart:
5857
```console
5958
$ cd kubernetes-ingress/deployments/helm-chart
59+
$ git checkout v1.6.2
6060
```
6161
3. To install the chart with the release name my-release (my-release is the name that you choose):
6262

docs-web/third-party-modules/opentracing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
The Ingress Controller supports [OpenTracing](http://opentracing.io/) with the third-party module [opentracing-contrib/nginx-opentracing](https://github.com/opentracing-contrib/nginx-opentracing).
44

5-
This document explains how to use OpenTracing with the Ingress Controller. Additionally, we have an [example](https://github.com/nginxinc/kubernetes-ingress/blob/v1.6.1/docs/opentracing.md) on how to enable OpenTracing for a simple web application using Jaeger as a tracer.
5+
This document explains how to use OpenTracing with the Ingress Controller. Additionally, we have an [example](https://github.com/nginxinc/kubernetes-ingress/blob/v1.6.2/examples/opentracing) on how to enable OpenTracing for a simple web application using Jaeger as a tracer.
66

77
## Prerequisites
8-
1. **Use the Ingress Controller image with OpenTracing.** The default Ingress Controller images don’t include the OpenTracing module. To use OpenTracing, you need to build the image with that module. Follow the build instructions to build the image using `DockerfileWithOpentracing` for NGINX or `DockerfileWithOpentracingForPlus` for NGINX Plus.
8+
1. **Use the Ingress Controller image with OpenTracing.** The default Ingress Controller images don’t include the OpenTracing module. To use OpenTracing, you need to build the image with that module. Follow the build instructions to build the image using `DockerfileWithOpentracing` for NGINX or `DockerfileWithOpentracingForPlus` for NGINX Plus.
99
By default, the Dockerfiles install Jaeger as a tracer. However, it is possible to replace Jaeger with other supported [tracers](https://github.com/opentracing-contrib/nginx-opentracing#building-from-source). For that, please modify the Dockerfile accordingly:
1010
1. Change the download line in the tracer-downloader stage of the Dockerfile to download the right tracer.
1111
1. Edit the COPY line of the final image to copy the previously downloaded tracer to the image
1212

1313
1. **Load the OpenTracing module.** You need to load the module with the configuration for the chosen tracer using the following ConfigMap keys:
1414
* `opentracing-tracer`: sets the path to the vendor tracer binary plugin. This is the path you used in the COPY line of step *ii* above.
1515
* `opentracing-tracer-config`: sets the tracer configuration in JSON format.
16-
16+
1717
Below an example on how to use those keys to load the module with Jaeger tracer:
1818
```yaml
1919
opentracing-tracer: "/usr/local/lib/libjaegertracing_plugin.so"
@@ -55,7 +55,7 @@ Consider the following two cases:
5555
```
5656

5757
2. OpenTracing is globally enabled:
58-
1. To disable OpenTracing for a specific Ingress Resource, use the server snippet annotation:
58+
1. To disable OpenTracing for a specific Ingress Resource, use the server snippet annotation:
5959
```yaml
6060
nginx.org/server-snippets: |
6161
opentracing off;
@@ -69,9 +69,9 @@ Consider the following two cases:
6969

7070
## Customize OpenTracing
7171

72-
You can customize OpenTracing though the supported [OpenTracing module directives](https://github.com/opentracing-contrib/nginx-opentracing/blob/v1.6.1/doc/Reference.md). Use the snippets ConfigMap keys or annotations to insert those directives into the http, server or location contexts of the generated NGINX configuration.
72+
You can customize OpenTracing though the supported [OpenTracing module directives](https://github.com/opentracing-contrib/nginx-opentracing/blob/v1.6.2/doc/Reference.md). Use the snippets ConfigMap keys or annotations to insert those directives into the http, server or location contexts of the generated NGINX configuration.
7373

74-
For example, to propagate the active span context for upstream requests, it is required to set the `opentracing_propagate_context` directive, which you can add to an Ingress resource using the location snippets annotation:
74+
For example, to propagate the active span context for upstream requests, it is required to set the `opentracing_propagate_context` directive, which you can add to an Ingress resource using the location snippets annotation:
7575

7676
```yaml
7777
nginx.org/location-snippets: |

0 commit comments

Comments
 (0)