Skip to content

Commit e1b17a1

Browse files
committed
Merge branch 'main' into ngf-release-2.0
2 parents 98e431d + 0be9711 commit e1b17a1

Some content is hidden

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

48 files changed

+446
-986
lines changed

_banners/eos-cltr.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 Controller Application Delivery 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 NGINX Controller Application Delivery 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/K000137993">End of Sale announcement</a> for more details
8+
{{</ banner >}}

_banners/eos-mesh.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/upgrade-r33.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{< banner "caution" "NGINX Plus R33 requires NGINX Instance Manager 2.18 or later" >}}
2+
If your NGINX data plane instances are running NGINX Plus R33 or later, you must upgrade to NGINX Instance Manager 2.18 or later to support usage reporting. NGINX Plus R33 instances must report usage data to the F5 licensing endpoint or NGINX Instance Manager. Otherwise, they will stop processing traffic.
3+
<br><br>
4+
For more details about usage reporting and enforcement, see [About solution licenses](../../../../solutions/about-subscription-licenses)
5+
{{</ banner >}}

content/controller/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ title: F5 NGINX Controller
55
weight: 2100
66
cascade:
77
logo: "NGINX-Controller-product-icon-RGB.svg"
8-
type: "ctlr-eos"
98
noindex: true
9+
banner:
10+
enabled: true
11+
type: deprecation
12+
md: _banners/eos-cltr.md
1013
url: /nginx-controller/
1114
---
1215

content/mesh/_index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ description: 'NGINX Service Mesh is a fully integrated lightweight service mesh
55
environments.
66
77
'
8+
url: /nginx-service-mesh/
89
cascade:
9-
type: mesh-eos
1010
noindex: true
11-
url: /nginx-service-mesh/
11+
banner:
12+
enabled: true
13+
type: deprecation
14+
md: _banners/eos-mesh.md
1215
---
1316

content/nginx-one/how-to/staged-configs/import-export-staged-config.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ When you work with such archives, consider the following:
3636
- Do _not_ unpack archives directly to your NGINX configuration directories. You do not want to accidentally overwrite existing configuration files.
3737
- The files are set to a default file permission mode of 0644.
3838
- Do not include files with secrets or personally identifying information.
39-
- We ignore hidden files.
40-
- If you import or export such files in archives, NGINX One Console does not include those files.
4139
- The size of the archive is limited to 5 MB. The size of all uncompressed files in the archive is limited to 10 MB.
4240

4341
{{< tip >}}

content/nginx/admin-guide/installing-nginx/installing-nginx-plus-amazon-web-services.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ To quickly set up an NGINX Plus environment on AWS:
3030

3131
Click the **Continue to Subscribe** button to proceed to the **Launch on EC2** page.
3232

