Skip to content

Commit df40f8b

Browse files
lamATnginxlamATnginx
authored
Merge branch 'mainframe-mod-ref-testing' into update-icon-usage
2 parents c2c4bc2 + 0e9346b commit df40f8b

File tree

118 files changed

+37179
-342
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+37179
-342
lines changed

‎_banners/eos-acm.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{< banner "warning" "End of Sale Notice:" >}}
2+
<br>
3+
F5 NGINX is announcing the <strong>End of Sale (EoS)</strong> for NGINX Management Suite API Connectivity Manager Module, <strong>effective January 1, 2024</strong>.
4+
<br><br>
5+
F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. <strong>License renewals are not available after September 30, 2024.</strong>
6+
<br><br>
7+
See our <a href="https://my.f5.com/manage/s/article/K000137989">End of Sale announcement</a> for more details.
8+
{{</ banner >}}

‎_banners/eos-mesh.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{{< banner "warning" "End of Sale Notice:" >}}
2-
<br>
3-
F5 NGINX is announcing the <strong>End of Sale (EoS)</strong> for NGINX Management Suite API Connectivity Manager Module, <strong>effective January 1, 2024</strong>.
4-
<br><br>
5-
F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. <strong>License renewals are not available after September 30, 2024.</strong>
6-
<br><br>
7-
See our <a href="https://my.f5.com/manage/s/article/K000137989">End of Sale announcement</a> for more details.
2+
<p>
3+
Commercial support for NGINX Service Mesh is available to customers who currently have active NGINX Microservices Bundle subscriptions. F5 NGINX announced the End of Sale (EoS) for the NGINX Microservices Bundles as of <strong>July 1, 2023</strong>.
4+
</p>
5+
<p>
6+
See our <a href="https://my.f5.com/manage/s/article/K000135468">End of Sale announcement</a> for more details.
7+
</p>
88
{{</ banner >}}

