From 49b12c662d9543f6c531b6e37cd6bbb9473d1577 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Wed, 8 Jan 2025 10:28:30 -0700 Subject: [PATCH 1/2] docs: remove deprecated docs with draft: true value --- .../admin-guide/rbac/add-rbac-with-tagging.md | 98 ------------------- content/nim/deploy/uninstall-guide.md | 64 ------------ content/nim/deploy/upgrade-guide.md | 59 ----------- .../monitoring/count-nginx-plus-instances.md | 81 --------------- content/nim/reference/_index.md | 7 -- content/nim/reference/api/_index.md | 6 -- content/nim/reference/api/api.md | 9 -- content/nim/reference/cli/_index.md | 6 -- content/nim/reference/cli/agent-cli.md | 53 ---------- content/nim/reference/cli/server-cli.md | 49 ---------- .../getting-started/add-sso-integration.md | 3 - content/nms/help.md | 72 -------------- content/nms/reference/api/_index.md | 5 - content/nms/reference/api/api.md | 9 -- content/nms/reference/cli/_index.md | 5 - content/nms/reference/cli/agent-cli.md | 53 ---------- content/nms/reference/cli/server-cli.md | 49 ---------- content/nms/security/_index.md | 17 ---- content/nms/security/about/_index.md | 7 -- .../nms/security/getting-started/_index.md | 7 -- content/nms/security/how-to/_index.md | 6 -- content/nms/security/reference/_index.md | 6 -- content/nms/security/tutorials/_index.md | 6 -- 23 files changed, 677 deletions(-) delete mode 100644 content/nim/admin-guide/rbac/add-rbac-with-tagging.md delete mode 100644 content/nim/deploy/uninstall-guide.md delete mode 100644 content/nim/deploy/upgrade-guide.md delete mode 100644 content/nim/monitoring/count-nginx-plus-instances.md delete mode 100644 content/nim/reference/_index.md delete mode 100644 content/nim/reference/api/_index.md delete mode 100644 content/nim/reference/api/api.md delete mode 100644 content/nim/reference/cli/_index.md delete mode 100644 content/nim/reference/cli/agent-cli.md delete mode 100644 content/nim/reference/cli/server-cli.md delete mode 100644 content/nms/acm/getting-started/add-sso-integration.md delete mode 100644 content/nms/help.md delete mode 100644 content/nms/reference/api/_index.md delete mode 100644 content/nms/reference/api/api.md delete mode 100644 content/nms/reference/cli/_index.md delete mode 100644 content/nms/reference/cli/agent-cli.md delete mode 100644 content/nms/reference/cli/server-cli.md delete mode 100644 content/nms/security/_index.md delete mode 100644 content/nms/security/about/_index.md delete mode 100644 content/nms/security/getting-started/_index.md delete mode 100644 content/nms/security/how-to/_index.md delete mode 100644 content/nms/security/reference/_index.md delete mode 100644 content/nms/security/tutorials/_index.md diff --git a/content/nim/admin-guide/rbac/add-rbac-with-tagging.md b/content/nim/admin-guide/rbac/add-rbac-with-tagging.md deleted file mode 100644 index 24a8dbcee..000000000 --- a/content/nim/admin-guide/rbac/add-rbac-with-tagging.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -description: Deprecated in Instance Manager 2.1.0. This topic explains how to set - up role-based access control with tags in Instance Manager. -docs: DOCS-790 -doctypes: task -draft: true -tags: -- docs -- deprecated -title: (Deprecated) Set Up RBAC with Tagging -toc: true -weight: 1000 ---- - -{{< shortversions "2.0.0" "2.0.1" "nimvers" >}} - -## Overview - -{{< deprecated >}}Adding tags to set up RBAC is deprecated in Instance Manager 2.1.0. To use the new RBAC, refer to the [Set Up RBAC]({{< relref "/nim/admin-guide/rbac/overview-rbac" >}}) guide. -{{< /deprecated >}} - -When [defining a role]({{< relref "/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md#roles" >}}) in Instance Manager, you can use [tags]({{< relref "/nim/nginx-instances/add-tags.md" >}}) to restrict a role's permissions for groups of instances. - -To access an instance with an assigned tag, a role must have `Instance Management` permission, and the permission needs to have a tag matching the instance's. - -{{}} -Changes made to a role may take up to 10 minutes to take effect. - -Admin users can view, add, and change any system tags, as well as any access levels. Non-admin users are restricted to viewing only the roles and tags they've been assigned. - -Untagged instances can be accessed by all users that have the `Instance Management` permission. -{{}} - -## Set Role Permissions Using the API - -To set a role's permissions with tags using the Instance Manager Rest API, send a POST request similar to the following example to the Roles API: - -```shell -curl -X POST "https:///api/platform/v1/roles" -H "Authorization: Bearer " -H "content-type: application/json" -d " -{ - "metadata": { - "description": "Role settings for managers", - "displayName": "manager", - "name": "manager" - }, - "roleDef": { - "permissions": [ - { - "access": "READ", - "scope": "INSTANCE-MANAGEMENT", - "tags": [ - "env:prod" - ] - }, - { - "access": "WRITE", - "scope": "INSTANCE-MANAGEMENT", - "tags": [ - "env:dev" - ] - } - ] - } -}" -``` - -{{}} - -| Parameter | Type | Description | -|--------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `permissions.access` | string | The access level determines the role's ability to access a path or object.