33-
3. Select the type of launch by clicking the appropriate tab (**1&#8209;Click&nbsp;Launch***, **Manual&nbsp;Launch**, or **Service&nbsp;Catalog**). Choose the desired options for billing, instance size, and so on, and click the **Accept&nbsp;Software&nbsp;Terms…** button.
34-
4. When configuring the firewall rules, add a rule to accept web traffic on TCP ports 80 and 443 (this happens automatically if you launch from the **1&#8209;Click&nbsp;Launch** tab).
33+
3. Select the type of launch by clicking the appropriate tab ({{<nb>}}**1-Click Launch**{{</nb>}}, {{<nb>}}**Manual Launch**{{</nb>}}, or {{<nb>}}**Service Catalog**{{</nb>}}). Choose the desired options for billing, instance size, and so on, and click the {{<nb>}}**Accept Software Terms…**{{</nb>}} button.
34+
4. When configuring the firewall rules, add a rule to accept web traffic on TCP ports 80 and 443 (this happens automatically if you launch from the {{<nb>}}**1-Click Launch**{{</nb>}} tab).
3535
5. As soon as the new EC2 instance launches, NGINX Plus starts automatically and serves a default **index.html** page. To view the page, use a web browser to access the public DNS name of the new instance. You can also check the status of the NGINX Plus server by logging into the EC2 instance and running this command:
3636

3737
```nginx

content/nginx/admin-guide/monitoring/new-relic-plugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Download the [plug‑in and installation instructions](https://docs.newrelic.com
3333

3434
## Configuring the Plug‑In
3535

36-
The configuration file for the NGINX plug‑in is **/etc/nginx&#8209;nr&#8209;agent/nginx&#8209;nr&#8209;agent.ini**. The minimal configuration includes:
36+
The configuration file for the NGINX plug‑in is {{<nb>}}**/etc/nginx-nr-agent/nginx-nr-agent.ini**{{</nb>}}. The minimal configuration includes:
3737

3838
- Your New Relic license key in the `newrelic_license_key` statement in the `global` section.
3939

@@ -44,7 +44,7 @@ The configuration file for the NGINX plug‑in is **/etc/nginx&#8209;nr&#8209;ag
4444

4545
You can include the optional `http_user` and `http_pass` statements to set HTTP basic authentication credentials in cases where the corresponding location is protected by the NGINX [auth_basic](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic) directive.
4646

47-
The default log file is **/var/log/nginx&#8209;nr&#8209;agent.log**.
47+
The default log file is {{<nb>}}**/var/log/nginx-nr-agent.log**{{</nb>}}.
4848

4949
## Running the Plug‑In
5050

content/nginx/deployment-guides/amazon-web-services/high-availability-keepalived.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ Allocate an Elastic IP address and remember its ID. For detailed instructions, s
9696

9797
The NGINX Plus HA solution uses two scripts, which are invoked by `keepalived`:
9898

99-
- **nginx&#8209;ha&#8209;check** – Determines the health of NGINX Plus.
100-
- **nginx&#8209;ha&#8209;notify** – Moves the Elastic IP address when a state transition happens, for example when the backup instance becomes the primary.
99+
- {{<nb>}}**nginx-ha-check**{{</nb>}} – Determines the health of NGINX Plus.
100+
- {{<nb>}}**nginx-ha-notify**{{</nb>}} – Moves the Elastic IP address when a state transition happens, for example when the backup instance becomes the primary.
101101

102102
1. Create a directory for the scripts, if it doesn’t already exist.
103103

@@ -121,7 +121,7 @@ The NGINX Plus HA solution uses two scripts, which are invoked by `keepalived`:
121121
There are two configuration files for the HA solution:
122122

123123
- **keepalived.conf** – The main configuration file for `keepalived`, slightly different for each NGINX Plus instance.
124-
- **nginx&#8209;ha&#8209;notify** – The script you downloaded in [Step 4](#ha-aws_ha-scripts), with several user‑defined variables.
124+
- {{<nb>}}**nginx-ha-notify**{{</nb>}} – The script you downloaded in [Step 4](#ha-aws_ha-scripts), with several user‑defined variables.
125125

126126
<span id="ha-aws_keepalived-conf-file"></span>
127127
### Creating keepalived.conf
@@ -158,8 +158,8 @@ You must change values for the following configuration keywords. As you do so, a
158158

159159
- `script` in the `chk_nginx_service` block – The script that sends health checks to NGINX Plus.
160160

161-
- On Ubuntu systems, **/usr/lib/keepalived/nginx&#8209;ha&#8209;check**
162-
- On CentOS systems, **/usr/libexec/keepalived/nginx&#8209;ha&#8209;check**
161+
- On Ubuntu systems, {{<nb>}}**/usr/lib/keepalived/nginx-ha-check**{{</nb>}}
162+
- On CentOS systems, {{<nb>}}**/usr/libexec/keepalived/nginx-ha-check**{{</nb>}}
163163

164164
- `priority` – The value that controls which instance becomes primary, with a higher value meaning a higher priority. Use `101` for the primary instance and `100` for the backup.
165165

@@ -171,13 +171,13 @@ You must change values for the following configuration keywords. As you do so, a
171171

172172
- `notify` – The script that is invoked during a state transition.
173173

174-
- On Ubuntu systems, **/usr/lib/keepalived/nginx&#8209;ha&#8209;notify**
175-
- On CentOS systems, **/usr/libexec/keepalived/nginx&#8209;ha&#8209;notify**
174+
- On Ubuntu systems, {{<nb>}}**/usr/lib/keepalived/nginx-ha-notify**{{</nb>}}
175+
- On CentOS systems, {{<nb>}}**/usr/libexec/keepalived/nginx-ha-notify**{{</nb>}}
176176

177177
<span id="ha-aws_nginx-ha-notify-script"></span>
178178
### Creating nginx-ha-notify
179179

180-
Modify the user‑defined variables section of the **nginx&#8209;ha&#8209;notify** script, replacing each `<value>` placeholder with the value specified in the list below:
180+
Modify the user‑defined variables section of the {{<nb>}}**nginx-ha-notify**{{</nb>}} script, replacing each `<value>` placeholder with the value specified in the list below:
181181

182182
```none
183183
export AWS_ACCESS_KEY_ID=<value>
@@ -223,7 +223,7 @@ Check the state on the backup instance, confirming that it has transitioned to `
223223
<span id="ha-aws_troubleshooting"></span>
224224
## Troubleshooting
225225

226-
If the solution doesn’t work as expected, check the `keepalived` logs, which are written to **/var/log/syslog**. Also, you can manually run the commands that invoke the `awscli` utility in the **nginx&#8209;ha&#8209;notify** script to check that the utility is working properly.
226+
If the solution doesn’t work as expected, check the `keepalived` logs, which are written to **/var/log/syslog**. Also, you can manually run the commands that invoke the `awscli` utility in the {{<nb>}}**nginx-ha-notify**{{</nb>}} script to check that the utility is working properly.
227227

228228
<span id="ha-aws_caveats"></span>
229229
## Caveats

content/nginx/deployment-guides/amazon-web-services/high-availability-network-load-balancer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ Configure NGINX Plus instances as load balancers. These distribute requests to
291291

292292
Use the *Step‑by‑step* instructions in our deployment guide, [Setting Up an NGINX Demo Environment]({{< ref "/nginx/deployment-guides/setting-up-nginx-demo-environment.md" >}}).
293293

294-
Repeat the instructions on both **ngx&#8209;plus&#8209;1** and **ngx&#8209;plus&#8209;2**.
294+
Repeat the instructions on both {{<nb>}}**ngx-plus-1**{{</nb>}} and {{<nb>}}**ngx-plus-2**{{</nb>}}.
295295

296296
<span id="create-instances-automated"></span>
297297
### Automate instance setup with Packer and Terraform
@@ -317,7 +317,7 @@ To run the scripts, follow these instructions:
317317

318318
3. Set your AWS credentials in the Packer and Terraform scripts:
319319

320-
- For Packer, set your credentials in the `variables` block in <span style="text-decoration: underline;">both</span> **packer/ngx&#8209;oss/packer.json** and **packer/ngx&#8209;plus/packer.json**:
320+
- For Packer, set your credentials in the `variables` block in <span style="text-decoration: underline;">both</span> {{<nb>}}**packer/ngx-oss/packer.json**{{</nb>}} and {{<nb>}}**packer/ngx-plus/packer.json**{{</nb>}}:
321321

322322
```none
323323
"variables": {

content/nginx/deployment-guides/amazon-web-services/ingress-controller-elastic-kubernetes-services.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ This guide covers the `eksctl` command as it is the simplest option.
4343

4444
1. Follow the instructions in the [eksctl.io documentation](https://eksctl.io/installation/) to install or update the `eksctl` command.
4545

46-
2. Create an Amazon EKS cluster by following the instructions in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html). Select the **Managed&nbsp;nodes&nbsp;&nbsp;Linux** option for each step. Note that the <span style="white-space: nowrap;">`eksctl create cluster`</span> command in the first step can take ten minutes or more.
46+
2. Create an Amazon EKS cluster by following the instructions in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html). Select the {{<nb>}}**Managed nodesLinux**{{</nb>}} option for each step. Note that the <span style="white-space: nowrap;">`eksctl create cluster`</span> command in the first step can take ten minutes or more.
4747

4848
<span id="amazon-ecr"></span>
4949
## Push the NGINX Plus Ingress Controller Image to AWS ECR
5050

5151
This step is only required if you do not plan to use the prebuilt NGINX Open Source image.
5252

53-
1. Use the [AWS documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) to create a repository in the Amazon Elastic Container Registry (ECR). In Step 4 of the AWS instructions, name the repository **nginx&#8209;plus&#8209;ic** as that is what we use in this guide.
53+
1. Use the [AWS documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) to create a repository in the Amazon Elastic Container Registry (ECR). In Step 4 of the AWS instructions, name the repository {{<nb>}}**nginx-plus-ic**{{</nb>}} as that is what we use in this guide.
5454

5555
2. Run the following AWS CLI command. It generates an auth token for your AWS ECR registry, then pipes it into the `docker login` command. This lets AWS ECR authenticate and authorize the upcoming Docker requests. For details about the command, see the [AWS documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html).
5656

0 commit comments

Comments
 (0)