‎content/agent/_index.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,50 @@ cascade:
99
start-date: 2025-05-29
1010
end-date: 2025-09-09
1111
md: /_banners/agent-v3-release.md
12+
# The subtitle displays directly underneath the heading of a given page
13+
nd-subtitle:
14+
# Indicates that this is a custom landing page
15+
nd-landing-page: true
16+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
17+
nd-content-type: landing-page
18+
# Intended for internal catalogue and search, case sensitive:
19+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
20+
nd-product: Agent
1221
---
22+
23+
## About
24+
25+
NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables remote management of NGINX
26+
configurations, collection and reporting of real-time NGINX performance and operating system metrics, and notifications of NGINX events.
27+
28+
[//]: # "This initial section introduces the product to a reader: give a short 1-2 sentence summary of what the product does and its value to the reader."
29+
[//]: # "Name specific functionality it provides: avoid ambiguous descriptions such as 'enables efficiency', focus on what makes it unique."
30+
31+
## Featured content
32+
[//]: # "You can add a maximum of three cards: any extra will not display."
33+
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
34+
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
35+
36+
{{<card-layout>}}
37+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
38+
{{<card title="About" titleUrl="/nginx-agent/about" icon="info">}}
39+
Learn everything you need to know about NGINX Agent
40+
{{</card>}}
41+
<!-- The titleURL and icon are both optional -->
42+
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
43+
{{<card title="Getting started" titleUrl="/nginx-agent/installation-upgrade/getting-started" icon="unplug">}}
44+
Install NGINX Agent and run a mock control plane
45+
{{</card>}}
46+
{{</card-section>}}
47+
{{</card-layout>}}
48+
49+
{{<card-layout>}}
50+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
51+
{{<card title="Upgrade" titleUrl="/nginx-agent/installation-upgrade/upgrade/" icon="circle-fading-arrow-up">}}
52+
{{</card>}}
53+
{{<card title="Configuration" titleUrl="/nginx-agent/configuration" icon="cog">}}
54+
{{</card>}}
55+
{{<card title="Support" titleUrl="/nginx-agent/support" icon="hand-helping">}}
56+
{{</card>}}
57+
{{</card-section>}}
58+
{{</card-layout>}}

‎content/ngf/get-started.md‎

Lines changed: 128 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,76 @@ The YAML code in the following sections can be found in the [cafe-example folder
132132

133133
### Create the application resources
134134

135-
Create the file _cafe.yaml_ with the following contents:
136-
137-
{{< ghcode `https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe.yaml`>}}
138-
139-
Apply it using `kubectl`:
140-
141-
```shell
135+
Run the following command to create the file _cafe.yaml_, which is then used to deploy the *coffee* application to your cluster:
136+
137+
```yaml
138+
cat <<EOF > cafe.yaml
139+
apiVersion: apps/v1
140+
kind: Deployment
141+
metadata:
142+
name: coffee
143+
spec:
144+
replicas: 1
145+
selector:
146+
matchLabels:
147+
app: coffee
148+
template:
149+
metadata:
150+
labels:
151+
app: coffee
152+
spec:
153+
containers:
154+
- name: coffee
155+
image: nginxdemos/nginx-hello:plain-text
156+
ports:
157+
- containerPort: 8080
158+
---
159+
apiVersion: v1
160+
kind: Service
161+
metadata:
162+
name: coffee
163+
spec:
164+
ports:
165+
- port: 80
166+
targetPort: 8080
167+
protocol: TCP
168+
name: http
169+
selector:
170+
app: coffee
171+
---
172+
apiVersion: apps/v1
173+
kind: Deployment
174+
metadata:
175+
name: tea
176+
spec:
177+
replicas: 1
178+
selector:
179+
matchLabels:
180+
app: tea
181+
template:
182+
metadata:
183+
labels:
184+
app: tea
185+
spec:
186+
containers:
187+
- name: tea
188+
image: nginxdemos/nginx-hello:plain-text
189+
ports:
190+
- containerPort: 8080
191+
---
192+
apiVersion: v1
193+
kind: Service
194+
metadata:
195+
name: tea
196+
spec:
197+
ports:
198+
- port: 80
199+
targetPort: 8080
200+
protocol: TCP
201+
name: http
202+
selector:
203+
app: tea
204+
EOF
142205
kubectl apply -f cafe.yaml
143206
```
144207

@@ -163,13 +226,22 @@ tea-6fbfdcb95d-9lhbj 1/1 Running 0 9s
163226

164227
### Create Gateway and HTTPRoute resources
165228

166-
Create the file _gateway.yaml_ with the following contents:
167-
168-
{{< ghcode `https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/gateway.yaml`>}}
169-
170-
Apply it using `kubectl`:
171-
172-
```shell
229+
Run the following command to create the file _gateway.yaml_, which is then used to deploy a Gateway to your cluster:
230+
231+
```yaml
232+
cat <<EOF > gateway.yaml
233+
apiVersion: gateway.networking.k8s.io/v1
234+
kind: Gateway
235+
metadata:
236+
name: gateway
237+
spec:
238+
gatewayClassName: nginx
239+
listeners:
240+
- name: http
241+
port: 80
242+
protocol: HTTP
243+
hostname: "*.example.com"
244+
EOF
173245
kubectl apply -f gateway.yaml
174246
```
175247

@@ -190,13 +262,48 @@ gateway-nginx-66b5d78f8f-4fmtb 1/1 Running 0 13s
190262
tea-6fbfdcb95d-9lhbj 1/1 Running 0 31s
191263
```
192264

193-
Create the file _cafe-routes.yaml_ with the following contents:
194-
195-
{{< ghcode `https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe-routes.yaml`>}}
196-
197-
Apply it using `kubectl`:
198-
199-
```shell
265+
Run the following command to create the file _cafe-routes.yaml_. It is then used to deploy two *HTTPRoute* resources in your cluster: one each for _/coffee_ and _/tea_.
266+
267+
```yaml
268+
cat <<EOF > cafe-routes.yaml
269+
apiVersion: gateway.networking.k8s.io/v1
270+
kind: HTTPRoute
271+
metadata:
272+
name: coffee
273+
spec:
274+
parentRefs:
275+
- name: gateway
276+
sectionName: http
277+
hostnames:
278+
- "cafe.example.com"
279+
rules:
280+
- matches:
281+
- path:
282+
type: PathPrefix
283+
value: /coffee
284+
backendRefs:
285+
- name: coffee
286+
port: 80
287+
---
288+
apiVersion: gateway.networking.k8s.io/v1
289+
kind: HTTPRoute
290+
metadata:
291+
name: tea
292+
spec:
293+
parentRefs:
294+
- name: gateway
295+
sectionName: http
296+
hostnames:
297+
- "cafe.example.com"
298+
rules:
299+
- matches:
300+
- path:
301+
type: Exact
302+
value: /tea
303+
backendRefs:
304+
- name: tea
305+
port: 80
306+
EOF
200307
kubectl apply -f cafe-routes.yaml
201308
```
202309

‎content/nginx/module-reference/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: NGINX Module Reference
3+
description:
4+
---

‎content/nginx/module-reference/http/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: NGINX HTTP Reference
3+
description:
4+
---

‎content/nginx/module-reference/http/ngx_http_access_module.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: ngx_http_access_module
3+
description: ngx_http_access_module
4+
toc: true
5+
nd-org-source: http/ngx_http_access_module.xml
6+
nd-plus: false
7+
nd-partial-plus: false
8+
---
9+
10+
11+
<!--
12+
********************************************************************************
13+
🛑 WARNING: AUTOGENERATED FILE - DO NOT EDIT 🛑 This Markdown file was
14+
automatically generated from the source XML documentation. Any manual
15+
changes made directly to this file will be overwritten. To request or
16+
suggest changes, please edit the source XML files instead.
17+
https://github.com/nginx/nginx.org/tree/main/xml/en
18+
********************************************************************************
19+
-->
20+
21+
22+
The `ngx_http_access_module` module allows
23+
limiting access to certain client addresses.
24+
25+
Access can also be limited by
26+
[password](/nginx/module-reference/http/ngx_http_auth_basic_module), by the
27+
[result of subrequest](/nginx/module-reference/http/ngx_http_auth_request_module),
28+
or by [JWT](/nginx/module-reference/http/ngx_http_auth_jwt_module).
29+
Simultaneous limitation of access by address and by password is controlled
30+
by the [satisfy](/nginx/module-reference/http/ngx_http_core_module#satisfy) directive.
31+
## Example Configuration
32+
33+
34+
```nginx
35+
location / {
36+
deny 192.168.1.1;
37+
allow 192.168.1.0/24;
38+
allow 10.1.1.0/16;
39+
allow 2001:0db8::/32;
40+
deny all;
41+
}
42+
43+
```
44+
45+
46+
The rules are checked in sequence until the first match is found.
47+
In this example, access is allowed only for IPv4 networks
48+
`10.1.1.0/16` and `192.168.1.0/24`
49+
excluding the address `192.168.1.1`,
50+
and for IPv6 network `2001:0db8::/32`.
51+
In case of a lot of rules, the use of the
52+
[ngx_http_geo_module](/nginx/module-reference/http/ngx_http_geo_module)
53+
module variables is preferable.
54+
## Directives
55+
56+
### allow
57+
58+
{{< call-out >}}
59+
60+
**Syntax:** allow `address` | `CIDR` | `unix:` | `all`
61+
62+
**Default:** -
63+
64+
**Context:** http, server, location, limit_except
65+
66+
67+
{{</call-out>}}
68+
69+
70+
Allows access for the specified network or address.
71+
If the special value `unix:` is specified (1.5.1),
72+
allows access for all UNIX-domain sockets.
73+
### deny
74+
75+
{{< call-out >}}
76+
77+
**Syntax:** deny `address` | `CIDR` | `unix:` | `all`
78+
79+
**Default:** -
80+
81+
**Context:** http, server, location, limit_except
82+
83+
84+
{{</call-out>}}
85+
86+
87+
Denies access for the specified network or address.
88+
If the special value `unix:` is specified (1.5.1),
89+
denies access for all UNIX-domain sockets.

0 commit comments

Comments
 (0)