The options are:

• READ: has read-only access (HTTP, GET requests)

• WRITE: has read and write access (POST, PUT, PATCH, DELETE requests) | -| `permissions.scope` | string | Sets the scope the role has access to.

The options are:

• SETTINGS: has access to the Instance Manager settings APIs, including license, users, and roles

• INSTANCE-MANAGEMENT: has access to to the instance management APIs | -| `permissions.tags` | string | Tags are matched to resources in the API to determine access privileges. Tags can only be used with the INSTANCE-MANAGEMENT scope. | - -{{}} - -The example above defines a role with `READ` permission for instances with the `env:prod` tag and `WRITE` permission for instances with the `env:dev` tag. - -For more information about the Roles API, see the Instance Manager REST API Documentation: `https:///ui/docs`. - -## Set Role Permissions Using the Web Interface - -1. In a web browser, go to the FQDN for your F5 NGINX Management Suite host and log in. -2. Select the **Settings** gear icon. -3. In the left menu, select **Roles**. -4. Select **Create**. -5. On the **Create Role** form, complete the following: - - - In the **Name** box, type the name of the role. - - In the **Display Name** box, type a display name for the role. - - In the **Permissions** section, select **Create**. - - In the **Scope** list, select **Instance Management**. - - In the **Access** list, select the access level for the role. The options are `Read` or `Write`. - - In the **Tags** list, select a tag or tags to apply to the role, or select **Add New Tag** to create a tag. - -6. Select **Save**. - -{{< img src="/rbac/role-create-with-tags.png" alt="Role creation: create role with tags." width="600" height="415" >}}
diff --git a/content/nim/deploy/uninstall-guide.md b/content/nim/deploy/uninstall-guide.md deleted file mode 100644 index 0f57dd7b9..000000000 --- a/content/nim/deploy/uninstall-guide.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: This guide explains how to uninstall F5 NGINX Management Suite, including NGINX - Instance Manager. -docs: DOCS-804 -doctypes: task -title: Uninstall Guide -toc: true -weight: 1000 -draft: true ---- - -## F5 NGINX Management Suite {#uninstall-nms} - -{{}} -{{%tab name="CentOS, RHEL, and RPM-Based"%}} - -To uninstall NGINX Management Suite and all of its modules, complete the following steps: - -1. To uninstall NGINX Management Suite, run the following command: - - ```bash - yum remove nms-* - ``` - -2. Stop the ClickHouse service: - - ```bash - sudo systemctl stop clickhouse-server - ``` - -3. To uninstall ClickHouse, run the following command: - - ```bash - yum remove clickhouse-server - ``` - -{{%/tab%}} -{{%tab name="Debian, Ubuntu, and Deb-Based"%}} - -To uninstall NGINX Management suite and all of its modules, complete the following steps: - -1. To uninstall NGINX Management Suite, run the following command: - - ```bash - sudo apt-get remove nms-* - ``` - -2. Stop the ClickHouse service: - - ```bash - sudo systemctl stop clickhouse-server - ``` - -3. To uninstall ClickHouse, run the following command: - - ```bash - sudo apt-get remove clickhouse-server - ``` - - > **Note:** The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. - - -{{%/tab%}} -{{}} diff --git a/content/nim/deploy/upgrade-guide.md b/content/nim/deploy/upgrade-guide.md deleted file mode 100644 index 4ded52430..000000000 --- a/content/nim/deploy/upgrade-guide.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: This guide explains how to upgrade NGINX Instance Manager, NGINX Agent, and NGINX Plus. -docs: DOCS-920 -doctypes: -- tutorial -tags: -- docs -title: Upgrade Guide -toc: true -weight: 600 -draft: true ---- - -## Overview - -This guide explains how to upgrade NGINX Instance Manager, NGINX Agent, and NGINX Plus to their latest versions. It includes steps to back up your current configuration, run the upgrade script, and verify the results. You’ll also find instructions for troubleshooting any potential upgrade issues. - -{{< call-out "tip" "" "">}}Make sure to read the NGINX Instance Manager release notes for important information before upgrading.{{}} - ---- - -## {#pre-upgrade-steps} - -- Review release notes -- - - - -## Upgrade NGINX Instance Manager - -### Instance Manager - -- [Upgrade Instance Manager on a virtual machine or bare metal]({{< relref "/nim/deploy/vm-bare-metal/install.md#upgrade-nim" >}}) -- [Upgrade Instance Manager from a Helm Chart]({{< relref "/nim/deploy/kubernetes/deploy-using-helm.md#helm-upgrade-nim" >}}) -- [Upgrade Instance Manager in an offline environment]({{< relref "/nim/disconnected/offline-install-guide.md#upgrade-nim-offline" >}}) - -### Security Monitoring - -- [Upgrade Security Monitoring on a virtual machine or bare metal]({{< relref "/nim/monitoring/security-monitoring/deploy/install-security-monitoring.md#upgrade-security-monitoring" >}}) - ---- - -## Upgrade NGINX Agent {#upgrade-nginx-agent} - -To upgrade NGINX Agent, refer to the [NGINX Agent Installation and Upgrade Guide](https://docs.nginx.com/nginx-agent/installation-upgrade/). - ---- - -## Upgrade NGINX Plus - -For instructions on upgrading NGINX Plus, see the [NGINX Plus Installation and Upgrade Guide](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/). - ---- - -## Troubleshooting - -If you encounter problems with the upgrade, you can [create a support package]({{< relref "/nms/support/support-package.md" >}}). The support package script compiles system and service information into a tar archive for troubleshooting. If you contact [NGINX Customer Support]({{< relref "/nms/support/contact-support.md" >}}), they may ask you to provide the support package file. - -The [AskF5 knowledge base](https://support.f5.com/csp/home) is a helpful resource for articles related to upgrade issues and solutions. \ No newline at end of file diff --git a/content/nim/monitoring/count-nginx-plus-instances.md b/content/nim/monitoring/count-nginx-plus-instances.md deleted file mode 100644 index cf31404a8..000000000 --- a/content/nim/monitoring/count-nginx-plus-instances.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -description: Tracking your [NGINX Plus]({{< relref "nginx/" >}}) installations is - straightforward with [NGINX Instance Manager]({{< relref "nim/" - >}}). If you're enrolled in a commercial program like the [F5 Flex Consumption Program](https://www.f5.com/products/get-f5/flex-consumption-program), - you'll need to regularly report this data to F5. -docs: DOCS-934 -doctypes: -- task -tags: -- docs -title: Tracking NGINX Plus installations for compliance -toc: true -weight: 1000 -draft: true ---- - -## Overview - -Tracking your [NGINX Plus]({{< relref "nginx/" >}}) installations is - straightforward with [NGINX Instance Manager]({{< relref "nim/" - >}}). If you're enrolled in a commercial program like the [F5 Flex Consumption Program](https://www.f5.com/products/get-f5/flex-consumption-program), - you'll need to regularly report this data to F5. - -{{< include "nginx-plus/usage-tracking/overview.md" >}} - -## Prerequisites - -### Install F5 NGINX Instance Manager on a dedicated host {#install-instance-manager} - -{{< include "nginx-plus/usage-tracking/install-nim.md" >}} - - -## View your NGINX Plus and NGINX App Protect Inventory - -After you've installed NGINX Instance Manager, the next step involves configuring your NGINX Plus data plane to report back. This can be done in two ways. First, you can install NGINX Agent on each instance. Alternatively, for an agentless approach, you can set up HTTP Health Checks, which don't require additional installations. Both methods enable your instances to communicate with Instance Manager. - -### Set up instance reporting for NGINX Plus {#set-up-reporting} - -Select the tab that matches your preferred method for setting up reporting: - -- Configure native usage reporting (since NGINX Plus [Release 31]({{< relref "/nginx/releases.md#nginxplusrelease-31-r31" >}})) -- Install NGINX Agent -- Configure HTTP Health Check for NGINX Plus without NGINX Agent - -{{}} - -{{%tab name="Native Usage Reporting"%}} - -{{< include "nginx-plus/usage-tracking/agentless-reporting.md" >}} - -{{%/tab%}} - -{{%tab name="NGINX Agent"%}} - -{{< include "nginx-plus/usage-tracking/install-nginx-agent.md" >}} - -{{%/tab%}} - -{{%tab name="HTTP Health Check"%}} - -{{< include "nginx-plus/usage-tracking/http-health-check.md" >}} - -{{%/tab%}} - -{{}} - -### Reporting your NGINX Plus inventory to F5 {#view-nginx-plus-usage} - -{{< include "nginx-plus/usage-tracking/view-nginx-plus-count.md" >}} - -## View your NGINX Ingress Controller instances and nodes - -You can set up your Kubernetes-based NGINX Plus products, including [NGINX Ingress Controller](https://www.nginx.com/products/nginx-ingress-controller/) and [Connectivity Stack for Kubernetes](https://www.nginx.com/solutions/kubernetes/), to report usage data to NGINX Instance Manager. - -### Set up usage reporting for NGINX Ingress Controller - -Follow the instructions in the [Enabling Usage Reporting](https://docs.nginx.com/nginx-ingress-controller/usage-reporting/) guide to enable usage reporting for NGINX Ingress Controller. - -### Reporting your NGINX Ingress Controller clusters to F5 - -{{< include "nginx-plus/usage-tracking/get-list-k8s-deployments.md" >}} diff --git a/content/nim/reference/_index.md b/content/nim/reference/_index.md deleted file mode 100644 index ebefe9a4f..000000000 --- a/content/nim/reference/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -description: "This section includes the reference documentation for the Instance Manager." -title: Reference -weight: 750 -url: /nginx-instance-manager/reference/ -draft: true ---- diff --git a/content/nim/reference/api/_index.md b/content/nim/reference/api/_index.md deleted file mode 100644 index 595d156c8..000000000 --- a/content/nim/reference/api/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: API -description: API docs -draft: true -url: /nginx-instance-manager/reference/api/ ---- \ No newline at end of file diff --git a/content/nim/reference/api/api.md b/content/nim/reference/api/api.md deleted file mode 100644 index b0339b951..000000000 --- a/content/nim/reference/api/api.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: Instance Manager API Reference -docs: DOCS-809 -draft: true -title: API Reference -toc: true -weight: 300 ---- - diff --git a/content/nim/reference/cli/_index.md b/content/nim/reference/cli/_index.md deleted file mode 100644 index e25f5b764..000000000 --- a/content/nim/reference/cli/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: CLI Reference -description: Command-line reference docs -draft: true -url: /nginx-instance-manager/reference/cli/ ---- \ No newline at end of file diff --git a/content/nim/reference/cli/agent-cli.md b/content/nim/reference/cli/agent-cli.md deleted file mode 100644 index 438f8fb69..000000000 --- a/content/nim/reference/cli/agent-cli.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Man page and instructions for using the NGINX Agent CLI -docs: DOCS-814 -draft: true -title: Agent CLI Reference -toc: true -weight: 300 ---- - - - - -{{< shortversions "2.0.0" "latest" "nimvers" >}} - -{{%heading "overview"%}} - -This document is intended to help people run NGINX Agent on the command line. The agent runs as a linux daemon and sends information to the Instance Manager server over grpc polling every 1 seconds. - -## Prerequisites {#prerequisites} - -Install NGINX Agent and know where the binary location is. By default the packager installs nginx-manager to /usr/sbin/nginx-agent. - -## Usage {#usage} - -`nginx-agent` is the CLI binary for NGINX agent. - -```bash -Usage: - nginx-agent [flags] - -Flags: - --api-token string set token to auth to commander & metrics service - --config-dirs string set comma-separated list of allowed config directories (default "/etc/nginx") - -h, --help help for nginx-agent - --log-level string set log level (panic, fatal, error, info, debug, trace, info) (default "info") - --log-path string set log path. If empty, logs only to stdout/stderr instead (default "/var/log/nginx-agent") - --metadata stringToString set metadata for the specific instance/machine. Each entry is a key/value pair separated by an equals sign. (default []) - --metrics-mode string set type of nginx metrics collected (nim, controller) (default "nim") - --metrics-server string set gRPC port of the metrics server to connect to - --nginx-bin-path string set path to the NGINX Binary - --nginx-exclude-logs string set comma-separated list of NGINX access log paths to exclude from metrics - --nginx-metrics-poll-interval duration set metrics poll interval (default 1s) - --nginx-pid-path string set path to the NGINX PID file - --nginx-plus-api string set NGINX plus status api URL (see nginx.org/r/api) - --nginx-stub-status string set NGINX stub status URL (see: nginx.org/r/stub_status) - --server string set gRPC port of the server to connect to (default "localhost:10000") - --tags strings set comma-separated list of tags for this specific instance / machine for inventory purposes - --tls-ca string set path to CA certificate file - --tls-cert string set path to certificate file - --tls-enable set to True for grpcs or False for offloading grpc without encrypting grpcs on nginx-manager. Omit for no encryption. - --tls-key string set path to the certificate key file - -v, --version version for nginx-agent -``` diff --git a/content/nim/reference/cli/server-cli.md b/content/nim/reference/cli/server-cli.md deleted file mode 100644 index 4e0bb0961..000000000 --- a/content/nim/reference/cli/server-cli.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: Man page and instructions for using the Instance Manager CLI -docs: DOCS-815 -draft: true -title: Server CLI Reference -toc: true -weight: 300 ---- - - - - -{{< shortversions "2.0.0" "latest" "nimvers" >}} - -{{%heading "overview"%}} - -This document is intended to help people run Instance Manager on the command line. - -## Prerequisites {#prerequisites} - -Install Instance Manager and know where the binary location is. By default the packager installs nginx-manager to /usr/sbin/nginx-manager. - -## Usage {#usage} - -`nginx-manager` is the CLI binary for Instance Manager. - -```bash -Usage: - nginx-manager [flags] - -Flags: - --audit-log string set API access log path - --auth enable auth checks on server - --bind-address string set the bind address for all service ports (default "localhost") - --cert string Path to x.509 certificate file - --gateway-port string set gRPC-gateway service port for API and UI (default "11000") - --grpc-port string set gRPC service port for agent communication (default "10000") - -h, --help help for nginx-manager - --key string set path to x.509 certificate key file - --license string set path to the license file - --log-level string set log level (panic, fatal, error, info, debug, trace, info) (default "info") - --log-path string set log path and if empty log only to stdout/stderr (default "/var/log/nginx-manager/") - --login enable temp login page - --metrics-storage-path string set storage path on disk for metrics (default "/tmp/metrics") - --rbac enable Role-Based Access Control - --server-name string set the bind address for all service ports - --skip-validation disable NGINX config validation in editor - -v, --version version for nginx-manager -``` diff --git a/content/nms/acm/getting-started/add-sso-integration.md b/content/nms/acm/getting-started/add-sso-integration.md deleted file mode 100644 index 4d6e3deb2..000000000 --- a/content/nms/acm/getting-started/add-sso-integration.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -draft: true ---- diff --git a/content/nms/help.md b/content/nms/help.md deleted file mode 100644 index 4f06da923..000000000 --- a/content/nms/help.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -_build: - list: never - publishResources: true - render: always -description: F5 NGINX Management Suite documentation and help. -docs: DOCS-898 -doctypes: -- reference -- troubleshooting -title: Help -toc: false -draft: true ---- - -## Overview - -F5 NGINX Management Suite is a family of management plane solutions that enable governance of the data plane to easily scale, secure, and monitor applications and APIs. It consists of: - -- **Instance Manager:** Configure, scale, and manage NGINX Open Source, NGINX Plus, and NGINX App Protect WAF instances. - -- **Security Monitoring:** Monitor NGINX App Protect WAF instances, analyze possible threats and identify opportunities for tuning your security policies. - -## Documentation Sections - -The documentation for NGINX Management Suite is divided into the following sections: - -### [Admin Guides]({{< relref "/nim/admin-guide/" >}}) - -- Learn how to install NGINX Management Suite and configure user access. - -### [Tech Specs]({{< relref "/nim/fundamentals/tech-specs" >}}) - -- Learn about the requirements for NGINX Management Suite. - -### [NGINX Agent]({{< relref "/nms/nginx-agent/" >}}) - -- Learn how to install and configure the NGINX Agent. - -### [Instance Manager]({{< relref "/nim/" >}}) - -- Learn how to configure and use Instance Manager. - -### [Security Monitoring]({{< relref "/nms/security/" >}}) - -- Learn how to configure and use the Security Monitoring module. - -### [Support]({{< relref "/nms/support/" >}}) - -- Learn how to get support for NGINX Management Suite. - -## Popular Topics - -Check out some of our most consulted topics: - -### [Install Guide]({{< relref "/nim/deploy/_index.md" >}}) - -- Complete the steps in this guide to install NGINX Management Suite. - -### [Upgrade Guide]({{< relref "/nim/deploy/uninstall-guide.md" >}}) - -- This guide explains how to upgrade NGINX Management Suite and NGINX Agent. - -### [Tech Specs]({{< relref "/nim/fundamentals/tech-specs" >}}) - -- This document lists the requirements for NGINX Management Suite, including supported platforms, hardware specs, sizing guidelines, supported browsers, and more. - ---- - -## What's Next - -- [Get support for NGINX Management Suite]({{< relref "/nms/support/" >}}) diff --git a/content/nms/reference/api/_index.md b/content/nms/reference/api/_index.md deleted file mode 100644 index a66954b99..000000000 --- a/content/nms/reference/api/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: API -description: API docs -draft: true ---- \ No newline at end of file diff --git a/content/nms/reference/api/api.md b/content/nms/reference/api/api.md deleted file mode 100644 index b0339b951..000000000 --- a/content/nms/reference/api/api.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: Instance Manager API Reference -docs: DOCS-809 -draft: true -title: API Reference -toc: true -weight: 300 ---- - diff --git a/content/nms/reference/cli/_index.md b/content/nms/reference/cli/_index.md deleted file mode 100644 index b6437e7d8..000000000 --- a/content/nms/reference/cli/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: CLI Reference -description: Command-line reference docs -draft: true ---- \ No newline at end of file diff --git a/content/nms/reference/cli/agent-cli.md b/content/nms/reference/cli/agent-cli.md deleted file mode 100644 index 438f8fb69..000000000 --- a/content/nms/reference/cli/agent-cli.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Man page and instructions for using the NGINX Agent CLI -docs: DOCS-814 -draft: true -title: Agent CLI Reference -toc: true -weight: 300 ---- - - - - -{{< shortversions "2.0.0" "latest" "nimvers" >}} - -{{%heading "overview"%}} - -This document is intended to help people run NGINX Agent on the command line. The agent runs as a linux daemon and sends information to the Instance Manager server over grpc polling every 1 seconds. - -## Prerequisites {#prerequisites} - -Install NGINX Agent and know where the binary location is. By default the packager installs nginx-manager to /usr/sbin/nginx-agent. - -## Usage {#usage} - -`nginx-agent` is the CLI binary for NGINX agent. - -```bash -Usage: - nginx-agent [flags] - -Flags: - --api-token string set token to auth to commander & metrics service - --config-dirs string set comma-separated list of allowed config directories (default "/etc/nginx") - -h, --help help for nginx-agent - --log-level string set log level (panic, fatal, error, info, debug, trace, info) (default "info") - --log-path string set log path. If empty, logs only to stdout/stderr instead (default "/var/log/nginx-agent") - --metadata stringToString set metadata for the specific instance/machine. Each entry is a key/value pair separated by an equals sign. (default []) - --metrics-mode string set type of nginx metrics collected (nim, controller) (default "nim") - --metrics-server string set gRPC port of the metrics server to connect to - --nginx-bin-path string set path to the NGINX Binary - --nginx-exclude-logs string set comma-separated list of NGINX access log paths to exclude from metrics - --nginx-metrics-poll-interval duration set metrics poll interval (default 1s) - --nginx-pid-path string set path to the NGINX PID file - --nginx-plus-api string set NGINX plus status api URL (see nginx.org/r/api) - --nginx-stub-status string set NGINX stub status URL (see: nginx.org/r/stub_status) - --server string set gRPC port of the server to connect to (default "localhost:10000") - --tags strings set comma-separated list of tags for this specific instance / machine for inventory purposes - --tls-ca string set path to CA certificate file - --tls-cert string set path to certificate file - --tls-enable set to True for grpcs or False for offloading grpc without encrypting grpcs on nginx-manager. Omit for no encryption. - --tls-key string set path to the certificate key file - -v, --version version for nginx-agent -``` diff --git a/content/nms/reference/cli/server-cli.md b/content/nms/reference/cli/server-cli.md deleted file mode 100644 index 4e0bb0961..000000000 --- a/content/nms/reference/cli/server-cli.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: Man page and instructions for using the Instance Manager CLI -docs: DOCS-815 -draft: true -title: Server CLI Reference -toc: true -weight: 300 ---- - - - - -{{< shortversions "2.0.0" "latest" "nimvers" >}} - -{{%heading "overview"%}} - -This document is intended to help people run Instance Manager on the command line. - -## Prerequisites {#prerequisites} - -Install Instance Manager and know where the binary location is. By default the packager installs nginx-manager to /usr/sbin/nginx-manager. - -## Usage {#usage} - -`nginx-manager` is the CLI binary for Instance Manager. - -```bash -Usage: - nginx-manager [flags] - -Flags: - --audit-log string set API access log path - --auth enable auth checks on server - --bind-address string set the bind address for all service ports (default "localhost") - --cert string Path to x.509 certificate file - --gateway-port string set gRPC-gateway service port for API and UI (default "11000") - --grpc-port string set gRPC service port for agent communication (default "10000") - -h, --help help for nginx-manager - --key string set path to x.509 certificate key file - --license string set path to the license file - --log-level string set log level (panic, fatal, error, info, debug, trace, info) (default "info") - --log-path string set log path and if empty log only to stdout/stderr (default "/var/log/nginx-manager/") - --login enable temp login page - --metrics-storage-path string set storage path on disk for metrics (default "/tmp/metrics") - --rbac enable Role-Based Access Control - --server-name string set the bind address for all service ports - --skip-validation disable NGINX config validation in editor - -v, --version version for nginx-manager -``` diff --git a/content/nms/security/_index.md b/content/nms/security/_index.md deleted file mode 100644 index b474d8a49..000000000 --- a/content/nms/security/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Security Monitoring -weight: 700 -url: /nginx-management-suite/security/ ---- - - - -You can use F5 NGINX Management Suite Security Monitoring to monitor NGINX App Protect WAF. The module provides analytics dashboards and security log details that provide protection insights and help you analyze possible threats or identify opportunities for tuning your security policies. - -
diff --git a/content/nms/security/about/_index.md b/content/nms/security/about/_index.md deleted file mode 100644 index a436b32c4..000000000 --- a/content/nms/security/about/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -description: "Learn about Security Monitoring" -title: About -weight: 100 -draft: true ---- - diff --git a/content/nms/security/getting-started/_index.md b/content/nms/security/getting-started/_index.md deleted file mode 100644 index 71eb3b44a..000000000 --- a/content/nms/security/getting-started/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -description: "Learn how to get up and running with F5 NGINX Management Security Monitoring" -title: Quick Start Guides -weight: 400 -draft: true ---- - diff --git a/content/nms/security/how-to/_index.md b/content/nms/security/how-to/_index.md deleted file mode 100644 index 4a34abb5a..000000000 --- a/content/nms/security/how-to/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: How-To Guides -weight: 500 -description: "Task-oriented topics that focus on how to use F5 NGINX Management Suite Security Monitoring." -url: /nginx-management-suite/security/how-to/ ---- \ No newline at end of file diff --git a/content/nms/security/reference/_index.md b/content/nms/security/reference/_index.md deleted file mode 100644 index 8d3702a0c..000000000 --- a/content/nms/security/reference/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Reference -description: "Reference documentation for F5 NGINX Management Suite Security Monitoring." -weight: 750 -draft: true ---- \ No newline at end of file diff --git a/content/nms/security/tutorials/_index.md b/content/nms/security/tutorials/_index.md deleted file mode 100644 index 212454f54..000000000 --- a/content/nms/security/tutorials/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -description: "The guides in this section feature end-to-end examples that will help you get the most out of F5 NGINX Management Suite Security Monitoring." -title: Tutorials -weight: 600 -draft: true ---- From 7dea5c4c7a38d075e07d7fead1d0bfa56f525aa9 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Wed, 8 Jan 2025 11:02:31 -0700 Subject: [PATCH 2/2] fix: remove broken links --- .../nginx-app-protect/overview-nap-waf-config-management.md | 1 - content/nim/nginx-app-protect/setup-waf-config-management.md | 2 +- content/nms/about.md | 4 ++-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/content/nim/nginx-app-protect/overview-nap-waf-config-management.md b/content/nim/nginx-app-protect/overview-nap-waf-config-management.md index d1b7794c2..8639aa5fd 100644 --- a/content/nim/nginx-app-protect/overview-nap-waf-config-management.md +++ b/content/nim/nginx-app-protect/overview-nap-waf-config-management.md @@ -22,7 +22,6 @@ You can use NGINX App Protect WAF with Instance Manager to inspect incoming traf - Manage NGINX App Protect WAF security configurations by using the NGINX Management Suite user interface or REST API - Update Attack Signatures and Threat Campaign packages - Compile security configurations into a binary bundle for consumption by NGINX App Protect WAF instances -- Provide metrics to the [NGINX Management Suite Security Monitoring]({{< relref "/nms/security/" >}}) module. The Security Monitoring module lets you monitor the security of your applications and APIs and get protection insights that help when analyzing possible threats and tuning security policies. ## Architecture diff --git a/content/nim/nginx-app-protect/setup-waf-config-management.md b/content/nim/nginx-app-protect/setup-waf-config-management.md index 19983ca37..71bbe7256 100644 --- a/content/nim/nginx-app-protect/setup-waf-config-management.md +++ b/content/nim/nginx-app-protect/setup-waf-config-management.md @@ -916,7 +916,7 @@ server { } ``` -{{< note >}}If you're using the NGINX Management Suite [Security Monitoring module]({{< relref "/nms/security/" >}}), you should already have the `app_protect_security_log` directive set to reference the `secops_dashboard.tgz` file as shown below. Do not change this setting. +{{< note >}}If you're using the NGINX Management Suite Security Monitoring module, you should already have the `app_protect_security_log` directive set to reference the `secops_dashboard.tgz` file as shown below. Do not change this setting. ```nginx app_protect_security_log "/etc/nms/secops_dashboard.tgz" syslog:server=127.0.0.1:514; diff --git a/content/nms/about.md b/content/nms/about.md index ed2dd5df5..1159cae2a 100644 --- a/content/nms/about.md +++ b/content/nms/about.md @@ -18,7 +18,7 @@ Explore the topics below to find out what the F5 NGINX Management Suite modules [NGINX Instance Manager]({{< relref "/nim/">}}) allows you to configure, scale, and manage NGINX Open Source and NGINX Plus instances at scale. Instance Manager provides a [REST API]({{< relref "/nim/fundamentals/api-overview">}}) and web-based graphical user interface (GUI) for managing NGINX instances across multiple servers, making it easier to configure, monitor, and troubleshoot NGINX deployments. -Instance Manager can be used to manage instances running on-premises, in the cloud, or in hybrid environments, and it supports the deployment of NGINX instances on a variety of operating systems and container platforms. +Instance Manager can be used to manage instances running on-premises, in the cloud, or in hybrid environments, and it supports the deployment of NGINX instances on a variety of operating systems and container platforms. Instance Manager also includes advanced features like health checks, rolling updates, and configuration backups, which help to ensure the reliability and security of NGINX deployments. @@ -38,7 +38,7 @@ Instance Manager provides the following features: ## Security Monitoring {#security-monitoring} -[Security Monitoring]({{< relref "/nms/security/">}}) allows you to monitor NGINX App Protect WAF with analytics dashboards and security log details to get protection insights for analyzing possible threats or areas for tuning policies. +Security Monitoring allows you to monitor NGINX App Protect WAF with analytics dashboards and security log details to get protection insights for analyzing possible threats or areas for tuning policies. ### Security Monitoring Key Features