Skip to content

Commit 9b1af26

Browse files
committed
Use https in docs/examples where applicable
1 parent 81be764 commit 9b1af26

File tree

9 files changed

+59
-59
lines changed

9 files changed

+59
-59
lines changed

docs-web/configuration/global-configuration/configmap-resource.md

+37-37
Large diffs are not rendered by default.

docs-web/configuration/ingress-resources/advanced-configuration-with-annotations.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -76,47 +76,47 @@ The table below summarizes the available annotations.
7676
- Example
7777
* - ``nginx.org/proxy-connect-timeout``
7878
- ``proxy-connect-timeout``
79-
- 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.
79+
- 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.
8080
- ``60s``
8181
-
8282
* - ``nginx.org/proxy-read-timeout``
8383
- ``proxy-read-timeout``
84-
- 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.
84+
- 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.
8585
- ``60s``
8686
-
8787
* - ``nginx.org/proxy-send-timeout``
8888
- ``proxy-send-timeout``
89-
- 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.
89+
- 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.
9090
- ``60s``
9191
-
9292
* - ``nginx.org/client-max-body-size``
9393
- ``client-max-body-size``
94-
- 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.
94+
- 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.
9595
- ``1m``
9696
-
9797
* - ``nginx.org/proxy-buffering``
9898
- ``proxy-buffering``
99-
- Enables or disables `buffering of responses <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ from the proxied server.
99+
- Enables or disables `buffering of responses <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ from the proxied server.
100100
- ``True``
101101
-
102102
* - ``nginx.org/proxy-buffers``
103103
- ``proxy-buffers``
104-
- Sets the value of the `proxy_buffers <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers>`_ directive.
104+
- Sets the value of the `proxy_buffers <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers>`_ directive.
105105
- Depends on the platform.
106106
-
107107
* - ``nginx.org/proxy-buffer-size``
108108
- ``proxy-buffer-size``
109-
- 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.
109+
- 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.
110110
- Depends on the platform.
111111
-
112112
* - ``nginx.org/proxy-max-temp-file-size``
113113
- ``proxy-max-temp-file-size``
114-
- 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.
114+
- 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.
115115
- ``1024m``
116116
-
117117
* - ``nginx.org/server-tokens``
118118
- ``server-tokens``
119-
- 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.
119+
- 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.
120120
- ``True``
121121
-
122122
```
@@ -134,12 +134,12 @@ The table below summarizes the available annotations.
134134
- Example
135135
* - ``nginx.org/proxy-hide-headers``
136136
- ``proxy-hide-headers``
137-
- 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"``
137+
- 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"``
138138
- N/A
139139
-
140140
* - ``nginx.org/proxy-pass-headers``
141141
- ``proxy-pass-headers``
142-
- 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"``
142+
- 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"``
143143
- N/A
144144
-
145145
* - ``nginx.org/rewrites``
@@ -293,7 +293,7 @@ The table below summarizes the available annotations.
293293
- `Session Persistence <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/session-persistence>`_.
294294
* - ``nginx.org/keepalive``
295295
- ``keepalive``
296-
- 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.
296+
- 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.
297297
- ``0``
298298
-
299299
* - ``nginx.com/health-checks``

docs-web/configuration/virtualserver-and-virtualserverroute-resources.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ The route defines rules for matching client requests to actions like passing a r
172172
- Type
173173
- Required
174174
* - ``path``
175-
- 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.
175+
- 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.
176176
- ``string``
177177
- Yes
178178
* - ``action``
@@ -422,7 +422,7 @@ tls:
422422
- `tls <#upstream-tls>`_
423423
- No
424424
* - ``healthCheck``
425-
- 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.
425+
- 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.
426426
- `healthcheck <#upstream-healthcheck>`_
427427
- No
428428
* - ``slow-start``
@@ -499,7 +499,7 @@ size: 10
499499
timeout: 60s
500500
```
501501
502-
See [`queue`](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue) directive for additional information.
502+
See [`queue`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue) directive for additional information.
503503

504504
Note: This feature is supported only in NGINX Plus.
505505

@@ -854,7 +854,7 @@ action:
854854
pass: coffee-stable
855855
```
856856

857-
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:
857+
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:
858858
* all POST requests -> `coffee-post`
859859
* all non-POST requests -> `coffee`
860860

docs-web/logging-and-monitoring/status-page.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ If you want to access the dashboard externally (without `kubectl port-forward`):
3636
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`.
3737
1. Use the IP/port through which the Ingress Controller pod/pods are available to connect the dashboard at the `/dashboard.html` path.
3838
39-
**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.
39+
**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.

examples/daemon-set/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Deploying NGINX and NGINX Plus Controllers as a Daemon Set
22

3-
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.
3+
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.
44

55
Read the installation instructions [here](../../docs/installation.md).

examples/health-checks/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The Ingress controller provides the following annotations for configuring active
99

1010
* Required: `nginx.com/health-checks: "true"` -- enables active health checks. The default is `false`.
1111
* 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`.
12-
* 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`.
12+
* 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`.
1313

1414
# Example
1515

examples/jwt/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Support for JSON Web Tokens (JWTs)
22

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

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

examples/proxy-protocol/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ proxy-protocol: "True | False"
1111

1212
Additionally, you must configure the following keys:
1313
* **real-ip-header**: Set its value to `proxy_protocol`.
14-
* **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
14+
* **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
1515

1616
## Example
1717

examples/session-persistence/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Here each service follows the following syntactic rule:
1414
```
1515
serviceName=serviceName cookieName [expires=time] [domain=domain] [httponly] [secure] [path=path]
1616
```
17-
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.
17+
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.
1818

1919
## Example
2020

0 commit comments

Comments
 (0)