Skip to content

Commit 6d87a70

Browse files
travisamartintravisamartin
authored
Merge pull request #192 from nginx/internal/191-nim-2.20-script-updates
Internal/191 nim 2.20 script updates
2 parents 2b6eb67 + ed0d959 commit 6d87a70

37 files changed

+1166
-162
lines changed

‎cleanup_log.txt

Lines changed: 929 additions & 0 deletions
Large diffs are not rendered by default.

‎content/includes/nginx-plus/usage-tracking/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Start by installing NGINX Instance Manager on a dedicated host. Then, configure
66

77

88
{{<call-out tip "Tip for Automated Reporting">}}
9-
To set up automatic reporting, [add your JWT-based license to NGINX Instance Manager]({{< ref "/nim/admin-guide/license/add-license.md#apply-jwt-license" >}}). This license can be downloaded from [MyF5](https://account.f5.com/myf5) if needed.
9+
To set up automatic reporting, [add your JWT-based license to NGINX Instance Manager]({{< ref "/nim/admin-guide/add-license.md#apply-jwt-license" >}}). This license can be downloaded from [MyF5](https://account.f5.com/myf5) if needed.
1010
{{</call-out>}}

‎content/includes/nim/admin-guide/license/connected-install-license-note.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ docs:
44

55
A valid license is required to make full use of all the features in NGINX Instance Manager.
66

7-
Refer to the [Add a License]({{< ref "nim/admin-guide/license/add-license.md" >}}) topic for instructions on how to download and apply a trial license, subscription license, or Flexible Consumption Program license.
7+
Refer to the [Add a License]({{< ref "nim/admin-guide/add-license.md" >}}) topic for instructions on how to download and apply a trial license, subscription license, or Flexible Consumption Program license.

‎content/includes/nim/clickhouse/cli-skip-clickhouse.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,4 @@ files:
55
- content/nim/disconnected/offline-install-guide.md
66
---
77

8-
{{< call-out "note" "Optional: Disable metrics collection" "" >}}
9-
To skip downloading and installing ClickHouse, add the `-s` flag to the script. This is useful if you do not plan to collect metrics.
10-
11-
If you skip ClickHouse, make sure to [disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}) in the `/etc/nms/nms.conf` configuration file after installing NGINX Instance Manager.
12-
{{< /call-out >}}
8+
If you skip installing ClickHouse, make sure to [disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}) in the `/etc/nms/nms.conf` file after installation.

‎content/includes/nim/installation/install-script-flags/cert.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
docs:
3+
files:
4+
- content/nim/deploy/vm-bare-metal/install.md
5+
- content/nim/disconnected/offline-install-guide.md
6+
---
7+
8+
`-c <path/to/nginx-repo.crt>`: Path to the SSL certificate file. (default: `/etc/ssl/nginx`)

‎content/includes/nim/installation/install-script-flags/clickhouse-version.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
docs:
3+
files:
4+
- content/nim/deploy/vm-bare-metal/install.md
5+
- content/nim/disconnected/offline-install-guide.md
6+
---
7+
8+
`-v <clickhouse-version>`: Install a specific version of ClickHouse. If not set, version `{{< clickhouse-version >}}` is installed by default.

‎content/includes/nim/installation/install-script-flags/distribution.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
docs:
3+
files:
4+
- content/nim/deploy/vm-bare-metal/install.md
5+
- content/nim/disconnected/offline-install-guide.md
6+
---
7+
8+
`-d <distribution>`: Target Linux distribution (for example, `ubuntu22.04`, `rhel8`)
9+
10+
To see the list of supported distributions, run:
11+
12+
```shell
13+
grep '\-d distribution' install-nim-bundle.sh
14+
```

‎content/includes/nim/installation/install-script-flags/key.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
docs:
3+
files:
4+
- content/nim/deploy/vm-bare-metal/install.md
5+
- content/nim/disconnected/offline-install-guide.md
6+
---
7+
8+
`-k <path/to/nginx-repo.key>`: Path to the private key file. (default: `/etc/ssl/nginx`)

‎content/includes/nim/installation/install-script-flags/skip-clickhouse.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
docs:
3+
files:
4+
- content/nim/deploy/vm-bare-metal/install.md
5+
- content/nim/disconnected/offline-install-guide.md
6+
---
7+
8+
`-s`: Skip installing ClickHouse (useful if you don’t require metrics).
9+
10+
{{< include "nim/clickhouse/cli-skip-clickhouse.md" >}}

‎content/includes/nim/tech-specs/supported-distros.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
docs: DOCS-1071
3+
files:
4+
- content/nim/fundamentals/tech-specs.md
35
---
46

57
The following table lists the Linux distributions supported by NGINX Instance Manager and NGINX App Protect:

‎content/includes/nim/tech-specs/supported-nginx-versions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
docs: DOCS-1075
3+
files:
4+
- content/nim/fundamentals/tech-specs.md
35
---
46

57
NGINX Instance Manager supports the following NGINX Open Source and NGINX Plus versions:
@@ -8,7 +10,7 @@ NGINX Instance Manager supports the following NGINX Open Source and NGINX Plus v
810

911
| NGINX Instance Manager | NGINX OSS | NGINX Plus |
1012
| ---------------------- | ----------- | ---------- |
11-
| 2.18.0 and later | 1.18–1.25.1 | R31–R33 |
13+
| 2.18.0 and later | 1.18–1.28.0 | R31–R34 |
1214
| 2.16.0–2.17.x | 1.18–1.25.1 | R31–R32 |
1315
| 2.7.0–2.15.x | 1.18–1.25.1 | R21–R30 |
1416
| 2.0.0–2.6.0 | 1.18–1.21.6 | R21–R27 |

