Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation https usage #965

Merged
merged 2 commits into from
May 25, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions docs-web/configuration/global-configuration/configmap-resource.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -76,47 +76,47 @@ The table below summarizes the available annotations.
- Example
* - ``nginx.org/proxy-connect-timeout``
- ``proxy-connect-timeout``
- Sets the value of the `proxy_connect_timeout <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout>`_ and `grpc_connect_timeout <http://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_connect_timeout>`_ directive.
- Sets the value of the `proxy_connect_timeout <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout>`_ and `grpc_connect_timeout <https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_connect_timeout>`_ directive.
- ``60s``
-
* - ``nginx.org/proxy-read-timeout``
- ``proxy-read-timeout``
- Sets the value of the `proxy_read_timeout <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout>`_ and `grpc_read_timeout <http://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_read_timeout>`_ directive.
- Sets the value of the `proxy_read_timeout <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout>`_ and `grpc_read_timeout <https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_read_timeout>`_ directive.
- ``60s``
-
* - ``nginx.org/proxy-send-timeout``
- ``proxy-send-timeout``
- Sets the value of the `proxy_send_timeout <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_send_timeout>`_ and `grpc_send_timeout <http://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_send_timeout>`_ directive.
- Sets the value of the `proxy_send_timeout <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_send_timeout>`_ and `grpc_send_timeout <https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_send_timeout>`_ directive.
- ``60s``
-
* - ``nginx.org/client-max-body-size``
- ``client-max-body-size``
- Sets the value of the `client_max_body_size <http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_ directive.
- Sets the value of the `client_max_body_size <https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_ directive.
- ``1m``
-
* - ``nginx.org/proxy-buffering``
- ``proxy-buffering``
- Enables or disables `buffering of responses <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ from the proxied server.
- Enables or disables `buffering of responses <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ from the proxied server.
- ``True``
-
* - ``nginx.org/proxy-buffers``
- ``proxy-buffers``
- Sets the value of the `proxy_buffers <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers>`_ directive.
- Sets the value of the `proxy_buffers <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers>`_ directive.
- Depends on the platform.
-
* - ``nginx.org/proxy-buffer-size``
- ``proxy-buffer-size``
- Sets the value of the `proxy_buffer_size <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size>`_ and `grpc_buffer_size <http://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_buffer_size>`_ directives.
- Sets the value of the `proxy_buffer_size <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size>`_ and `grpc_buffer_size <https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_buffer_size>`_ directives.
- Depends on the platform.
-
* - ``nginx.org/proxy-max-temp-file-size``
- ``proxy-max-temp-file-size``
- Sets the value of the `proxy_max_temp_file_size <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_max_temp_file_size>`_ directive.
- Sets the value of the `proxy_max_temp_file_size <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_max_temp_file_size>`_ directive.
- ``1024m``
-
* - ``nginx.org/server-tokens``
- ``server-tokens``
- Enables or disables the `server_tokens <http://nginx.org/en/docs/http/ngx_http_core_module.html#server_tokens>`_ directive. Additionally, with the NGINX Plus, you can specify a custom string value, including the empty string value, which disables the emission of the “Server” field.
- Enables or disables the `server_tokens <https://nginx.org/en/docs/http/ngx_http_core_module.html#server_tokens>`_ directive. Additionally, with the NGINX Plus, you can specify a custom string value, including the empty string value, which disables the emission of the “Server” field.
- ``True``
-
```
Expand All @@ -134,12 +134,12 @@ The table below summarizes the available annotations.
- Example
* - ``nginx.org/proxy-hide-headers``
- ``proxy-hide-headers``
- Sets the value of one or more `proxy_hide_header <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_hide_header>`_ directives. Example: ``"nginx.org/proxy-hide-headers": "header-a,header-b"``
- Sets the value of one or more `proxy_hide_header <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_hide_header>`_ directives. Example: ``"nginx.org/proxy-hide-headers": "header-a,header-b"``
- N/A
-
* - ``nginx.org/proxy-pass-headers``
- ``proxy-pass-headers``
- Sets the value of one or more `proxy_pass_header <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass_header>`_ directives. Example: ``"nginx.org/proxy-pass-headers": "header-a,header-b"``
- Sets the value of one or more `proxy_pass_header <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass_header>`_ directives. Example: ``"nginx.org/proxy-pass-headers": "header-a,header-b"``
- N/A
-
* - ``nginx.org/rewrites``
Expand Down Expand Up @@ -293,7 +293,7 @@ The table below summarizes the available annotations.
- `Session Persistence <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/session-persistence>`_.
* - ``nginx.org/keepalive``
- ``keepalive``
- Sets the value of the `keepalive <http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive>`_ directive. Note that ``proxy_set_header Connection "";`` is added to the generated configuration when the value > 0.
- Sets the value of the `keepalive <https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive>`_ directive. Note that ``proxy_set_header Connection "";`` is added to the generated configuration when the value > 0.
- ``0``
-
* - ``nginx.com/health-checks``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ The route defines rules for matching client requests to actions like passing a r
- Type
- Required
* - ``path``
- The path of the route. NGINX will match it against the URI of a request. Possible values are: a prefix (\ ``/``\ , ``/path``\ ), an exact match (\ ``=/exact/match``\ ), a case insensitive regular expression (\ ``~*^/Bar.*\\.jpg``\ ) or a case sensitive regular expression (\ ``~^/foo.*\\.jpg``\ ). In the case of a prefix (must start with ``/``\ ) or an exact match (must start with ``=``\ ), the path must not include any whitespace characters, ``{``\ , ``}`` or ``;``. In the case of the regex matches, all double quotes ``"`` must be escaped and the match can't end in an unescaped backslash ``\``. The path must be unique among the paths of all routes of the VirtualServer. Check the `location <http://nginx.org/en/docs/http/ngx_http_core_module.html#location>`_ directive for more information.
- The path of the route. NGINX will match it against the URI of a request. Possible values are: a prefix (\ ``/``\ , ``/path``\ ), an exact match (\ ``=/exact/match``\ ), a case insensitive regular expression (\ ``~*^/Bar.*\\.jpg``\ ) or a case sensitive regular expression (\ ``~^/foo.*\\.jpg``\ ). In the case of a prefix (must start with ``/``\ ) or an exact match (must start with ``=``\ ), the path must not include any whitespace characters, ``{``\ , ``}`` or ``;``. In the case of the regex matches, all double quotes ``"`` must be escaped and the match can't end in an unescaped backslash ``\``. The path must be unique among the paths of all routes of the VirtualServer. Check the `location <https://nginx.org/en/docs/http/ngx_http_core_module.html#location>`_ directive for more information.
- ``string``
- Yes
* - ``action``
Expand Down Expand Up @@ -422,7 +422,7 @@ tls:
- `tls <#upstream-tls>`_
- No
* - ``healthCheck``
- The health check configuration for the Upstream. See the `health_check <http://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check>`_ directive. Note: this feature is supported only in NGINX Plus.
- The health check configuration for the Upstream. See the `health_check <https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check>`_ directive. Note: this feature is supported only in NGINX Plus.
- `healthcheck <#upstream-healthcheck>`_
- No
* - ``slow-start``
Expand Down Expand Up @@ -499,7 +499,7 @@ size: 10
timeout: 60s
```

See [`queue`](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue) directive for additional information.
See [`queue`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue) directive for additional information.

Note: This feature is supported only in NGINX Plus.

Expand Down Expand Up @@ -854,7 +854,7 @@ action:
pass: coffee-stable
```

