From 107ddd29f53e9606ca0ff22652dae39dc03f7fdf Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Mon, 15 Dec 2025 17:19:02 +0000 Subject: [PATCH] chore: update NIM metadata --- content/nim/_index.md | 1 + content/nim/admin-guide/add-license.md | 4 ++-- .../basic-auth/set-up-basic-authentication.md | 4 ++-- .../authentication/oidc/keycloak-setup.md | 4 ++-- .../oidc/microsoft-entra-automation.md | 4 ++-- .../authentication/oidc/microsoft-entra-setup.md | 1 + .../authentication/oidc/scim-provisioning.md | 4 ++-- .../maintenance/backup-and-recovery.md | 2 ++ .../maintenance/sqlite-installation.md | 2 ++ content/nim/admin-guide/rbac/assign-roles.md | 4 ++-- content/nim/admin-guide/rbac/create-roles.md | 4 ++-- .../admin-guide/rbac/manage-resource-groups.md | 4 ++-- content/nim/admin-guide/rbac/overview-rbac.md | 4 ++-- .../report-usage-connected-deployment.md | 6 +++--- ...eploy-nginx-instance-manager-docker-compose.md | 4 ++-- .../docker/deploy-nginx-plus-and-agent-docker.md | 4 ++-- .../infrastructure-as-code/build-and-deploy.md | 4 ++-- .../infrastructure-as-code/configuration.md | 4 ++-- .../nim/deploy/infrastructure-as-code/overview.md | 4 ++-- .../nim/deploy/kubernetes/deploy-using-helm.md | 4 ++-- .../kubernetes/frequently-used-helm-configs.md | 4 ++-- .../nim/deploy/kubernetes/helm-config-settings.md | 3 +-- content/nim/deploy/vm-bare-metal/install.md | 4 ++-- .../disconnected/offline-install-guide-manual.md | 4 ++-- content/nim/disconnected/offline-install-guide.md | 4 ++-- .../report-usage-disconnected-deployment.md | 6 +++--- content/nim/fundamentals/api-overview.md | 4 ++-- content/nim/fundamentals/dashboard-overview.md | 4 ++-- content/nim/fundamentals/tech-specs.md | 4 ++-- content/nim/monitoring/catalogs/dimensions.md | 4 ++-- content/nim/monitoring/catalogs/events.md | 4 ++-- content/nim/monitoring/catalogs/metrics.md | 4 ++-- content/nim/monitoring/metrics-api.md | 4 ++-- content/nim/monitoring/overview-metrics.md | 4 ++-- .../concepts/augment-templates.md | 6 +++--- .../config-templates/concepts/config-templates.md | 6 +++--- .../concepts/default-base-template.md | 6 +++--- .../concepts/template-resources.md | 6 +++--- .../how-to/manage-nginx-configs-with-templates.md | 6 +++--- .../rbac-config-templates-and-submissions.md | 6 +++--- .../reference/json-schema-reference.md | 6 +++--- .../tutorials/round-robin-reverse-proxy.md | 4 ++-- .../publish-configs-version-control.md | 2 ++ content/nim/nginx-configs/publish-configs.md | 4 ++-- content/nim/nginx-configs/stage-configs.md | 4 ++-- content/nim/nginx-instances/add-tags.md | 4 ++-- .../nim/nginx-instances/manage-certificates.md | 4 ++-- .../nim/nginx-instances/manage-instance-groups.md | 4 ++-- content/nim/releases/known-issues.md | 2 ++ ...ve-access-to-security-monitoring-dashboards.md | 4 ++-- .../nim/security-monitoring/troubleshooting.md | 4 ++-- content/nim/security-monitoring/update-geo-db.md | 4 ++-- .../nim/security-monitoring/update-signatures.md | 4 ++-- content/nim/support/contact-support.md | 4 ++-- content/nim/support/k8s-support-package.md | 5 ++--- content/nim/support/support-package.md | 5 ++--- .../system-configuration/configure-clickhouse.md | 4 ++-- .../configure-forward-proxy.md | 4 ++-- .../nim/system-configuration/configure-gateway.md | 4 ++-- .../configure-high-availability.md | 4 ++-- .../nim/system-configuration/configure-selinux.md | 4 ++-- .../system-configuration/configure-telemetry.md | 4 ++-- .../nim/system-configuration/configure-vault.md | 4 ++-- .../system-configuration/configure-with-config.md | 4 ++-- content/nim/troubleshooting.md | 4 ++-- .../configuration/compiler-resource-pruning.md | 11 +++++------ .../install-waf-compiler/automatic-download.md | 1 - .../install-waf-compiler/download-from-myf5.md | 1 - .../install-waf-compiler/install-disconnected.md | 1 - .../configuration/install-waf-compiler/install.md | 1 - .../add-configuration.md | 1 - .../edit-waf-configuration.md | 1 - .../onboard-custom-security-policies.md | 1 - .../verify-configuration.md | 1 - .../onboard-instances/configure-docker-compose.md | 1 - .../onboard-instances/configure-nginx-agent.md | 1 - .../onboard-instances/install-nginx-agent.md | 3 +-- .../onboard-instances/verify-installation.md | 1 - .../automatic-download.md | 1 - .../setup-signatures-and-threats/manual-update.md | 1 - .../update-security-monitoring-signature-db.md | 1 - .../configuration/troubleshooting.md | 3 +-- content/nim/waf-integration/overview.md | 4 ++-- .../waf-integration/policies-and-logs/_index.md | 14 +++++++------- .../policies-and-logs/bundles/create-bundle.md | 9 ++++----- .../policies-and-logs/bundles/download-bundle.md | 13 ++++++------- .../policies-and-logs/bundles/list-bundles.md | 15 +++++++-------- .../log-profiles/create-log-profile.md | 2 -- .../log-profiles/delete-log-profile.md | 4 +--- .../log-profiles/update-log-profile.md | 4 +--- .../policies/add-signature-sets.md | 2 +- .../policies/cookies-parameters-urls.md | 1 - .../policies-and-logs/policies/create-policy.md | 1 - .../policies-and-logs/policies/delete-policy.md | 1 - .../policies-and-logs/policies/review-policy.md | 7 +++---- .../policies-and-logs/policies/update-policy.md | 1 - .../policies/waf-policy-matching-types.md | 1 - .../publish/check-publication-status.md | 1 - .../publish/publish-to-instances.md | 15 +++++++-------- 99 files changed, 182 insertions(+), 209 deletions(-) diff --git a/content/nim/_index.md b/content/nim/_index.md index c7dca2a3c0..cb1507bed0 100644 --- a/content/nim/_index.md +++ b/content/nim/_index.md @@ -5,6 +5,7 @@ url: /nginx-instance-manager/ nd-landing-page: true cascade: logo: "NGINX-Instance-Manager-product-icon.svg" +nd-product: NIMNGR --- ## About diff --git a/content/nim/admin-guide/add-license.md b/content/nim/admin-guide/add-license.md index d2beee9c6a..a8c6fe90a1 100644 --- a/content/nim/admin-guide/add-license.md +++ b/content/nim/admin-guide/add-license.md @@ -3,8 +3,8 @@ nd-docs: DOCS-789 title: Add a license (connected) toc: true weight: 10 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< call-out "note" >}}For disconnected environments, see [Add a license (disconnected)]({{< ref "nim/disconnected/add-license-disconnected-deployment.md" >}}).{{< /call-out >}} diff --git a/content/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md b/content/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md index c26343eabf..f7141f66d2 100644 --- a/content/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md +++ b/content/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md @@ -3,8 +3,8 @@ title: Set up basic authentication description: Learn how to manage user access in NGINX Instance Manager using basic authentication with NGINX as a front-end proxy. This guide covers first-time login, creating additional users, and setting passwords. toc: true weight: 10 -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-792 --- diff --git a/content/nim/admin-guide/authentication/oidc/keycloak-setup.md b/content/nim/admin-guide/authentication/oidc/keycloak-setup.md index 4391a2d9eb..4ab0f5c6ad 100644 --- a/content/nim/admin-guide/authentication/oidc/keycloak-setup.md +++ b/content/nim/admin-guide/authentication/oidc/keycloak-setup.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1268 title: 'Keycloak: Set up OIDC authentication' toc: true weight: 400 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/authentication/oidc/microsoft-entra-automation.md b/content/nim/admin-guide/authentication/oidc/microsoft-entra-automation.md index 2446c5cff4..6bb953da91 100644 --- a/content/nim/admin-guide/authentication/oidc/microsoft-entra-automation.md +++ b/content/nim/admin-guide/authentication/oidc/microsoft-entra-automation.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1197 title: Automate OIDC with Microsoft Entra toc: true weight: 300 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/authentication/oidc/microsoft-entra-setup.md b/content/nim/admin-guide/authentication/oidc/microsoft-entra-setup.md index 0439f5247e..544cfcffa3 100644 --- a/content/nim/admin-guide/authentication/oidc/microsoft-entra-setup.md +++ b/content/nim/admin-guide/authentication/oidc/microsoft-entra-setup.md @@ -5,6 +5,7 @@ weight: 100 nd-content-type: how-to nd-product: NIMNGR nd-docs: DOCS-795 +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/authentication/oidc/scim-provisioning.md b/content/nim/admin-guide/authentication/oidc/scim-provisioning.md index ff67f390cd..55dd3390ae 100644 --- a/content/nim/admin-guide/authentication/oidc/scim-provisioning.md +++ b/content/nim/admin-guide/authentication/oidc/scim-provisioning.md @@ -3,8 +3,8 @@ nd-docs: DOCS-918 title: Provision users and groups using SCIM toc: true weight: 500 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/maintenance/backup-and-recovery.md b/content/nim/admin-guide/maintenance/backup-and-recovery.md index ac009796ef..ca932eb859 100644 --- a/content/nim/admin-guide/maintenance/backup-and-recovery.md +++ b/content/nim/admin-guide/maintenance/backup-and-recovery.md @@ -3,6 +3,8 @@ nd-docs: DOCS-1098 title: Back up and restore toc: true weight: 1 +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/maintenance/sqlite-installation.md b/content/nim/admin-guide/maintenance/sqlite-installation.md index fde332b161..5a420d656d 100644 --- a/content/nim/admin-guide/maintenance/sqlite-installation.md +++ b/content/nim/admin-guide/maintenance/sqlite-installation.md @@ -3,6 +3,8 @@ nd-docs: DOCS-1270 title: Install SQLite (for NGINX Instance Manager 2.14.1 and earlier) toc: true weight: 10 +nd-content-type: how-to +nd-product: NIMNGR --- ## Install SQLite for your Linux distribution diff --git a/content/nim/admin-guide/rbac/assign-roles.md b/content/nim/admin-guide/rbac/assign-roles.md index b5971df571..81040211ee 100644 --- a/content/nim/admin-guide/rbac/assign-roles.md +++ b/content/nim/admin-guide/rbac/assign-roles.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1273 title: Assign roles to users or user groups toc: true weight: 210 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/rbac/create-roles.md b/content/nim/admin-guide/rbac/create-roles.md index 60927c7e20..1c2004615b 100644 --- a/content/nim/admin-guide/rbac/create-roles.md +++ b/content/nim/admin-guide/rbac/create-roles.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1272 title: Create and manage roles toc: true weight: 200 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/rbac/manage-resource-groups.md b/content/nim/admin-guide/rbac/manage-resource-groups.md index 65e884495a..f4455e4a37 100644 --- a/content/nim/admin-guide/rbac/manage-resource-groups.md +++ b/content/nim/admin-guide/rbac/manage-resource-groups.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1271 title: Manage resource groups toc: true weight: 300 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/admin-guide/rbac/overview-rbac.md b/content/nim/admin-guide/rbac/overview-rbac.md index 95d47e1a6b..81235e7194 100644 --- a/content/nim/admin-guide/rbac/overview-rbac.md +++ b/content/nim/admin-guide/rbac/overview-rbac.md @@ -2,8 +2,8 @@ title: "Overview: RBAC" weight: 1 toc: true -type: concept -product: nim +nd-content-type: concept +nd-product: NIMNGR nd-docs: DOCS-919 --- diff --git a/content/nim/admin-guide/report-usage-connected-deployment.md b/content/nim/admin-guide/report-usage-connected-deployment.md index 4e492a1bdb..e19983fa14 100644 --- a/content/nim/admin-guide/report-usage-connected-deployment.md +++ b/content/nim/admin-guide/report-usage-connected-deployment.md @@ -4,13 +4,13 @@ description: '' weight: 20 toc: true nd-docs: DOCS-1650 -personas: +nd-personas: - devops - netops - secops - support -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< call-out "note" >}}For disconnected environments, see [Report usage data to F5 (disconnected)]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}}).{{< /call-out >}} diff --git a/content/nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md b/content/nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md index 9d67538136..76fd7a910d 100644 --- a/content/nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md +++ b/content/nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md @@ -4,8 +4,8 @@ title: Deploy using Docker Compose toc: true weight: 100 nd-docs: DOCS-1653 -type: -- task +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/deploy/docker/deploy-nginx-plus-and-agent-docker.md b/content/nim/deploy/docker/deploy-nginx-plus-and-agent-docker.md index 040dc06f23..0c62552289 100644 --- a/content/nim/deploy/docker/deploy-nginx-plus-and-agent-docker.md +++ b/content/nim/deploy/docker/deploy-nginx-plus-and-agent-docker.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1654 title: Deploy NGINX Plus in a container (data plane) toc: true weight: 200 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/deploy/infrastructure-as-code/build-and-deploy.md b/content/nim/deploy/infrastructure-as-code/build-and-deploy.md index aed40e2796..b8a16ea2e8 100644 --- a/content/nim/deploy/infrastructure-as-code/build-and-deploy.md +++ b/content/nim/deploy/infrastructure-as-code/build-and-deploy.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1247 title: Build and deploy images toc: true weight: 300 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/deploy/infrastructure-as-code/configuration.md b/content/nim/deploy/infrastructure-as-code/configuration.md index 825aaaf511..26c49a3e12 100644 --- a/content/nim/deploy/infrastructure-as-code/configuration.md +++ b/content/nim/deploy/infrastructure-as-code/configuration.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1248 title: Install with Ansible toc: true weight: 200 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/deploy/infrastructure-as-code/overview.md b/content/nim/deploy/infrastructure-as-code/overview.md index 8c20eb32a7..9503ed4b7b 100644 --- a/content/nim/deploy/infrastructure-as-code/overview.md +++ b/content/nim/deploy/infrastructure-as-code/overview.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1249 title: Overview toc: true weight: 100 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/deploy/kubernetes/deploy-using-helm.md b/content/nim/deploy/kubernetes/deploy-using-helm.md index d087f8fe88..c78ba34343 100644 --- a/content/nim/deploy/kubernetes/deploy-using-helm.md +++ b/content/nim/deploy/kubernetes/deploy-using-helm.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1651 title: Deploy using Helm toc: true weight: 100 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/deploy/kubernetes/frequently-used-helm-configs.md b/content/nim/deploy/kubernetes/frequently-used-helm-configs.md index 77b0de767d..1a702266c2 100644 --- a/content/nim/deploy/kubernetes/frequently-used-helm-configs.md +++ b/content/nim/deploy/kubernetes/frequently-used-helm-configs.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1275 title: Frequently used Helm configurations toc: true weight: 400 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/deploy/kubernetes/helm-config-settings.md b/content/nim/deploy/kubernetes/helm-config-settings.md index 8f7f2e5234..3a19a70a76 100644 --- a/content/nim/deploy/kubernetes/helm-config-settings.md +++ b/content/nim/deploy/kubernetes/helm-config-settings.md @@ -3,8 +3,7 @@ nd-docs: DOCS-1112 title: Configurable helm settings toc: true weight: 300 -nd-content-type: -- reference +nd-content-nd-content-type: reference nd-product: NIMNGR --- diff --git a/content/nim/deploy/vm-bare-metal/install.md b/content/nim/deploy/vm-bare-metal/install.md index ffe5955e49..b85707905f 100644 --- a/content/nim/deploy/vm-bare-metal/install.md +++ b/content/nim/deploy/vm-bare-metal/install.md @@ -3,8 +3,8 @@ description: '' title: Install the latest NGINX Instance Manager with a script toc: true weight: 10 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/disconnected/offline-install-guide-manual.md b/content/nim/disconnected/offline-install-guide-manual.md index 900a3a67e2..94cc77a9a4 100644 --- a/content/nim/disconnected/offline-install-guide-manual.md +++ b/content/nim/disconnected/offline-install-guide-manual.md @@ -3,8 +3,8 @@ title: Manually install any version of NGINX Instance Manager (disconnected) weight: 100 toc: true noindex: true -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-000 --- diff --git a/content/nim/disconnected/offline-install-guide.md b/content/nim/disconnected/offline-install-guide.md index fa6311487d..80a007792c 100644 --- a/content/nim/disconnected/offline-install-guide.md +++ b/content/nim/disconnected/offline-install-guide.md @@ -2,8 +2,8 @@ title: Install the latest NGINX Instance Manager with a script (disconnected) toc: true weight: 100 -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-803 --- diff --git a/content/nim/disconnected/report-usage-disconnected-deployment.md b/content/nim/disconnected/report-usage-disconnected-deployment.md index 5dc4a8c00e..69d4d1b54e 100644 --- a/content/nim/disconnected/report-usage-disconnected-deployment.md +++ b/content/nim/disconnected/report-usage-disconnected-deployment.md @@ -3,13 +3,13 @@ title: Report usage data to F5 (disconnected) weight: 300 toc: true nd-docs: DOCS-1658 -personas: +nd-personas: - devops - netops - secops - support -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/fundamentals/api-overview.md b/content/nim/fundamentals/api-overview.md index 849a1e9ed0..1ce889211b 100644 --- a/content/nim/fundamentals/api-overview.md +++ b/content/nim/fundamentals/api-overview.md @@ -4,8 +4,8 @@ nd-docs: DOCS-798 title: 'Overview: NGINX Instance Manager REST API' toc: true weight: 400 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/fundamentals/dashboard-overview.md b/content/nim/fundamentals/dashboard-overview.md index ab92d7ff76..578a0de462 100644 --- a/content/nim/fundamentals/dashboard-overview.md +++ b/content/nim/fundamentals/dashboard-overview.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1387 title: NGINX Instance Manager dashboard toc: true weight: 300 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- The NGINX Instance Manager dashboard gives you a high-level view of the health and performance of your NGINX instances. It provides a central place to identify, diagnose, and resolve issues in your data plane. You can also track how deployments affect the performance of individual instances and identify trends over time. diff --git a/content/nim/fundamentals/tech-specs.md b/content/nim/fundamentals/tech-specs.md index 9f0cb9a65b..9c3d11aeb7 100644 --- a/content/nim/fundamentals/tech-specs.md +++ b/content/nim/fundamentals/tech-specs.md @@ -3,8 +3,8 @@ nd-docs: DOCS-805 title: Technical Specifications toc: true weight: 20 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/monitoring/catalogs/dimensions.md b/content/nim/monitoring/catalogs/dimensions.md index b10ddbf83b..48ff0ed484 100644 --- a/content/nim/monitoring/catalogs/dimensions.md +++ b/content/nim/monitoring/catalogs/dimensions.md @@ -4,8 +4,8 @@ nd-docs: DOCS-812 title: Dimensions Catalog toc: true weight: 20 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- {{< catalogs-dimensions >}} diff --git a/content/nim/monitoring/catalogs/events.md b/content/nim/monitoring/catalogs/events.md index 35369f963c..45854c2af1 100644 --- a/content/nim/monitoring/catalogs/events.md +++ b/content/nim/monitoring/catalogs/events.md @@ -4,8 +4,8 @@ nd-docs: DOCS-1132 title: Events Catalog toc: true weight: 20 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- {{< catalogs-events >}} diff --git a/content/nim/monitoring/catalogs/metrics.md b/content/nim/monitoring/catalogs/metrics.md index e4bf50997d..d3fde5e3d2 100644 --- a/content/nim/monitoring/catalogs/metrics.md +++ b/content/nim/monitoring/catalogs/metrics.md @@ -4,8 +4,8 @@ nd-docs: DOCS-813 title: Metrics Catalog toc: true weight: 20 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- {{< catalogs-metrics >}} diff --git a/content/nim/monitoring/metrics-api.md b/content/nim/monitoring/metrics-api.md index fdff54643d..b79695e782 100644 --- a/content/nim/monitoring/metrics-api.md +++ b/content/nim/monitoring/metrics-api.md @@ -5,8 +5,8 @@ nd-docs: DOCS-825 title: Query the Metrics API toc: true weight: 200 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/monitoring/overview-metrics.md b/content/nim/monitoring/overview-metrics.md index cb1fe13e65..f77f1f0e1d 100644 --- a/content/nim/monitoring/overview-metrics.md +++ b/content/nim/monitoring/overview-metrics.md @@ -4,8 +4,8 @@ nd-docs: DOCS-826 title: 'Overview: NGINX instance metrics' toc: true weight: 100 -type: - - reference +nd-content-type: reference +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-configs/config-templates/concepts/augment-templates.md b/content/nim/nginx-configs/config-templates/concepts/augment-templates.md index 7470516010..e498d4085d 100644 --- a/content/nim/nginx-configs/config-templates/concepts/augment-templates.md +++ b/content/nim/nginx-configs/config-templates/concepts/augment-templates.md @@ -4,13 +4,13 @@ description: '' weight: 120 toc: true nd-docs: DOCS-1656 -personas: +nd-personas: - devops - netops - secops - support -type: -- concept +nd-content-type: concept +nd-product: NIMNGR --- ## Overview {#augmenting-global-default-base-template} diff --git a/content/nim/nginx-configs/config-templates/concepts/config-templates.md b/content/nim/nginx-configs/config-templates/concepts/config-templates.md index f3b30e55fb..958cabe392 100644 --- a/content/nim/nginx-configs/config-templates/concepts/config-templates.md +++ b/content/nim/nginx-configs/config-templates/concepts/config-templates.md @@ -4,13 +4,13 @@ description: '' weight: 100 toc: true nd-docs: DOCS-1502 -personas: +nd-personas: - devops - netops - secops - support -type: -- concept +nd-content-type: concept +nd-product: NIMNGR --- ## Config templates diff --git a/content/nim/nginx-configs/config-templates/concepts/default-base-template.md b/content/nim/nginx-configs/config-templates/concepts/default-base-template.md index 1f0177eb34..98a8c7eade 100644 --- a/content/nim/nginx-configs/config-templates/concepts/default-base-template.md +++ b/content/nim/nginx-configs/config-templates/concepts/default-base-template.md @@ -4,13 +4,13 @@ description: '' weight: 110 toc: true nd-docs: DOCS-1503 -personas: +nd-personas: - devops - netops - secops - support -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-configs/config-templates/concepts/template-resources.md b/content/nim/nginx-configs/config-templates/concepts/template-resources.md index 48164445ae..de5071c163 100644 --- a/content/nim/nginx-configs/config-templates/concepts/template-resources.md +++ b/content/nim/nginx-configs/config-templates/concepts/template-resources.md @@ -4,13 +4,13 @@ description: '' weight: 200 toc: true nd-docs: DOCS-1501 -personas: +nd-personas: - devops - netops - secops - support -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- ## Config Template, Schema, and README Files diff --git a/content/nim/nginx-configs/config-templates/how-to/manage-nginx-configs-with-templates.md b/content/nim/nginx-configs/config-templates/how-to/manage-nginx-configs-with-templates.md index ffbb466d3b..be59ddf6f1 100644 --- a/content/nim/nginx-configs/config-templates/how-to/manage-nginx-configs-with-templates.md +++ b/content/nim/nginx-configs/config-templates/how-to/manage-nginx-configs-with-templates.md @@ -4,13 +4,13 @@ description: '' weight: 200 toc: true nd-docs: DOCS-1506 -personas: +nd-personas: - devops - netops - secops - support -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Create a Config Template diff --git a/content/nim/nginx-configs/config-templates/how-to/rbac-config-templates-and-submissions.md b/content/nim/nginx-configs/config-templates/how-to/rbac-config-templates-and-submissions.md index 9f2afcce5c..c4ca54f0bf 100644 --- a/content/nim/nginx-configs/config-templates/how-to/rbac-config-templates-and-submissions.md +++ b/content/nim/nginx-configs/config-templates/how-to/rbac-config-templates-and-submissions.md @@ -4,13 +4,13 @@ description: '' weight: 300 toc: true nd-docs: DOCS-1505 -personas: +nd-personas: - devops - netops - secops - support -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-configs/config-templates/reference/json-schema-reference.md b/content/nim/nginx-configs/config-templates/reference/json-schema-reference.md index a1ea70fa53..f268da6f6f 100644 --- a/content/nim/nginx-configs/config-templates/reference/json-schema-reference.md +++ b/content/nim/nginx-configs/config-templates/reference/json-schema-reference.md @@ -4,13 +4,13 @@ description: '' weight: 300 toc: true nd-docs: DOCS-1504 -personas: +nd-personas: - devops - netops - secops - support -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-configs/config-templates/tutorials/round-robin-reverse-proxy.md b/content/nim/nginx-configs/config-templates/tutorials/round-robin-reverse-proxy.md index 16f201755f..8f1ffc812c 100644 --- a/content/nim/nginx-configs/config-templates/tutorials/round-robin-reverse-proxy.md +++ b/content/nim/nginx-configs/config-templates/tutorials/round-robin-reverse-proxy.md @@ -5,8 +5,8 @@ description: Learn how to set up a round-robin reverse proxy using NGINX Instanc weight: 100 toc: true nd-docs: DOCS-1655 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-configs/publish-configs-version-control.md b/content/nim/nginx-configs/publish-configs-version-control.md index e8cd5f3165..7322e28ba0 100644 --- a/content/nim/nginx-configs/publish-configs-version-control.md +++ b/content/nim/nginx-configs/publish-configs-version-control.md @@ -3,6 +3,8 @@ nd-docs: DOCS-1348 title: Publish NGINX configs with version control toc: true weight: 3 +nd-product: NIMNGR +nd-content-type: how-to --- ## Overview diff --git a/content/nim/nginx-configs/publish-configs.md b/content/nim/nginx-configs/publish-configs.md index 8bae0b153e..a438680567 100644 --- a/content/nim/nginx-configs/publish-configs.md +++ b/content/nim/nginx-configs/publish-configs.md @@ -3,8 +3,8 @@ nd-docs: DOCS-822 title: Publish NGINX configs toc: true weight: 2 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-configs/stage-configs.md b/content/nim/nginx-configs/stage-configs.md index 04d1805e44..ecb87f4aea 100644 --- a/content/nim/nginx-configs/stage-configs.md +++ b/content/nim/nginx-configs/stage-configs.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1277 title: Stage NGINX configs toc: true weight: 1 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-instances/add-tags.md b/content/nim/nginx-instances/add-tags.md index 76fa0e8188..1a6b031ece 100644 --- a/content/nim/nginx-instances/add-tags.md +++ b/content/nim/nginx-instances/add-tags.md @@ -4,8 +4,8 @@ nd-docs: DOCS-829 title: Organize instances with tags toc: true weight: 650 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/nginx-instances/manage-certificates.md b/content/nim/nginx-instances/manage-certificates.md index ac35a3c6d6..b60f0be64b 100644 --- a/content/nim/nginx-instances/manage-certificates.md +++ b/content/nim/nginx-instances/manage-certificates.md @@ -3,8 +3,8 @@ nd-docs: DOCS-821 title: Manage SSL certificates toc: true weight: 650 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- {{< include "nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/nginx-instances/manage-instance-groups.md b/content/nim/nginx-instances/manage-instance-groups.md index 9f52f6706a..34a317c6d5 100644 --- a/content/nim/nginx-instances/manage-instance-groups.md +++ b/content/nim/nginx-instances/manage-instance-groups.md @@ -6,8 +6,8 @@ nd-docs: DOCS-935 title: Create and manage instance groups toc: true weight: 600 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/releases/known-issues.md b/content/nim/releases/known-issues.md index e252930bdb..25fbac4b2d 100644 --- a/content/nim/releases/known-issues.md +++ b/content/nim/releases/known-issues.md @@ -4,6 +4,8 @@ type: reference title: Known issues toc: true weight: 200 +nd-product: NIMNGR +nd-content-type: reference --- This document lists and describes the known issues and possible workarounds in F5 NGINX Instance Manager. We also list the issues resolved in the latest releases. diff --git a/content/nim/security-monitoring/give-access-to-security-monitoring-dashboards.md b/content/nim/security-monitoring/give-access-to-security-monitoring-dashboards.md index 088be21ff0..86b9b8a985 100644 --- a/content/nim/security-monitoring/give-access-to-security-monitoring-dashboards.md +++ b/content/nim/security-monitoring/give-access-to-security-monitoring-dashboards.md @@ -2,8 +2,8 @@ title: Add user access to Security Monitoring dashboards weight: 200 toc: true -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-1026 --- diff --git a/content/nim/security-monitoring/troubleshooting.md b/content/nim/security-monitoring/troubleshooting.md index abbe9c9ebc..2bc929ac20 100644 --- a/content/nim/security-monitoring/troubleshooting.md +++ b/content/nim/security-monitoring/troubleshooting.md @@ -2,8 +2,8 @@ title: Troubleshooting weight: 500 toc: true -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-1226 --- diff --git a/content/nim/security-monitoring/update-geo-db.md b/content/nim/security-monitoring/update-geo-db.md index daa7477224..e6c79b5d07 100644 --- a/content/nim/security-monitoring/update-geo-db.md +++ b/content/nim/security-monitoring/update-geo-db.md @@ -2,8 +2,8 @@ title: Update the geolocation database used in dashboards weight: 400 toc: true -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-1108 --- diff --git a/content/nim/security-monitoring/update-signatures.md b/content/nim/security-monitoring/update-signatures.md index 41d76de64e..fc0a97e860 100644 --- a/content/nim/security-monitoring/update-signatures.md +++ b/content/nim/security-monitoring/update-signatures.md @@ -2,8 +2,8 @@ title: Update the attack signature database weight: 300 toc: true -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR nd-docs: DOCS-1109 --- diff --git a/content/nim/support/contact-support.md b/content/nim/support/contact-support.md index fa7adb5a90..87bd60c311 100644 --- a/content/nim/support/contact-support.md +++ b/content/nim/support/contact-support.md @@ -3,8 +3,8 @@ nd-docs: DOCS-817 title: Where to go for support toc: true weight: 300 -type: -- concept +nd-content-type: concept +nd-product: NIMNGR --- ## Support policy diff --git a/content/nim/support/k8s-support-package.md b/content/nim/support/k8s-support-package.md index 3dd152a526..ee4b41871f 100644 --- a/content/nim/support/k8s-support-package.md +++ b/content/nim/support/k8s-support-package.md @@ -3,9 +3,8 @@ nd-docs: DOCS-1123 title: Create a support package from a Helm installation toc: true weight: 200 -type: -- reference -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/support/support-package.md b/content/nim/support/support-package.md index 5141f711e2..5619061b60 100644 --- a/content/nim/support/support-package.md +++ b/content/nim/support/support-package.md @@ -3,9 +3,8 @@ nd-docs: DOCS-818 title: Create a support package toc: true weight: 200 -type: -- reference -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/system-configuration/configure-clickhouse.md b/content/nim/system-configuration/configure-clickhouse.md index 37478250bc..5f32431721 100644 --- a/content/nim/system-configuration/configure-clickhouse.md +++ b/content/nim/system-configuration/configure-clickhouse.md @@ -4,8 +4,8 @@ nd-docs: DOCS-998 title: Configure ClickHouse toc: true weight: 100 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/system-configuration/configure-forward-proxy.md b/content/nim/system-configuration/configure-forward-proxy.md index 01d24842d9..7a01341ebd 100644 --- a/content/nim/system-configuration/configure-forward-proxy.md +++ b/content/nim/system-configuration/configure-forward-proxy.md @@ -2,8 +2,8 @@ Title: Use a third-party forward proxy weight: 2 toc: true -type: how-to -product: NIM +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/system-configuration/configure-gateway.md b/content/nim/system-configuration/configure-gateway.md index 4c8a583fce..01d839bffb 100644 --- a/content/nim/system-configuration/configure-gateway.md +++ b/content/nim/system-configuration/configure-gateway.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1131 title: Optimize NGINX proxy gateway for large data planes toc: true weight: 400 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/system-configuration/configure-high-availability.md b/content/nim/system-configuration/configure-high-availability.md index 6bccae0797..5259296dcb 100644 --- a/content/nim/system-configuration/configure-high-availability.md +++ b/content/nim/system-configuration/configure-high-availability.md @@ -2,8 +2,8 @@ Title: High availability with keepalived weight: 3 toc: true -type: how-to -product: NGINX Instance Manager +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/system-configuration/configure-selinux.md b/content/nim/system-configuration/configure-selinux.md index 279bf93ea0..e5cb6bbd97 100644 --- a/content/nim/system-configuration/configure-selinux.md +++ b/content/nim/system-configuration/configure-selinux.md @@ -3,8 +3,8 @@ nd-docs: DOCS-796 title: Configure SELinux toc: true weight: 250 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/system-configuration/configure-telemetry.md b/content/nim/system-configuration/configure-telemetry.md index 375523b2d7..b85ec0c7de 100644 --- a/content/nim/system-configuration/configure-telemetry.md +++ b/content/nim/system-configuration/configure-telemetry.md @@ -3,8 +3,8 @@ nd-docs: DOCS-1269 title: Configure telemetry and web analytics toc: true weight: 260 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- ## Overview diff --git a/content/nim/system-configuration/configure-vault.md b/content/nim/system-configuration/configure-vault.md index 1e77e92f39..28492ccd0b 100644 --- a/content/nim/system-configuration/configure-vault.md +++ b/content/nim/system-configuration/configure-vault.md @@ -3,8 +3,8 @@ nd-docs: DOCS-999 title: Use Vault for storing secrets toc: true weight: 200 -type: -- tutorial +nd-content-type: tutorial +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/system-configuration/configure-with-config.md b/content/nim/system-configuration/configure-with-config.md index 063078d95d..7765248d74 100644 --- a/content/nim/system-configuration/configure-with-config.md +++ b/content/nim/system-configuration/configure-with-config.md @@ -4,8 +4,8 @@ nd-docs: DOCS-1100 title: Configure settings with nms.conf toc: true weight: 1 -type: -- how-to +nd-content-type: how-to +nd-product: NIMNGR --- {{< include "/nim/decoupling/note-legacy-nms-references.md" >}} diff --git a/content/nim/troubleshooting.md b/content/nim/troubleshooting.md index de7261b987..91e8a2de32 100644 --- a/content/nim/troubleshooting.md +++ b/content/nim/troubleshooting.md @@ -6,8 +6,8 @@ title: Troubleshooting toc: true weight: 1000 draft: true -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- ## New NGINX instances don't show up in Instance Manager diff --git a/content/nim/waf-integration/configuration/compiler-resource-pruning.md b/content/nim/waf-integration/configuration/compiler-resource-pruning.md index c49aea4e66..f13a541e3a 100644 --- a/content/nim/waf-integration/configuration/compiler-resource-pruning.md +++ b/content/nim/waf-integration/configuration/compiler-resource-pruning.md @@ -5,16 +5,15 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- You can configure NGINX Instance Manager to automatically remove unused compiled security resources, including: -- Compiled security policies -- Compiled security log profiles -- Attack signatures -- Bot signatures -- Threat campaigns +- Compiled security policies +- Compiled security log profiles +- Attack signatures +- Bot signatures +- Threat campaigns Only compiled bundles are removed. NGINX Instance Manager does not delete the base definitions for security policies or log profiles. diff --git a/content/nim/waf-integration/configuration/install-waf-compiler/automatic-download.md b/content/nim/waf-integration/configuration/install-waf-compiler/automatic-download.md index d99e5320d6..2c87aa84b5 100644 --- a/content/nim/waf-integration/configuration/install-waf-compiler/automatic-download.md +++ b/content/nim/waf-integration/configuration/install-waf-compiler/automatic-download.md @@ -5,7 +5,6 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- After you manually [install at least one version of the F5 WAF for NGINX compiler]({{< ref "/nim/waf-integration/configuration/install-waf-compiler/install.md" >}}), NGINX Instance Manager can automatically download and install newer versions as needed. diff --git a/content/nim/waf-integration/configuration/install-waf-compiler/download-from-myf5.md b/content/nim/waf-integration/configuration/install-waf-compiler/download-from-myf5.md index 3a64ed46ca..358b8d79d8 100644 --- a/content/nim/waf-integration/configuration/install-waf-compiler/download-from-myf5.md +++ b/content/nim/waf-integration/configuration/install-waf-compiler/download-from-myf5.md @@ -5,7 +5,6 @@ toc: true weight: 400 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- If your NGINX Instance Manager host doesn’t have access to the public NGINX repository, you can manually download and install the WAF compiler from [MyF5](https://my.f5.com/). diff --git a/content/nim/waf-integration/configuration/install-waf-compiler/install-disconnected.md b/content/nim/waf-integration/configuration/install-waf-compiler/install-disconnected.md index ce0ce01529..853a368f7c 100644 --- a/content/nim/waf-integration/configuration/install-waf-compiler/install-disconnected.md +++ b/content/nim/waf-integration/configuration/install-waf-compiler/install-disconnected.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- You can install the WAF compiler on a system without internet access by creating the package on a connected system, then transferring and installing it offline. diff --git a/content/nim/waf-integration/configuration/install-waf-compiler/install.md b/content/nim/waf-integration/configuration/install-waf-compiler/install.md index 3cf2d6d0a8..7a3b7377c5 100644 --- a/content/nim/waf-integration/configuration/install-waf-compiler/install.md +++ b/content/nim/waf-integration/configuration/install-waf-compiler/install.md @@ -5,7 +5,6 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- The WAF compiler lets NGINX Instance Manager precompile security configurations before deploying them to F5 WAF for NGINX instances. diff --git a/content/nim/waf-integration/configuration/manage-waf-configurations/add-configuration.md b/content/nim/waf-integration/configuration/manage-waf-configurations/add-configuration.md index 9a4d06a7bd..8a296a8df5 100644 --- a/content/nim/waf-integration/configuration/manage-waf-configurations/add-configuration.md +++ b/content/nim/waf-integration/configuration/manage-waf-configurations/add-configuration.md @@ -5,7 +5,6 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- Start by adding an F5 WAF for NGINX configuration to your instances. You can apply one of the built-in security policies or reference your own custom policy bundle. diff --git a/content/nim/waf-integration/configuration/manage-waf-configurations/edit-waf-configuration.md b/content/nim/waf-integration/configuration/manage-waf-configurations/edit-waf-configuration.md index 102a14d6a6..c2024ba761 100644 --- a/content/nim/waf-integration/configuration/manage-waf-configurations/edit-waf-configuration.md +++ b/content/nim/waf-integration/configuration/manage-waf-configurations/edit-waf-configuration.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- After you’ve added a WAF configuration to your instances, edit your NGINX configuration files to apply the required F5 WAF for NGINX directives. This step ensures that protection is enabled and that your configuration references the correct policy and log profile bundles. You can complete this task using the **F5 NGINX Instance Manager** web interface or REST API. diff --git a/content/nim/waf-integration/configuration/manage-waf-configurations/onboard-custom-security-policies.md b/content/nim/waf-integration/configuration/manage-waf-configurations/onboard-custom-security-policies.md index 3c56dbc8ac..00cccaed79 100644 --- a/content/nim/waf-integration/configuration/manage-waf-configurations/onboard-custom-security-policies.md +++ b/content/nim/waf-integration/configuration/manage-waf-configurations/onboard-custom-security-policies.md @@ -5,7 +5,6 @@ toc: true weight: 400 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- After verifying that F5 WAF for NGINX is active on your instances, you can onboard your own custom security policies. Use this option when you need to apply application-specific rules or integrate policies created in other environments. You’ll upload your JSON policy files, package them into `.tgz` bundles, and publish them through **F5 NGINX Instance Manager**. diff --git a/content/nim/waf-integration/configuration/manage-waf-configurations/verify-configuration.md b/content/nim/waf-integration/configuration/manage-waf-configurations/verify-configuration.md index 6870c2c194..3d9cb7217a 100644 --- a/content/nim/waf-integration/configuration/manage-waf-configurations/verify-configuration.md +++ b/content/nim/waf-integration/configuration/manage-waf-configurations/verify-configuration.md @@ -5,7 +5,6 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- After applying your configuration, verify that F5 WAF for NGINX is active and running as expected on your instances. You can confirm status and version details through the **F5 NGINX Instance Manager** web interface. diff --git a/content/nim/waf-integration/configuration/onboard-instances/configure-docker-compose.md b/content/nim/waf-integration/configuration/onboard-instances/configure-docker-compose.md index cf4d13dfbf..99bb46de68 100644 --- a/content/nim/waf-integration/configuration/onboard-instances/configure-docker-compose.md +++ b/content/nim/waf-integration/configuration/onboard-instances/configure-docker-compose.md @@ -5,7 +5,6 @@ toc: true weight: 400 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- ## Before you begin diff --git a/content/nim/waf-integration/configuration/onboard-instances/configure-nginx-agent.md b/content/nim/waf-integration/configuration/onboard-instances/configure-nginx-agent.md index 62a98b7691..3c2c6e18ee 100644 --- a/content/nim/waf-integration/configuration/onboard-instances/configure-nginx-agent.md +++ b/content/nim/waf-integration/configuration/onboard-instances/configure-nginx-agent.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- {{< call-out "note" "Before you begin" >}} diff --git a/content/nim/waf-integration/configuration/onboard-instances/install-nginx-agent.md b/content/nim/waf-integration/configuration/onboard-instances/install-nginx-agent.md index 11f6b93869..48e1ba1e61 100644 --- a/content/nim/waf-integration/configuration/onboard-instances/install-nginx-agent.md +++ b/content/nim/waf-integration/configuration/onboard-instances/install-nginx-agent.md @@ -5,12 +5,11 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- To onboard your F5 WAF for NGINX instances to NGINX Instance Manager, install and configure NGINX Agent on each instance. -1. Use SSH to connect to an F5 WAF for NGINX instance. +1. Use SSH to connect to an F5 WAF for NGINX instance. Repeat these steps for each instance you want to onboard. 1. Download the NGINX Agent package from your NGINX Instance Manager host and run the installation script. diff --git a/content/nim/waf-integration/configuration/onboard-instances/verify-installation.md b/content/nim/waf-integration/configuration/onboard-instances/verify-installation.md index 99595261b4..122ce6b07c 100644 --- a/content/nim/waf-integration/configuration/onboard-instances/verify-installation.md +++ b/content/nim/waf-integration/configuration/onboard-instances/verify-installation.md @@ -5,7 +5,6 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- {{< call-out "note" "Before you begin" >}} diff --git a/content/nim/waf-integration/configuration/setup-signatures-and-threats/automatic-download.md b/content/nim/waf-integration/configuration/setup-signatures-and-threats/automatic-download.md index c936900a44..f96a095316 100644 --- a/content/nim/waf-integration/configuration/setup-signatures-and-threats/automatic-download.md +++ b/content/nim/waf-integration/configuration/setup-signatures-and-threats/automatic-download.md @@ -5,7 +5,6 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- ## Upload the F5 WAF for NGINX certificate and key diff --git a/content/nim/waf-integration/configuration/setup-signatures-and-threats/manual-update.md b/content/nim/waf-integration/configuration/setup-signatures-and-threats/manual-update.md index c10e88cd4e..08ae1fb6c3 100644 --- a/content/nim/waf-integration/configuration/setup-signatures-and-threats/manual-update.md +++ b/content/nim/waf-integration/configuration/setup-signatures-and-threats/manual-update.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- If you prefer not to enable automatic updates, you can manually update the attack signature, bot signature, and threat campaign packages by downloading them from the NGINX repository and uploading them to NGINX Instance Manager. diff --git a/content/nim/waf-integration/configuration/setup-signatures-and-threats/update-security-monitoring-signature-db.md b/content/nim/waf-integration/configuration/setup-signatures-and-threats/update-security-monitoring-signature-db.md index b6fa4ac073..9ced381b8b 100644 --- a/content/nim/waf-integration/configuration/setup-signatures-and-threats/update-security-monitoring-signature-db.md +++ b/content/nim/waf-integration/configuration/setup-signatures-and-threats/update-security-monitoring-signature-db.md @@ -5,7 +5,6 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- The Security Monitoring dashboards in NGINX Instance Manager use an attack signature database to display details about detected security violations, including each signature’s name, accuracy, and risk level. diff --git a/content/nim/waf-integration/configuration/troubleshooting.md b/content/nim/waf-integration/configuration/troubleshooting.md index 9ba75c0099..40bd7686e4 100644 --- a/content/nim/waf-integration/configuration/troubleshooting.md +++ b/content/nim/waf-integration/configuration/troubleshooting.md @@ -5,10 +5,9 @@ toc: true weight: 1000 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- -If you're having trouble with F5 WAF for NGINX, try the steps below. +If you're having trouble with F5 WAF for NGINX, try the steps below. If these steps don’t fix the issue, contact F5 Support. --- diff --git a/content/nim/waf-integration/overview.md b/content/nim/waf-integration/overview.md index 50c8deb159..186a03458a 100644 --- a/content/nim/waf-integration/overview.md +++ b/content/nim/waf-integration/overview.md @@ -4,8 +4,8 @@ nd-docs: DOCS-992 title: "How WAF policy management works" toc: true weight: 100 -type: -- reference +nd-content-type: reference +nd-product: NIMNGR --- F5 NGINX Instance Manager helps you manage [F5 WAF for NGINX]({{< ref "/waf/" >}}) security configurations. diff --git a/content/nim/waf-integration/policies-and-logs/_index.md b/content/nim/waf-integration/policies-and-logs/_index.md index ce65f1ee03..5f42efd084 100644 --- a/content/nim/waf-integration/policies-and-logs/_index.md +++ b/content/nim/waf-integration/policies-and-logs/_index.md @@ -1,11 +1,11 @@ --- title: Manage security policies and log profiles description: Create, update, and deploy F5 WAF for NGINX security policies and log profiles using NGINX Instance Manager. -nd-docs: weight: 300 nd-content-type: landing-page nd-landing-page: true url: /nginx-instance-manager/waf-integration/policies-and-logs/ +nd-product: NIMNGR --- ## Overview @@ -17,7 +17,7 @@ You can also compile security policies and associated components—such as attac {{< call-out "note" "Note" >}} The following capabilities are available only through the NGINX Instance Manager REST API: -- Create, read, update, and delete security log profiles +- Create, read, update, and delete security log profiles - Publish security policies, log profiles, attack signatures, bot signatures, and threat campaigns to instances and instance groups **Access the REST API** @@ -33,16 +33,16 @@ The following capabilities are available only through the NGINX Instance Manager Before you start, complete these prerequisites: -- [Set up F5 WAF for NGINX configuration management]({{< ref "/nim/waf-integration/configuration/_index.md" >}}). +- [Set up F5 WAF for NGINX configuration management]({{< ref "/nim/waf-integration/configuration/_index.md" >}}). - Make sure your user account has the [required permissions]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}) to access the REST API: - - **Module:** Instance Manager - - **Feature:** Instance Management → `READ` + - **Module:** Instance Manager + - **Feature:** Instance Management → `READ` - **Feature:** Security Policies → `READ`, `CREATE`, `UPDATE`, `DELETE` To use policy bundles, you also need: -- `UPDATE` permissions for each referenced security policy -- The correct [`nms-nap-compiler` package]({{< ref "/nim/waf-integration/configuration/install-waf-compiler/_index.md" >}}) for your F5 WAF for NGINX version +- `UPDATE` permissions for each referenced security policy +- The correct [`nms-nap-compiler` package]({{< ref "/nim/waf-integration/configuration/install-waf-compiler/_index.md" >}}) for your F5 WAF for NGINX version - The required [attack signatures, bot signatures, and threat campaigns]({{< ref "/nim/waf-integration/configuration/setup-signatures-and-threats/_index.md" >}}) --- diff --git a/content/nim/waf-integration/policies-and-logs/bundles/create-bundle.md b/content/nim/waf-integration/policies-and-logs/bundles/create-bundle.md index 5d93283375..8b2da5e26f 100644 --- a/content/nim/waf-integration/policies-and-logs/bundles/create-bundle.md +++ b/content/nim/waf-integration/policies-and-logs/bundles/create-bundle.md @@ -5,12 +5,11 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- -NGINX Instance Manager lets you package your complete F5 WAF for NGINX configuration into a precompiled bundle for faster, more reliable deployments. +NGINX Instance Manager lets you package your complete F5 WAF for NGINX configuration into a precompiled bundle for faster, more reliable deployments. -A security policy bundle includes your policies, attack signatures, bot signatures, and threat campaigns—compiled into a single `.tgz` file that can be deployed across multiple instances. +A security policy bundle includes your policies, attack signatures, bot signatures, and threat campaigns—compiled into a single `.tgz` file that can be deployed across multiple instances. Precompiling with NGINX Instance Manager reduces processing overhead on WAF instances and ensures consistent, reusable configurations. @@ -26,8 +25,8 @@ To create a security policy bundle using the NGINX Instance Manager web interfac 2. In the left menu, select **WAF > Policies**. 3. On the **Security Policies** page, find the policy you want to create a bundle for. 4. Select the **Actions** menu (…) and choose **Compile**. -5. Check the **Compilation Status** column to monitor the bundle creation progress. - - The default status is **Not Compiled**. +5. Check the **Compilation Status** column to monitor the bundle creation progress. + - The default status is **Not Compiled**. - Other states include **Compiling**, **Compiled**, and **Error**. > **Note:** By default, **Compile** uses the latest revision of the selected policy, the latest available compiler version, and the most recent versions of attack signatures, bot signatures, and threat campaigns. diff --git a/content/nim/waf-integration/policies-and-logs/bundles/download-bundle.md b/content/nim/waf-integration/policies-and-logs/bundles/download-bundle.md index 1ac443b616..7ad65d5eac 100644 --- a/content/nim/waf-integration/policies-and-logs/bundles/download-bundle.md +++ b/content/nim/waf-integration/policies-and-logs/bundles/download-bundle.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- {{}} @@ -14,12 +13,12 @@ nd-docs: To download a security policy bundle using the NGINX Instance Manager web interface: -1. In your browser, go to the FQDN for your NGINX Instance Manager host and log in. -2. In the left menu, select **WAF > Policies**. -3. On the **Security Policies** page, find the policy you want to download a bundle for. -4. Select the **Actions** menu (…) and choose **Download Bundle**. - - The **Download Bundle** option is available only when the **Compilation Status** is **Compiled**. -5. When the download starts, a `.tgz` file named `-security-policy-bundle.tgz` is saved to your system. +1. In your browser, go to the FQDN for your NGINX Instance Manager host and log in. +2. In the left menu, select **WAF > Policies**. +3. On the **Security Policies** page, find the policy you want to download a bundle for. +4. Select the **Actions** menu (…) and choose **Download Bundle**. + - The **Download Bundle** option is available only when the **Compilation Status** is **Compiled**. +5. When the download starts, a `.tgz` file named `-security-policy-bundle.tgz` is saved to your system. > **Note:** By default, **Download Bundle** retrieves the latest bundle revision of the selected policy. diff --git a/content/nim/waf-integration/policies-and-logs/bundles/list-bundles.md b/content/nim/waf-integration/policies-and-logs/bundles/list-bundles.md index 6641d798f3..a2df4f7b33 100644 --- a/content/nim/waf-integration/policies-and-logs/bundles/list-bundles.md +++ b/content/nim/waf-integration/policies-and-logs/bundles/list-bundles.md @@ -5,7 +5,6 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- {{}} @@ -14,8 +13,8 @@ nd-docs: To view the list of security policy bundles using the NGINX Instance Manager web interface: -1. In your browser, go to the FQDN for your NGINX Instance Manager host and log in. -2. In the left menu, select **WAF > Policies**. +1. In your browser, go to the FQDN for your NGINX Instance Manager host and log in. +2. In the left menu, select **WAF > Policies**. The list shows all available security policy bundles, including their compilation status and associated F5 WAF for NGINX version. @@ -29,11 +28,11 @@ You’ll only see bundles you have `"READ"` permissions for. You can use the following query parameters to filter results: -- `includeBundleContent`: Whether to include base64-encoded content in the response. Defaults to `false`. -- `policyName`: Return only bundles that match this policy name. -- `policyUID`: Return only bundles that match this policy UID. -- `startTime`: Return only bundles modified at or after this time. -- `endTime`: Return only bundles modified before this time. +- `includeBundleContent`: Whether to include base64-encoded content in the response. Defaults to `false`. +- `policyName`: Return only bundles that match this policy name. +- `policyUID`: Return only bundles that match this policy UID. +- `startTime`: Return only bundles modified at or after this time. +- `endTime`: Return only bundles modified before this time. If no time range is provided, the API defaults to showing bundles modified in the past 24 hours. diff --git a/content/nim/waf-integration/policies-and-logs/log-profiles/create-log-profile.md b/content/nim/waf-integration/policies-and-logs/log-profiles/create-log-profile.md index a0f916021a..19f1d58045 100644 --- a/content/nim/waf-integration/policies-and-logs/log-profiles/create-log-profile.md +++ b/content/nim/waf-integration/policies-and-logs/log-profiles/create-log-profile.md @@ -5,9 +5,7 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- - You can create and upload new F5 WAF for NGINX security log profiles using the NGINX Instance Manager REST API. A log profile defines how security events are recorded and exported from your NGINX instances. diff --git a/content/nim/waf-integration/policies-and-logs/log-profiles/delete-log-profile.md b/content/nim/waf-integration/policies-and-logs/log-profiles/delete-log-profile.md index dab64354de..fe6c91de7e 100644 --- a/content/nim/waf-integration/policies-and-logs/log-profiles/delete-log-profile.md +++ b/content/nim/waf-integration/policies-and-logs/log-profiles/delete-log-profile.md @@ -5,10 +5,8 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- - -You can delete an existing F5 WAF for NGINX security log profile from NGINX Instance Manager using the REST API. +You can delete an existing F5 WAF for NGINX security log profile from NGINX Instance Manager using the REST API. Deleting a log profile permanently removes it from the system. To delete a security log profile, send a `DELETE` request to the Security Log Profiles API using the profile’s UID. diff --git a/content/nim/waf-integration/policies-and-logs/log-profiles/update-log-profile.md b/content/nim/waf-integration/policies-and-logs/log-profiles/update-log-profile.md index 2219a12edd..7641a01859 100644 --- a/content/nim/waf-integration/policies-and-logs/log-profiles/update-log-profile.md +++ b/content/nim/waf-integration/policies-and-logs/log-profiles/update-log-profile.md @@ -5,14 +5,12 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- - You can update an existing F5 WAF for NGINX security log profile using the NGINX Instance Manager REST API. Depending on your workflow, you can either overwrite the current version or create a new revision. To update a log profile, use one of the following methods: -- `POST` with the `isNewRevision=true` parameter to create a new revision. +- `POST` with the `isNewRevision=true` parameter to create a new revision. - `PUT` with the log profile UID to overwrite the existing version. {{< call-out "note" "Access the REST API" >}} diff --git a/content/nim/waf-integration/policies-and-logs/policies/add-signature-sets.md b/content/nim/waf-integration/policies-and-logs/policies/add-signature-sets.md index 468330773c..e599d232b0 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/add-signature-sets.md +++ b/content/nim/waf-integration/policies-and-logs/policies/add-signature-sets.md @@ -15,7 +15,7 @@ Attack signatures are rules or patterns that identify known attack sequences or ### Signature sets -A **signature set** is a collection of attack signatures with a specific name and purpose. These sets are predefined and can be enabled or disabled in your policy. +A **signature set** is a collection of attack signatures with a specific name and purpose. These sets are predefined and can be enabled or disabled in your policy. For example, you might have sets for SQL Injection Signatures, Cross-Site Scripting Signatures, or Buffer Overflow Signatures. diff --git a/content/nim/waf-integration/policies-and-logs/policies/cookies-parameters-urls.md b/content/nim/waf-integration/policies-and-logs/policies/cookies-parameters-urls.md index dc3646e8d2..42bc93a23c 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/cookies-parameters-urls.md +++ b/content/nim/waf-integration/policies-and-logs/policies/cookies-parameters-urls.md @@ -5,7 +5,6 @@ toc: true weight: 500 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- ## Add cookies diff --git a/content/nim/waf-integration/policies-and-logs/policies/create-policy.md b/content/nim/waf-integration/policies-and-logs/policies/create-policy.md index b22e1c7971..0b6b5bb932 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/create-policy.md +++ b/content/nim/waf-integration/policies-and-logs/policies/create-policy.md @@ -5,7 +5,6 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- You can create and manage security policies in F5 NGINX Instance Manager to control F5 WAF for NGINX behavior. When you create a policy, the interface provides guided options and presets aligned with F5 WAF for NGINX. If you’re familiar with WAF configuration, you can also customize your policy directly in JSON. diff --git a/content/nim/waf-integration/policies-and-logs/policies/delete-policy.md b/content/nim/waf-integration/policies-and-logs/policies/delete-policy.md index 8bf6e414eb..1f7dc97a4b 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/delete-policy.md +++ b/content/nim/waf-integration/policies-and-logs/policies/delete-policy.md @@ -5,7 +5,6 @@ toc: true weight: 300 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- You can delete a security policy using either the NGINX Instance Manager web interface or the REST API. diff --git a/content/nim/waf-integration/policies-and-logs/policies/review-policy.md b/content/nim/waf-integration/policies-and-logs/policies/review-policy.md index a41ad35434..7d6036774d 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/review-policy.md +++ b/content/nim/waf-integration/policies-and-logs/policies/review-policy.md @@ -5,7 +5,6 @@ toc: true weight: 600 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- Before deploying a policy to an NGINX instance or instance group, you can review it in NGINX Instance Manager. The system stores all F5 WAF for NGINX policies and their version history, so you can review details or roll back to an earlier version if needed. @@ -17,7 +16,7 @@ In the NGINX Instance Manager web interface, go to **WAF > Policies**, then sele - **Details**, which includes: - Policy Details: Descriptions, status, enforcement type, latest version, and last deployed time. - Deployments: List of instances and instance groups where the F5 WAF for NGINX policy is deployed. -- **Policy JSON** – Shows the full security policy in JSON format. Select **Edit** to make changes directly. +- **Policy JSON** – Shows the full security policy in JSON format. Select **Edit** to make changes directly. - **Versions** – Displays previous revisions of the security policy. You can redeploy an older version if necessary. ## Manage existing policies @@ -26,10 +25,10 @@ From **WAF > Policies**, you can manage your existing policies. On the **Securit - **Edit** – Modify the selected security policy. - **Compile** – Precompile the complete WAF configuration — including security policies, attack signatures, threat campaigns, and log profiles — into a single `.tgz` bundle and push it to the selected F5 WAF for NGINX instances. -- **Save As** – Create a copy of the security policy under a new name to use as a baseline for customization. +- **Save As** – Create a copy of the security policy under a new name to use as a baseline for customization. - **Export as JSON** – Download the security policy definition in JSON format. - **Download Bundle** – Download the compiled `.tgz` security bundle for reuse or offline deployment. -- **Delete** – Permanently remove the security policy from NGINX Instance Manager. +- **Delete** – Permanently remove the security policy from NGINX Instance Manager. {{< call-out "note" "Note" >}} If you use **Save As** to create a new policy, include the `app_protect_cookie_seed` [directive]({{< ref "/waf/policies/directives.md" >}}). diff --git a/content/nim/waf-integration/policies-and-logs/policies/update-policy.md b/content/nim/waf-integration/policies-and-logs/policies/update-policy.md index d7eb05ddbd..2eabf09254 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/update-policy.md +++ b/content/nim/waf-integration/policies-and-logs/policies/update-policy.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- You can update an existing F5 WAF for NGINX security policy using either the NGINX Instance Manager web interface or the REST API. diff --git a/content/nim/waf-integration/policies-and-logs/policies/waf-policy-matching-types.md b/content/nim/waf-integration/policies-and-logs/policies/waf-policy-matching-types.md index 0499c073dd..40f9a36ec3 100644 --- a/content/nim/waf-integration/policies-and-logs/policies/waf-policy-matching-types.md +++ b/content/nim/waf-integration/policies-and-logs/policies/waf-policy-matching-types.md @@ -5,7 +5,6 @@ toc: true weight: 700 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- In F5 WAF for NGINX, you can define how the WAF identifies and protects URLs, cookies, and parameters using **explicit** or **wildcard** matching. The matching type determines how closely the WAF compares incoming requests to the entities defined in your security policy. diff --git a/content/nim/waf-integration/policies-and-logs/publish/check-publication-status.md b/content/nim/waf-integration/policies-and-logs/publish/check-publication-status.md index 24618bc39b..824107d362 100644 --- a/content/nim/waf-integration/policies-and-logs/publish/check-publication-status.md +++ b/content/nim/waf-integration/policies-and-logs/publish/check-publication-status.md @@ -5,7 +5,6 @@ toc: true weight: 200 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- After you publish security updates, you can check their deployment status using the NGINX Instance Manager REST API. diff --git a/content/nim/waf-integration/policies-and-logs/publish/publish-to-instances.md b/content/nim/waf-integration/policies-and-logs/publish/publish-to-instances.md index e24b8f08aa..6600baf62c 100644 --- a/content/nim/waf-integration/policies-and-logs/publish/publish-to-instances.md +++ b/content/nim/waf-integration/policies-and-logs/publish/publish-to-instances.md @@ -5,10 +5,9 @@ toc: true weight: 100 nd-content-type: how-to nd-product: NIMNGR -nd-docs: --- -Use the NGINX Instance Manager Publish API to deploy updated security configurations to your NGINX instances or instance groups. +Use the NGINX Instance Manager Publish API to deploy updated security configurations to your NGINX instances or instance groups. You can publish security policies, log profiles, attack signatures, bot signatures, and threat campaigns. Call this endpoint **after** you’ve created or updated the resources you want to deploy. @@ -25,12 +24,12 @@ Call this endpoint **after** you’ve created or updated the resources you want Include the following details in your request body, depending on what you’re publishing: -- Instance and instance group UIDs -- Policy UID and name -- Log profile UID and name -- Attack signature library UID and version -- Bot signature library UID and version -- Threat campaign UID and version +- Instance and instance group UIDs +- Policy UID and name +- Log profile UID and name +- Attack signature library UID and version +- Bot signature library UID and version +- Threat campaign UID and version ### Example request