‎content/nim/admin-guide/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Platform administration
2+
title: Administer your platform
33
weight: 40
44
url: /nginx-instance-manager/admin-guide/
55
---

‎content/nim/admin-guide/license/add-license.md renamed to ‎content/nim/admin-guide/add-license.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
22
docs: DOCS-789
3-
title: Add license
3+
title: Add a license (connected)
44
toc: true
5-
weight: 1
5+
weight: 10
66
type:
77
- how-to
88
---
99

10+
{{< note >}}For disconnected environments, see [Add a license (disconnected)]({{< ref "nim/disconnected/add-license-disconnected-deployment.md" >}}).{{< /note >}}
11+
1012
## Overview
1113

1214
To unlock all of the features in NGINX Instance Manager, you’ll need to add a JSON Web Token (JWT) license from MyF5. This guide shows you how to set up your network for reporting, download the license file, and apply it to NGINX Instance Manager. If needed, you can also cancel the license at any time.

‎content/nim/admin-guide/license/_index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎content/nim/admin-guide/rbac/overview-rbac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following are essential concepts related to RBAC:
2424

2525
## Features {#features}
2626

27-
NGINX Instance Manager provides a range of capabilities called features, which system administrators can manage using role-based access control (RBAC). The availability of some features depends on your license. For more information on licensing, see the [Add a license]({{< ref "/nim/admin-guide/license/add-license.md" >}}) topic.
27+
NGINX Instance Manager provides a range of capabilities called features, which system administrators can manage using role-based access control (RBAC). The availability of some features depends on your license. For more information on licensing, see the [Add a license]({{< ref "/nim/admin-guide/add-license.md" >}}) topic.
2828

2929
### NGINX Instance Manager features
3030

‎content/nim/admin-guide/license/report-usage-connected-deployment.md renamed to ‎content/nim/admin-guide/report-usage-connected-deployment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Report usage data to F5
2+
title: Report usage data to F5 (connected)
33
draft: false
44
description: ''
5-
weight: 10
5+
weight: 20
66
toc: true
77
docs: DOCS-1650
88
personas:
@@ -14,6 +14,8 @@ type:
1414
- how-to
1515
---
1616

17+
{{< note >}}For disconnected environments, see [Report usage data to F5 (disconnected)]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}}).{{< /note >}}
18+
1719
## Overview
1820

1921
In environments where NGINX Instance Manager has internet access but NGINX Plus doesn’t, NGINX Plus sends usage data to NGINX Instance Manager. NGINX Instance Manager will automatically send the usage reports to F5 for verification, or you can choose to send them manually.
@@ -22,8 +24,6 @@ In environments where NGINX Instance Manager has internet access but NGINX Plus
2224

2325
See the steps below to configure NGINX Plus to report usage data to NGINX Instance Manager and how to submit the report to F5 for verification.
2426

25-
{{<call-out "tip" "For network-restricted environments:" "" >}}If your deployment of NGINX Instance Manager doesn’t allow internet access, follow the steps in [Report usage data in network-restricted environments]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}}) to report usage data to F5.{{</call-out>}}
26-
2727
---
2828

2929
## Before you begin
@@ -49,7 +49,7 @@ To configure NGINX Plus (R33 and later) to report usage data to NGINX Instance M
4949

5050
### Automatic reporting
5151

52-
When you [add your JSON Web Token (JWT)]({{< ref "nim/admin-guide/license/add-license.md" >}}) to NGINX Instance Manager, usage reporting is enabled by default.
52+
When you [add your JSON Web Token (JWT)]({{< ref "nim/admin-guide/add-license.md" >}}) to NGINX Instance Manager, usage reporting is enabled by default.
5353

5454
NGINX Instance Manager will automatically report subscription entitlement and usage data to F5 if internet access is available.
5555

‎content/nim/deploy/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Deploy
2+
title: Deploy in a connected environment
33
description:
44
weight: 20
55
url: /nginx-instance-manager/deploy/

‎content/nim/deploy/kubernetes/deploy-using-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ The status should show `STATUS: deployed` if successful.
246246

247247
A valid license is required to use all NGINX Instance Manager features.
248248

249-
For instructions on downloading and applying a license, see [Add a License]({{< ref "/nim/admin-guide/license/add-license.md" >}}).
249+
For instructions on downloading and applying a license, see [Add a License]({{< ref "/nim/admin-guide/add-license.md" >}}).
250250

251251
---
252252

‎content/nim/deploy/vm-bare-metal/install-nim-deprecated.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: ''
33
docs: DOCS-1211
4-
title: Manually install on a virtual machine or bare metal (deprecated)
4+
title: Manually install any version of NGINX Instance Manager
55
toc: true
66
weight: 10
77
noindex: true
@@ -11,10 +11,7 @@ type:
1111

1212
## Overview
1313

14-
Follow the steps in this guide to install or upgrade NGINX Instance Manager.
15-
16-
{{<call-out "caution" "Deprecated documentation notice" "fa fa-exclamation-triangle" >}}
17-
This document outlines manual steps that have been replaced by a simplified script-based process. For most users, we recommend using the updated process documented [here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}).{{</call-out>}}
14+
Follow the steps in this guide to install or upgrade a specific version of NGINX Instance Manager.
1815

1916
## Before You Begin
2017

0 commit comments

Comments
 (0)