In the next example, NGINX routes requests based on the value of the built-in [`$request_method` variable](http://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_method), which represents the HTTP method of a request:
In the next example, NGINX routes requests based on the value of the built-in [`$request_method` variable](https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_method), which represents the HTTP method of a request:
* all POST requests -> `coffee-post`
* all non-POST requests -> `coffee`

Expand Down
2 changes: 1 addition & 1 deletion docs-web/logging-and-monitoring/status-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ If you want to access the dashboard externally (without `kubectl port-forward`):
1. Configure `-nginx-status-allow-cidrs` command-line argument with IPv4 IP/CIDR blocks for which you want to allow access to the dashboard. By default, the access is allowed for `127.0.0.1`.
1. Use the IP/port through which the Ingress Controller pod/pods are available to connect the dashboard at the `/dashboard.html` path.

**Note**: The [API](http://nginx.org/en/docs/http/ngx_http_api_module.html), which the dashboard uses to get the metrics, is also accessible: use the `/api` path. Note that the API is configured in the read-only mode.
**Note**: The [API](https://nginx.org/en/docs/http/ngx_http_api_module.html), which the dashboard uses to get the metrics, is also accessible: use the `/api` path. Note that the API is configured in the read-only mode.
2 changes: 1 addition & 1 deletion examples/daemon-set/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Deploying NGINX and NGINX Plus Controllers as a Daemon Set

You can deploy the NGINX or NGINX Plus controller as a [Daemon Set](http://kubernetes.io/docs/admin/daemons/). This allows you to deploy the controller on all or select nodes of your cluster.
You can deploy the NGINX or NGINX Plus controller as a [Daemon Set](https://kubernetes.io/docs/admin/daemons/). This allows you to deploy the controller on all or select nodes of your cluster.

Read the installation instructions [here](../../docs/installation.md).
2 changes: 1 addition & 1 deletion examples/health-checks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Ingress controller provides the following annotations for configuring active

* Required: `nginx.com/health-checks: "true"` -- enables active health checks. The default is `false`.
* Optional: `nginx.com/health-checks-mandatory: "true"` -- configures active health checks as mandatory. With the default active health checks, when an endpoint is added to NGINX Plus via the API or after a configuration reload, NGINX Plus considers the endpoint to be healthy. With mandatory health checks, when an endpoint is added to NGINX Plus or after a configuration reload, NGINX Plus considers the endpoint to be unhealthy until its health check passes. The default is `false`.
* Optional: `nginx.com/health-checks-mandatory-queue: "500"` -- configures a [queue](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue) for temporary storing incoming requests during the time when NGINX Plus is checking the health of the endpoints after a configuration reload. If the queue is not configured or the queue is full, NGINX Plus will drop an incoming request returning the `502` code to the client. The queue is configured only when health checks are mandatory. The timeout parameter of the queue is configured with the value of the timeoutSeconds field of the corresponding Readiness Probe. Choose the size of the queue according with your requirements such as the expected number of requests per second and the timeout. The default is `0`.
* Optional: `nginx.com/health-checks-mandatory-queue: "500"` -- configures a [queue](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue) for temporary storing incoming requests during the time when NGINX Plus is checking the health of the endpoints after a configuration reload. If the queue is not configured or the queue is full, NGINX Plus will drop an incoming request returning the `502` code to the client. The queue is configured only when health checks are mandatory. The timeout parameter of the queue is configured with the value of the timeoutSeconds field of the corresponding Readiness Probe. Choose the size of the queue according with your requirements such as the expected number of requests per second and the timeout. The default is `0`.

# Example

Expand Down
2 changes: 1 addition & 1 deletion examples/jwt/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Support for JSON Web Tokens (JWTs)

NGINX Plus supports validating JWTs with [ngx_http_auth_jwt_module](http://nginx.org/en/docs/http/ngx_http_auth_jwt_module.html).
NGINX Plus supports validating JWTs with [ngx_http_auth_jwt_module](https://nginx.org/en/docs/http/ngx_http_auth_jwt_module.html).

The Ingress controller provides the following 4 annotations for configuring JWT validation:

Expand Down
2 changes: 1 addition & 1 deletion examples/mergeable-ingress-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ nginx-ingress-66bc44674b-hrcx8 1/1 Running 0 4m

2. Examine the NGINX Configuration.
```
$ kubectl exec -it nginx-ingress-66bc44674b-hrcx8 -n nginx-ingress cat /etc/nginx/conf.d/default-cafe-ingress-master.conf
$ kubectl exec -it nginx-ingress-66bc44674b-hrcx8 -n nginx-ingress -- cat /etc/nginx/conf.d/default-cafe-ingress-master.conf

upstream default-cafe-ingress-coffee-minion-cafe.example.com-coffee-svc {
server 172.17.0.5:80;
Expand Down
2 changes: 1 addition & 1 deletion examples/proxy-protocol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ proxy-protocol: "True | False"

Additionally, you must configure the following keys:
* **real-ip-header**: Set its value to `proxy_protocol`.
* **set-real-ip-from**: Set its value to the IP address or the subnet of the proxy or the load balancer. See http://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from
* **set-real-ip-from**: Set its value to the IP address or the subnet of the proxy or the load balancer. See https://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from

## Example

Expand Down
2 changes: 1 addition & 1 deletion examples/session-persistence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Here each service follows the following syntactic rule:
```
serviceName=serviceName cookieName [expires=time] [domain=domain] [httponly] [secure] [path=path]
```
The syntax of the *cookieName*, *expires*, *domain*, *httponly*, *secure* and *path* parameters is the same as for the [sticky directive](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky) in the NGINX Plus configuration.
The syntax of the *cookieName*, *expires*, *domain*, *httponly*, *secure* and *path* parameters is the same as for the [sticky directive](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky) in the NGINX Plus configuration.

## Example

Expand Down