From ca3874ce58d1ad2d96001692b0204185f1201b93 Mon Sep 17 00:00:00 2001 From: Travis Martin Date: Thu, 13 Mar 2025 10:43:36 -0700 Subject: [PATCH 01/10] Removed unnecessary metadata keys and standardized the remaining ones --- content/agent/_index.md | 11 +++---- content/agent/configuration/_index.md | 10 +++--- .../configuration/configuration-overview.md | 10 +++--- .../configure-nginx-agent-features.md | 8 ++--- .../configure-nginx-agent-group.md | 10 +++--- .../configuration/encrypt-communication.md | 5 ++- content/agent/configuration/health-checks.md | 8 ++--- content/agent/contribute/_index.md | 10 +++--- content/agent/contribute/community.md | 10 +++--- .../agent/contribute/dev-environment-setup.md | 10 +++--- content/agent/installation-upgrade/_index.md | 7 ++-- .../container-environments/_index.md | 7 ++-- .../container-environments/docker-images.md | 10 +++--- .../container-environments/docker-support.md | 8 ++--- .../installation-upgrade/getting-started.md | 10 +++--- .../installation-github.md | 10 +++--- .../installation-upgrade/installation-oss.md | 10 +++--- .../installation-upgrade/installation-plus.md | 10 +++--- .../agent/installation-upgrade/uninstall.md | 10 +++--- content/agent/installation-upgrade/upgrade.md | 10 +++--- content/agent/overview.md | 10 +++--- content/agent/technical-specifications.md | 10 +++--- content/amplify/additional-resources.md | 4 +-- content/amplify/faq/general.md | 4 +-- content/amplify/faq/metrics-and-metadata.md | 4 +-- content/amplify/faq/nginx-amplify-agent.md | 4 +-- content/amplify/faq/user-interface.md | 4 +-- content/amplify/known-issues.md | 4 +-- .../metrics-metadata/metrics-overview.md | 4 +-- .../amplify/metrics-metadata/nginx-metrics.md | 4 +-- .../amplify/metrics-metadata/os-metrics.md | 4 +-- .../amplify/metrics-metadata/other-metrics.md | 4 +-- .../amplify-agent-overview.md | 4 +-- .../configuration-analysis.md | 4 +-- .../configuring-metric-collection.md | 4 +-- .../detecting-monitoring-instances.md | 4 +-- .../install/configuring-amplify-agent.md | 4 +-- .../install/installing-amplify-agent.md | 4 +-- .../install/uninstalling-amplify-agent.md | 4 +-- .../install/updating-amplify-agent.md | 4 +-- .../install/using-amplify-agent-docker.md | 4 +-- .../metadata-metrics-collection.md | 4 +-- .../nginx-amplify-agent/source-code.md | 4 +-- .../troubleshooting-metrics-collection.md | 4 +-- .../overview/overview-main-components.md | 4 +-- .../user-interface/account-settings.md | 4 +-- content/amplify/user-interface/alerts.md | 4 +-- content/amplify/user-interface/analyzer.md | 4 +-- content/amplify/user-interface/dashboards.md | 4 +-- content/amplify/user-interface/graphs.md | 4 +-- content/amplify/user-interface/inventory.md | 4 +-- content/amplify/user-interface/overview.md | 4 +-- content/controller/admin-guides/_index.md | 4 +-- .../admin-guides/backup-restore/_index.md | 6 +--- .../backup-restore-cluster-config.md | 7 ++-- .../backup-restore-embedded-config-db.md | 7 ++-- .../backup-restore-external-config-db.md | 7 ++-- .../backup-restore-metrics-db.md | 7 ++-- .../admin-guides/config-agent/_index.md | 10 ++---- .../config-agent/about-controller-agent.md | 7 ++-- .../configure-metrics-collection.md | 11 +++---- .../config-agent/configure-the-agent.md | 7 ++-- .../config-agent/use-agent-with-docker.md | 7 ++-- .../controller/admin-guides/install/_index.md | 7 +--- .../admin-guides/install/agent-restart.md | 7 ++-- .../install/get-n-plus-cert-and-key.md | 11 +++---- .../install/install-agent-non-root.md | 7 ++-- .../install/install-for-controller.md | 9 +++--- .../install/install-nginx-controller-agent.md | 8 ++--- .../install-nginx-controller-rhel-8.md | 8 ++--- .../install/install-nginx-controller.md | 7 ++-- .../install/nginx-controller-tech-specs.md | 7 ++-- .../install/resilient-cluster-aws.md | 11 +++---- .../resilient-cluster-private-cloud.md | 11 +++---- .../install/try-nginx-controller-app-sec.md | 11 +++---- .../install/try-nginx-controller.md | 11 +++---- .../install/using-helper-script.md | 7 ++-- content/controller/analytics/_index.md | 5 +-- content/controller/analytics/alerts/_index.md | 5 +-- .../analytics/alerts/about-alerts.md | 7 ++-- .../analytics/alerts/manage-alerts.md | 7 ++-- .../alerts/manage-registered-emails.md | 7 ++-- .../alerts/service-now-notifications.md | 8 ++--- .../controller/analytics/catalogs/_index.md | 8 +---- .../analytics/catalogs/dimensions.md | 8 ++--- .../controller/analytics/catalogs/metrics.md | 11 +++---- .../controller/analytics/dashboards/_index.md | 5 +-- .../dashboards/application-health-score.md | 7 ++-- .../analytics/dashboards/custom-dashboards.md | 7 ++-- .../dashboards/overview-dashboard.md | 7 ++-- .../analytics/data-explorer/_index.md | 5 +-- .../analytics/data-explorer/how-to-use.md | 10 +++--- content/controller/analytics/events/_index.md | 5 +-- .../analytics/events/view-events.md | 7 ++-- .../controller/analytics/forwarders/_index.md | 5 +-- .../forward-analytics-to-datadog.md | 7 ++-- .../forwarders/forward-analytics-to-otlp.md | 7 ++-- .../forwarders/forward-analytics-to-splunk.md | 7 ++-- .../forwarders/forward-analytics-to-syslog.md | 7 ++-- .../controller/analytics/metrics/_index.md | 5 +-- .../analytics/metrics/metrics-api.md | 7 ++-- .../metrics/overview-metrics-metadata.md | 11 +++---- .../metrics/overview-traffic-metrics.md | 9 +++--- .../analytics/metrics/view-traffic-metrics.md | 9 +++--- .../analytics/view-app-security-analytics.md | 9 +++--- content/controller/api-management/_index.md | 4 +-- .../controller/api-management/manage-apis.md | 7 ++-- .../api-management/manage-dev-portals.md | 7 ++-- content/controller/api/_index.md | 4 +-- content/controller/api/overview.md | 7 ++-- .../controller/api/reference/ctlr-adc-api.md | 13 +++----- .../api/reference/ctlr-analytics-api.md | 8 ++--- .../controller/api/reference/ctlr-apim-api.md | 8 ++--- .../api/reference/ctlr-platform-api.md | 8 ++--- content/controller/app-delivery/_index.md | 6 +--- .../controller/app-delivery/about-caching.md | 11 +++---- .../controller/app-delivery/about-snippets.md | 7 ++-- .../app-delivery/deploy-simple-app.md | 7 ++-- .../controller/app-delivery/manage-apps.md | 7 ++-- .../app-delivery/security/_index.md | 3 +- .../app-delivery/security/concepts/_index.md | 3 +- .../app-sec-default-policy-original.md | 9 +++--- .../security/concepts/app-sec-metrics.md | 10 +++--- .../concepts/bring-your-own-policy.md | 10 +++--- .../concepts/extend-app-security-snippets.md | 9 +++--- .../security/concepts/what-is-waf.md | 9 +++--- .../app-delivery/security/tutorials/_index.md | 3 +- .../tutorials/add-app-security-with-waf.md | 9 +++--- .../tutorials/set-waf-monitor-mode.md | 7 ++-- .../security/tutorials/tune-waf-for-app.md | 9 +++--- .../tutorials/using-rbac-with-app-security.md | 7 ++-- .../tutorials/view-app-security-analytics.md | 9 +++--- content/controller/infrastructure/_index.md | 4 +-- .../infrastructure/instances/_index.md | 4 +-- .../instances/add-aws-instance.md | 7 ++-- .../instances/add-azure-instance.md | 8 ++--- .../instances/add-nap-instance.md | 7 ++-- .../instances/add-vsphere-instance.md | 8 ++--- .../infrastructure/instances/analyzer.md | 7 ++-- .../infrastructure/instances/graphs.md | 14 ++++---- .../infrastructure/instances/ha-data-plane.md | 7 ++-- .../manage-containerized-instances.md | 7 ++-- .../instances/manage-instance-templates.md | 7 ++-- .../instances/manage-instances.md | 7 ++-- .../locations/manage-locations.md | 7 ++-- content/controller/platform/_index.md | 4 +-- .../platform/about/get-controller-version.md | 7 ++-- .../platform/about/what-is-controller.md | 7 ++-- .../platform/access-management/_index.md | 4 +-- .../manage-active-directory-auth-provider.md | 11 +++---- .../access-management/manage-roles.md | 7 ++-- .../access-management/manage-users.md | 7 ++-- .../platform/integrations/_index.md | 4 +-- .../platform/integrations/aws-integration.md | 7 ++-- .../integrations/big-ip-self-service.md | 7 ++-- .../platform/licensing-controller.md | 7 ++-- .../controller/platform/maintenance/_index.md | 4 +-- .../maintenance/changing-ip-address.md | 9 +++--- content/controller/platform/manage-cluster.md | 9 +++--- content/controller/releases/_index.md | 4 +-- content/controller/releases/adc/_index.md | 8 ++--- .../releases/adc/adc-release-notes-3.20.1.md | 7 ++-- .../releases/adc/adc-release-notes-3.20.md | 7 ++-- .../releases/adc/adc-release-notes-3.21.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.1.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.2.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.3.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.4.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.5.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.6.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.7.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.8.md | 7 ++-- .../releases/adc/adc-release-notes-3.22.md | 7 ++-- content/controller/releases/apim/_index.md | 4 +-- .../apim/apim-release-notes-3.18.1.md | 7 ++-- .../releases/apim/apim-release-notes-3.18.md | 7 ++-- .../apim/apim-release-notes-3.19.1.md | 7 ++-- .../apim/apim-release-notes-3.19.2.md | 7 ++-- .../releases/apim/apim-release-notes-3.19.md | 7 ++-- content/controller/releases/release-notes.md | 9 +++--- content/controller/services/_index.md | 4 +-- .../controller/services/available-policies.md | 7 ++-- content/controller/services/manage-certs.md | 7 ++-- .../services/manage-environments.md | 7 ++-- .../controller/services/manage-gateways.md | 7 ++-- .../services/manage-identity-providers.md | 7 ++-- content/controller/services/overview.md | 7 ++-- content/controller/support/_index.md | 4 +-- content/controller/support/contact-support.md | 8 ++--- .../support/troubleshooting-controller.md | 12 +++---- .../support/troubleshooting-forwarders.md | 7 ++-- content/mesh/_index.md | 16 ++++++---- content/mesh/about/_index.md | 9 +++--- content/mesh/about/architecture.md | 11 ++++--- content/mesh/about/mesh-tech-specs.md | 10 +++--- content/mesh/about/what-is-nsm.md | 10 +++--- content/mesh/get-started/_index.md | 9 +++--- .../mesh/get-started/install/configuration.md | 10 +++--- .../get-started/install/install-with-helm.md | 10 +++--- content/mesh/get-started/install/install.md | 9 +++--- .../mesh/get-started/platform-setup/_index.md | 5 +-- .../mesh/get-started/platform-setup/gke.md | 9 ++++-- .../get-started/platform-setup/kubeadm.md | 6 ++-- .../get-started/platform-setup/kubespray.md | 6 ++-- .../get-started/platform-setup/openshift.md | 9 ++++-- .../platform-setup/persistent-storage.md | 9 ++++-- .../mesh/get-started/platform-setup/rke.md | 9 ++++-- .../platform-setup/supported-platforms.md | 7 ++-- .../uninstall/uninstall-with-helm.md | 10 +++--- .../mesh/get-started/uninstall/uninstall.md | 8 +++-- .../get-started/upgrade/upgrade-with-helm.md | 10 +++--- content/mesh/get-started/upgrade/upgrade.md | 10 +++--- content/mesh/guides/_index.md | 6 ++-- content/mesh/guides/inject-sidecar-proxy.md | 12 ++++--- content/mesh/guides/monitoring-and-tracing.md | 12 ++++--- content/mesh/guides/private-registry.md | 10 +++--- content/mesh/guides/production-tuning.md | 8 +++-- content/mesh/guides/prometheus-metrics.md | 11 ++++--- content/mesh/guides/secure-traffic-mtls.md | 11 ++++--- content/mesh/guides/smi-traffic-metrics.md | 11 ++++--- content/mesh/guides/smi-traffic-policies.md | 12 ++++--- content/mesh/guides/v1alpha1-ratelimit.md | 9 +++--- content/mesh/reference/_index.md | 4 +-- content/mesh/reference/api-usage.md | 9 +++--- content/mesh/reference/nginx-meshctl.md | 8 +++-- content/mesh/reference/permissions.md | 11 +++---- content/mesh/releases/_index.md | 7 ++-- .../mesh/releases/oss-dependencies/index.md | 3 +- content/mesh/releases/release-notes-0.5.0.md | 13 +++++--- content/mesh/releases/release-notes-0.6.0.md | 13 +++++--- content/mesh/releases/release-notes-0.7.0.md | 13 +++++--- content/mesh/releases/release-notes-0.8.0.md | 13 +++++--- content/mesh/releases/release-notes-0.9.0.md | 13 +++++--- content/mesh/releases/release-notes-0.9.1.md | 13 +++++--- content/mesh/releases/release-notes-1.0.0.md | 13 +++++--- content/mesh/releases/release-notes-1.0.1.md | 13 +++++--- content/mesh/releases/release-notes-1.1.0.md | 13 +++++--- content/mesh/releases/release-notes-1.2.0.md | 13 +++++--- content/mesh/releases/release-notes-1.2.1.md | 13 +++++--- content/mesh/releases/release-notes-1.3.0.md | 13 +++++--- content/mesh/releases/release-notes-1.3.1.md | 13 +++++--- content/mesh/releases/release-notes-1.4.0.md | 13 +++++--- content/mesh/releases/release-notes-1.4.1.md | 13 +++++--- content/mesh/releases/release-notes-1.5.0.md | 13 +++++--- content/mesh/releases/release-notes-1.6.0.md | 13 +++++--- content/mesh/releases/release-notes-1.7.0.md | 13 +++++--- content/mesh/releases/release-notes-2.0.0.md | 14 +++++--- content/mesh/support/_index.md | 6 ++-- content/mesh/support/contact-support.md | 9 +++--- content/mesh/tutorials/_index.md | 6 ++-- content/mesh/tutorials/deploy-example-app.md | 11 ++++--- content/mesh/tutorials/kic/deploy-with-kic.md | 10 +++--- .../mesh/tutorials/kic/egress-walkthrough.md | 10 +++--- .../tutorials/kic/ingress-udp-walkthrough.md | 10 +++--- .../mesh/tutorials/kic/ingress-walkthrough.md | 10 +++--- content/mesh/tutorials/observability.md | 10 +++--- .../mesh/tutorials/ratelimit-walkthrough.md | 9 +++--- .../tutorials/trafficsplit-deployments.md | 10 +++--- content/nap-dos/deployment-guide/_index.md | 4 +-- ...with-dos-and-waf-on-amazon-web-services.md | 5 +-- .../learn-about-deployment.md | 5 +-- .../nap-dos/directives-and-policy/_index.md | 4 +-- content/nap-dos/monitoring/_index.md | 4 +-- content/nap-dos/monitoring/access-log.md | 5 +-- .../monitoring/live-activity-monitoring.md | 5 +-- content/nap-dos/monitoring/operation-log.md | 5 +-- content/nap-dos/monitoring/security-log.md | 5 +-- content/nap-dos/monitoring/types-of-logs.md | 5 +-- content/nap-dos/releases/_index.md | 4 +-- .../nap-dos/troubleshooting-guide/_index.md | 4 +-- .../how-to-troubleshoot.md | 5 +-- content/nap-waf/_index.md | 11 ++++--- content/nap-waf/v4/_index.md | 4 +-- content/nap-waf/v4/admin-guide/_index.md | 8 ++--- content/nap-waf/v4/admin-guide/install-nms.md | 5 +-- .../nap-waf/v4/admin-guide/upgrade-nap-waf.md | 8 ++--- .../nap-waf/v4/configuration-guide/_index.md | 5 +-- .../v4/configuration-guide/configuration.md | 5 +-- .../nap-waf/v4/declarative-policy/_index.md | 7 ++-- content/nap-waf/v4/logging-overview/_index.md | 8 ++--- .../nap-waf/v4/logging-overview/access-log.md | 5 +-- .../nap-waf/v4/logging-overview/debug-logs.md | 5 +-- .../v4/logging-overview/logs-overview.md | 5 +-- .../v4/logging-overview/operation-logs.md | 5 +-- .../v4/logging-overview/security-log.md | 5 +-- content/nap-waf/v4/releases/_index.md | 8 ++--- .../v4/troubleshooting-guide/_index.md | 7 ++-- .../troubleshooting-guide/troubleshooting.md | 5 +-- content/nap-waf/v5/_index.md | 4 +-- content/nap-waf/v5/admin-guide/_index.md | 8 ++--- .../nap-waf/v5/configuration-guide/_index.md | 5 +-- .../v5/configuration-guide/configuration.md | 9 +++--- .../nap-waf/v5/declarative-policy/_index.md | 4 +-- .../nap-waf/v5/declarative-policy/policy.md | 11 +++---- content/nap-waf/v5/logging-overview/_index.md | 8 ++--- .../nap-waf/v5/logging-overview/access-log.md | 11 ++++--- .../v5/logging-overview/logs-overview.md | 5 +-- .../v5/logging-overview/security-log.md | 11 ++++--- content/nap-waf/v5/releases/_index.md | 8 ++--- .../v5/troubleshooting-guide/_index.md | 4 +-- .../troubleshooting-guide/troubleshooting.md | 11 ++++--- content/nginx-one/about.md | 7 ++-- content/nginx-one/api/api-reference-guide.md | 10 +++--- content/nginx-one/api/authentication.md | 7 ++-- content/nginx-one/changelog.md | 9 +++--- content/nginx-one/glossary.md | 7 ++-- .../certificates/manage-certificates.md | 9 +++--- .../how-to/config-sync-groups/add-file-csg.md | 9 +++--- .../manage-config-sync-groups.md | 9 +++--- ...ginx-plus-container-images-to-nginx-one.md | 9 +++--- .../create-manage-data-plane-keys.md | 7 ++-- .../how-to/nginx-configs/add-file.md | 9 +++--- .../how-to/nginx-configs/add-instance.md | 7 ++-- .../clean-up-unavailable-instances.md | 9 +++--- .../manage-config-sync-groups.md | 9 +++--- .../view-edit-nginx-configurations.md | 9 +++--- .../set-up-nginx-proxy-for-nginx-one.md | 9 +++--- content/nginx/_index.md | 9 +++--- content/nginx/admin-guide/_index.md | 4 +-- .../admin-guide/basic-functionality/_index.md | 4 +-- .../managing-configuration-files.md | 5 +-- .../basic-functionality/runtime-control.md | 5 +-- .../nginx/admin-guide/content-cache/_index.md | 8 ++--- .../content-cache/content-caching.md | 5 +-- .../admin-guide/dynamic-modules/_index.md | 4 +-- .../admin-guide/dynamic-modules/brotli.md | 5 +-- .../dynamic-modules/cookie-flag.md | 5 +-- .../dynamic-modules/dynamic-modules.md | 5 +-- .../dynamic-modules/encrypted-session.md | 5 +-- .../nginx/admin-guide/dynamic-modules/fips.md | 5 +-- .../admin-guide/dynamic-modules/geoip.md | 5 +-- .../admin-guide/dynamic-modules/geoip2.md | 5 +-- .../dynamic-modules/headers-more.md | 5 +-- .../http-substitutions-filter.md | 5 +-- .../dynamic-modules/image-filter.md | 5 +-- .../nginx/admin-guide/dynamic-modules/lua.md | 5 +-- .../nginx/admin-guide/dynamic-modules/ndk.md | 5 +-- .../admin-guide/dynamic-modules/nginscript.md | 5 +-- .../admin-guide/dynamic-modules/nginx-waf.md | 5 +-- .../dynamic-modules/opentelemetry.md | 5 +-- .../dynamic-modules/opentracing.md | 15 +++++---- .../dynamic-modules/passenger-open-source.md | 5 +-- .../nginx/admin-guide/dynamic-modules/perl.md | 5 +-- .../dynamic-modules/prometheus-njs.md | 5 +-- .../nginx/admin-guide/dynamic-modules/rtmp.md | 5 +-- .../admin-guide/dynamic-modules/set-misc.md | 5 +-- .../admin-guide/dynamic-modules/spnego.md | 5 +-- .../admin-guide/dynamic-modules/uninstall.md | 5 +-- .../nginx/admin-guide/dynamic-modules/xslt.md | 5 +-- .../admin-guide/high-availability/_index.md | 8 ++--- .../configuration-sharing.md | 9 +++--- .../high-availability/ha-keepalived-nodes.md | 5 +-- .../high-availability/ha-keepalived.md | 5 +-- .../high-availability/zone_sync.md | 11 ++++--- .../high-availability/zone_sync_details.md | 5 +-- .../admin-guide/installing-nginx/_index.md | 4 +-- .../installing-nginx-docker.md | 5 +-- .../installing-nginx-open-source.md | 5 +-- ...stalling-nginx-plus-amazon-web-services.md | 5 +-- ...alling-nginx-plus-google-cloud-platform.md | 5 +-- .../installing-nginx-plus-microsoft-azure.md | 9 +++--- .../installing-nginx/installing-nginx-plus.md | 9 +++--- .../nginx/admin-guide/load-balancer/_index.md | 8 ++--- .../dynamic-configuration-api.md | 9 +++--- .../load-balancer/grpc-health-check.md | 5 +-- .../load-balancer/http-health-check.md | 5 +-- .../load-balancer/http-load-balancer.md | 5 +-- .../load-balancer/tcp-health-check.md | 5 +-- .../load-balancer/tcp-udp-load-balancer.md | 9 +++--- .../load-balancer/udp-health-check.md | 9 +++--- .../load-balancer/using-proxy-protocol.md | 5 +-- .../nginx/admin-guide/mail-proxy/_index.md | 8 ++--- .../admin-guide/mail-proxy/mail-proxy.md | 5 +-- .../nginx/admin-guide/monitoring/_index.md | 4 +-- .../nginx/admin-guide/monitoring/debugging.md | 9 +++--- .../monitoring/diagnostic-package.md | 5 +-- .../monitoring/live-activity-monitoring.md | 10 +++--- .../nginx/admin-guide/monitoring/logging.md | 5 +-- .../monitoring/new-relic-plugin.md | 9 +++--- .../admin-guide/security-controls/_index.md | 9 +++--- .../configuring-http-basic-authentication.md | 5 +-- .../configuring-jwt-authentication.md | 5 +-- .../configuring-subrequest-authentication.md | 5 +-- .../controlling-access-by-geoip.md | 5 +-- .../controlling-access-proxied-http.md | 5 +-- .../controlling-access-proxied-tcp.md | 5 +-- .../denylisting-ip-addresses.md | 5 +-- .../securing-http-traffic-upstream.md | 5 +-- .../securing-tcp-traffic-upstream.md | 5 +-- .../security-controls/terminating-ssl-http.md | 5 +-- .../security-controls/terminating-ssl-tcp.md | 5 +-- .../nginx/admin-guide/web-server/_index.md | 8 ++--- .../web-server/app-gateway-uwsgi-django.md | 9 +++--- .../admin-guide/web-server/compression.md | 5 +-- .../admin-guide/web-server/reverse-proxy.md | 5 +-- .../web-server/serving-static-content.md | 5 +-- .../admin-guide/web-server/web-server.md | 5 +-- content/nginx/deployment-guides/_index.md | 10 +++--- .../amazon-web-services/_index.md | 8 ++--- .../high-availability-keepalived.md | 9 +++--- ...high-availability-network-load-balancer.md | 9 +++--- ...-controller-elastic-kubernetes-services.md | 5 +-- .../route-53-global-server-load-balancing.md | 5 +-- .../global-server-load-balancing/_index.md | 4 +-- .../ns1-global-server-load-balancing.md | 5 +-- .../google-cloud-platform/_index.md | 4 +-- .../high-availability-all-active.md | 9 +++--- .../load-balance-third-party/_index.md | 4 +-- .../load-balance-third-party/apache-tomcat.md | 5 +-- .../microsoft-exchange.md | 5 +-- .../load-balance-third-party/node-js.md | 5 +-- .../oracle-e-business-suite.md | 5 +-- .../oracle-weblogic-server.md | 5 +-- .../load-balance-third-party/wildfly.md | 5 +-- .../microsoft-azure/_index.md | 4 +-- ...igh-availability-standard-load-balancer.md | 9 +++--- .../virtual-machines-for-nginx.md | 8 +++-- .../migrate-hardware-adc/_index.md | 4 +-- .../citrix-adc-configuration.md | 9 +++--- .../f5-big-ip-configuration.md | 5 +-- .../nginx-plus-high-availability-chef.md | 5 +-- .../setting-up-nginx-demo-environment.md | 5 +-- .../single-sign-on/_index.md | 4 +-- .../active-directory-federation-services.md | 5 +-- .../deployment-guides/single-sign-on/auth0.md | 7 ++-- .../single-sign-on/cognito.md | 5 +-- .../single-sign-on/keycloak.md | 5 +-- .../deployment-guides/single-sign-on/okta.md | 5 +-- .../single-sign-on/onelogin.md | 7 ++-- .../single-sign-on/ping-identity.md | 5 +-- content/nginx/directives.md | 3 +- content/nginx/fips-compliance-nginx-plus.md | 5 +-- content/nginx/open-source-components.md | 5 +-- content/nginx/releases.md | 9 +++--- content/nginx/technical-specs.md | 11 ++++--- content/nginxaas-azure/_index.md | 15 +++++---- content/nginxaas-azure/app-protect/_index.md | 4 +-- .../app-protect/configure-waf.md | 6 ++-- .../nginxaas-azure/app-protect/disable-waf.md | 6 ++-- .../app-protect/enable-logging.md | 6 ++-- .../nginxaas-azure/app-protect/enable-waf.md | 6 ++-- content/nginxaas-azure/billing/_index.md | 5 +-- content/nginxaas-azure/billing/overview.md | 8 +++-- .../billing/usage-and-cost-estimator.md | 8 +++-- .../changelog-archive/_index.md | 5 +-- content/nginxaas-azure/client-tools/_index.md | 5 +-- content/nginxaas-azure/client-tools/cli.md | 9 +++--- content/nginxaas-azure/client-tools/sdk.md | 10 +++--- .../nginxaas-azure/client-tools/templates.md | 10 +++--- .../nginxaas-azure/client-tools/terraform.md | 9 +++--- content/nginxaas-azure/faq.md | 9 +++--- .../nginxaas-azure/getting-started/_index.md | 5 +-- .../create-deployment/_index.md | 5 +-- .../create-deployment/deploy-azure-cli.md | 6 ++-- .../create-deployment/deploy-azure-portal.md | 8 +++-- .../create-deployment/deploy-terraform.md | 6 ++-- .../managed-identity-portal.md | 8 +++-- .../nginx-configuration/_index.md | 5 +-- .../nginx-configuration-azure-cli.md | 6 ++-- .../nginx-configuration-portal.md | 8 +++-- .../nginx-configurations-terraform.md | 6 ++-- .../nginx-configuration/overview.md | 6 ++-- .../getting-started/prerequisites.md | 8 +++-- .../ssl-tls-certificates/_index.md | 7 ++-- .../ssl-tls-certificates/overview.md | 6 ++-- .../ssl-tls-certificates-azure-cli.md | 6 ++-- .../ssl-tls-certificates-portal.md | 8 +++-- .../ssl-tls-certificates-terraform.md | 6 ++-- content/nginxaas-azure/monitoring/_index.md | 5 +-- .../monitoring/configure-alerts.md | 8 +++-- .../monitoring/enable-logging/_index.md | 4 +-- .../enable-logging/logging-using-cli.md | 8 +++-- .../enable-logging/logging-using-portal.md | 8 +++-- .../enable-logging/logging-using-terraform.md | 8 +++-- .../monitoring/enable-monitoring.md | 8 +++-- .../monitoring/metrics-catalog.md | 8 +++-- content/nginxaas-azure/overview/_index.md | 5 +-- .../overview/feature-comparison.md | 10 +++--- content/nginxaas-azure/overview/overview.md | 8 +++-- content/nginxaas-azure/quickstart/_index.md | 5 +-- .../quickstart/basic-caching.md | 8 +++-- content/nginxaas-azure/quickstart/geoip2.md | 6 ++-- .../quickstart/hosting-static-content.md | 8 +++-- .../quickstart/loadbalancer-kubernetes.md | 6 ++-- .../nginxaas-azure/quickstart/njs-support.md | 8 +++-- .../quickstart/rate-limiting.md | 8 +++-- content/nginxaas-azure/quickstart/recreate.md | 8 +++-- .../quickstart/runtime-state-sharing.md | 8 +++-- content/nginxaas-azure/quickstart/scaling.md | 8 +++-- .../quickstart/security-controls/_index.md | 5 +-- .../security-controls/auth-basic.md | 6 ++-- .../security-controls/certificates.md | 6 ++-- .../quickstart/security-controls/jwt.md | 6 ++-- .../quickstart/security-controls/oidc.md | 6 ++-- .../private-link-to-upstreams.md | 6 ++-- .../securing-upstream-traffic.md | 8 +++-- .../quickstart/upgrade-channels.md | 8 +++-- .../nginxaas-azure/troubleshooting/_index.md | 5 +-- .../troubleshooting/migrate-from-standard.md | 6 ++-- .../troubleshooting/troubleshooting.md | 8 +++-- .../authentication/oidc/getting-started.md | 7 ++-- .../authentication/oidc/keycloak-setup.md | 9 +++--- .../oidc/microsoft-entra-automation.md | 7 ++-- .../oidc/microsoft-entra-setup.md | 9 +++--- .../authentication/oidc/scim-provisioning.md | 7 ++-- .../nim/admin-guide/license/add-license.md | 12 ++++--- .../report-usage-connected-deployment.md | 32 +++++++------------ .../maintenance/backup-and-recovery.md | 3 +- .../maintenance/sqlite-installation.md | 3 +- content/nim/admin-guide/rbac/assign-roles.md | 7 ++-- content/nim/admin-guide/rbac/create-roles.md | 7 ++-- .../rbac/manage-resource-groups.md | 7 ++-- ...y-nginx-instance-manager-docker-compose.md | 16 +++------- .../deploy-nginx-plus-and-agent-docker.md | 11 +++---- .../build-and-deploy.md | 7 ++-- .../infrastructure-as-code/configuration.md | 7 ++-- .../deploy/infrastructure-as-code/overview.md | 7 ++-- .../deploy/kubernetes/deploy-using-helm.md | 9 +++--- .../frequently-used-helm-configs.md | 7 ++-- .../deploy/kubernetes/helm-config-settings.md | 7 ++-- .../vm-bare-metal/install-nim-deprecated.md | 9 +++--- content/nim/deploy/vm-bare-metal/install.md | 9 +++--- .../add-license-disconnected-deployment.md | 32 +++++++------------ .../report-usage-disconnected-deployment.md | 27 ++++++---------- content/nim/fundamentals/api-overview.md | 11 +++---- .../nim/fundamentals/dashboard-overview.md | 7 ++-- content/nim/fundamentals/tech-specs.md | 4 ++- content/nim/monitoring/catalogs/_index.md | 11 ++----- content/nim/monitoring/catalogs/dimensions.md | 9 ++---- content/nim/monitoring/catalogs/events.md | 9 ++---- content/nim/monitoring/catalogs/metrics.md | 9 ++---- content/nim/monitoring/metrics-api.md | 7 ++-- content/nim/monitoring/overview-metrics.md | 9 +++--- content/nim/monitoring/view-events-metrics.md | 4 ++- .../overview-nap-waf-config-management.md | 7 ++-- .../security-monitoring/troubleshooting.md | 7 ++-- .../setup-waf-config-management.md | 11 +++---- .../waf-config-management.md | 3 +- .../concepts/augment-templates.md | 31 +++++++----------- .../concepts/config-templates.md | 31 +++++++----------- .../concepts/default-base-template.md | 22 ++++++------- .../concepts/template-resources.md | 31 +++++++----------- .../manage-nginx-configs-with-templates.md | 32 +++++++------------ .../rbac-config-templates-and-submissions.md | 31 +++++++----------- .../reference/json-schema-reference.md | 31 +++++++----------- .../tutorials/round-robin-reverse-proxy.md | 17 ++++------ content/nim/nginx-configs/publish-configs.md | 7 ++-- content/nim/nginx-configs/stage-configs.md | 7 ++-- content/nim/nginx-instances/add-tags.md | 7 ++-- .../nginx-instances/manage-certificates.md | 7 ++-- .../nginx-instances/manage-instance-groups.md | 12 +++---- content/nim/nginx-instances/scan-instances.md | 7 ++-- content/nim/releases/known-issues.md | 3 +- content/nim/support/contact-support.md | 7 ++-- content/nim/support/k8s-support-package.md | 9 +++--- content/nim/support/support-package.md | 9 +++--- .../configure-clickhouse.md | 7 ++-- .../system-configuration/configure-gateway.md | 7 ++-- .../system-configuration/configure-selinux.md | 7 ++-- .../configure-telemetry.md | 7 ++-- .../system-configuration/configure-vault.md | 7 ++-- .../configure-with-config.md | 9 +++--- .../system-configuration/secure-traffic.md | 7 ++-- content/nim/troubleshooting.md | 7 ++-- content/nms/acm/_index.md | 5 ++- content/nms/acm/about/api-overview.md | 3 +- content/nms/acm/about/architecture.md | 7 ++-- content/nms/acm/about/policies-overview.md | 6 ++-- .../acm/getting-started/add-api-gateway.md | 7 ++-- .../nms/acm/getting-started/add-devportal.md | 7 ++-- content/nms/acm/getting-started/overview.md | 3 +- .../acm/getting-started/publish-api-proxy.md | 7 ++-- .../how-to/deploy-api-connectivity-manager.md | 7 ++-- .../devportals/devportal-support-package.md | 9 +++--- .../configure-devportal-helm-options.md | 7 ++-- .../installation/devportal-helm-chart.md | 7 ++-- .../installation/install-dev-portal.md | 7 ++-- .../installation/install-devportal-offline.md | 7 ++-- .../how-to/devportals/publish-to-devportal.md | 7 ++-- .../configure-devportal-backend.md | 3 +- .../infrastructure/customize-devportal.md | 3 +- .../enable-create-credentials.md | 7 ++-- .../infrastructure/enable-sso-devportal.md | 7 ++-- .../manage-api-infrastructure.md | 11 +++---- .../publish-developer-portal.md | 7 ++-- content/nms/acm/how-to/install-acm.md | 7 ++-- .../how-to/policies/access-control-routing.md | 7 ++-- .../acm/how-to/policies/advanced-security.md | 9 ++---- .../how-to/policies/allowed-http-methods.md | 9 ++---- .../policies/api-access-control-lists.md | 3 +- .../nms/acm/how-to/policies/apikey-authn.md | 13 +++----- .../nms/acm/how-to/policies/basic-authn.md | 13 +++----- .../how-to/policies/cluster-wide-config.md | 9 ++---- .../acm/how-to/policies/cluster-zone-sync.md | 9 ++---- content/nms/acm/how-to/policies/cors.md | 13 +++----- .../how-to/policies/error-response-format.md | 9 ++---- .../nms/acm/how-to/policies/grpc-policies.md | 11 +++---- .../nms/acm/how-to/policies/health-check.md | 10 +++--- .../policies/http-backend-configuration.md | 9 ++---- .../nms/acm/how-to/policies/introspection.md | 9 ++---- .../nms/acm/how-to/policies/jwt-assertion.md | 13 +++----- content/nms/acm/how-to/policies/log-format.md | 11 +++---- .../acm/how-to/policies/manage-policies.md | 11 +++---- .../nms/acm/how-to/policies/openID-connect.md | 14 +++----- .../nms/acm/how-to/policies/proxy-cache.md | 11 +++---- .../how-to/policies/proxy-request-headers.md | 13 +++----- .../how-to/policies/proxy-response-headers.md | 11 +++---- content/nms/acm/how-to/policies/rate-limit.md | 9 ++---- .../policies/request-body-size-limit.md | 7 ++-- .../how-to/policies/request-correlation-id.md | 9 ++---- .../policies/request-header-specification.md | 9 ++---- .../nms/acm/how-to/policies/tls-policies.md | 11 +++---- .../nms/acm/how-to/services/publish-api.md | 11 +++---- .../acm/how-to/services/publish-gRPC-proxy.md | 11 +++---- content/nms/acm/releases/known-issues.md | 15 ++++----- content/nms/acm/releases/release-notes.md | 3 +- content/nms/acm/troubleshooting.md | 7 ++-- content/nms/acm/tutorials/advanced-routing.md | 11 +++---- content/nms/acm/tutorials/aws-deploy.md | 3 +- content/nms/acm/tutorials/enable-metrics.md | 7 ++-- .../acm/tutorials/introspection-keycloak.md | 7 ++-- .../nms/acm/tutorials/oas-security-schemes.md | 7 ++-- content/nms/acm/tutorials/rbac-api-owners.md | 7 ++-- .../nms/acm/tutorials/rbac-infra-admins.md | 7 ++-- .../nms/nginx-agent/install-nginx-agent.md | 7 ++-- .../getting-started/waf-config-management.md | 7 ++-- content/nms/nms-resilience.md | 7 ++-- content/nms/oss-attribution-notice.md | 7 ++-- content/nms/reference/catalogs/_index.md | 11 ++----- content/nms/reference/catalogs/dimensions.md | 9 ++---- content/nms/reference/catalogs/events.md | 9 ++---- content/nms/reference/catalogs/metrics.md | 9 ++---- content/nms/support/contact-support.md | 7 ++-- content/nms/support/k8s-support-package.md | 9 +++--- content/nms/support/support-package.md | 9 +++--- content/ossc.md | 5 +-- content/search.md | 5 +-- content/solutions/_index.md | 7 ++-- .../solutions/about-subscription-licenses.md | 6 ++-- content/solutions/nginx-one-subscription.md | 7 ++-- ...release-guidance-for-automatic-upgrades.md | 8 ++--- 641 files changed, 2345 insertions(+), 2587 deletions(-) diff --git a/content/agent/_index.md b/content/agent/_index.md index 95b9e6b1b..330490eb8 100644 --- a/content/agent/_index.md +++ b/content/agent/_index.md @@ -1,9 +1,8 @@ --- -title: "NGINX Agent" -description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance." -linkTitle: "NGINX Agent" -menu: docs +title: NGINX Agent +description: NGINX Agent is a companion daemon for your NGINX Open Source or NGINX + Plus instance. url: /nginx-agent/ cascade: - logo: "NGINX-product-icon.png" ---- \ No newline at end of file + logo: NGINX-product-icon.png +--- diff --git a/content/agent/configuration/_index.md b/content/agent/configuration/_index.md index 7a1f1bce8..a81279b78 100644 --- a/content/agent/configuration/_index.md +++ b/content/agent/configuration/_index.md @@ -1,8 +1,6 @@ --- -title: "Configuration" -description: "Learn how to configure NGINX Agent." -linkTitle: "Configuration" -weight: "400" -menu: docs +title: Configuration +description: Learn how to configure NGINX Agent. +weight: '400' url: /nginx-agent/configuration/ ---- \ No newline at end of file +--- diff --git a/content/agent/configuration/configuration-overview.md b/content/agent/configuration/configuration-overview.md index e82e76246..9e5c857f8 100644 --- a/content/agent/configuration/configuration-overview.md +++ b/content/agent/configuration/configuration-overview.md @@ -1,14 +1,14 @@ --- -title: "Basic configuration" +title: Basic configuration draft: false weight: 100 toc: true -tags: [ "docs" ] -docs: "DOCS-1229" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1229 +type: +- how-to --- + The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables. {{}} diff --git a/content/agent/configuration/configure-nginx-agent-features.md b/content/agent/configuration/configure-nginx-agent-features.md index 2a1cddcd1..9bfd6abe6 100644 --- a/content/agent/configuration/configure-nginx-agent-features.md +++ b/content/agent/configuration/configure-nginx-agent-features.md @@ -1,13 +1,13 @@ --- -title: "Features configuration" +title: Features configuration draft: false weight: 150 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +type: +- how-to --- + ## Overview This guide describes the F5 NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file. diff --git a/content/agent/configuration/configure-nginx-agent-group.md b/content/agent/configuration/configure-nginx-agent-group.md index bb6260daf..67ec23c3e 100644 --- a/content/agent/configuration/configure-nginx-agent-group.md +++ b/content/agent/configuration/configure-nginx-agent-group.md @@ -1,14 +1,14 @@ --- -title: "Add NGINX users to nginx-agent Group" +title: Add NGINX users to nginx-agent Group draft: false weight: 300 toc: true -tags: [ "docs" ] -docs: "DOCS-933" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-933 +type: +- how-to --- + ## Overview During installation, NGINX Agent detects the NGINX user (typically `nginx`) for the master and worker processes and adds this user to a group called `nginx-agent`. diff --git a/content/agent/configuration/encrypt-communication.md b/content/agent/configuration/encrypt-communication.md index 7d9f1b547..9e9da8f55 100644 --- a/content/agent/configuration/encrypt-communication.md +++ b/content/agent/configuration/encrypt-communication.md @@ -1,12 +1,11 @@ --- title: Encrypt communication -tags: -- docs toc: true weight: 200 -docs: "DOCS-802" +docs: DOCS-802 --- + ## Overview Follow the steps in this guide to encrypt communication between NGINX Agent and Instance Manager with TLS. diff --git a/content/agent/configuration/health-checks.md b/content/agent/configuration/health-checks.md index f045955fb..b0524509d 100644 --- a/content/agent/configuration/health-checks.md +++ b/content/agent/configuration/health-checks.md @@ -1,13 +1,13 @@ --- -title: "Health checks" +title: Health checks draft: false weight: 400 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +type: +- how-to --- + ## Overview The REST API includes a health endpoint to verify the status of NGINX Agent. diff --git a/content/agent/contribute/_index.md b/content/agent/contribute/_index.md index 24e4c7de2..42d522b73 100644 --- a/content/agent/contribute/_index.md +++ b/content/agent/contribute/_index.md @@ -1,8 +1,6 @@ --- -title: "Contribute" -description: "Learn about the NGINX Agent community and contribute to the project." -linkTitle: "Contribute" -menu: docs -weight: "500" +title: Contribute +description: Learn about the NGINX Agent community and contribute to the project. +weight: '500' url: /nginx-agent/contribute/ ---- \ No newline at end of file +--- diff --git a/content/agent/contribute/community.md b/content/agent/contribute/community.md index 2566b4741..3d768fa2e 100644 --- a/content/agent/contribute/community.md +++ b/content/agent/contribute/community.md @@ -1,14 +1,14 @@ --- -title: "Community and contribution" +title: Community and contribution draft: false weight: 100 toc: true -tags: [ "docs" ] -docs: "DOCS-1087" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1087 +type: +- how-to --- + # Community - Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts. diff --git a/content/agent/contribute/dev-environment-setup.md b/content/agent/contribute/dev-environment-setup.md index 4860764f5..d24ebd936 100644 --- a/content/agent/contribute/dev-environment-setup.md +++ b/content/agent/contribute/dev-environment-setup.md @@ -1,14 +1,14 @@ --- -title: "Development environment setup" +title: Development environment setup draft: false weight: 200 toc: true -tags: [ "docs" ] -docs: "DOCS-1088" -categories: ["development"] -doctypes: ["task"] +docs: DOCS-1088 +type: +- how-to --- + ## Overview Learn how to setup a Development Environment for NGINX Agent. diff --git a/content/agent/installation-upgrade/_index.md b/content/agent/installation-upgrade/_index.md index 3ef1ed5bb..1d84d3ebc 100644 --- a/content/agent/installation-upgrade/_index.md +++ b/content/agent/installation-upgrade/_index.md @@ -1,7 +1,6 @@ --- -title: "Installation and upgrade" -description: "Learn how to install, upgrade, and uninstall NGINX Agent." -menu: docs +title: Installation and upgrade +description: Learn how to install, upgrade, and uninstall NGINX Agent. weight: 300 url: /nginx-agent/installation-upgrade/ ---- \ No newline at end of file +--- diff --git a/content/agent/installation-upgrade/container-environments/_index.md b/content/agent/installation-upgrade/container-environments/_index.md index ae6338d52..35c6aa73f 100644 --- a/content/agent/installation-upgrade/container-environments/_index.md +++ b/content/agent/installation-upgrade/container-environments/_index.md @@ -1,7 +1,6 @@ --- -title: "Container environments" -description: "Learn how to build and run NGINX Agent docker images." -menu: docs +title: Container environments +description: Learn how to build and run NGINX Agent docker images. weight: 800 ur: /nginx-agent/installation-upgrade/container-environments/ ---- \ No newline at end of file +--- diff --git a/content/agent/installation-upgrade/container-environments/docker-images.md b/content/agent/installation-upgrade/container-environments/docker-images.md index 88879d743..7897d139c 100644 --- a/content/agent/installation-upgrade/container-environments/docker-images.md +++ b/content/agent/installation-upgrade/container-environments/docker-images.md @@ -1,14 +1,14 @@ --- -title: "Build container images" +title: Build container images draft: false weight: 100 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] -docs: "DOCS-1410" +docs: DOCS-1410 +type: +- how-to --- + ## Overview NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. This document explains multiple ways in which NGINX Agent can be run alongside NGINX in a container. diff --git a/content/agent/installation-upgrade/container-environments/docker-support.md b/content/agent/installation-upgrade/container-environments/docker-support.md index 6d764a1f0..bf1cf2157 100644 --- a/content/agent/installation-upgrade/container-environments/docker-support.md +++ b/content/agent/installation-upgrade/container-environments/docker-support.md @@ -1,15 +1,13 @@ --- title: Container support and troubleshooting -categories: -- installation draft: false -tags: -- docs toc: true weight: 200 -docs: "DOCS-909" +docs: DOCS-909 +type: [] --- + ## Overview The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/agent/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. diff --git a/content/agent/installation-upgrade/getting-started.md b/content/agent/installation-upgrade/getting-started.md index 222ff2b48..acd80d486 100644 --- a/content/agent/installation-upgrade/getting-started.md +++ b/content/agent/installation-upgrade/getting-started.md @@ -1,14 +1,14 @@ --- -title: "Getting started" +title: Getting started draft: false weight: 100 toc: true -tags: [ "docs" ] -docs: "DOCS-1089" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1089 +type: +- how-to --- + ## Overview Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which NGINX Agent will report. diff --git a/content/agent/installation-upgrade/installation-github.md b/content/agent/installation-upgrade/installation-github.md index d53a07006..36747863f 100644 --- a/content/agent/installation-upgrade/installation-github.md +++ b/content/agent/installation-upgrade/installation-github.md @@ -1,14 +1,14 @@ --- -title: "Installation from GitHub release" +title: Installation from GitHub release draft: false weight: 200 toc: true -tags: [ "docs" ] -docs: "DOCS-1090" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1090 +type: +- how-to --- + ## Overview Learn how to install NGINX Agent from a GitHub Release. diff --git a/content/agent/installation-upgrade/installation-oss.md b/content/agent/installation-upgrade/installation-oss.md index cf24dd1a6..4afaddefa 100644 --- a/content/agent/installation-upgrade/installation-oss.md +++ b/content/agent/installation-upgrade/installation-oss.md @@ -1,14 +1,14 @@ --- -title: "Installation from NGINX repository" +title: Installation from NGINX repository draft: false weight: 300 toc: true -tags: [ "docs" ] -docs: "DOCS-1216" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1216 +type: +- how-to --- + ## Overview Learn how to install NGINX Agent from the NGINX Open Source repository. diff --git a/content/agent/installation-upgrade/installation-plus.md b/content/agent/installation-upgrade/installation-plus.md index fe77bbb58..9b005a657 100644 --- a/content/agent/installation-upgrade/installation-plus.md +++ b/content/agent/installation-upgrade/installation-plus.md @@ -1,14 +1,14 @@ --- -title: "Installation from NGINX Plus repository" +title: Installation from NGINX Plus repository draft: false weight: 400 toc: true -tags: [ "docs" ] -docs: "DOCS-1217" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1217 +type: +- how-to --- + ## Overview Learn how to install NGINX Agent from NGINX Plus repository diff --git a/content/agent/installation-upgrade/uninstall.md b/content/agent/installation-upgrade/uninstall.md index 49184df82..c38856811 100644 --- a/content/agent/installation-upgrade/uninstall.md +++ b/content/agent/installation-upgrade/uninstall.md @@ -1,14 +1,14 @@ --- -title: "Uninstall NGINX Agent package" +title: Uninstall NGINX Agent package draft: false weight: 700 toc: true -tags: [ "docs" ] -docs: "DOCS-1230" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1230 +type: +- how-to --- + ## Overview Learn how to uninstall NGINX Agent from your system. diff --git a/content/agent/installation-upgrade/upgrade.md b/content/agent/installation-upgrade/upgrade.md index f5e3409af..a7e3f2a09 100644 --- a/content/agent/installation-upgrade/upgrade.md +++ b/content/agent/installation-upgrade/upgrade.md @@ -1,14 +1,14 @@ --- -title: "Upgrade NGINX Agent package" +title: Upgrade NGINX Agent package draft: false weight: 600 toc: true -tags: [ "docs" ] -docs: "DOCS-1227" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1227 +type: +- how-to --- + ## Overview Learn how to upgrade NGINX Agent. diff --git a/content/agent/overview.md b/content/agent/overview.md index ea9e92ddd..4617b47e9 100644 --- a/content/agent/overview.md +++ b/content/agent/overview.md @@ -1,14 +1,14 @@ --- -title: "Overview" +title: Overview draft: false weight: 100 toc: true -tags: [ "docs" ] -docs: "DOCS-1091" -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-1091 +type: +- how-to --- + ## Overview NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables: diff --git a/content/agent/technical-specifications.md b/content/agent/technical-specifications.md index a17b9fe9f..b03d0ad1a 100644 --- a/content/agent/technical-specifications.md +++ b/content/agent/technical-specifications.md @@ -1,14 +1,14 @@ --- -title: "Technical specifications" +title: Technical specifications draft: false weight: 200 toc: true -tags: [ "docs" ] -docs: "DOCS-1092" -categories: ["development"] -doctypes: ["task"] +docs: DOCS-1092 +type: +- how-to --- + ## Overview This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging. diff --git a/content/amplify/additional-resources.md b/content/amplify/additional-resources.md index 301f7c13c..9d8aa80e8 100644 --- a/content/amplify/additional-resources.md +++ b/content/amplify/additional-resources.md @@ -2,10 +2,10 @@ title: Other NGINX Amplify Resources weight: 899 toc: true -tags: ["docs"] -docs: "DOCS-977" +docs: DOCS-977 --- + If you are interested in learning more about F5 NGINX Amplify, visit the [NGINX Amplify Resources Page](https://amplify.nginx.com/docs/), where you will find links to: - The Amplify Blog diff --git a/content/amplify/faq/general.md b/content/amplify/faq/general.md index 96f884a63..15e894345 100644 --- a/content/amplify/faq/general.md +++ b/content/amplify/faq/general.md @@ -3,11 +3,11 @@ title: General description: General questions about F5 NGINX Amplify weight: 10 toc: true -tags: ["docs"] -docs: "DOCS-956" +docs: DOCS-956 --- + ### What Is F5 NGINX Amplify? NGINX Amplify is a tool for comprehensive NGINX monitoring. With NGINX Amplify it's easy to proactively analyze and fix problems related to running and scaling NGINX-based web applications. diff --git a/content/amplify/faq/metrics-and-metadata.md b/content/amplify/faq/metrics-and-metadata.md index 701c98376..595e6647f 100644 --- a/content/amplify/faq/metrics-and-metadata.md +++ b/content/amplify/faq/metrics-and-metadata.md @@ -3,10 +3,10 @@ title: NGINX Amplify Metrics and Metadata description: Questions about F5 NGINX Amplify's Metrics and Metadata weight: 40 toc: true -tags: ["docs"] -docs: "DOCS-957" +docs: DOCS-957 --- + ### What Data Does F5 NGINX Amplify Agent Gather? [NGINX Amplify Agent Metrics and Metadata]({{< relref "/amplify/nginx-amplify-agent/metadata-metrics-collection" >}}) diff --git a/content/amplify/faq/nginx-amplify-agent.md b/content/amplify/faq/nginx-amplify-agent.md index f4506a01f..e5b822d92 100644 --- a/content/amplify/faq/nginx-amplify-agent.md +++ b/content/amplify/faq/nginx-amplify-agent.md @@ -3,10 +3,10 @@ title: NGINX Amplify Agent description: Questions about F5 NGINX Amplify Agent weight: 20 toc: true -tags: ["docs"] -docs: "DOCS-958" +docs: DOCS-958 --- + ### What Operating Systems are Supported? The F5 NGINX Amplify Agent is currently officially packaged and supported for the following Linux flavors only: diff --git a/content/amplify/faq/user-interface.md b/content/amplify/faq/user-interface.md index fc05e70b1..216031ce9 100644 --- a/content/amplify/faq/user-interface.md +++ b/content/amplify/faq/user-interface.md @@ -3,10 +3,10 @@ title: NGINX Amplify User Interface description: Questions about F5 NGINX Amplify's User Interface weight: 30 toc: true -tags: ["docs"] -docs: "DOCS-959" +docs: DOCS-959 --- + ### What Browsers are Supported? Currently, the following desktop browsers are officially supported: diff --git a/content/amplify/known-issues.md b/content/amplify/known-issues.md index c91861925..c9fe34e93 100644 --- a/content/amplify/known-issues.md +++ b/content/amplify/known-issues.md @@ -1,11 +1,11 @@ --- title: Known Issues weight: 1000 -description: "List of known issues in the latest release of F5 NGINX Amplify" +description: List of known issues in the latest release of F5 NGINX Amplify toc: true -tags: ["docs"] --- + {{}} --- diff --git a/content/amplify/metrics-metadata/metrics-overview.md b/content/amplify/metrics-metadata/metrics-overview.md index c0aa38c7b..dd7438e4a 100644 --- a/content/amplify/metrics-metadata/metrics-overview.md +++ b/content/amplify/metrics-metadata/metrics-overview.md @@ -3,10 +3,10 @@ title: Metrics and Metadata Overview description: Learn about the metrics and metadata F5 NGINX Amplify collects. weight: 10 toc: true -tags: ["docs"] -docs: "DOCS-972" +docs: DOCS-972 --- + Most metrics are collected by F5 NGINX Amplify Agent without requiring the user to perform any additional setup. For troubleshooting, see [Troubleshooting Metrics Collection]({{< relref "/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md" >}}). Some additional metrics for NGINX monitoring will only be reported if the NGINX configuration file is modified accordingly. See [Additional NGINX Metrics]({{< relref "/amplify/metrics-metadata/nginx-metrics#additional-nginx-metrics" >}}), and review the *Source* and *Variable* fields in the metric descriptions that follow. \ No newline at end of file diff --git a/content/amplify/metrics-metadata/nginx-metrics.md b/content/amplify/metrics-metadata/nginx-metrics.md index ece5a188c..576b872e6 100644 --- a/content/amplify/metrics-metadata/nginx-metrics.md +++ b/content/amplify/metrics-metadata/nginx-metrics.md @@ -3,10 +3,10 @@ title: NGINX Metrics description: List of NGINX Metrics weight: 30 toc: true -tags: ["docs"] -docs: "DOCS-973" +docs: DOCS-973 --- + ## HTTP Connections and Requests - #### **nginx.http.conn.accepted** diff --git a/content/amplify/metrics-metadata/os-metrics.md b/content/amplify/metrics-metadata/os-metrics.md index 620b35411..21719abed 100644 --- a/content/amplify/metrics-metadata/os-metrics.md +++ b/content/amplify/metrics-metadata/os-metrics.md @@ -3,10 +3,10 @@ title: OS Metrics description: List of OS Metrics weight: 20 toc: true -tags: ["docs"] -docs: "DOCS-974" +docs: DOCS-974 --- + ## System Metrics - #### **system.disk.free** diff --git a/content/amplify/metrics-metadata/other-metrics.md b/content/amplify/metrics-metadata/other-metrics.md index 62b7d7f2d..cbca094f9 100644 --- a/content/amplify/metrics-metadata/other-metrics.md +++ b/content/amplify/metrics-metadata/other-metrics.md @@ -3,10 +3,10 @@ title: Other Metrics description: Learn about other metrics used by F5 NGINX Amplify weight: 40 toc: true -tags: ["docs"] -docs: "DOCS-975" +docs: DOCS-975 --- + {{< note >}}Monitoring PHP-FPM and MySQL metrics is only supported by F5 NGINX Amplify Agent.{{< /note >}} ## PHP-FPM metrics diff --git a/content/amplify/nginx-amplify-agent/amplify-agent-overview.md b/content/amplify/nginx-amplify-agent/amplify-agent-overview.md index a42891ce6..dd974145f 100644 --- a/content/amplify/nginx-amplify-agent/amplify-agent-overview.md +++ b/content/amplify/nginx-amplify-agent/amplify-agent-overview.md @@ -3,10 +3,10 @@ title: NGINX Amplify Agent Overview description: Learn about F5 NGINX Amplify Agent. weight: 1 toc: true -tags: ["docs"] -docs: "DOCS-960" +docs: DOCS-960 --- + F5 NGINX Amplify Agent is a compact application written in Python. Its role is to collect various metrics and metadata and send them securely to the backend for storage and visualization. You need to install NGINX Amplify Agent on all hosts you want to monitor. diff --git a/content/amplify/nginx-amplify-agent/configuration-analysis.md b/content/amplify/nginx-amplify-agent/configuration-analysis.md index 424058f55..0d28977b9 100644 --- a/content/amplify/nginx-amplify-agent/configuration-analysis.md +++ b/content/amplify/nginx-amplify-agent/configuration-analysis.md @@ -3,10 +3,10 @@ title: NGINX Configuration Analysis description: Learn about F5 NGINX Amplify Agent's configuration analysis feature. weight: 600 toc: true -tags: ["docs"] -docs: "DOCS-961" +docs: DOCS-961 --- + F5 NGINX Amplify Agent can automatically find all relevant NGINX configuration files, parse them, extract their logical structure, and send the associated JSON data to the Amplify backend for further analysis and reporting. For more information on configuration analysis, please see the [Analyzer]({{< relref "/amplify/user-interface/analyzer.md" >}})) documentation. After NGINX Amplify Agent finds a particular NGINX configuration, it then automatically starts to keep track of its changes. When a change is detected with NGINX — e.g., a master process restarts, or the NGINX config is edited, an update is sent to the Amplify backend. diff --git a/content/amplify/nginx-amplify-agent/configuring-metric-collection.md b/content/amplify/nginx-amplify-agent/configuring-metric-collection.md index 168e82b8d..25eea7b73 100644 --- a/content/amplify/nginx-amplify-agent/configuring-metric-collection.md +++ b/content/amplify/nginx-amplify-agent/configuring-metric-collection.md @@ -3,10 +3,10 @@ title: Configuring NGINX for Metric Collection description: Learn how to configure NGINX Instances to collect data. weight: 400 toc: true -tags: ["docs"] -docs: "DOCS-963" +docs: DOCS-963 --- + To monitor an NGINX instance, F5 NGINX Amplify Agent must [find the relevant NGINX master process]({{< relref "/amplify/nginx-amplify-agent/detecting-monitoring-instances" >}}) and determine its key characteristics. ## Metrics from stub_status diff --git a/content/amplify/nginx-amplify-agent/detecting-monitoring-instances.md b/content/amplify/nginx-amplify-agent/detecting-monitoring-instances.md index fa35ddfc3..ee531c035 100644 --- a/content/amplify/nginx-amplify-agent/detecting-monitoring-instances.md +++ b/content/amplify/nginx-amplify-agent/detecting-monitoring-instances.md @@ -3,10 +3,10 @@ title: Detecting and Monitoring NGINX Instances description: Learn how F5 NGINX Amplify Agent detects NGINX Instances. weight: 300 toc: true -tags: ["docs"] -docs: "DOCS-962" +docs: DOCS-962 --- + F5 NGINX Amplify Agent is capable of detecting several types of NGINX instances: * Installed from a repository package diff --git a/content/amplify/nginx-amplify-agent/install/configuring-amplify-agent.md b/content/amplify/nginx-amplify-agent/install/configuring-amplify-agent.md index 82d012fc4..b31f0a022 100644 --- a/content/amplify/nginx-amplify-agent/install/configuring-amplify-agent.md +++ b/content/amplify/nginx-amplify-agent/install/configuring-amplify-agent.md @@ -3,10 +3,10 @@ title: Configuring NGINX Amplify Agent description: Learn how to configure F5 NGINX Amplify Agent. weight: 300 toc: true -tags: ["docs"] -docs: "DOCS-967" +docs: DOCS-967 --- + F5 NGINX Amplify Agent keeps its configuration in `/etc/amplify-agent/agent.conf`. The NGINX Amplify Agent configuration is a text-based file. ## Overriding the Effective User ID diff --git a/content/amplify/nginx-amplify-agent/install/installing-amplify-agent.md b/content/amplify/nginx-amplify-agent/install/installing-amplify-agent.md index 9e65e86c3..41c0b2464 100644 --- a/content/amplify/nginx-amplify-agent/install/installing-amplify-agent.md +++ b/content/amplify/nginx-amplify-agent/install/installing-amplify-agent.md @@ -3,10 +3,10 @@ title: Install NGINX Amplify Agent description: Learn how to install F5 NGINX Amplify Agent. weight: 100 toc: true -tags: ["docs"] -docs: "DOCS-968" +docs: DOCS-968 --- + To use F5 NGINX Amplify to monitor your infrastructure, you need to install NGINX Amplify Agent on each system you wish to monitor. {{< note >}} NGINX Amplify Agent will drop *root* privileges on startup. It will then use the user ID of the user `nginx` to set its effective user ID. The package install procedure will add the `nginx` user automatically unless it's already found in the system. If the [user](https://nginx.org/en/docs/ngx_core_module.html#user) directive appears in the NGINX configuration, NGINX Amplify Agent will pick up the user specified in the NGINX config for its effective user ID (e.g. `www-data`). {{< /note >}} diff --git a/content/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent.md b/content/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent.md index a74142dc2..9259d2bcf 100644 --- a/content/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent.md +++ b/content/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent.md @@ -3,10 +3,10 @@ title: Uninstall NGINX Amplify Agent description: Learn how to uninstall F5 NGINX Amplify Agent. weight: 400 toc: true -tags: ["docs"] -docs: "DOCS-969" +docs: DOCS-969 --- + To completely delete a previously monitored object, perform the following steps: diff --git a/content/amplify/nginx-amplify-agent/install/updating-amplify-agent.md b/content/amplify/nginx-amplify-agent/install/updating-amplify-agent.md index 02e2eba92..5bcddce50 100644 --- a/content/amplify/nginx-amplify-agent/install/updating-amplify-agent.md +++ b/content/amplify/nginx-amplify-agent/install/updating-amplify-agent.md @@ -3,10 +3,10 @@ title: Update NGINX Amplify Agent description: Learn how to update F5 NGINX Amplify Agent. weight: 200 toc: true -tags: ["docs"] -docs: "DOCS-970" +docs: DOCS-970 --- + {{< important >}} It is *highly* recommended that you periodically check for updates and install the latest stable version of F5 NGINX Amplify Agent. {{< /important >}} diff --git a/content/amplify/nginx-amplify-agent/install/using-amplify-agent-docker.md b/content/amplify/nginx-amplify-agent/install/using-amplify-agent-docker.md index d2030e8a0..70c90685b 100644 --- a/content/amplify/nginx-amplify-agent/install/using-amplify-agent-docker.md +++ b/content/amplify/nginx-amplify-agent/install/using-amplify-agent-docker.md @@ -3,10 +3,10 @@ title: Use NGINX Amplify Agent with Docker description: Learn how to use F5 NGINX Amplify Agent with Docker. weight: 500 toc: true -tags: ["docs"] -docs: "DOCS-971" +docs: DOCS-971 --- + You can use F5 NGINX Amplify Agent in a Docker environment. Although it's still work-in-progress, NGINX Amplify Agent can collect most of the metrics and send them over to the Amplify backend in either "standalone" or "aggregate" mode. The standalone mode of operation is the simplest one, with a separate "host" created for each Docker container. Alternatively, the metrics from NGINX Amplify Agents running in different containers can be aggregated on a "per-image" basis — this is the aggregate mode of deploying NGINX Amplify Agent with Docker. For more information, please refer to our [Amplify Dockerfile](https://github.com/nginxinc/docker-nginx-amplify) repository. diff --git a/content/amplify/nginx-amplify-agent/metadata-metrics-collection.md b/content/amplify/nginx-amplify-agent/metadata-metrics-collection.md index cf3a88ac7..dd99f9438 100644 --- a/content/amplify/nginx-amplify-agent/metadata-metrics-collection.md +++ b/content/amplify/nginx-amplify-agent/metadata-metrics-collection.md @@ -3,10 +3,10 @@ title: Metadata and Metrics Collection description: Learn how F5 NGINX Amplify Agent collects data. weight: 200 toc: true -tags: ["docs"] -docs: "DOCS-964" +docs: DOCS-964 --- + F5 NGINX Amplify Agent collects the following types of data: * **NGINX metrics.** NGINX Amplify Agent collects a lot of NGINX related metrics from [stub_status](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html), the NGINX Plus status API, the NGINX log files, and from the NGINX process state. diff --git a/content/amplify/nginx-amplify-agent/source-code.md b/content/amplify/nginx-amplify-agent/source-code.md index 8e4b5d22d..39e172a5a 100644 --- a/content/amplify/nginx-amplify-agent/source-code.md +++ b/content/amplify/nginx-amplify-agent/source-code.md @@ -3,10 +3,10 @@ title: NGINX Amplify Agent Source Code description: Learn where to find F5 NGINX Amplify Agent's source code. weight: 700 toc: true -tags: ["docs"] -docs: "DOCS-965" +docs: DOCS-965 --- + F5 NGINX Amplify Agent is an open source application. It is licensed under the [2-clause BSD license](https://github.com/nginxinc/nginx-amplify-agent/blob/master/LICENSE), and is available here: * Sources: https://github.com/nginxinc/nginx-amplify-agent diff --git a/content/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md b/content/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md index ff8635c34..230d334ef 100644 --- a/content/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md +++ b/content/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md @@ -3,10 +3,10 @@ title: Troubleshooting Metrics Collection description: Learn what to check if F5 NGINX Amplify Agent isn't reporting metrics. weight: 500 toc: true -tags: ["docs"] -docs: "DOCS-966" +docs: DOCS-966 --- + After you [install and start]({{< relref "/amplify/nginx-amplify-agent/install/installing-amplify-agent" >}}) F5 NGINX Amplify Agent, it should start reporting right away, pushing aggregated data to the Amplify backend at regular 1 minute intervals. It'll take about a minute for a new system to appear in the Amplify web interface. If you don't see the new system or NGINX instance in the web interface, or (some) metrics aren't being collected, please review the following: diff --git a/content/amplify/overview/overview-main-components.md b/content/amplify/overview/overview-main-components.md index e0aeb6dbc..4f5c4e912 100644 --- a/content/amplify/overview/overview-main-components.md +++ b/content/amplify/overview/overview-main-components.md @@ -3,10 +3,10 @@ title: Overview and Main Components description: Learn about F5 NGINX Amplify and its main components. weight: 10 toc: true -tags: ["docs"] -docs: "DOCS-976" +docs: DOCS-976 --- + ## What Is F5 NGINX Amplify? [NGINX Amplify](https://amplify.nginx.com/signup/) offers in-depth monitoring for NGINX-based web applications. It simplifies the process of analyzing and resolving issues related to performance and scalability. diff --git a/content/amplify/user-interface/account-settings.md b/content/amplify/user-interface/account-settings.md index 9e2bc8e18..9f1b51979 100644 --- a/content/amplify/user-interface/account-settings.md +++ b/content/amplify/user-interface/account-settings.md @@ -3,10 +3,10 @@ title: Account Settings description: Learn about the Account settings for the User Interface. weight: 70 toc: true -tags: ["docs"] -docs: "DOCS-978" +docs: DOCS-978 --- + The **Account** option in the user menu at the top right corner of the user interface povides access to several user settings. ### Account Information diff --git a/content/amplify/user-interface/alerts.md b/content/amplify/user-interface/alerts.md index 42f2c2462..692472d0e 100644 --- a/content/amplify/user-interface/alerts.md +++ b/content/amplify/user-interface/alerts.md @@ -3,10 +3,10 @@ title: Alerts description: Learn about the Alerts page of the User Interface. weight: 60 toc: false -tags: ["docs"] -docs: "DOCS-979" +docs: DOCS-979 --- + The **Alerts** page describes the configuration of the alert rules used to notify you of any anomalies in the behavior of your systems. Alerts are based on setting a rule to monitor a particular metric. Alert rules allow the user to specify the metric, the trigger condition, the threshold, and the email for notifications. diff --git a/content/amplify/user-interface/analyzer.md b/content/amplify/user-interface/analyzer.md index 9958828bc..69f84952b 100644 --- a/content/amplify/user-interface/analyzer.md +++ b/content/amplify/user-interface/analyzer.md @@ -3,10 +3,10 @@ title: Analyzer description: Learn about the Analyzer page of the User Interface. weight: 50 toc: false -tags: ["docs"] -docs: "DOCS-980" +docs: DOCS-980 --- + F5 NGINX Amplify Agent parses NGINX configuration files and transmits them to the backend component for further analysis. NGINX Amplify offers configuration recommendations to help improve the performance, reliability, and security of your applications. With well-thought-out and detailed recommendations, you’ll know exactly where the problem is, why it is a problem, and how to fix it. When you switch to the **Analyzer** page, select a particular system on the left to see the associated report. If there are no NGINX instances on a system, there will be no report. diff --git a/content/amplify/user-interface/dashboards.md b/content/amplify/user-interface/dashboards.md index 6ddeb5fc8..c2d2cd5eb 100644 --- a/content/amplify/user-interface/dashboards.md +++ b/content/amplify/user-interface/dashboards.md @@ -3,10 +3,10 @@ title: Dashboards description: Learn about the Dashboards page of the User Interface. weight: 40 toc: false -tags: ["docs"] -docs: "DOCS-981" +docs: DOCS-981 --- + You can create your own dashboards populated with highly customizable graphs of NGINX and system-level metrics. Some of the use cases for a custom set of graphs are the following: diff --git a/content/amplify/user-interface/graphs.md b/content/amplify/user-interface/graphs.md index 1562565c9..64d713848 100644 --- a/content/amplify/user-interface/graphs.md +++ b/content/amplify/user-interface/graphs.md @@ -3,10 +3,10 @@ title: Graphs description: Learn about the Graphs page of the User Interface. weight: 20 toc: false -tags: ["docs"] -docs: "DOCS-982" +docs: DOCS-982 --- + On the **Graphs** page, you can find a collection of predefined graphs. Here you can see an overview of the key metric stats, such as CPU, memory, and disk usage for all your systems. If you click on a system on the left, the graphs will change to reflect the metrics for the selected system. The graphs are further split into tabs such as "System", "NGINX" and so on. diff --git a/content/amplify/user-interface/inventory.md b/content/amplify/user-interface/inventory.md index 5824bc056..704b5be4c 100644 --- a/content/amplify/user-interface/inventory.md +++ b/content/amplify/user-interface/inventory.md @@ -3,10 +3,10 @@ title: Inventory description: Learn about the Inventory page of the User Interface. weight: 30 toc: false -tags: ["docs"] -docs: "DOCS-983" +docs: DOCS-983 --- + You can access the inventory by selecting the first icon on the top menu. The inventory gives an overview of the systems that are being monitored. When F5 NGINX Amplify Agent is running and reporting on a new system, it's listed in the system index on the left side of the user interface and in the **Inventory** section. {{< img src="amplify/amplify-inventory.png" alt="Inventory section of the User Interface" >}} diff --git a/content/amplify/user-interface/overview.md b/content/amplify/user-interface/overview.md index f4975cf00..2fa25c1b1 100644 --- a/content/amplify/user-interface/overview.md +++ b/content/amplify/user-interface/overview.md @@ -3,10 +3,10 @@ title: Overview description: Learn about the Overview page of the User Interface. weight: 10 toc: true -tags: ["docs"] -docs: "DOCS-984" +docs: DOCS-984 --- + The Overview page is designed to provide a quick summary of the state of your NGINX infrastructure. Here you can quickly check the total sum of HTTP 5xx errors over the past 24 hours and compare it to the previous 24 hours. Five key overlay graphs are displayed for the selected period. By switching over various periods, you can compare trends and see if anything abnormal shows up. diff --git a/content/controller/admin-guides/_index.md b/content/controller/admin-guides/_index.md index a1ae4ba2a..7c7510467 100644 --- a/content/controller/admin-guides/_index.md +++ b/content/controller/admin-guides/_index.md @@ -1,10 +1,8 @@ --- description: Learn how to install and manage NGINX Controller and NGINX Controller Agent. -menu: - docs: - parent: NGINX Controller title: Admin Guides weight: 100 url: /nginx-controller/admin-guides/ --- + diff --git a/content/controller/admin-guides/backup-restore/_index.md b/content/controller/admin-guides/backup-restore/_index.md index ac42e8e9a..542b76cb3 100644 --- a/content/controller/admin-guides/backup-restore/_index.md +++ b/content/controller/admin-guides/backup-restore/_index.md @@ -1,11 +1,7 @@ --- description: Learn how to back up and restore NGINX Controller. -menu: - docs: - parent: Admin Guides - title: Backup & Restore - weight: 50 title: Back Up & Restore weight: 300 url: /nginx-controller/admin-guides/backup-restore/ --- + diff --git a/content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md b/content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md index 6edfb59cb..a8a0b4663 100644 --- a/content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md +++ b/content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md @@ -2,15 +2,14 @@ description: Learn how to back up your F5 NGINX Controller cluster configuration and encryption keys. docs: DOCS-247 -doctypes: -- task -tags: -- docs title: Back Up & Restore Cluster Config and Encryption Keys toc: true weight: 97 +type: +- how-to --- + ## Overview After installing F5 NGINX Controller, you should back up the cluster config and encryption keys. You'll need these if you ever need to restore the NGINX config database on top of a new NGINX Controller installation. diff --git a/content/controller/admin-guides/backup-restore/backup-restore-embedded-config-db.md b/content/controller/admin-guides/backup-restore/backup-restore-embedded-config-db.md index 156cf2f21..9e8a89f92 100644 --- a/content/controller/admin-guides/backup-restore/backup-restore-embedded-config-db.md +++ b/content/controller/admin-guides/backup-restore/backup-restore-embedded-config-db.md @@ -2,15 +2,14 @@ description: Learn how to back up and restore the embedded F5 NGINX Controller config database. docs: DOCS-248 -doctypes: -- tutorial -tags: -- docs title: Back Up & Restore an Embedded Config Database toc: true weight: 98 +type: +- tutorial --- + ## Overview Follow the steps in this guide to back up and restore an internal F5 NGINX Controller config database. Use this guide if you selected the option to use an embedded config database when you installed NGINX Controller. Embedded config means that NGINX Controller is using an internal database to store configuration data. diff --git a/content/controller/admin-guides/backup-restore/backup-restore-external-config-db.md b/content/controller/admin-guides/backup-restore/backup-restore-external-config-db.md index 2c465c0b6..80328d41e 100644 --- a/content/controller/admin-guides/backup-restore/backup-restore-external-config-db.md +++ b/content/controller/admin-guides/backup-restore/backup-restore-external-config-db.md @@ -2,15 +2,14 @@ description: Learn how to back up and restore the external F5 NGINX Controller config database. docs: DOCS-249 -doctypes: -- tutorial -tags: -- docs title: Back Up & Restore an External Config Database toc: true weight: 99 +type: +- tutorial --- + ## Overview Follow the steps in this guide to back up and restore an external F5 NGINX Controller config database. Use this guide if you selected the option to use an external PostgreSQL config database when you installed NGINX Controller. External config means that you set up NGINX Controller to store configuration data in your own Postgres database. diff --git a/content/controller/admin-guides/backup-restore/backup-restore-metrics-db.md b/content/controller/admin-guides/backup-restore/backup-restore-metrics-db.md index 101d6c0ed..5aee3f728 100644 --- a/content/controller/admin-guides/backup-restore/backup-restore-metrics-db.md +++ b/content/controller/admin-guides/backup-restore/backup-restore-metrics-db.md @@ -1,15 +1,14 @@ --- description: Learn how to back up and restore the F5 NGINX Controller analytics database. docs: DOCS-250 -doctypes: -- task -tags: -- docs title: Back Up & Restore the Analytics Database toc: true weight: 100 +type: +- how-to --- + ## Overview This guide explains how to back up and restore the F5 NGINX Controller analytics database. Backing up and restoring the analytics data lets you preserve the history of graphs. Backing up this information is optional. diff --git a/content/controller/admin-guides/config-agent/_index.md b/content/controller/admin-guides/config-agent/_index.md index 1edb9dc6e..5d32cc45c 100644 --- a/content/controller/admin-guides/config-agent/_index.md +++ b/content/controller/admin-guides/config-agent/_index.md @@ -1,12 +1,8 @@ --- -description: Learn how to configure and manage the interaction between the F5 NGINX Plus - data plane and NGINX Controller. -menu: - docs: - parent: Admin Guides - title: Configure NGINX Controller Agent - weight: 30 +description: Learn how to configure and manage the interaction between the F5 NGINX + Plus data plane and NGINX Controller. title: Configure NGINX Controller Agent weight: 200 url: /nginx-controller/admin-guides/config-agent/ --- + diff --git a/content/controller/admin-guides/config-agent/about-controller-agent.md b/content/controller/admin-guides/config-agent/about-controller-agent.md index 53c26b7e8..2e7bb09dd 100644 --- a/content/controller/admin-guides/config-agent/about-controller-agent.md +++ b/content/controller/admin-guides/config-agent/about-controller-agent.md @@ -1,15 +1,14 @@ --- description: Learn about the NGINX Controller Agent. docs: DOCS-508 -doctypes: -- concept -tags: -- docs title: Get to Know the F5 NGINX Controller Agent toc: true weight: 100 +type: +- concept --- + ## Overview The F5 NGINX Controller Agent is a compact application written in Golang. NGINX Controller uses the Controller Agent to manage and monitor each NGINX Plus instance that the Agent is installed on. Once installed, the NGINX Controller Agent collects metrics and metadata and sends them securely to NGINX Controller for storage and visualization. diff --git a/content/controller/admin-guides/config-agent/configure-metrics-collection.md b/content/controller/admin-guides/config-agent/configure-metrics-collection.md index 767cb5099..d65478f4c 100644 --- a/content/controller/admin-guides/config-agent/configure-metrics-collection.md +++ b/content/controller/admin-guides/config-agent/configure-metrics-collection.md @@ -1,16 +1,15 @@ --- -description: Contains instructions for setting up the F5 NGINX Controller Agent to collect - metrics for NGINX Plus instances. +description: Contains instructions for setting up the F5 NGINX Controller Agent to + collect metrics for NGINX Plus instances. docs: DOCS-509 -doctypes: -- task -tags: -- docs title: Set up Metrics Collection toc: true weight: 120 +type: +- how-to --- + ## Before You Begin - Before you can set up metrics collection, you first need to [install and start the F5 NGINX Controller Agent]({{< relref "/controller/admin-guides/install/install-nginx-controller-agent.md" >}}), so that the Agent can start pushing aggregated data to NGINX Controller. diff --git a/content/controller/admin-guides/config-agent/configure-the-agent.md b/content/controller/admin-guides/config-agent/configure-the-agent.md index 23ee87785..778f68dc2 100644 --- a/content/controller/admin-guides/config-agent/configure-the-agent.md +++ b/content/controller/admin-guides/config-agent/configure-the-agent.md @@ -1,15 +1,14 @@ --- description: Customize the F5 NGINX Controller Agent configuration. docs: DOCS-510 -doctypes: -- tutorial -tags: -- docs title: Configure the NGINX Controller Agent toc: true weight: 110 +type: +- tutorial --- + ## Overview Follow the steps in this guide to customize the F5 NGINX Controller Agent configuration. diff --git a/content/controller/admin-guides/config-agent/use-agent-with-docker.md b/content/controller/admin-guides/config-agent/use-agent-with-docker.md index d6debdf89..8a3255eb6 100644 --- a/content/controller/admin-guides/config-agent/use-agent-with-docker.md +++ b/content/controller/admin-guides/config-agent/use-agent-with-docker.md @@ -1,15 +1,14 @@ --- description: Learn how to use the F5 NGINX Controller Agent in a Docker environment. docs: DOCS-511 -doctypes: -- reference -tags: -- docs title: Use the NGINX Controller Agent with Docker toc: true weight: 200 +type: +- reference --- + ## Before You Begin We support running the F5 NGINX Controller Agent in a Docker environment on the following distributions: CentOS, Debian, and Ubuntu. diff --git a/content/controller/admin-guides/install/_index.md b/content/controller/admin-guides/install/_index.md index 0a0f35294..fbede0eb5 100644 --- a/content/controller/admin-guides/install/_index.md +++ b/content/controller/admin-guides/install/_index.md @@ -1,13 +1,8 @@ --- description: Learn how to install and update F5 NGINX Controller and the NGINX Controller Agent. -menu: - docs: - parent: Admin Guides - title: Installation - weight: 10 title: Installation weight: 100 -aliases: /admin-guides/installation/ url: /nginx-controller/admin-guides/install/ --- + diff --git a/content/controller/admin-guides/install/agent-restart.md b/content/controller/admin-guides/install/agent-restart.md index 7e6190270..1e9938d18 100644 --- a/content/controller/admin-guides/install/agent-restart.md +++ b/content/controller/admin-guides/install/agent-restart.md @@ -2,15 +2,14 @@ description: How to start, stop, and verify the state of the F5 NGINX Controller Agent service. docs: DOCS-251 -doctypes: -- task -tags: -- docs title: Manage the NGINX Controller Agent Service toc: true weight: 210 +type: +- how-to --- + ## Starting and Stopping the Agent To start, stop, and restart the F5 NGINX Controller Agent, run the following commands on the NGINX Plus system where you installed the Agent. diff --git a/content/controller/admin-guides/install/get-n-plus-cert-and-key.md b/content/controller/admin-guides/install/get-n-plus-cert-and-key.md index 2e8c1f977..a2a893322 100644 --- a/content/controller/admin-guides/install/get-n-plus-cert-and-key.md +++ b/content/controller/admin-guides/install/get-n-plus-cert-and-key.md @@ -1,16 +1,15 @@ --- -description: How to download the F5 NGINX Plus nginx.crt and nginx.key files using the - NGINX Controller API. +description: How to download the F5 NGINX Plus nginx.crt and nginx.key files using + the NGINX Controller API. docs: DOCS-252 -doctypes: -- task -tags: -- docs title: Download the NGINX Plus Cert and Key Bundle toc: true weight: 105 +type: +- how-to --- + ## Overview This topic explains how to use the [F5 NGINX Controller REST API](https://docs.nginx.com/nginx-controller/api/ctlr-platform-api/) to download your NGINX Plus `nginx.crt` and `nginx.key` files. You'll need these files if you're [installing NGINX Plus as part of an NGINX Controller trial]({{< relref "/controller/admin-guides/install/try-nginx-controller.md" >}}). diff --git a/content/controller/admin-guides/install/install-agent-non-root.md b/content/controller/admin-guides/install/install-agent-non-root.md index 22e30d56d..70a88925f 100644 --- a/content/controller/admin-guides/install/install-agent-non-root.md +++ b/content/controller/admin-guides/install/install-agent-non-root.md @@ -1,15 +1,14 @@ --- description: How to install the F5 NGINX Controller Agent to run as a non-root user. docs: DOCS-253 -doctypes: -- beta -- tutorial -- troubleshooting title: Install NGINX Controller Agent for Non-root Users toc: true weight: 205 +type: +- tutorial --- + ## Overview This document provides the instructions to run F5 NGINX Controller Agent as a non-root user, by making a few adjustments to the deployment process. diff --git a/content/controller/admin-guides/install/install-for-controller.md b/content/controller/admin-guides/install/install-for-controller.md index 5d02707bc..bf40b2466 100644 --- a/content/controller/admin-guides/install/install-for-controller.md +++ b/content/controller/admin-guides/install/install-for-controller.md @@ -1,14 +1,15 @@ --- -description: Take the steps in this guide to deploy F5 NGINX App Protect WAF as a datapath - instance for use with NGINX Controller. +description: Take the steps in this guide to deploy F5 NGINX App Protect WAF as a + datapath instance for use with NGINX Controller. docs: DOCS-645 -doctypes: -- task title: Using NGINX App Protect WAF with NGINX Controller toc: true weight: 500 +type: +- how-to --- + **Note:** Refer to the [F5 NGINX Controller Technical Specifications]({{< relref "/controller/admin-guides/install/nginx-controller-tech-specs.md" >}}) guide to find out which distributions are supported for use with NGINX Controller and NGINX Controller Agent. ## Setup diff --git a/content/controller/admin-guides/install/install-nginx-controller-agent.md b/content/controller/admin-guides/install/install-nginx-controller-agent.md index 7378817ba..c00b933e9 100644 --- a/content/controller/admin-guides/install/install-nginx-controller-agent.md +++ b/content/controller/admin-guides/install/install-nginx-controller-agent.md @@ -1,16 +1,14 @@ --- description: How to install, upgrade, and uninstall the F5 Controller Agent. docs: DOCS-254 -doctypes: -- tutorial -- troubleshooting -tags: -- docs title: Install NGINX Controller Agent toc: true weight: 150 +type: +- tutorial --- + ## Overview This page shows how to install, update, and uninstall the F5 NGINX Controller Agent. diff --git a/content/controller/admin-guides/install/install-nginx-controller-rhel-8.md b/content/controller/admin-guides/install/install-nginx-controller-rhel-8.md index a0c17f1a0..ffc5dbf7a 100644 --- a/content/controller/admin-guides/install/install-nginx-controller-rhel-8.md +++ b/content/controller/admin-guides/install/install-nginx-controller-rhel-8.md @@ -2,16 +2,14 @@ description: This guide explains how to prepare your RHEL 8 system to install F5 NGINX Controller and the NGINX Controller Agent. docs: DOCS-342 -doctypes: -- beta -- tutorial -tags: -- docs title: Install NGINX Controller on RHEL 8 (experimental) toc: true weight: 200 +type: +- tutorial --- + ## Preparing the F5 NGINX Controller Host To install NGINX Controller on RHEL 8, you must complete the following steps to allow iptables-based routing for Kubernetes. Failure to complete these steps may cause the installation to hang. diff --git a/content/controller/admin-guides/install/install-nginx-controller.md b/content/controller/admin-guides/install/install-nginx-controller.md index a6c359768..e58a443fc 100644 --- a/content/controller/admin-guides/install/install-nginx-controller.md +++ b/content/controller/admin-guides/install/install-nginx-controller.md @@ -1,15 +1,14 @@ --- description: This guide explains how to install and update F5 NGINX Controller. docs: DOCS-255 -doctypes: -- tutorial -tags: -- docs title: Install NGINX Controller toc: true weight: 120 +type: +- tutorial --- + ## Overview F5 NGINX Controller is NGINX's control-plane solution that manages the NGINX data plane. Built on a modular architecture, NGINX Controller enables you to manage the entire lifecycle of NGINX Plus, whether it's deployed as a load balancer, API gateway, or a proxy in a service mesh environment. diff --git a/content/controller/admin-guides/install/nginx-controller-tech-specs.md b/content/controller/admin-guides/install/nginx-controller-tech-specs.md index 41d318a24..0357a2d38 100644 --- a/content/controller/admin-guides/install/nginx-controller-tech-specs.md +++ b/content/controller/admin-guides/install/nginx-controller-tech-specs.md @@ -1,15 +1,14 @@ --- description: Guidelines and recommendations for configuring F5 NGINX Controller. docs: DOCS-256 -doctypes: -- reference -tags: -- docs title: NGINX Controller Tech Specs toc: true weight: 100 +type: +- reference --- + ## Overview This guide lists the technical recommendations for F5 NGINX Controller v3 and NGINX Controller Agent. Review this guide before installing or updating NGINX Controller or NGINX Controller Agent. diff --git a/content/controller/admin-guides/install/resilient-cluster-aws.md b/content/controller/admin-guides/install/resilient-cluster-aws.md index 9efe83a77..135740893 100644 --- a/content/controller/admin-guides/install/resilient-cluster-aws.md +++ b/content/controller/admin-guides/install/resilient-cluster-aws.md @@ -1,16 +1,15 @@ --- -description: This guide explains how to deploy F5 NGINX Controller as a multi-node resilient. - cluster on AWS. +description: This guide explains how to deploy F5 NGINX Controller as a multi-node + resilient. cluster on AWS. docs: DOCS-257 -doctypes: -- tutorial -tags: -- docs title: Deploy NGINX Controller as a Resilient Cluster on AWS toc: true weight: 310 +type: +- tutorial --- + ## Overview Complete the steps in this guide to deploy F5 NGINX Controller as a resilient, three-node cluster on AWS. A multi-node cluster ensures that NGINX Controller stays up even if one of the control-plane hosts becomes unavailable. diff --git a/content/controller/admin-guides/install/resilient-cluster-private-cloud.md b/content/controller/admin-guides/install/resilient-cluster-private-cloud.md index cc9dbedf1..d407bb4fc 100644 --- a/content/controller/admin-guides/install/resilient-cluster-private-cloud.md +++ b/content/controller/admin-guides/install/resilient-cluster-private-cloud.md @@ -1,16 +1,15 @@ --- -description: This guide explains how to deploy F5 NGINX Controller as a multi-node resilient - cluster on a private cloud. +description: This guide explains how to deploy F5 NGINX Controller as a multi-node + resilient cluster on a private cloud. docs: DOCS-258 -doctypes: -- tutorial -tags: -- docs title: Deploy NGINX Controller as a Resilient Cluster on a Private Cloud toc: true weight: 300 +type: +- tutorial --- + ## Overview Complete the steps in this guide to deploy F5 NGINX Controller as a resilient, three-node cluster on your private cloud. A multi-node cluster ensures that NGINX Controller stays up even if one of the control-plane hosts becomes unavailable. diff --git a/content/controller/admin-guides/install/try-nginx-controller-app-sec.md b/content/controller/admin-guides/install/try-nginx-controller-app-sec.md index c65534569..9bb36b2e6 100644 --- a/content/controller/admin-guides/install/try-nginx-controller-app-sec.md +++ b/content/controller/admin-guides/install/try-nginx-controller-app-sec.md @@ -1,16 +1,15 @@ --- -description: This quick-start tutorial shows you how to get started using F5 NGINX Controller - with the Application Security Add-on. +description: This quick-start tutorial shows you how to get started using F5 NGINX + Controller with the Application Security Add-on. docs: DOCS-259 -doctypes: -- tutorial -tags: -- docs title: Trial NGINX Controller with App Security toc: true weight: 115 +type: +- tutorial --- + ## Overview This quick-start tutorial shows you how to get started using F5 NGINX Controller with the Application Security Add-on ("App Security"). The App Security add-on to the NGINX Controller Application Delivery Module enables a web application firewall (WAF) that you can use to protect your apps. diff --git a/content/controller/admin-guides/install/try-nginx-controller.md b/content/controller/admin-guides/install/try-nginx-controller.md index cbdc29fb7..7c7a87c1b 100644 --- a/content/controller/admin-guides/install/try-nginx-controller.md +++ b/content/controller/admin-guides/install/try-nginx-controller.md @@ -1,16 +1,15 @@ --- -description: This quick-start tutorial shows you how to get started using F5 NGINX Controller - with NGINX Plus. +description: This quick-start tutorial shows you how to get started using F5 NGINX + Controller with NGINX Plus. docs: DOCS-260 -doctypes: -- tutorial -tags: -- docs title: Trial NGINX Controller with NGINX Plus toc: true weight: 110 +type: +- tutorial --- + ## Overview This quick-start tutorial shows you how to get started using F5 NGINX Controller with NGINX Plus. diff --git a/content/controller/admin-guides/install/using-helper-script.md b/content/controller/admin-guides/install/using-helper-script.md index 023363a09..5309f2bbc 100644 --- a/content/controller/admin-guides/install/using-helper-script.md +++ b/content/controller/admin-guides/install/using-helper-script.md @@ -2,15 +2,14 @@ description: Learn how to update F5 NGINX Controller installation settings and manage the NGINX Controller service using the helper.sh script. docs: DOCS-261 -doctypes: -- task -tags: -- docs title: Update NGINX Controller Settings with helper.sh toc: true weight: 200 +type: +- how-to --- + ## Overview You can use the F5 NGINX Controller `helper.sh` script to update NGINX Controller installation settings and manage the NGINX Controller process. This tutorial shows you how to use `helper.sh` to perform the following tasks: diff --git a/content/controller/analytics/_index.md b/content/controller/analytics/_index.md index 7a62df501..885c42874 100644 --- a/content/controller/analytics/_index.md +++ b/content/controller/analytics/_index.md @@ -1,10 +1,7 @@ --- description: Learn about the F5 NGINX Controller Analytics module. -menu: - docs: - parent: NGINX Controller - title: Analytics title: Analytics weight: 120 url: /nginx-controller/analytics/ --- + diff --git a/content/controller/analytics/alerts/_index.md b/content/controller/analytics/alerts/_index.md index 4bae6e7ab..272f87c87 100644 --- a/content/controller/analytics/alerts/_index.md +++ b/content/controller/analytics/alerts/_index.md @@ -1,10 +1,7 @@ --- description: Learn about F5 NGINX Controller alerts and notifications. -menu: - docs: - parent: Analytics - weight: 10 title: Alerts weight: 100 url: /nginx-controller/analytics/alerts/ --- + diff --git a/content/controller/analytics/alerts/about-alerts.md b/content/controller/analytics/alerts/about-alerts.md index 9277494ed..787f16239 100644 --- a/content/controller/analytics/alerts/about-alerts.md +++ b/content/controller/analytics/alerts/about-alerts.md @@ -1,15 +1,14 @@ --- description: Learn about NGINX Controller Alerts and Notifications. docs: DOCS-520 -doctypes: -- concept -tags: -- docs title: About Alerts toc: true weight: 100 +type: +- concept --- + ## Overview The F5 NGINX Controller Analytics module lets you configure alerts and notifications, so you can stay informed about your system and app performance. In this topic, you'll learn about [alerts](#alerts), [alert rules](#alert-rules), and [alert notifications](#alert-notifications). diff --git a/content/controller/analytics/alerts/manage-alerts.md b/content/controller/analytics/alerts/manage-alerts.md index 746390e08..7e6885a8a 100644 --- a/content/controller/analytics/alerts/manage-alerts.md +++ b/content/controller/analytics/alerts/manage-alerts.md @@ -1,15 +1,14 @@ --- description: Learn how to view, add, mute, and delete Alerts. docs: DOCS-521 -doctypes: -- concept -tags: -- docs title: Manage Alerts toc: true weight: 200 +type: +- concept --- + ## Overview [Alerts]({{< relref "/controller/analytics/alerts/about-alerts.md" >}}) are notifications about the F5 NGINX Controller system and your applications' performance. diff --git a/content/controller/analytics/alerts/manage-registered-emails.md b/content/controller/analytics/alerts/manage-registered-emails.md index f21d815a6..bfb6d085c 100644 --- a/content/controller/analytics/alerts/manage-registered-emails.md +++ b/content/controller/analytics/alerts/manage-registered-emails.md @@ -2,15 +2,14 @@ description: Learn how to manage the email addresses that receive automatic alert notifications. docs: DOCS-522 -doctypes: -- concept -tags: -- docs title: Manage Registered Email Addresses toc: true weight: 310 +type: +- concept --- + ## Overview In order to receive email notifications for [Alerts]({{< relref "/controller/analytics/alerts/about-alerts.md" >}}), you need to provide a valid email address and complete the verification process. diff --git a/content/controller/analytics/alerts/service-now-notifications.md b/content/controller/analytics/alerts/service-now-notifications.md index f14ff27cc..dbb5f2bdd 100644 --- a/content/controller/analytics/alerts/service-now-notifications.md +++ b/content/controller/analytics/alerts/service-now-notifications.md @@ -1,16 +1,14 @@ --- description: Set up Alerts Integration with ServiceNow. Deprecated in v3.13. docs: DOCS-523 -doctypes: -- task -tags: -- docs -- deprecated title: ServiceNow Alerts Integration toc: true weight: 600 +type: +- how-to --- + ## ServiceNow Alert Integration {{< deprecated >}} diff --git a/content/controller/analytics/catalogs/_index.md b/content/controller/analytics/catalogs/_index.md index 42f5a7ff3..6edb79a50 100644 --- a/content/controller/analytics/catalogs/_index.md +++ b/content/controller/analytics/catalogs/_index.md @@ -1,13 +1,7 @@ --- -aliases: -- /analytics/dimensions/reference/ -- /analytics/metrics/reference/ description: Reference information for F5 NGINX Controller Catalogs. -menu: - docs: - parent: Analytics - weight: 20 title: Catalogs Reference weight: 210 url: /nginx-controller/analytics/catalogs/ --- + diff --git a/content/controller/analytics/catalogs/dimensions.md b/content/controller/analytics/catalogs/dimensions.md index dbf884d61..2748f85e9 100644 --- a/content/controller/analytics/catalogs/dimensions.md +++ b/content/controller/analytics/catalogs/dimensions.md @@ -1,17 +1,15 @@ --- -catalog: true description: Information about all of the Dimensions collected by F5 NGINX Controller Agent. docs: DOCS-524 -doctypes: -- reference -tags: -- docs title: NGINX Controller Dimensions Catalog toc: false weight: 20 +type: +- reference --- + {{< dimensions path="/static/ctlr/catalogs/dimensions-catalog.json" >}} {{< versions "3.0" "latest" "ctrlvers" >}} diff --git a/content/controller/analytics/catalogs/metrics.md b/content/controller/analytics/catalogs/metrics.md index 39e167b92..063a01aa2 100644 --- a/content/controller/analytics/catalogs/metrics.md +++ b/content/controller/analytics/catalogs/metrics.md @@ -1,16 +1,15 @@ --- -catalog: true -description: Information about all of the Metrics collected by F5 NGINX Controller Agent. +description: Information about all of the Metrics collected by F5 NGINX Controller + Agent. docs: DOCS-525 -doctypes: -- reference -tags: -- docs title: NGINX Controller Metrics Catalog toc: false weight: 20 +type: +- reference --- + {{< metrics path="/static/ctlr/catalogs/metrics-catalog.json" >}} {{< versions "3.0" "latest" "ctrlvers" >}} diff --git a/content/controller/analytics/dashboards/_index.md b/content/controller/analytics/dashboards/_index.md index 8b6ae2a58..88cfef7a1 100644 --- a/content/controller/analytics/dashboards/_index.md +++ b/content/controller/analytics/dashboards/_index.md @@ -1,10 +1,7 @@ --- description: Learn about F5 NGINX Controller Dashboards. -menu: - docs: - parent: Analytics - weight: 40 title: Dashboards weight: 120 url: /nginx-controller/analytics/dashboards/ --- + diff --git a/content/controller/analytics/dashboards/application-health-score.md b/content/controller/analytics/dashboards/application-health-score.md index 135b78d2c..e0dd0787a 100644 --- a/content/controller/analytics/dashboards/application-health-score.md +++ b/content/controller/analytics/dashboards/application-health-score.md @@ -1,15 +1,14 @@ --- description: View and understand the Application Health Score for your application. docs: DOCS-526 -doctypes: -- concept -tags: -- docs title: Understanding the Application Health Score toc: true weight: 20 +type: +- concept --- + ## Overview When you log in to the F5 NGINX Controller user interface, you will see the **Analytics Dashboard Overview** page. This page contains an Application Health Score (AHS) that reflects your application's performance. diff --git a/content/controller/analytics/dashboards/custom-dashboards.md b/content/controller/analytics/dashboards/custom-dashboards.md index de2458940..9b62b7687 100644 --- a/content/controller/analytics/dashboards/custom-dashboards.md +++ b/content/controller/analytics/dashboards/custom-dashboards.md @@ -1,15 +1,14 @@ --- description: Create custom dashboards to view custom graphs. docs: DOCS-527 -doctypes: -- task -tags: -- docs title: Create Custom Dashboards toc: true weight: 20 +type: +- how-to --- + ## Overview You can use the F5 NGINX Controller user interface to create your own Dashboards populated with customizable graphs of NGINX and system-level metrics. diff --git a/content/controller/analytics/dashboards/overview-dashboard.md b/content/controller/analytics/dashboards/overview-dashboard.md index fa1467bd3..4c9ee04dd 100644 --- a/content/controller/analytics/dashboards/overview-dashboard.md +++ b/content/controller/analytics/dashboards/overview-dashboard.md @@ -2,15 +2,14 @@ description: Learn about the Dashboards that displays cumulative metrics for your NGINX Instances. docs: DOCS-528 -doctypes: -- task -tags: -- docs title: Analytics Overview toc: true weight: 10 +type: +- how-to --- + ## Overview The **Analytics Dashboards** provides an at-a-glance summary of the state of your F5 NGINX infrastructure and your application performance. diff --git a/content/controller/analytics/data-explorer/_index.md b/content/controller/analytics/data-explorer/_index.md index 59a5fefb5..ce3a033f6 100644 --- a/content/controller/analytics/data-explorer/_index.md +++ b/content/controller/analytics/data-explorer/_index.md @@ -1,10 +1,7 @@ --- description: Learn about F5 NGINX Controller Data Explorer. -menu: - docs: - parent: Analytics - weight: 40 title: Data Explorer weight: 120 url: /nginx-controller/analytics/data-explorer/ --- + diff --git a/content/controller/analytics/data-explorer/how-to-use.md b/content/controller/analytics/data-explorer/how-to-use.md index fa575fc17..a77b14f00 100644 --- a/content/controller/analytics/data-explorer/how-to-use.md +++ b/content/controller/analytics/data-explorer/how-to-use.md @@ -1,15 +1,15 @@ --- -description: Use the Data Explorer to examine the metrics that F5 NGINX Controller collects. +description: Use the Data Explorer to examine the metrics that F5 NGINX Controller + collects. docs: DOCS-529 -doctypes: -- task -tags: -- docs title: How To Use the Data Explorer toc: true weight: 20 +type: +- how-to --- + ## Overview This topic explains how to use the Data Explorer to view the metrics that F5 NGINX Controller collects. diff --git a/content/controller/analytics/events/_index.md b/content/controller/analytics/events/_index.md index 0dff2641d..5a1be006d 100644 --- a/content/controller/analytics/events/_index.md +++ b/content/controller/analytics/events/_index.md @@ -1,10 +1,7 @@ --- description: View system events and audit logs. -menu: - docs: - parent: Analytics - weight: 30 title: Events weight: 140 url: /nginx-controller/analytics/events/ --- + diff --git a/content/controller/analytics/events/view-events.md b/content/controller/analytics/events/view-events.md index 6e28bfb8c..3b3a851f1 100644 --- a/content/controller/analytics/events/view-events.md +++ b/content/controller/analytics/events/view-events.md @@ -1,15 +1,14 @@ --- description: View the audit log of system and user actions. docs: DOCS-530 -doctypes: -- task -tags: -- docs title: View Events toc: true weight: 20 +type: +- how-to --- + ## Overview The Events page shows a log of the system and user actions for F5 NGINX Controller. The logs are organized by event categories and levels, making it easy to identify and review issues. diff --git a/content/controller/analytics/forwarders/_index.md b/content/controller/analytics/forwarders/_index.md index 77ce17e24..4fa75a092 100644 --- a/content/controller/analytics/forwarders/_index.md +++ b/content/controller/analytics/forwarders/_index.md @@ -1,10 +1,7 @@ --- description: Learn how to forward data from F5 NGINX Controller to external services. -menu: - docs: - parent: Analytics - weight: 40 title: Data Forwarders weight: 130 url: /nginx-controller/analytics/forwarders/ --- + diff --git a/content/controller/analytics/forwarders/forward-analytics-to-datadog.md b/content/controller/analytics/forwarders/forward-analytics-to-datadog.md index 098d33703..a8a099d3c 100644 --- a/content/controller/analytics/forwarders/forward-analytics-to-datadog.md +++ b/content/controller/analytics/forwarders/forward-analytics-to-datadog.md @@ -1,15 +1,14 @@ --- description: How to forward Analytics data to Datadog. docs: DOCS-531 -doctypes: -- tutorial -tags: -- docs title: Forward Analytics Data to Datadog toc: true weight: 100 +type: +- tutorial --- + ## Overview Follow the steps in this guide to set up an F5 NGINX Controller Integration that forwards data to [Datadog](https://www.datadoghq.com/). diff --git a/content/controller/analytics/forwarders/forward-analytics-to-otlp.md b/content/controller/analytics/forwarders/forward-analytics-to-otlp.md index d1aa43915..7e5974fbb 100644 --- a/content/controller/analytics/forwarders/forward-analytics-to-otlp.md +++ b/content/controller/analytics/forwarders/forward-analytics-to-otlp.md @@ -1,15 +1,14 @@ --- description: How to forward Analytics Metrics to OpenTelemetry Collector. docs: DOCS-532 -doctypes: -- tutorial -tags: -- docs title: Forward Analytics Metrics to OpenTelemetry Collector toc: true weight: 201 +type: +- tutorial --- + ## Overview Follow the steps in this guide to set up an F5 NGINX Controller integration that forwards metrics to OpenTelemetry Collector. diff --git a/content/controller/analytics/forwarders/forward-analytics-to-splunk.md b/content/controller/analytics/forwarders/forward-analytics-to-splunk.md index 3c94a73e6..5dd7c28ca 100644 --- a/content/controller/analytics/forwarders/forward-analytics-to-splunk.md +++ b/content/controller/analytics/forwarders/forward-analytics-to-splunk.md @@ -1,15 +1,14 @@ --- description: How to forward Analytics data to Splunk. docs: DOCS-533 -doctypes: -- tutorial -tags: -- docs title: Forward Analytics Data to Splunk toc: true weight: 200 +type: +- tutorial --- + ## Overview Follow the steps in this guide to set up an F5 NGINX Controller Integration that forwards data to [Splunk](https://www.splunk.com/). diff --git a/content/controller/analytics/forwarders/forward-analytics-to-syslog.md b/content/controller/analytics/forwarders/forward-analytics-to-syslog.md index 018a31c30..243434346 100644 --- a/content/controller/analytics/forwarders/forward-analytics-to-syslog.md +++ b/content/controller/analytics/forwarders/forward-analytics-to-syslog.md @@ -1,15 +1,14 @@ --- description: How to forward Analytics Events to Syslog. docs: DOCS-534 -doctypes: -- tutorial -tags: -- docs title: Forward Analytics Events to Syslog toc: true weight: 201 +type: +- tutorial --- + ## Overview Follow the steps in this guide to set up a F5 NGINX Controller Integration that forwards events to a syslog server. diff --git a/content/controller/analytics/metrics/_index.md b/content/controller/analytics/metrics/_index.md index e5640c17d..841c2b5b5 100644 --- a/content/controller/analytics/metrics/_index.md +++ b/content/controller/analytics/metrics/_index.md @@ -1,10 +1,7 @@ --- description: Learn about F5 NGINX Controller Metrics. -menu: - docs: - parent: Analytics - weight: 50 title: Metrics weight: 150 url: /nginx-controller/analytics/metrics/ --- + diff --git a/content/controller/analytics/metrics/metrics-api.md b/content/controller/analytics/metrics/metrics-api.md index 52b85d6ed..0acc2e014 100644 --- a/content/controller/analytics/metrics/metrics-api.md +++ b/content/controller/analytics/metrics/metrics-api.md @@ -2,15 +2,14 @@ description: Tips and tricks for using the Metrics API query parameters to refine your data. docs: DOCS-535 -doctypes: -- tutorial -tags: -- docs title: Using the Metrics API toc: true weight: 50 +type: +- tutorial --- + ## Overview You can use the F5 NGINX Controller Analytics module to monitor your NGINX instances and evaluate your applications' performance. The [Metrics API]({{< relref "/controller/api/_index.md" >}}) query parameters let you fine-tune your system data based on parameters such as time window, aggregation, time resolution, and filter. diff --git a/content/controller/analytics/metrics/overview-metrics-metadata.md b/content/controller/analytics/metrics/overview-metrics-metadata.md index ff67020c8..bba0715e1 100644 --- a/content/controller/analytics/metrics/overview-metrics-metadata.md +++ b/content/controller/analytics/metrics/overview-metrics-metadata.md @@ -1,16 +1,15 @@ --- -description: Understanding how the F5 NGINX Controller Agent collects and reports metrics - and metadata. +description: Understanding how the F5 NGINX Controller Agent collects and reports + metrics and metadata. docs: DOCS-536 -doctypes: -- reference -tags: -- docs title: 'Overview: Metrics and Metadata' toc: true weight: 20 +type: +- reference --- + ## Overview The data that F5 NGINX Controller collects can be divided into two categories: diff --git a/content/controller/analytics/metrics/overview-traffic-metrics.md b/content/controller/analytics/metrics/overview-traffic-metrics.md index de4b7271a..23dddad38 100644 --- a/content/controller/analytics/metrics/overview-traffic-metrics.md +++ b/content/controller/analytics/metrics/overview-traffic-metrics.md @@ -1,16 +1,15 @@ --- description: Understanding how traffic metrics are collected, aggregated, and reported. docs: DOCS-537 -doctypes: -- concept -- reference -tags: -- docs title: 'Overview: Traffic Metrics' toc: true weight: 100 +type: +- concept +- reference --- + ## Overview The data that F5 NGINX Controller collects can be divided into two categories: diff --git a/content/controller/analytics/metrics/view-traffic-metrics.md b/content/controller/analytics/metrics/view-traffic-metrics.md index 4afd3f773..da7237191 100644 --- a/content/controller/analytics/metrics/view-traffic-metrics.md +++ b/content/controller/analytics/metrics/view-traffic-metrics.md @@ -1,16 +1,15 @@ --- description: How to view the traffic metrics gathered by NGINX Controller Analytics. docs: DOCS-538 -doctypes: -- task -- tutorial -tags: -- docs title: View Traffic Metrics toc: true weight: 150 +type: +- how-to +- tutorial --- + ## Overview This topic explains how to use the [NGINX Controller REST API]({{< relref "/controller/api/_index.md" >}}) diff --git a/content/controller/analytics/view-app-security-analytics.md b/content/controller/analytics/view-app-security-analytics.md index d54262e27..7ca948c31 100644 --- a/content/controller/analytics/view-app-security-analytics.md +++ b/content/controller/analytics/view-app-security-analytics.md @@ -1,16 +1,15 @@ --- description: How to view App Security Analytics. docs: DOCS-539 -doctypes: -- concept -- reference -tags: -- task title: View App Security Analytics toc: true weight: 500 +type: +- concept +- reference --- + ## Overview When App Security flags or blocks a request made to an App Component as a security violation, it generates an App Security event. diff --git a/content/controller/api-management/_index.md b/content/controller/api-management/_index.md index f8f0f8394..91312bebd 100644 --- a/content/controller/api-management/_index.md +++ b/content/controller/api-management/_index.md @@ -1,9 +1,7 @@ --- description: Tasks for deploying and managing your APIs. -menu: - docs: - parent: NGINX Controller title: API Management weight: 155 url: /nginx-controller/api-management/ --- + diff --git a/content/controller/api-management/manage-apis.md b/content/controller/api-management/manage-apis.md index 696158c9e..65432ab00 100644 --- a/content/controller/api-management/manage-apis.md +++ b/content/controller/api-management/manage-apis.md @@ -2,15 +2,14 @@ description: Use the F5 NGINX Controller API Manager to add APIs and control how your APIs are exposed and consumed. docs: DOCS-569 -doctypes: -- tutorial -tags: -- docs title: Manage Your APIs toc: true weight: 110 +type: +- tutorial --- + ## Overview The F5 NGINX Controller API Management module provides full life cycle management for your APIs. This document provides a walkthrough of the steps needed to create, version, and publish your API using the NGINX Controller API Management module. When you have completed this guide, you should have the following resources: diff --git a/content/controller/api-management/manage-dev-portals.md b/content/controller/api-management/manage-dev-portals.md index 02923d76e..4b01ac122 100644 --- a/content/controller/api-management/manage-dev-portals.md +++ b/content/controller/api-management/manage-dev-portals.md @@ -1,15 +1,14 @@ --- description: Learn how to create and manage Developer Portals for your API documentation. docs: DOCS-570 -doctypes: -- tutorial -tags: -- docs title: Manage Developer Portals toc: true weight: 120 +type: +- tutorial --- + ## Overview You can use F5 NGINX Controller Developer Portals (also called 'Dev Portals') to create and manage beautiful, easy-to-use API reference documentation to support your [Published APIs]({{< relref "/controller/api-management/manage-apis.md#publish-an-api" >}}). diff --git a/content/controller/api/_index.md b/content/controller/api/_index.md index fbce5140c..100d0ce46 100644 --- a/content/controller/api/_index.md +++ b/content/controller/api/_index.md @@ -1,9 +1,7 @@ --- description: Learn how to use the F5 NGINX Controller REST API. -menu: - docs: - parent: NGINX Controller title: API Reference weight: 210 url: /nginx-controller/api/reference/ --- + diff --git a/content/controller/api/overview.md b/content/controller/api/overview.md index 2e277cd0d..88c2a7a41 100644 --- a/content/controller/api/overview.md +++ b/content/controller/api/overview.md @@ -1,16 +1,15 @@ --- description: Provides information about the F5 NGINX Controller API. docs: DOCS-343 -doctypes: -- concept layout: docs -tags: -- docs title: API Overview toc: true weight: 10 +type: +- concept --- + ## Introduction The F5 NGINX Controller API is a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API that allows you to programmatically manage your NGINX Plus data planes. diff --git a/content/controller/api/reference/ctlr-adc-api.md b/content/controller/api/reference/ctlr-adc-api.md index 94af14cb5..e4a096be5 100644 --- a/content/controller/api/reference/ctlr-adc-api.md +++ b/content/controller/api/reference/ctlr-adc-api.md @@ -1,16 +1,13 @@ --- -description: - Represents the state of the F5 NGINX Controller Application Delivery REST - API. +description: Represents the state of the F5 NGINX Controller Application Delivery + REST API. docs: DOCS-1280 -doctypes: - - reference -type: redoc -tags: - - api +type: +- reference title: ADC API toc: false weight: 300 --- + {{< openapi spec="/controller/api/reference/ctlr-adc-openapi.json" >}} diff --git a/content/controller/api/reference/ctlr-analytics-api.md b/content/controller/api/reference/ctlr-analytics-api.md index 40499bac0..9c645eb30 100644 --- a/content/controller/api/reference/ctlr-analytics-api.md +++ b/content/controller/api/reference/ctlr-analytics-api.md @@ -1,14 +1,12 @@ --- description: Represents the state of the F5 NGINX Controller Analytics REST API. docs: DOCS-1279 -doctypes: - - reference -type: redoc -tags: - - api +type: +- reference title: Analytics API toc: false weight: 200 --- + {{< openapi spec="/controller/api/reference/ctlr-analytics-openapi.json" >}} diff --git a/content/controller/api/reference/ctlr-apim-api.md b/content/controller/api/reference/ctlr-apim-api.md index 0003f6235..bb453259b 100644 --- a/content/controller/api/reference/ctlr-apim-api.md +++ b/content/controller/api/reference/ctlr-apim-api.md @@ -1,14 +1,12 @@ --- description: Represents the state of the F5 NGINX Controller API Management REST API. docs: DOCS-1281 -doctypes: - - reference -type: redoc -tags: - - api +type: +- reference title: APIM API toc: false weight: 400 --- + {{< openapi spec="/controller/api/reference/ctlr-apim-openapi.json" >}} diff --git a/content/controller/api/reference/ctlr-platform-api.md b/content/controller/api/reference/ctlr-platform-api.md index dcf93ec2b..4ae314af7 100644 --- a/content/controller/api/reference/ctlr-platform-api.md +++ b/content/controller/api/reference/ctlr-platform-api.md @@ -1,14 +1,12 @@ --- description: Represents the state of the F5 NGINX Controller Platform REST API. docs: DOCS-1278 -doctypes: - - reference -type: redoc -tags: - - api +type: +- reference title: Platform API toc: false weight: 100 --- + {{< openapi spec="/controller/api/reference/ctlr-platform-openapi.json" >}} diff --git a/content/controller/app-delivery/_index.md b/content/controller/app-delivery/_index.md index e6ae5aeea..021e9ba97 100644 --- a/content/controller/app-delivery/_index.md +++ b/content/controller/app-delivery/_index.md @@ -1,11 +1,7 @@ --- -aliases: -- /services/apps/_index.md description: Tasks for deploying and managing your applications. -menu: - docs: - parent: NGINX Controller title: Application Delivery weight: 152 url: /nginx-controller/app-delivery/ --- + diff --git a/content/controller/app-delivery/about-caching.md b/content/controller/app-delivery/about-caching.md index 4a8212ccb..fef978bc5 100644 --- a/content/controller/app-delivery/about-caching.md +++ b/content/controller/app-delivery/about-caching.md @@ -1,16 +1,15 @@ --- -description: Learn how F5 NGINX Controller handles caching configurations and what NGINX - cache directives are supported. +description: Learn how F5 NGINX Controller handles caching configurations and what + NGINX cache directives are supported. docs: DOCS-339 -doctypes: -- concept -tags: -- docs title: About Caching toc: true weight: 200 +type: +- concept --- + ## Overview The F5 NGINX Controller Application Delivery (AD) module lets you configure content caching by using either the user interface (UI) or the [Components REST API](https://docs.nginx.com/nginx-controller/api/ctlr-adc-api/#tag/Components). diff --git a/content/controller/app-delivery/about-snippets.md b/content/controller/app-delivery/about-snippets.md index da03de377..84226a898 100644 --- a/content/controller/app-delivery/about-snippets.md +++ b/content/controller/app-delivery/about-snippets.md @@ -1,14 +1,13 @@ --- docs: DOCS-340 -doctypes: -- concept -tags: -- docs title: About Snippets toc: true weight: 300 +type: +- concept --- + ## Overview The F5 NGINX Controller Application Delivery (AD) module lets you configure NGINX directives that aren't represented in the NGINX Controller API via "config snippets", or "Snippets". You can do so by using either the user interface (UI) or the [Application Delivery REST API](https://docs.nginx.com/nginx-controller/api/ctlr-adc-api/). diff --git a/content/controller/app-delivery/deploy-simple-app.md b/content/controller/app-delivery/deploy-simple-app.md index e62726cb9..e3ec4cad8 100644 --- a/content/controller/app-delivery/deploy-simple-app.md +++ b/content/controller/app-delivery/deploy-simple-app.md @@ -1,15 +1,14 @@ --- description: Overview of the steps required to deploy a simple App. docs: DOCS-477 -doctypes: -- tutorial -tags: -- docs title: Deploy a Simple Application toc: true weight: 400 +type: +- tutorial --- + ## Overview This topic provides an overview of the steps required to create a simple application by using F5 NGINX Controller's user interface. Use the links provided to learn more about each step. diff --git a/content/controller/app-delivery/manage-apps.md b/content/controller/app-delivery/manage-apps.md index ab4e10613..118151402 100644 --- a/content/controller/app-delivery/manage-apps.md +++ b/content/controller/app-delivery/manage-apps.md @@ -1,15 +1,14 @@ --- description: Create, view, and edit Apps and Components. docs: DOCS-478 -doctypes: -- task -tags: -- docs title: Manage Apps & Components toc: true weight: 300 +type: +- how-to --- + ## Overview Follow the steps in this topic to learn how to create and manage Apps and App Components. diff --git a/content/controller/app-delivery/security/_index.md b/content/controller/app-delivery/security/_index.md index e1d529167..54d5419bf 100644 --- a/content/controller/app-delivery/security/_index.md +++ b/content/controller/app-delivery/security/_index.md @@ -1,8 +1,7 @@ --- -aliases: -- services/apps/security/_index.md description: Secure your applications using F5 NGINX Controller App Security title: App Security weight: 100 url: /nginx-controller/app-delivery/security/ --- + diff --git a/content/controller/app-delivery/security/concepts/_index.md b/content/controller/app-delivery/security/concepts/_index.md index 1fd100ddc..097169f5b 100644 --- a/content/controller/app-delivery/security/concepts/_index.md +++ b/content/controller/app-delivery/security/concepts/_index.md @@ -1,8 +1,7 @@ --- -aliases: -- services/apps/security/concepts/_index.md description: Overview of the App Security module and default policy title: Learn About App Security weight: 100 url: /nginx-controller/app-delivery/security/concepts/ --- + diff --git a/content/controller/app-delivery/security/concepts/app-sec-default-policy-original.md b/content/controller/app-delivery/security/concepts/app-sec-default-policy-original.md index a422b0e9c..8d338266c 100644 --- a/content/controller/app-delivery/security/concepts/app-sec-default-policy-original.md +++ b/content/controller/app-delivery/security/concepts/app-sec-default-policy-original.md @@ -2,16 +2,15 @@ description: Learn about the default protections provided by F5 NGINX Controller App Security. docs: DOCS-479 -doctypes: -- concept -- reference -tags: -- docs title: Default WAF Policy toc: true weight: 200 +type: +- concept +- reference --- + ## Overview You can use the F5 NGINX Controller App Security module to configure and manage a web application firewall (WAF). The App Security WAF protects your applications from HTTP and web-based threats, including the [OWASP Top 10](https://owasp.org/www-project-top-ten/). diff --git a/content/controller/app-delivery/security/concepts/app-sec-metrics.md b/content/controller/app-delivery/security/concepts/app-sec-metrics.md index 6a0da647d..f06c19106 100644 --- a/content/controller/app-delivery/security/concepts/app-sec-metrics.md +++ b/content/controller/app-delivery/security/concepts/app-sec-metrics.md @@ -1,15 +1,15 @@ --- -description: Learn about the F5 NGINX Controller Application Security metrics and events. +description: Learn about the F5 NGINX Controller Application Security metrics and + events. docs: DOCS-480 -doctypes: -- reference -tags: -- docs title: App Security Metrics toc: true weight: 400 +type: +- reference --- + ## Overview This topic provides reference information for the metrics and events that F5 NGINX Controller reports for Application Security. diff --git a/content/controller/app-delivery/security/concepts/bring-your-own-policy.md b/content/controller/app-delivery/security/concepts/bring-your-own-policy.md index 9345d0b73..28c558580 100644 --- a/content/controller/app-delivery/security/concepts/bring-your-own-policy.md +++ b/content/controller/app-delivery/security/concepts/bring-your-own-policy.md @@ -1,15 +1,15 @@ --- -description: Learn how to use your own F5 NGINX App Protect WAF policies with NGINX Controller. +description: Learn how to use your own F5 NGINX App Protect WAF policies with NGINX + Controller. docs: DOCS-481 -doctypes: -- concept -tags: -- docs title: Bring Your Own WAF Policy toc: true weight: 300 +type: +- concept --- + ## Overview You can use the App Security Add-on for F5 NGINX Controller ADC to bring your own ("BYO") NGINX App Protect policies into NGINX Controller. This lets you use your existing declarative JSON policies from NGINX App Protect to protect your ADC app components. diff --git a/content/controller/app-delivery/security/concepts/extend-app-security-snippets.md b/content/controller/app-delivery/security/concepts/extend-app-security-snippets.md index 9f5375b47..90c05e47e 100644 --- a/content/controller/app-delivery/security/concepts/extend-app-security-snippets.md +++ b/content/controller/app-delivery/security/concepts/extend-app-security-snippets.md @@ -2,16 +2,15 @@ description: Learn how to extend your App Security configurations using F5 NGINX Controller Snippets. docs: DOCS-338 -doctypes: -- concept -- reference -tags: -- task title: Extend App Security with Snippets toc: true weight: 400 +type: +- concept +- reference --- + ## Overview F5 NGINX Controller [Snippets]({{< relref "/controller/app-delivery/about-snippets.md" >}}) let you customize your NGINX configuration by adding NGINX directives that aren't represented by the NGINX Controller API. diff --git a/content/controller/app-delivery/security/concepts/what-is-waf.md b/content/controller/app-delivery/security/concepts/what-is-waf.md index 96a7e120f..a70af5232 100644 --- a/content/controller/app-delivery/security/concepts/what-is-waf.md +++ b/content/controller/app-delivery/security/concepts/what-is-waf.md @@ -1,16 +1,15 @@ --- description: Overview of the App Security module's WAF feature. docs: DOCS-483 -doctypes: -- concept -- reference -tags: -- docs title: About App Security toc: true weight: 100 +type: +- concept +- reference --- + ## Overview The App Security Add-on for F5 NGINX Controller ADC lets you protect your applications with a web applications firewall (WAF). The WAF protects your apps from a variety of application layer attacks such as [cross-site scripting (XSS)](https://www.f5.com/services/resources/glossary/cross-site-scripting-xss-or-css), [SQL injection](https://www.f5.com/services/resources/glossary/sql-injection), and [cookie poisoning](https://www.f5.com/services/resources/glossary/cookie-poisoning), among others. diff --git a/content/controller/app-delivery/security/tutorials/_index.md b/content/controller/app-delivery/security/tutorials/_index.md index 5dc3298fd..838458c47 100644 --- a/content/controller/app-delivery/security/tutorials/_index.md +++ b/content/controller/app-delivery/security/tutorials/_index.md @@ -1,8 +1,7 @@ --- -aliases: -- services/apps/security/tutorials/_index.md description: How to deploy and configure the App Security module title: Manage App Security weight: 200 url: /nginx-controller/app-delivery/security/tutorials/ --- + diff --git a/content/controller/app-delivery/security/tutorials/add-app-security-with-waf.md b/content/controller/app-delivery/security/tutorials/add-app-security-with-waf.md index bb01665e2..d64d7868f 100644 --- a/content/controller/app-delivery/security/tutorials/add-app-security-with-waf.md +++ b/content/controller/app-delivery/security/tutorials/add-app-security-with-waf.md @@ -1,16 +1,15 @@ --- description: How to add F5 NGINX Controller App Security to your applications. docs: DOCS-484 -doctypes: -- concept -- reference -tags: -- task title: Manage App Security toc: true weight: 100 +type: +- concept +- reference --- + ## Overview You can use the App Security add-on for F5 NGINX Controller ADC to enable Web Application Firewall (WAF) capabilities to protect your applications. WAF lets you flag or block suspicious requests or attacks. WAF can be added to individual app components. diff --git a/content/controller/app-delivery/security/tutorials/set-waf-monitor-mode.md b/content/controller/app-delivery/security/tutorials/set-waf-monitor-mode.md index cec01746d..f1f32eae1 100644 --- a/content/controller/app-delivery/security/tutorials/set-waf-monitor-mode.md +++ b/content/controller/app-delivery/security/tutorials/set-waf-monitor-mode.md @@ -2,15 +2,14 @@ description: How to use F5 NGINX Controller App Security to monitor or block security violations. docs: DOCS-485 -doctypes: -- task -tags: -- docs title: Set Up App Security Monitor Mode toc: true weight: 200 +type: +- how-to --- + ## Overview You can use the [F5 NGINX Controller REST API]({{< relref "/controller/api/_index.md" >}}) to enable or disable monitor-only mode for the App Security WAF policy. diff --git a/content/controller/app-delivery/security/tutorials/tune-waf-for-app.md b/content/controller/app-delivery/security/tutorials/tune-waf-for-app.md index 74a173b9a..0f06a7c84 100644 --- a/content/controller/app-delivery/security/tutorials/tune-waf-for-app.md +++ b/content/controller/app-delivery/security/tutorials/tune-waf-for-app.md @@ -1,16 +1,15 @@ --- description: How to tune WAF for your App. docs: DOCS-486 -doctypes: -- concept -- reference -tags: -- task title: Manage WAF Tuning for App Components toc: true weight: 300 +type: +- concept +- reference --- + ## Overview WAF Tuning helps remove false positives or exceptions from Security Events. diff --git a/content/controller/app-delivery/security/tutorials/using-rbac-with-app-security.md b/content/controller/app-delivery/security/tutorials/using-rbac-with-app-security.md index 9274bbdec..9c9b92c21 100644 --- a/content/controller/app-delivery/security/tutorials/using-rbac-with-app-security.md +++ b/content/controller/app-delivery/security/tutorials/using-rbac-with-app-security.md @@ -1,15 +1,14 @@ --- description: How to use Role Based Access Control with App Security. docs: DOCS-845 -doctypes: -- task -tags: -- docs title: Using RBAC with the App Security Add-On toc: true weight: 400 +type: +- how-to --- + Role Based Access Control (RBAC) allows you to define permissions for Apps Security resources. With RBAC, you can specify which role has the permissions to create, read (and reference), update, and delete a Security Strategy or a Security Policy. You can then assign roles to specific users so that the users inherit the permissions. For more information regarding roles, refer to [Manage Roles and Role Groups]({{< relref "/controller/platform/access-management/manage-roles.md" >}}) diff --git a/content/controller/app-delivery/security/tutorials/view-app-security-analytics.md b/content/controller/app-delivery/security/tutorials/view-app-security-analytics.md index 738d54cd8..993f5681e 100644 --- a/content/controller/app-delivery/security/tutorials/view-app-security-analytics.md +++ b/content/controller/app-delivery/security/tutorials/view-app-security-analytics.md @@ -1,16 +1,15 @@ --- description: How to view App Security Analytics. docs: DOCS-487 -doctypes: -- concept -- reference -tags: -- task title: View App Security Analytics toc: true weight: 500 +type: +- concept +- reference --- + ## Overview When App Security flags or blocks a request made to an App Component as a security violation, it generates an App Security event. diff --git a/content/controller/infrastructure/_index.md b/content/controller/infrastructure/_index.md index fa7e33a9e..e67c8e177 100644 --- a/content/controller/infrastructure/_index.md +++ b/content/controller/infrastructure/_index.md @@ -1,9 +1,7 @@ --- description: Learn how to manage F5 NGINX Controller's underlying infrastructure. -menu: - docs: - parent: NGINX Controller title: Infrastructure weight: 130 url: /nginx-controller/infrastructure/ --- + diff --git a/content/controller/infrastructure/instances/_index.md b/content/controller/infrastructure/instances/_index.md index 0ebddf5c8..fbeb3ebe1 100644 --- a/content/controller/infrastructure/instances/_index.md +++ b/content/controller/infrastructure/instances/_index.md @@ -1,8 +1,6 @@ --- -menu: - docs: - parent: Infrastructure title: Instance Management weight: 10 url: /nginx-controller/infrastructure/instances/ --- + diff --git a/content/controller/infrastructure/instances/add-aws-instance.md b/content/controller/infrastructure/instances/add-aws-instance.md index 07ca4f119..4220fca1a 100644 --- a/content/controller/infrastructure/instances/add-aws-instance.md +++ b/content/controller/infrastructure/instances/add-aws-instance.md @@ -1,15 +1,14 @@ --- description: Learn how to deploy an AWS F5 NGINX instance using NGINX Controller. docs: DOCS-768 -doctypes: -- tutorial -tags: -- docs title: Add an AWS NGINX Instance toc: true weight: 30 +type: +- tutorial --- + ## Overview diff --git a/content/controller/infrastructure/instances/add-azure-instance.md b/content/controller/infrastructure/instances/add-azure-instance.md index fbb7fb08a..1ea0590d3 100644 --- a/content/controller/infrastructure/instances/add-azure-instance.md +++ b/content/controller/infrastructure/instances/add-azure-instance.md @@ -1,16 +1,14 @@ --- description: Learn how to deploy an Azure NGINX instance using F5 NGINX Controller. docs: DOCS-769 -doctypes: -- beta -- tutorial -tags: -- docs title: Add an Azure NGINX Instance toc: true weight: 35 +type: +- tutorial --- + ## Overview diff --git a/content/controller/infrastructure/instances/add-nap-instance.md b/content/controller/infrastructure/instances/add-nap-instance.md index b8a760c65..662acf4e0 100644 --- a/content/controller/infrastructure/instances/add-nap-instance.md +++ b/content/controller/infrastructure/instances/add-nap-instance.md @@ -2,15 +2,14 @@ description: Learn how to register an F5 NGINX App Protect instance with NGINX Controller for use with the ADC module. docs: DOCS-770 -doctypes: -- task -tags: -- docs title: Add an NGINX App Protect Instance toc: true weight: 20 +type: +- how-to --- + ## Overview Follow the directions in this topic to deploy F5 NGINX App Protect and add the instance to NGINX Controller. diff --git a/content/controller/infrastructure/instances/add-vsphere-instance.md b/content/controller/infrastructure/instances/add-vsphere-instance.md index 9644b00e9..9a4fb9e7c 100644 --- a/content/controller/infrastructure/instances/add-vsphere-instance.md +++ b/content/controller/infrastructure/instances/add-vsphere-instance.md @@ -1,16 +1,14 @@ --- description: Learn how to deploy a vSphere NGINX instance using F5 NGINX Controller. docs: DOCS-771 -doctypes: -- beta -- tutorial -tags: -- docs title: Add a vSphere NGINX Instance toc: true weight: 35 +type: +- tutorial --- + ## Overview diff --git a/content/controller/infrastructure/instances/analyzer.md b/content/controller/infrastructure/instances/analyzer.md index 26b04788c..2f9ba9712 100644 --- a/content/controller/infrastructure/instances/analyzer.md +++ b/content/controller/infrastructure/instances/analyzer.md @@ -1,15 +1,14 @@ --- description: View graphs and system reports for your Instances. docs: DOCS-772 -doctypes: -- task -tags: -- docs title: View Performance Reports for Your Instances toc: true weight: 60 +type: +- how-to --- + ## Overview Use the **Analyzer** page in the F5 NGINX Controller **Infrastructure** section to see reports for your NGINX Plus instances. diff --git a/content/controller/infrastructure/instances/graphs.md b/content/controller/infrastructure/instances/graphs.md index 62f123a88..317fccd87 100644 --- a/content/controller/infrastructure/instances/graphs.md +++ b/content/controller/infrastructure/instances/graphs.md @@ -1,19 +1,17 @@ --- description: View key metrics for all of your monitored systems. docs: DOCS-773 -doctypes: -- task -- tutorial -- concept -- reference -- troubleshooting -tags: -- docs title: View System Metrics Graphs toc: true weight: 70 +type: +- how-to +- tutorial +- concept +- reference --- + ## Overview You can use the F5 NGINX Controller **Graphs** viewer to view key metrics for all of your monitored systems. diff --git a/content/controller/infrastructure/instances/ha-data-plane.md b/content/controller/infrastructure/instances/ha-data-plane.md index 6e8a03c6e..42a65f99d 100644 --- a/content/controller/infrastructure/instances/ha-data-plane.md +++ b/content/controller/infrastructure/instances/ha-data-plane.md @@ -2,15 +2,14 @@ description: Learn how to configure a high-availability data plane for your apps in on-premises deployments using F5 NGINX Controller, NGINX Plus, and keepalived. docs: DOCS-774 -doctypes: -- tutorial -tags: -- docs title: Set Up Data Plane High Availability toc: true weight: 40 +type: +- tutorial --- + ## Overview This topic explains how to configure a high-availability data plane for your apps in on-premises deployments using F5 NGINX Controller, NGINX Plus, and keepalived. High-availability data planes help to ensure your apps operate continuously without service interruptions. diff --git a/content/controller/infrastructure/instances/manage-containerized-instances.md b/content/controller/infrastructure/instances/manage-containerized-instances.md index b8d69675d..d7c318771 100644 --- a/content/controller/infrastructure/instances/manage-containerized-instances.md +++ b/content/controller/infrastructure/instances/manage-containerized-instances.md @@ -2,15 +2,14 @@ description: How to set up Kubernetes-native API Gateways using Instance Groups (requires the API Management module). docs: DOCS-775 -doctypes: -- tutorial -tags: -- docs title: Manage Containerized Instances toc: true weight: 15 +type: +- tutorial --- + ## Overview {{< important >}} Instance groups are supported in the F5 NGINX Controller API Management module beginning with version 3.18-APIM. Instance groups are supported in the NGINX Controller Application Delivery module versions 3.20, 3.21, and 3.22. diff --git a/content/controller/infrastructure/instances/manage-instance-templates.md b/content/controller/infrastructure/instances/manage-instance-templates.md index d7aab04bd..539c86f8c 100644 --- a/content/controller/infrastructure/instances/manage-instance-templates.md +++ b/content/controller/infrastructure/instances/manage-instance-templates.md @@ -1,15 +1,14 @@ --- description: Create and manage templates for your F5 NGINX Plus instances. docs: DOCS-776 -doctypes: -- tutorial -tags: -- docs title: Manage Your Instance Templates toc: true weight: 50 +type: +- tutorial --- + ## Overview An Instance Template defines the parameters to use when creating a data plane instance. diff --git a/content/controller/infrastructure/instances/manage-instances.md b/content/controller/infrastructure/instances/manage-instances.md index f2ee622e0..52b5faa3f 100644 --- a/content/controller/infrastructure/instances/manage-instances.md +++ b/content/controller/infrastructure/instances/manage-instances.md @@ -1,15 +1,14 @@ --- description: Use the Instance Overview page to view and manage your F5 NGINX Instances. docs: DOCS-777 -doctypes: -- tutorial -tags: -- docs title: Manage Your NGINX Instances toc: true weight: 10 +type: +- tutorial --- + ## Overview The **Infrastructure > Instances > Overview** page allows you to check the status of all your F5 NGINX instances at a glance. diff --git a/content/controller/infrastructure/locations/manage-locations.md b/content/controller/infrastructure/locations/manage-locations.md index 2eb8867f6..2b076a167 100644 --- a/content/controller/infrastructure/locations/manage-locations.md +++ b/content/controller/infrastructure/locations/manage-locations.md @@ -1,15 +1,14 @@ --- description: Create and manage Locations for your F5 NGINX Instances. docs: DOCS-778 -doctypes: -- tutorial -tags: -- docs title: Manage Locations toc: true weight: 10 +type: +- tutorial --- + ## Overview You can logically group your NGINX instances and instance groups by their physical locations using the **Locations** settings page in the F5 NGINX Controller web interface. diff --git a/content/controller/platform/_index.md b/content/controller/platform/_index.md index 2f12528fa..bd8b42cbe 100644 --- a/content/controller/platform/_index.md +++ b/content/controller/platform/_index.md @@ -1,9 +1,7 @@ --- description: Learn how to manage the F5 NGINX Controller platform. -menu: - docs: - parent: NGINX Controller title: Platform weight: 140 url: /nginx-controller/platform/ --- + diff --git a/content/controller/platform/about/get-controller-version.md b/content/controller/platform/about/get-controller-version.md index cf9cd94e9..3f6e126d7 100644 --- a/content/controller/platform/about/get-controller-version.md +++ b/content/controller/platform/about/get-controller-version.md @@ -1,15 +1,14 @@ --- description: How to look up the version details for F5 NGINX Controller and its components. docs: DOCS-780 -doctypes: -- task -tags: -- docs title: Look Up Version Information toc: true weight: 130 +type: +- how-to --- + ## Overview You can use the F5 NGINX Controller command-line interface, web interface, and API to look up the version information for NGINX Controller. The NGINX Controller API also returns version information for the NGINX Controller components. diff --git a/content/controller/platform/about/what-is-controller.md b/content/controller/platform/about/what-is-controller.md index 3a2f06aa4..907efffac 100644 --- a/content/controller/platform/about/what-is-controller.md +++ b/content/controller/platform/about/what-is-controller.md @@ -1,15 +1,14 @@ --- description: Overview of F5 NGINX Controller. docs: DOCS-781 -doctypes: -- concept -tags: -- docs title: Get to Know NGINX Controller toc: true weight: 100 +type: +- concept --- + ## Overview F5 NGINX Controller is designed to let you manage and monitor your NGINX Plus instances. With NGINX Controller, it's easy to proactively configure, analyze, and respond to problems related to running and scaling NGINX-based web applications. diff --git a/content/controller/platform/access-management/_index.md b/content/controller/platform/access-management/_index.md index 276e71b8b..703198839 100644 --- a/content/controller/platform/access-management/_index.md +++ b/content/controller/platform/access-management/_index.md @@ -1,9 +1,7 @@ --- description: Create and manage Authentication Providers, Users, Roles, and Role Groups -menu: - docs: - parent: Platform title: Access Management weight: 140 url: /nginx-controller/platform/access-management/ --- + diff --git a/content/controller/platform/access-management/manage-active-directory-auth-provider.md b/content/controller/platform/access-management/manage-active-directory-auth-provider.md index 7aa36efb3..6ed2a425d 100644 --- a/content/controller/platform/access-management/manage-active-directory-auth-provider.md +++ b/content/controller/platform/access-management/manage-active-directory-auth-provider.md @@ -1,16 +1,15 @@ --- -description: Set up Active Directory authentication for F5 NGINX Controller using OIDC - with Microsoft Entra or LDAP, LDAPs, and StartTLS with Windows Active Directory. +description: Set up Active Directory authentication for F5 NGINX Controller using + OIDC with Microsoft Entra or LDAP, LDAPs, and StartTLS with Windows Active Directory. docs: DOCS-782 -doctypes: -- tutorial -tags: -- docs title: Configure Active Directory Integration toc: true weight: 10 +type: +- tutorial --- + ## Overview By completing the steps in this guide, you will learn how to add an Active Directory (AD) integration to F5 NGINX Controller. NGINX Controller supports the following AD types and protocols: diff --git a/content/controller/platform/access-management/manage-roles.md b/content/controller/platform/access-management/manage-roles.md index 4d3f7a759..b64eb4869 100644 --- a/content/controller/platform/access-management/manage-roles.md +++ b/content/controller/platform/access-management/manage-roles.md @@ -1,15 +1,14 @@ --- description: Create and manage Roles and Role Groups. docs: DOCS-783 -doctypes: -- tutorial -tags: -- docs title: Manage Roles and Role Groups toc: true weight: 30 +type: +- tutorial --- + ## Overview This topic explains how to create and manage Roles and Role Groups. diff --git a/content/controller/platform/access-management/manage-users.md b/content/controller/platform/access-management/manage-users.md index 7a718eb26..e7e0cb84a 100644 --- a/content/controller/platform/access-management/manage-users.md +++ b/content/controller/platform/access-management/manage-users.md @@ -1,15 +1,14 @@ --- description: Create and manage User resources. docs: DOCS-784 -doctypes: -- tutorial -tags: -- docs title: Manage Users toc: true weight: 20 +type: +- tutorial --- + ## Overview This topic explains how to create and manage User resources. diff --git a/content/controller/platform/integrations/_index.md b/content/controller/platform/integrations/_index.md index 182dd5bdc..fdc4c07d0 100644 --- a/content/controller/platform/integrations/_index.md +++ b/content/controller/platform/integrations/_index.md @@ -1,9 +1,7 @@ --- description: 'Integrate popular third-party services with F5 NGINX Controller. ' -menu: - docs: - parent: Platform title: Integrations weight: 200 url: /nginx-controller/platform/integrations/ --- + diff --git a/content/controller/platform/integrations/aws-integration.md b/content/controller/platform/integrations/aws-integration.md index 6c21f88b8..28dd2ad2c 100644 --- a/content/controller/platform/integrations/aws-integration.md +++ b/content/controller/platform/integrations/aws-integration.md @@ -1,15 +1,14 @@ --- description: Integrate F5 NGINX Controller with Amazon Web Services. docs: DOCS-785 -doctypes: -- tutorial -tags: -- docs title: AWS Integration toc: true weight: 20 +type: +- tutorial --- + ## AWS Integration Requirements To create an Integration for AWS, you need to [configure an AWS IAM user](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#iam-user-name-and-password) with the following roles: diff --git a/content/controller/platform/integrations/big-ip-self-service.md b/content/controller/platform/integrations/big-ip-self-service.md index ab034be2f..7c6665826 100644 --- a/content/controller/platform/integrations/big-ip-self-service.md +++ b/content/controller/platform/integrations/big-ip-self-service.md @@ -1,15 +1,14 @@ --- description: Integrate F5 NGINX Controller with a BIG-IP cluster. docs: DOCS-786 -doctypes: -- tutorial -tags: -- docs title: BIG-IP Integration toc: true weight: 20 +type: +- tutorial --- + ## Overview You can use F5 NGINX Controller to configure a BIG-IP cluster to work with NGINX instances in your app delivery infrastructure. By using NGINX Controller, you can configure your NGINX instances as part of your BIG-IP device's virtual servers and server pools. diff --git a/content/controller/platform/licensing-controller.md b/content/controller/platform/licensing-controller.md index ed7f1119a..a57f40451 100644 --- a/content/controller/platform/licensing-controller.md +++ b/content/controller/platform/licensing-controller.md @@ -1,15 +1,14 @@ --- description: Follow these steps to license your F5 NGINX Controller. docs: DOCS-787 -doctypes: -- task -tags: -- docs title: License NGINX Controller toc: true weight: 120 +type: +- how-to --- + ## Overview This topic explains how to upload and manage licenses for F5 NGINX Controller. diff --git a/content/controller/platform/maintenance/_index.md b/content/controller/platform/maintenance/_index.md index bfe38953a..83e67b75f 100644 --- a/content/controller/platform/maintenance/_index.md +++ b/content/controller/platform/maintenance/_index.md @@ -1,9 +1,7 @@ --- description: Learn how to perform maintenance tasks on your F5 NGINX Controller. -menu: - docs: - parent: Platform title: Maintenance weight: 250 url: /nginx-controller/platform/maintenance/ --- + diff --git a/content/controller/platform/maintenance/changing-ip-address.md b/content/controller/platform/maintenance/changing-ip-address.md index e25a6e1d9..47e52b1fd 100644 --- a/content/controller/platform/maintenance/changing-ip-address.md +++ b/content/controller/platform/maintenance/changing-ip-address.md @@ -1,16 +1,15 @@ --- description: Learn how to safely change the management IP of F5 NGINX Controller. docs: DOCS-779 -doctypes: -- task -- tutorial -tags: -- docs title: Changing the IP address toc: true weight: 135 +type: +- how-to +- tutorial --- + ## Overview This topic explains how to safely update the management IP of F5 NGINX Controller. diff --git a/content/controller/platform/manage-cluster.md b/content/controller/platform/manage-cluster.md index ab6ded842..941e9b900 100644 --- a/content/controller/platform/manage-cluster.md +++ b/content/controller/platform/manage-cluster.md @@ -2,16 +2,15 @@ description: Learn how to add and manage additional F5 NGINX Controller nodes to create a resilient cluster. docs: DOCS-788 -doctypes: -- task -- tutorial -tags: -- docs title: Manage Your Cluster toc: true weight: 140 +type: +- how-to +- tutorial --- + ## Overview This topic explains how to update your cluster settings and how to manage nodes for a multi-node cluster. diff --git a/content/controller/releases/_index.md b/content/controller/releases/_index.md index 281c430e7..fce902795 100644 --- a/content/controller/releases/_index.md +++ b/content/controller/releases/_index.md @@ -1,13 +1,11 @@ --- description: Stay up-to-date with the latest F5 NGINX Controller releases. -menu: - docs: - parent: NGINX Controller title: Releases weight: 1000 url: /nginx-controller/releases/ --- + To learn more about the different F5 NGINX Controller offerings, see the following product pages: - [NGINX Controller Application Delivery Module](https://www.nginx.com/products/nginx-controller/load-balancer-application-delivery/) diff --git a/content/controller/releases/adc/_index.md b/content/controller/releases/adc/_index.md index 10b8f4388..be6bd6a49 100644 --- a/content/controller/releases/adc/_index.md +++ b/content/controller/releases/adc/_index.md @@ -1,10 +1,8 @@ --- -description: Stay up-to-date with the latest releases for the [F5 NGINX Controller Application - Delivery Module](https://www.nginx.com/products/nginx-controller/load-balancer-application-delivery/). -menu: - docs: - parent: NGINX Controller +description: Stay up-to-date with the latest releases for the [F5 NGINX Controller + Application Delivery Module](https://www.nginx.com/products/nginx-controller/load-balancer-application-delivery/). title: NGINX Controller Application Delivery Module weight: 50 url: /nginx-controller/releases/adc/ --- + diff --git a/content/controller/releases/adc/adc-release-notes-3.20.1.md b/content/controller/releases/adc/adc-release-notes-3.20.1.md index e1cd9f1ff..cc45f3ba9 100644 --- a/content/controller/releases/adc/adc-release-notes-3.20.1.md +++ b/content/controller/releases/adc/adc-release-notes-3.20.1.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-362 -doctypes: -- reference -tags: -- docs title: Release Notes 3.20.1 toc: true weight: 99 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.20.md b/content/controller/releases/adc/adc-release-notes-3.20.md index 25525767c..60762a7c8 100644 --- a/content/controller/releases/adc/adc-release-notes-3.20.md +++ b/content/controller/releases/adc/adc-release-notes-3.20.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-363 -doctypes: -- reference -tags: -- docs title: Release Notes 3.20.0 toc: true weight: 100 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.21.md b/content/controller/releases/adc/adc-release-notes-3.21.md index 882bef68e..86bf37a8b 100644 --- a/content/controller/releases/adc/adc-release-notes-3.21.md +++ b/content/controller/releases/adc/adc-release-notes-3.21.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-364 -doctypes: -- reference -tags: -- docs title: Release Notes 3.21.0 toc: true weight: 98 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.1.md b/content/controller/releases/adc/adc-release-notes-3.22.1.md index c95a4fcee..9d2b29bbb 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.1.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.1.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-834 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.1 toc: true weight: 96 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.2.md b/content/controller/releases/adc/adc-release-notes-3.22.2.md index a4e7deb53..45d72cd06 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.2.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.2.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-844 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.2 toc: true weight: 95 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.3.md b/content/controller/releases/adc/adc-release-notes-3.22.3.md index de886eec6..d874bd8bd 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.3.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.3.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-903 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.3 toc: true weight: 94 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.4.md b/content/controller/releases/adc/adc-release-notes-3.22.4.md index 96fe39bfa..f4e17c6c8 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.4.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.4.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-904 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.4 toc: true weight: 93 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.5.md b/content/controller/releases/adc/adc-release-notes-3.22.5.md index 32b148cf7..86c5a6ae5 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.5.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.5.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-945 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.5 toc: true weight: 92 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.6.md b/content/controller/releases/adc/adc-release-notes-3.22.6.md index 69d3c3931..9be567fa1 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.6.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.6.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-1086 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.6 toc: true weight: 91 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.7.md b/content/controller/releases/adc/adc-release-notes-3.22.7.md index 2e37daceb..a0ea657bb 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.7.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.7.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-1388 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.7 toc: true weight: 90 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.8.md b/content/controller/releases/adc/adc-release-notes-3.22.8.md index 9b3fad81a..1961f5c9b 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.8.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.8.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-1128 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.8 toc: true weight: 89 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/adc/adc-release-notes-3.22.md b/content/controller/releases/adc/adc-release-notes-3.22.md index ec48ca730..1d91b9140 100644 --- a/content/controller/releases/adc/adc-release-notes-3.22.md +++ b/content/controller/releases/adc/adc-release-notes-3.22.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller Application Delivery Module. docs: DOCS-833 -doctypes: -- reference -tags: -- docs title: Release Notes 3.22.0 toc: true weight: 97 +type: +- reference --- + {{< include "controller/adc-rn-preamble.md" >}}   diff --git a/content/controller/releases/apim/_index.md b/content/controller/releases/apim/_index.md index 3a96dd50b..df9a675f3 100644 --- a/content/controller/releases/apim/_index.md +++ b/content/controller/releases/apim/_index.md @@ -1,10 +1,8 @@ --- description: Stay up-to-date with the latest releases for the [NGINX Controller API Management Module](https://www.nginx.com/products/nginx-controller/api-management/). -menu: - docs: - parent: NGINX Controller title: NGINX Controller API Management Module weight: 100 url: /nginx-controller/releases/apim/ --- + diff --git a/content/controller/releases/apim/apim-release-notes-3.18.1.md b/content/controller/releases/apim/apim-release-notes-3.18.1.md index bddda7430..037148355 100644 --- a/content/controller/releases/apim/apim-release-notes-3.18.1.md +++ b/content/controller/releases/apim/apim-release-notes-3.18.1.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller API Management Module. docs: DOCS-365 -doctypes: -- reference -tags: -- docs title: Release Notes 3.18.1 toc: true weight: 99 +type: +- reference --- + {{< include "controller/apim-rn-preamble.md" >}}   diff --git a/content/controller/releases/apim/apim-release-notes-3.18.md b/content/controller/releases/apim/apim-release-notes-3.18.md index 2a7a0330d..3c3daab00 100644 --- a/content/controller/releases/apim/apim-release-notes-3.18.md +++ b/content/controller/releases/apim/apim-release-notes-3.18.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller API Management Module. docs: DOCS-366 -doctypes: -- reference -tags: -- docs title: Release Notes 3.18.0 toc: true weight: 100 +type: +- reference --- + {{< include "controller/apim-rn-preamble.md" >}}   diff --git a/content/controller/releases/apim/apim-release-notes-3.19.1.md b/content/controller/releases/apim/apim-release-notes-3.19.1.md index de0ea6b86..1bcf0bc5a 100644 --- a/content/controller/releases/apim/apim-release-notes-3.19.1.md +++ b/content/controller/releases/apim/apim-release-notes-3.19.1.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller API Management Module. docs: DOCS-367 -doctypes: -- reference -tags: -- docs title: Release Notes 3.19.1 toc: true weight: 96 +type: +- reference --- + {{< include "controller/apim-rn-preamble.md" >}}   diff --git a/content/controller/releases/apim/apim-release-notes-3.19.2.md b/content/controller/releases/apim/apim-release-notes-3.19.2.md index 6697d1d4a..6d1b6d664 100644 --- a/content/controller/releases/apim/apim-release-notes-3.19.2.md +++ b/content/controller/releases/apim/apim-release-notes-3.19.2.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller API Management Module. docs: DOCS-368 -doctypes: -- reference -tags: -- docs title: Release Notes 3.19.2 toc: true weight: 95 +type: +- reference --- + {{< include "controller/apim-rn-preamble.md" >}}   diff --git a/content/controller/releases/apim/apim-release-notes-3.19.md b/content/controller/releases/apim/apim-release-notes-3.19.md index 34ab0d06d..5d53eb305 100644 --- a/content/controller/releases/apim/apim-release-notes-3.19.md +++ b/content/controller/releases/apim/apim-release-notes-3.19.md @@ -2,15 +2,14 @@ description: These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller API Management Module. docs: DOCS-369 -doctypes: -- reference -tags: -- docs title: Release Notes 3.19.0 toc: true weight: 97 +type: +- reference --- + {{< include "controller/apim-rn-preamble.md" >}}   diff --git a/content/controller/releases/release-notes.md b/content/controller/releases/release-notes.md index 5654c32c1..397a1c80f 100644 --- a/content/controller/releases/release-notes.md +++ b/content/controller/releases/release-notes.md @@ -2,15 +2,14 @@ description: Learn about the new features, enhancements, resolved issues, and known issues in F5 NGINX Controller. docs: DOCS-370 -doctypes: -- reference -tags: -- docs -title: "NGINX Controller v3.0.0\u20133.18.3" +title: NGINX Controller v3.0.0–3.18.3 toc: true weight: 10 +type: +- reference --- + ## Release Notes Here you can find the release information for F5 NGINX Controller v3. NGINX Controller is NGINX's control-plane solution that manages the NGINX data plane. Built on a modular architecture, NGINX Controller enables you to manage the entire lifecycle of NGINX Plus, whether it’s deployed as a load balancer, API gateway, or a proxy in a service mesh environment. diff --git a/content/controller/services/_index.md b/content/controller/services/_index.md index a679c8374..4422fe534 100644 --- a/content/controller/services/_index.md +++ b/content/controller/services/_index.md @@ -1,10 +1,8 @@ --- description: Set up Environments, Certificates, and Gateways for Application Delivery and API Management. -menu: - docs: - parent: NGINX Controller title: Services weight: 150 url: /nginx-controller/services/ --- + diff --git a/content/controller/services/available-policies.md b/content/controller/services/available-policies.md index 3f68eeaeb..fb05f4748 100644 --- a/content/controller/services/available-policies.md +++ b/content/controller/services/available-policies.md @@ -1,15 +1,14 @@ --- description: Learn about the policies available for use in the F5 NGINX Controller. docs: DOCS-568 -doctypes: -- concept -tags: -- docs title: Learn About Policies toc: true weight: 130 +type: +- concept --- + ## Overview F5 NGINX Controller provides a set of policies that allow you to protect and secure your services (APIs for API Management module deployments, and Apps for App Delivery module deployments) and their data. The available policies fall under two basic categories: diff --git a/content/controller/services/manage-certs.md b/content/controller/services/manage-certs.md index 9737099e0..ea1191c88 100644 --- a/content/controller/services/manage-certs.md +++ b/content/controller/services/manage-certs.md @@ -1,15 +1,14 @@ --- description: Create, apply, and mange Certs to use with your environments. docs: DOCS-371 -doctypes: -- tutorial -tags: -- docs title: Manage Certs toc: true weight: 120 +type: +- tutorial --- + ## Overview Follow the steps in this topic to create and use Certs with an [Environment]({{< relref "/controller/services/manage-environments.md" >}}). diff --git a/content/controller/services/manage-environments.md b/content/controller/services/manage-environments.md index 243276cc9..2626cecc5 100644 --- a/content/controller/services/manage-environments.md +++ b/content/controller/services/manage-environments.md @@ -1,15 +1,14 @@ --- description: Create and manage environments to use with your apps, gateways, and certs. docs: DOCS-372 -doctypes: -- tutorial -tags: -- docs title: Manage Environments toc: true weight: 100 +type: +- tutorial --- + ## Overview This page contains instructions for creating and managing Environments in the F5 NGINX Controller user interface. diff --git a/content/controller/services/manage-gateways.md b/content/controller/services/manage-gateways.md index e61370473..e57b80ff7 100644 --- a/content/controller/services/manage-gateways.md +++ b/content/controller/services/manage-gateways.md @@ -1,15 +1,14 @@ --- description: Create, view, and edit Gateways. docs: DOCS-373 -doctypes: -- tutorial -tags: -- docs title: Manage Gateways toc: true weight: 120 +type: +- tutorial --- + ## Overview diff --git a/content/controller/services/manage-identity-providers.md b/content/controller/services/manage-identity-providers.md index 8eede4f03..084573e3f 100644 --- a/content/controller/services/manage-identity-providers.md +++ b/content/controller/services/manage-identity-providers.md @@ -1,15 +1,14 @@ --- description: Create and Manage Identity Providers. docs: DOCS-571 -doctypes: -- tutorial -tags: -- docs title: Manage Identity Providers toc: true weight: 140 +type: +- tutorial --- + ## Overview The **Identity Providers** page lets you create and manage Identity Providers to control access to your services (APIs for API Management module deployments, and Apps for App Delivery module deployments). diff --git a/content/controller/services/overview.md b/content/controller/services/overview.md index 9f895467d..9623fb4f4 100644 --- a/content/controller/services/overview.md +++ b/content/controller/services/overview.md @@ -2,15 +2,14 @@ description: Learn about the common tasks and resources that are required to deploy and manage Services using F5 NGINX Controller. docs: DOCS-374 -doctypes: -- tutorial -tags: -- docs title: Set Up NGINX Controller Services toc: true weight: 10 +type: +- tutorial --- + ## Introduction As noted in the F5 NGINX Controller [API Overview]({{< relref "/controller/api/overview.md" >}}), NGINX Controller is organized into four top-level areas: diff --git a/content/controller/support/_index.md b/content/controller/support/_index.md index a6606b43b..a73fa106c 100644 --- a/content/controller/support/_index.md +++ b/content/controller/support/_index.md @@ -1,10 +1,8 @@ --- description: How to get support for F5 NGINX Controller -menu: - docs: - parent: NGINX Controller title: Support weight: 500 url: /nginx-controller/support/ --- + diff --git a/content/controller/support/contact-support.md b/content/controller/support/contact-support.md index 7527a57e5..61f5afcdb 100644 --- a/content/controller/support/contact-support.md +++ b/content/controller/support/contact-support.md @@ -1,16 +1,14 @@ --- description: Contact information and knowledge resources for F5 NGINX Support. docs: DOCS-375 -doctypes: -- reference -- troubleshooting -tags: -- docs title: Where to Go for Support toc: true weight: 10 +type: +- reference --- + ## Contact F5 NGINX Support For questions and/or assistance with installing, troubleshooting, or using NGINX Controller, contact Support via the [MyF5 Customer Portal](https://account.f5.com/myf5). diff --git a/content/controller/support/troubleshooting-controller.md b/content/controller/support/troubleshooting-controller.md index f4ef2914c..25d2c6421 100644 --- a/content/controller/support/troubleshooting-controller.md +++ b/content/controller/support/troubleshooting-controller.md @@ -1,17 +1,15 @@ --- -description: Steps to take to investigate and fix issues with F5 NGINX Controller and - the Controller Agent. +description: Steps to take to investigate and fix issues with F5 NGINX Controller + and the Controller Agent. docs: DOCS-376 -doctypes: -- tutorial -- troubleshooting -tags: -- docs title: Troubleshoot NGINX Controller and the Controller Agent toc: true weight: 100 +type: +- tutorial --- + ## Overview If NGINX isn't behaving how you expect, you can take the following steps to troubleshoot issues. If you need to [contact F5 NGINX Support]({{< relref "/controller/support/contact-support.md" >}}), make sure to [create a support package](#create-a-support-package) first. diff --git a/content/controller/support/troubleshooting-forwarders.md b/content/controller/support/troubleshooting-forwarders.md index 04eedbbfc..269475451 100644 --- a/content/controller/support/troubleshooting-forwarders.md +++ b/content/controller/support/troubleshooting-forwarders.md @@ -1,15 +1,14 @@ --- description: Steps to take to investigate and fix issues with data forwarders. docs: DOCS-377 -doctypes: -- tutorial -tags: -- docs title: Troubleshoot Data Forwarders toc: true weight: 200 +type: +- tutorial --- + ## Overview If your Data Forwarders aren't behaving how you expect them to, you can take the following steps to troubleshoot issues. If you need to [contact F5 NGINX Support]({{< relref "/controller/support/contact-support.md" >}}), make sure to [create a support package](#support/create-a-support-package) first. diff --git a/content/mesh/_index.md b/content/mesh/_index.md index 76d2241e0..c30b9c2f1 100644 --- a/content/mesh/_index.md +++ b/content/mesh/_index.md @@ -1,11 +1,13 @@ --- -title: "F5 NGINX Service Mesh" -description: | - NGINX Service Mesh is a fully integrated lightweight service mesh that leverages a data plane powered by NGINX Plus to manage container traffic in Kubernetes environments. -linkTitle: "NGINX Service Mesh" -menu: docs +title: F5 NGINX Service Mesh +description: 'NGINX Service Mesh is a fully integrated lightweight service mesh that + leverages a data plane powered by NGINX Plus to manage container traffic in Kubernetes + environments. + + ' cascade: - type: "mesh-eos" - noindex: true + type: mesh-eos + noindex: true url: /nginx-service-mesh/ --- + diff --git a/content/mesh/about/_index.md b/content/mesh/about/_index.md index 8a1b6f517..510e7b8da 100644 --- a/content/mesh/about/_index.md +++ b/content/mesh/about/_index.md @@ -1,10 +1,9 @@ --- title: About NGINX Service Mesh -description: "Learn the fundamentals of NGINX Service Mesh." +description: Learn the fundamentals of NGINX Service Mesh. weight: 10 -categories: ["concepts"] -menu: - docs: - parent: NGINX Service Mesh url: /nginx-service-mesh/about/ +type: +- concept --- + diff --git a/content/mesh/about/architecture.md b/content/mesh/about/architecture.md index e088e4f21..03387686c 100644 --- a/content/mesh/about/architecture.md +++ b/content/mesh/about/architecture.md @@ -1,12 +1,15 @@ --- -title: "Architecture" +title: Architecture weight: 200 -description: "Learn about F5 NGINX Service Mesh Architecture." -categories: ["concepts", "reference"] +description: Learn about F5 NGINX Service Mesh Architecture. toc: true -docs: "DOCS-676" +docs: DOCS-676 +type: +- concept +- reference --- + ## Overview F5 NGINX Service Mesh is an infrastructure layer designed to decouple application business logic from deep networking concerns. A mesh is designed to provide fast, reliable, and low-latency network connections for modern application architectures. diff --git a/content/mesh/about/mesh-tech-specs.md b/content/mesh/about/mesh-tech-specs.md index 18e7fba37..74d3e10eb 100644 --- a/content/mesh/about/mesh-tech-specs.md +++ b/content/mesh/about/mesh-tech-specs.md @@ -1,12 +1,14 @@ --- -title: "Technical Specifications" +title: Technical Specifications weight: 110 -description: "Cluster requirements and F5 NGINX Service Mesh footprint" -categories: ["reference"] +description: Cluster requirements and F5 NGINX Service Mesh footprint toc: true -docs: "DOCS-677" +docs: DOCS-677 +type: +- reference --- + The following document outlines the software versions and overhead F5 NGINX Service Mesh uses while running. ## Software Versions diff --git a/content/mesh/about/what-is-nsm.md b/content/mesh/about/what-is-nsm.md index 59ce33fb8..845459d5a 100644 --- a/content/mesh/about/what-is-nsm.md +++ b/content/mesh/about/what-is-nsm.md @@ -1,12 +1,14 @@ --- -title: "What is NGINX Service Mesh?" +title: What is NGINX Service Mesh? weight: 100 -description: "Learn about F5 NGINX Service Mesh fundamentals." -categories: ["concepts"] +description: Learn about F5 NGINX Service Mesh fundamentals. toc: true -docs: "DOCS-678" +docs: DOCS-678 +type: +- concept --- + ## What is a Service Mesh? A *service mesh* is an infrastructure layer that's designed to provide fast, reliable, and low-latency network connections for highly distributed applications requiring inter-process communications. A service mesh abstracts lower layer networking concerns away from application developers and business logic. Meshes are often optimized for container environments and seamlessly integrate into the orchestration system, providing consistent and reliable services for the ephemeral, scalable, and dynamic applications built honoring today's modern architectures. Common properties defined by service meshes include service discovery, identity, load balancing, encryption, traffic control, resiliency and availability, and observability. diff --git a/content/mesh/get-started/_index.md b/content/mesh/get-started/_index.md index 0d89ca5c1..20a1cf0b6 100644 --- a/content/mesh/get-started/_index.md +++ b/content/mesh/get-started/_index.md @@ -1,11 +1,10 @@ --- title: Getting Started -description: "Learn how to install NGINX Service Mesh." +description: Learn how to install NGINX Service Mesh. weight: 100 -categories: ["concepts"] -menu: - docs: - parent: NGINX Service Mesh url: /nginx-service-mesh/get-started/ +type: +- concept --- + diff --git a/content/mesh/get-started/install/configuration.md b/content/mesh/get-started/install/configuration.md index 97ddd2ba5..4d203b04c 100644 --- a/content/mesh/get-started/install/configuration.md +++ b/content/mesh/get-started/install/configuration.md @@ -1,12 +1,14 @@ --- -title: "Configuration Options" +title: Configuration Options weight: 100 -description: "Learn about F5 NGINX Service Mesh features and deployment options." -categories: ["concepts"] +description: Learn about F5 NGINX Service Mesh features and deployment options. toc: true -docs: "DOCS-679" +docs: DOCS-679 +type: +- concept --- + ## Overview This document provides an overview of the various options you can configure when deploying F5 NGINX Service Mesh. We strongly recommended that you review all of the available options discussed in this document *before* deploying NGINX Service Mesh. diff --git a/content/mesh/get-started/install/install-with-helm.md b/content/mesh/get-started/install/install-with-helm.md index 4126bf7a7..765ea7272 100644 --- a/content/mesh/get-started/install/install-with-helm.md +++ b/content/mesh/get-started/install/install-with-helm.md @@ -1,13 +1,15 @@ --- -title: "Install with Helm" +title: Install with Helm draft: false toc: true -description: "This guide explains how to install F5 NGINX Service Mesh using Helm." +description: This guide explains how to install F5 NGINX Service Mesh using Helm. weight: 300 -categories: ["tasks"] -docs: "DOCS-680" +docs: DOCS-680 +type: +- how-to --- + ## Prerequisites Before installing F5 NGINX Service Mesh, make sure you've completed the following steps. diff --git a/content/mesh/get-started/install/install.md b/content/mesh/get-started/install/install.md index c9e9fd729..6ed5ebf37 100644 --- a/content/mesh/get-started/install/install.md +++ b/content/mesh/get-started/install/install.md @@ -1,13 +1,14 @@ --- -title: "Install with nginx-meshctl" -date: 2020-02-20T19:43:59Z +title: Install with nginx-meshctl draft: false toc: true weight: 200 -categories: ["tasks"] -docs: "DOCS-681" +docs: DOCS-681 +type: +- how-to --- + ## Overview This guide contains instructions for downloading and installing F5 NGINX Service Mesh using the `nginx-meshctl` command line tool. diff --git a/content/mesh/get-started/platform-setup/_index.md b/content/mesh/get-started/platform-setup/_index.md index 7395a7937..b336fdeba 100644 --- a/content/mesh/get-started/platform-setup/_index.md +++ b/content/mesh/get-started/platform-setup/_index.md @@ -1,8 +1,9 @@ --- title: Prepare Your Cluster -description: Prepare your Kubernetes or OpenShift cluster for use with NGINX Service Mesh. -date: 2020-08-17 +description: Prepare your Kubernetes or OpenShift cluster for use with NGINX Service + Mesh. weight: 1 url: /nginx-service-mesh/get-started/platform-setup/ --- + diff --git a/content/mesh/get-started/platform-setup/gke.md b/content/mesh/get-started/platform-setup/gke.md index 1f5d04486..dbf436249 100644 --- a/content/mesh/get-started/platform-setup/gke.md +++ b/content/mesh/get-started/platform-setup/gke.md @@ -1,11 +1,14 @@ --- title: Google Kubernetes Engine -description: Learn how to set up Google Kubernetes Engine (GKE) for use with F5 NGINX Service Mesh. -categories: ["tasks"] +description: Learn how to set up Google Kubernetes Engine (GKE) for use with F5 NGINX + Service Mesh. toc: true -docs: "DOCS-683" +docs: DOCS-683 +type: +- how-to --- + Google Kubernetes Engine (GKE) is a hosted Kubernetes solution created by Google. To use GKE with F5 NGINX Service Mesh, your Kubernetes user account has to have the `ClusterAdmin` role. {{< warning >}} diff --git a/content/mesh/get-started/platform-setup/kubeadm.md b/content/mesh/get-started/platform-setup/kubeadm.md index 0221b6ba7..b7b2af4a5 100644 --- a/content/mesh/get-started/platform-setup/kubeadm.md +++ b/content/mesh/get-started/platform-setup/kubeadm.md @@ -1,11 +1,13 @@ --- title: Kubeadm description: Learn how to set up Kubeadm for use with F5 NGINX Service Mesh. -categories: ["tasks"] toc: true -docs: "DOCS-684" +docs: DOCS-684 +type: +- how-to --- + Kubeadm is a tool that creates Kubernetes clusters by following best practices. To use kubeadm with F5 NGINX Service Mesh, you need to enable some extra flags on the Kubernetes API Server to enable Service Account Token Volume Projection. See [Service Account Token Volume Projection](#service-account-token-volume-projection) section to learn why this is needed. ## New cluster diff --git a/content/mesh/get-started/platform-setup/kubespray.md b/content/mesh/get-started/platform-setup/kubespray.md index 5d7a01899..a382b36b8 100644 --- a/content/mesh/get-started/platform-setup/kubespray.md +++ b/content/mesh/get-started/platform-setup/kubespray.md @@ -1,11 +1,13 @@ --- title: Kubespray description: Learn how to set up Kubespray for use with F5 NGINX Service Mesh. -categories: ["tasks"] toc: true -docs: "DOCS-685" +docs: DOCS-685 +type: +- how-to --- + [Kubespray](https://github.com/kubernetes-sigs/kubespray) is where Kubernetes meets [Ansible](https://www.ansible.com/). It's a composition of Ansible playbooks, provisioning tools, and domain knowledge for creating production-ready Kubernetes clusters. Kubespray builds on top of kubeadm. If you are using Kubespray v2.16.0 or later no changes are needed to deploy F5 NGINX Service Mesh. For older versions you need to enable some extra flags on the Kubernetes API Server to enable Service Account Token Volume Projection. See [Service Account Token Volume Projection]( {{< ref "kubeadm.md#service-account-token-volume-projection" >}} ) section to learn why this is needed. ## Configuration changes diff --git a/content/mesh/get-started/platform-setup/openshift.md b/content/mesh/get-started/platform-setup/openshift.md index d941f7b44..520a87f10 100644 --- a/content/mesh/get-started/platform-setup/openshift.md +++ b/content/mesh/get-started/platform-setup/openshift.md @@ -1,11 +1,14 @@ --- title: OpenShift -description: Learn what is different in OpenShift, and the considerations a user must make. -categories: ["tasks"] +description: Learn what is different in OpenShift, and the considerations a user must + make. toc: true -docs: "DOCS-689" +docs: DOCS-689 +type: +- how-to --- + ## Introduction OpenShift is a security-first platform, locking down privileges and capabilities to ensure that workloads are running securely. OpenShift creates additional security mechanisms in the form of [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html). These constraints restrict the default permissions a workload is able to operate with. It also needs a user or workload management tool (such as a service mesh) to iteratively build out the specific permissions. diff --git a/content/mesh/get-started/platform-setup/persistent-storage.md b/content/mesh/get-started/platform-setup/persistent-storage.md index f19110cd0..86fbfecd4 100644 --- a/content/mesh/get-started/platform-setup/persistent-storage.md +++ b/content/mesh/get-started/platform-setup/persistent-storage.md @@ -1,12 +1,15 @@ --- title: Persistent Storage -description: Learn how to set up persistent storage for use with F5 NGINX Service Mesh. -categories: ["tasks"] +description: Learn how to set up persistent storage for use with F5 NGINX Service + Mesh. weight: 101 toc: true -docs: "DOCS-686" +docs: DOCS-686 +type: +- how-to --- + F5 NGINX Service Mesh generates data that needs to persist across restarts and failures to ensure uninterrupted operations. For example, if the SPIRE Server restarts, the new instance can pick up the the existing database of identities without having to rebuild everything. Depending on the environment, persistent storage may already be set up and ready for use by NGINX Service Mesh. The big three hosted Kubernetes environments (Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), and Google Kubernetes Engine (GKE)) all have built-in persistent storage that NGINX Service Mesh will automatically pick up and use. diff --git a/content/mesh/get-started/platform-setup/rke.md b/content/mesh/get-started/platform-setup/rke.md index 2404cef53..a1f24e0b0 100644 --- a/content/mesh/get-started/platform-setup/rke.md +++ b/content/mesh/get-started/platform-setup/rke.md @@ -1,11 +1,14 @@ --- title: Rancher Kubernetes Engine -description: Learn how to set up Rancher Kubernetes Engine (RKE) for use with F5 NGINX Service Mesh. -categories: ["tasks"] +description: Learn how to set up Rancher Kubernetes Engine (RKE) for use with F5 NGINX + Service Mesh. toc: true -docs: "DOCS-687" +docs: DOCS-687 +type: +- how-to --- + Rancher Kubernetes Engine (RKE) is a CNCF-certified Kubernetes distribution that runs entirely within Docker containers. It works on bare-metal and virtualized servers. {{< important >}} diff --git a/content/mesh/get-started/platform-setup/supported-platforms.md b/content/mesh/get-started/platform-setup/supported-platforms.md index 16a756eeb..334dba001 100644 --- a/content/mesh/get-started/platform-setup/supported-platforms.md +++ b/content/mesh/get-started/platform-setup/supported-platforms.md @@ -1,12 +1,13 @@ --- title: Supported Platforms -description: Find out which platforms are supported for use with F5 NGINX Service Mesh. -date: 2020-08-17 +description: Find out which platforms are supported for use with F5 NGINX Service + Mesh. weight: 100 toc: true -docs: "DOCS-688" +docs: DOCS-688 --- + ## Kubernetes The Kubernetes platforms listed below will work with F5 NGINX Service Mesh using the Kubernetes versions listed in the [Technical Specifications]({{< ref "/mesh/about/mesh-tech-specs.md#supported-versions" >}}). Additional Kubernetes platforms may work, although they have not been validated. diff --git a/content/mesh/get-started/uninstall/uninstall-with-helm.md b/content/mesh/get-started/uninstall/uninstall-with-helm.md index 0e7b55c29..ea063a882 100644 --- a/content/mesh/get-started/uninstall/uninstall-with-helm.md +++ b/content/mesh/get-started/uninstall/uninstall-with-helm.md @@ -1,13 +1,15 @@ --- -title: "Uninstall with Helm" +title: Uninstall with Helm draft: false toc: true -description: "This topic explains how to uninstall F5 NGINX Service Mesh using Helm." +description: This topic explains how to uninstall F5 NGINX Service Mesh using Helm. weight: 300 -categories: ["tasks"] -docs: "DOCS-699" +docs: DOCS-699 +type: +- how-to --- + ## Uninstalling the Chart {{< important >}} diff --git a/content/mesh/get-started/uninstall/uninstall.md b/content/mesh/get-started/uninstall/uninstall.md index 50e7970f3..ebddbd1ba 100644 --- a/content/mesh/get-started/uninstall/uninstall.md +++ b/content/mesh/get-started/uninstall/uninstall.md @@ -1,12 +1,14 @@ --- -title: "Uninstall with nginx-meshctl" +title: Uninstall with nginx-meshctl draft: false toc: true weight: 200 -categories: ["tasks"] -docs: "DOCS-1481" +docs: DOCS-1481 +type: +- how-to --- + ## Overview This topic explains how to uninstall F5 NGINX Service Mesh using nginx-meshctl. diff --git a/content/mesh/get-started/upgrade/upgrade-with-helm.md b/content/mesh/get-started/upgrade/upgrade-with-helm.md index f97984585..eadaec054 100644 --- a/content/mesh/get-started/upgrade/upgrade-with-helm.md +++ b/content/mesh/get-started/upgrade/upgrade-with-helm.md @@ -1,13 +1,15 @@ --- -title: "Upgrade with Helm" +title: Upgrade with Helm draft: false toc: true -description: "This guide explains how to upgrade F5 NGINX Service Mesh using Helm." +description: This guide explains how to upgrade F5 NGINX Service Mesh using Helm. weight: 300 -categories: ["tasks"] -docs: "DOCS-700" +docs: DOCS-700 +type: +- how-to --- + You can upgrade to the latest mesh version from the version immediately before it (for example, from v1.6.0 to v1.7.0). F5 NGINX Service Mesh doesn't support skipping versions. {{< important >}} diff --git a/content/mesh/get-started/upgrade/upgrade.md b/content/mesh/get-started/upgrade/upgrade.md index db1058cb5..7735ae48d 100644 --- a/content/mesh/get-started/upgrade/upgrade.md +++ b/content/mesh/get-started/upgrade/upgrade.md @@ -1,13 +1,15 @@ --- -title: "Upgrade with nginx-meshctl" +title: Upgrade with nginx-meshctl draft: false toc: true -description: "This guide explains how to upgrade F5 NGINX Service Mesh using nginx-meshctl." +description: This guide explains how to upgrade F5 NGINX Service Mesh using nginx-meshctl. weight: 200 -categories: ["tasks"] -docs: "DOCS-1482" +docs: DOCS-1482 +type: +- how-to --- + You can upgrade to the latest mesh version from the version immediately before it (for example, from v1.6.0 to v1.7.0). F5 NGINX Service Mesh doesn't support skipping versions. {{< important >}} diff --git a/content/mesh/guides/_index.md b/content/mesh/guides/_index.md index c506c1ce4..833f0462f 100644 --- a/content/mesh/guides/_index.md +++ b/content/mesh/guides/_index.md @@ -1,10 +1,8 @@ --- title: Guides weight: 150 -description: "Learn how to use NGINX Service Mesh." +description: Learn how to use NGINX Service Mesh. draft: false -menu: - docs: - parent: NGINX Service Mesh url: /nginx-service-mesh/guides/ --- + diff --git a/content/mesh/guides/inject-sidecar-proxy.md b/content/mesh/guides/inject-sidecar-proxy.md index bad63b070..02d865544 100644 --- a/content/mesh/guides/inject-sidecar-proxy.md +++ b/content/mesh/guides/inject-sidecar-proxy.md @@ -1,13 +1,15 @@ --- -title: "Sidecar Proxy Injection" -date: 2020-08-24T11:46:19-06:00 +title: Sidecar Proxy Injection toc: true -description: "Learn about the configuration options for F5 NGINX Service Mesh sidecar proxy injection." +description: Learn about the configuration options for F5 NGINX Service Mesh sidecar + proxy injection. weight: 10 -categories: ["tasks"] -docs: "DOCS-692" +docs: DOCS-692 +type: +- how-to --- + ## Overview F5 NGINX Service Mesh works by injecting a sidecar proxy into Kubernetes resources. diff --git a/content/mesh/guides/monitoring-and-tracing.md b/content/mesh/guides/monitoring-and-tracing.md index 0093979ad..cd8a976f5 100644 --- a/content/mesh/guides/monitoring-and-tracing.md +++ b/content/mesh/guides/monitoring-and-tracing.md @@ -1,13 +1,15 @@ --- -title: "Monitoring and Tracing" -date: 2020-08-24T10:00:30-06:00 +title: Monitoring and Tracing toc: true -description: "Learn about the monitoring and tracing features available in F5 NGINX Service Mesh." +description: Learn about the monitoring and tracing features available in F5 NGINX + Service Mesh. weight: 20 -categories: ["tasks"] -docs: "DOCS-693" +docs: DOCS-693 +type: +- how-to --- + ## Overview F5 NGINX Service Mesh can integrate with your Prometheus, Grafana, and tracing backends for exporting metrics and tracing data. diff --git a/content/mesh/guides/private-registry.md b/content/mesh/guides/private-registry.md index 86c246095..5700554ef 100644 --- a/content/mesh/guides/private-registry.md +++ b/content/mesh/guides/private-registry.md @@ -1,12 +1,14 @@ --- -title: "Private Registry" -description: "How to set up access to a private registry" -categories: ["tasks"] +title: Private Registry +description: How to set up access to a private registry weight: 70 toc: true -docs: "DOCS-694" +docs: DOCS-694 +type: +- how-to --- + ## Overview F5 NGINX Service Mesh supports using a private registry to store its components. In order to deploy NGINX Service Mesh from a private registry, you need to configure the NGINX Service Mesh CLI with credentials that can access the registry. diff --git a/content/mesh/guides/production-tuning.md b/content/mesh/guides/production-tuning.md index ddd04561a..b9a89ce75 100644 --- a/content/mesh/guides/production-tuning.md +++ b/content/mesh/guides/production-tuning.md @@ -1,11 +1,13 @@ --- -title: "Production Tuning" -categories: ["tasks"] +title: Production Tuning weight: 80 toc: true -docs: "DOCS-695" +docs: DOCS-695 +type: +- how-to --- + #### Overview While F5 NGINX Service Mesh provides a number of capabilities for finely controlling and authorizing traffic, it is up to the user to configure these options to best suit the needs of their application. This document will go over the various deployment options and tools compatible with NGINX Service Mesh that you can use to secure and orchestrate traffic throughout your application. For the best production experience possible, consider the options below. diff --git a/content/mesh/guides/prometheus-metrics.md b/content/mesh/guides/prometheus-metrics.md index 2e7b9b769..c0430349e 100644 --- a/content/mesh/guides/prometheus-metrics.md +++ b/content/mesh/guides/prometheus-metrics.md @@ -1,13 +1,14 @@ --- -title: "Prometheus Metrics" -date: 2020-08-24T11:18:39-06:00 -description: "How to set up and view prometheus metrics for valuable workload insights" -categories: ["tasks"] +title: Prometheus Metrics +description: How to set up and view prometheus metrics for valuable workload insights weight: 40 toc: true -docs: "DOCS-840" +docs: DOCS-840 +type: +- how-to --- + ## Overview F5 NGINX Service Mesh integrates with Prometheus for metrics and Grafana for visualizations. diff --git a/content/mesh/guides/secure-traffic-mtls.md b/content/mesh/guides/secure-traffic-mtls.md index 6512428b1..add275f7e 100644 --- a/content/mesh/guides/secure-traffic-mtls.md +++ b/content/mesh/guides/secure-traffic-mtls.md @@ -1,13 +1,14 @@ --- -title: "Secure Mesh Traffic using mTLS" -date: 2020-08-24T10:48:05-06:00 +title: Secure Mesh Traffic using mTLS toc: true -description: "Learn about the mTLS options available in F5 NGINX Service Mesh." +description: Learn about the mTLS options available in F5 NGINX Service Mesh. weight: 30 -categories: ["tasks"] -docs: "DOCS-696" +docs: DOCS-696 +type: +- how-to --- + ## Overview TLS authentication is ubiquitous. Because of the baseline level of security TLS provides the client when connecting to an unknown host, and the low barrier to entry created by the advent of services like Let's Encrypt, TLS has become table stakes for any moderately reputable website. In a microservices, multi-tenant Kubernetes environment, it is no longer sufficient for a client to authenticate a server's signature. Clients may be compromised, and in a tightly controlled environment such as a service mesh, it is paramount that clients get vetted to ensure they should be making requests to any particular server. F5 NGINX Service Mesh does this authentication through mTLS, and provides the ability to define [Access Control policies]( {{< ref "/mesh/guides/smi-traffic-policies.md#access-control" >}}) for the additional authorization piece needed to properly grant access to an incoming request from a given client. This document details the steps required to enable mTLS in your cluster using NGINX Service Mesh. diff --git a/content/mesh/guides/smi-traffic-metrics.md b/content/mesh/guides/smi-traffic-metrics.md index 69a2ca33c..f65d07d60 100644 --- a/content/mesh/guides/smi-traffic-metrics.md +++ b/content/mesh/guides/smi-traffic-metrics.md @@ -1,13 +1,14 @@ --- -title: "SMI Traffic Metrics" -date: 2020-08-24T11:18:39-06:00 -description: "How to set up and view SMI traffic metrics" -categories: ["tasks"] +title: SMI Traffic Metrics +description: How to set up and view SMI traffic metrics weight: 50 toc: true -docs: "DOCS-697" +docs: DOCS-697 +type: +- how-to --- + ## Overview Traffic Metrics are a mechanism through which you can view important information about your running workloads. Exposed by the [SMI spec](https://github.com/servicemeshinterface/smi-spec), this allows you to migrate functionality from your existing service mesh. The F5 NGINX Service Mesh creates an extension API Server and shim that queries Prometheus and returns the results in a traffic metrics format. You can access these metrics through a variety of methods ranging from the `nginx-meshctl` tool to querying the Kubernetes API manually. diff --git a/content/mesh/guides/smi-traffic-policies.md b/content/mesh/guides/smi-traffic-policies.md index b13fc2fb0..519edddfd 100644 --- a/content/mesh/guides/smi-traffic-policies.md +++ b/content/mesh/guides/smi-traffic-policies.md @@ -1,13 +1,15 @@ --- -title: "SMI Traffic Policies" +title: SMI Traffic Policies toc: true -description: "Learn about the traffic policies supported by F5 NGINX Service Mesh and how to configure them." +description: Learn about the traffic policies supported by F5 NGINX Service Mesh and + how to configure them. weight: 60 -categories: ["tasks"] -toc: true -docs: "DOCS-698" +docs: DOCS-698 +type: +- how-to --- + ## Overview This topic discusses the various traffic policies that are supported by F5 NGINX Service Mesh. We support the SMI spec to allow for a variety of functionality within our mesh, from traffic shaping to access control. NGINX Service Mesh provides additional traffic policies to extend on the SMI spec. This topic provides examples of how you can use the SMI spec and NGINX custom resources with NGINX Service Mesh to apply policies and control your traffic. diff --git a/content/mesh/guides/v1alpha1-ratelimit.md b/content/mesh/guides/v1alpha1-ratelimit.md index e73a7b58c..4fe696a12 100644 --- a/content/mesh/guides/v1alpha1-ratelimit.md +++ b/content/mesh/guides/v1alpha1-ratelimit.md @@ -1,11 +1,10 @@ --- -title: "v1alpha1 RateLimit Documentation" -docs: "DOCS-701" -description: "v1alpha1 RateLimit documentation." -_build: - list: never +title: v1alpha1 RateLimit Documentation +docs: DOCS-701 +description: v1alpha1 RateLimit documentation. --- + ## RateLimit API Version: v1alpha1 diff --git a/content/mesh/reference/_index.md b/content/mesh/reference/_index.md index ae7441a15..36875c884 100644 --- a/content/mesh/reference/_index.md +++ b/content/mesh/reference/_index.md @@ -1,8 +1,6 @@ --- title: Reference weight: 500 -menu: - docs: - parent: NGINX Service Mesh url: /nginx-service-mesh/reference/ --- + diff --git a/content/mesh/reference/api-usage.md b/content/mesh/reference/api-usage.md index d58873154..1721032d3 100644 --- a/content/mesh/reference/api-usage.md +++ b/content/mesh/reference/api-usage.md @@ -1,13 +1,14 @@ --- title: NGINX Service Mesh API -description: "Instructions for interacting with the F5 NGINX Service Mesh API." +description: Instructions for interacting with the F5 NGINX Service Mesh API. toc: true -tags: ["api"] weight: 200 -categories: ["reference"] -docs: "DOCS-702" +docs: DOCS-702 +type: +- reference --- + ## Overview The F5 NGINX Service Mesh API exists within a Kubernetes Custom Resource, and can be used to manage the global mesh configuration. This resource is created when the mesh is deployed, and can be updated at runtime using the Kubernetes API. diff --git a/content/mesh/reference/nginx-meshctl.md b/content/mesh/reference/nginx-meshctl.md index b81257c3b..0c7482ad8 100644 --- a/content/mesh/reference/nginx-meshctl.md +++ b/content/mesh/reference/nginx-meshctl.md @@ -1,13 +1,15 @@ --- title: CLI Reference -description: "Man page and instructions for using the F5 NGINX Service Mesh CLI" +description: Man page and instructions for using the F5 NGINX Service Mesh CLI draft: false weight: 300 toc: true -categories: ["reference"] -docs: "DOCS-704" +docs: DOCS-704 +type: +- reference --- + ## Usage `nginx-meshctl` is the CLI utility for the F5 NGINX Service Mesh control plane. diff --git a/content/mesh/reference/permissions.md b/content/mesh/reference/permissions.md index 9521d78e6..96f49d74b 100644 --- a/content/mesh/reference/permissions.md +++ b/content/mesh/reference/permissions.md @@ -1,15 +1,14 @@ --- -title: "NGINX Service Mesh Permissions" -date: 2022-05-09T09:37:44-07:00 +title: NGINX Service Mesh Permissions weight: 100 draft: false toc: true -tags: [ "docs" ] -docs: "DOCS-883" -categories: ["reference"] -doctypes: ["beta"] +docs: DOCS-883 +type: +- reference --- + ## Init Container The init container is a privileged container that runs as root. In addition to the container running with root privileges on the host system, it also has weaker sandboxing. The init container needs this level of access in order to manipulate `iptables` and `eBPF` on the host. diff --git a/content/mesh/releases/_index.md b/content/mesh/releases/_index.md index a2a2e16f8..e92cc3699 100644 --- a/content/mesh/releases/_index.md +++ b/content/mesh/releases/_index.md @@ -1,8 +1,5 @@ --- title: Releases -description: "Stay up-to-date with the latest F5 NGINX Service Mesh release" -menu: - docs: - parent: NGINX Service Mesh +description: Stay up-to-date with the latest F5 NGINX Service Mesh release url: /nginx-service-mesh/releases/ ---- \ No newline at end of file +--- diff --git a/content/mesh/releases/oss-dependencies/index.md b/content/mesh/releases/oss-dependencies/index.md index 7ac379c77..6c99895d3 100644 --- a/content/mesh/releases/oss-dependencies/index.md +++ b/content/mesh/releases/oss-dependencies/index.md @@ -1,10 +1,9 @@ --- title: Open Source Licenses Addendum -_build: - list: never url: /nginx-service-mesh/releases/oss-dependencies/ --- + {{% table %}} | Package | License(s) | Added In | |---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|----------| diff --git a/content/mesh/releases/release-notes-0.5.0.md b/content/mesh/releases/release-notes-0.5.0.md index d7a64d951..22eafb2e5 100644 --- a/content/mesh/releases/release-notes-0.5.0.md +++ b/content/mesh/releases/release-notes-0.5.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 0.5.0" +title: Release Notes 0.5.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -500 -categories: ["reference"] -docs: "DOCS-705" +docs: DOCS-705 +type: +- reference --- + ## NGINX Service Mesh Version 0.5.0 diff --git a/content/mesh/releases/release-notes-0.6.0.md b/content/mesh/releases/release-notes-0.6.0.md index 278cd9106..102f4c558 100644 --- a/content/mesh/releases/release-notes-0.6.0.md +++ b/content/mesh/releases/release-notes-0.6.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 0.6.0" +title: Release Notes 0.6.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -600 -categories: ["reference"] -docs: "DOCS-706" +docs: DOCS-706 +type: +- reference --- + ## NGINX Service Mesh Version 0.6.0 diff --git a/content/mesh/releases/release-notes-0.7.0.md b/content/mesh/releases/release-notes-0.7.0.md index ee8a8ea0e..3d99a94d4 100644 --- a/content/mesh/releases/release-notes-0.7.0.md +++ b/content/mesh/releases/release-notes-0.7.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 0.7.0" +title: Release Notes 0.7.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -700 -categories: ["reference"] -docs: "DOCS-707" +docs: DOCS-707 +type: +- reference --- + ## NGINX Service Mesh Version 0.7.0 diff --git a/content/mesh/releases/release-notes-0.8.0.md b/content/mesh/releases/release-notes-0.8.0.md index 27b3f2f09..4c890cb3a 100644 --- a/content/mesh/releases/release-notes-0.8.0.md +++ b/content/mesh/releases/release-notes-0.8.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 0.8.0" +title: Release Notes 0.8.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -800 -categories: ["reference"] -docs: "DOCS-708" +docs: DOCS-708 +type: +- reference --- + ## NGINX Service Mesh Version 0.8.0 diff --git a/content/mesh/releases/release-notes-0.9.0.md b/content/mesh/releases/release-notes-0.9.0.md index 460a6226e..8bdab3afc 100644 --- a/content/mesh/releases/release-notes-0.9.0.md +++ b/content/mesh/releases/release-notes-0.9.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 0.9.0" +title: Release Notes 0.9.0 draft: false toc: true -description: Release information for F5 GINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 GINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -900 -categories: ["reference"] -docs: "DOCS-709" +docs: DOCS-709 +type: +- reference --- + ## NGINX Service Mesh Version 0.9.0 diff --git a/content/mesh/releases/release-notes-0.9.1.md b/content/mesh/releases/release-notes-0.9.1.md index f8a68a6d4..788422c64 100644 --- a/content/mesh/releases/release-notes-0.9.1.md +++ b/content/mesh/releases/release-notes-0.9.1.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 0.9.1" +title: Release Notes 0.9.1 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -901 -categories: ["reference"] -docs: "DOCS-710" +docs: DOCS-710 +type: +- reference --- + ## NGINX Service Mesh Version 0.9.1 diff --git a/content/mesh/releases/release-notes-1.0.0.md b/content/mesh/releases/release-notes-1.0.0.md index 373197706..7f69e3dc5 100644 --- a/content/mesh/releases/release-notes-1.0.0.md +++ b/content/mesh/releases/release-notes-1.0.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.0.0" +title: Release Notes 1.0.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1000 -categories: ["reference"] -docs: "DOCS-711" +docs: DOCS-711 +type: +- reference --- + ## NGINX Service Mesh Version 1.0.0 04 May 2021 diff --git a/content/mesh/releases/release-notes-1.0.1.md b/content/mesh/releases/release-notes-1.0.1.md index a09cdbf45..0a29b26e3 100644 --- a/content/mesh/releases/release-notes-1.0.1.md +++ b/content/mesh/releases/release-notes-1.0.1.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.0.1" +title: Release Notes 1.0.1 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1001 -categories: ["reference"] -docs: "DOCS-712" +docs: DOCS-712 +type: +- reference --- + ## NGINX Service Mesh Version 1.0.1 diff --git a/content/mesh/releases/release-notes-1.1.0.md b/content/mesh/releases/release-notes-1.1.0.md index 17993b1d0..633702145 100644 --- a/content/mesh/releases/release-notes-1.1.0.md +++ b/content/mesh/releases/release-notes-1.1.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.1.0" +title: Release Notes 1.1.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1100 -categories: ["reference"] -docs: "DOCS-713" +docs: DOCS-713 +type: +- reference --- + ## NGINX Service Mesh Version 1.1.0 29 June 2021 diff --git a/content/mesh/releases/release-notes-1.2.0.md b/content/mesh/releases/release-notes-1.2.0.md index d5377900b..0056e9369 100644 --- a/content/mesh/releases/release-notes-1.2.0.md +++ b/content/mesh/releases/release-notes-1.2.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.2.0" +title: Release Notes 1.2.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1200 -categories: ["reference"] -docs: "DOCS-714" +docs: DOCS-714 +type: +- reference --- + ## NGINX Service Mesh Version 1.2.0 14 September 2021 diff --git a/content/mesh/releases/release-notes-1.2.1.md b/content/mesh/releases/release-notes-1.2.1.md index cda42b971..040c3ad77 100644 --- a/content/mesh/releases/release-notes-1.2.1.md +++ b/content/mesh/releases/release-notes-1.2.1.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.2.1" +title: Release Notes 1.2.1 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1201 -categories: ["reference"] -docs: "DOCS-715" +docs: DOCS-715 +type: +- reference --- + ## NGINX Service Mesh Version 1.2.1 11 October 2021 diff --git a/content/mesh/releases/release-notes-1.3.0.md b/content/mesh/releases/release-notes-1.3.0.md index baddb8a58..74e0fd3d1 100644 --- a/content/mesh/releases/release-notes-1.3.0.md +++ b/content/mesh/releases/release-notes-1.3.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.3.0" +title: Release Notes 1.3.0 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1300 -categories: ["reference"] -docs: "DOCS-716" +docs: DOCS-716 +type: +- reference --- + ## NGINX Service Mesh Version 1.3.0 16 November 2021 diff --git a/content/mesh/releases/release-notes-1.3.1.md b/content/mesh/releases/release-notes-1.3.1.md index ecc1e9ddb..458f05074 100644 --- a/content/mesh/releases/release-notes-1.3.1.md +++ b/content/mesh/releases/release-notes-1.3.1.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.3.1" +title: Release Notes 1.3.1 draft: false toc: true -description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided. +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1301 -categories: ["reference"] -docs: "DOCS-717" +docs: DOCS-717 +type: +- reference --- + ## NGINX Service Mesh Version 1.3.1 22 November 2021 diff --git a/content/mesh/releases/release-notes-1.4.0.md b/content/mesh/releases/release-notes-1.4.0.md index 528eea655..c5b8f40a4 100644 --- a/content/mesh/releases/release-notes-1.4.0.md +++ b/content/mesh/releases/release-notes-1.4.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.4.0" +title: Release Notes 1.4.0 draft: false toc: true -description: "Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided." +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1400 -categories: ["reference"] -docs: "DOCS-1488" +docs: DOCS-1488 +type: +- reference --- + ## NGINX Service Mesh Version 1.4.0 23 February 2022 diff --git a/content/mesh/releases/release-notes-1.4.1.md b/content/mesh/releases/release-notes-1.4.1.md index c357bdb6c..3d0a43589 100644 --- a/content/mesh/releases/release-notes-1.4.1.md +++ b/content/mesh/releases/release-notes-1.4.1.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.4.1" +title: Release Notes 1.4.1 draft: false toc: true -description: "Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided." +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1401 -categories: ["reference"] -docs: "DOCS-1484" +docs: DOCS-1484 +type: +- reference --- + ## NGINX Service Mesh Version 1.4.1 26 May 2022 diff --git a/content/mesh/releases/release-notes-1.5.0.md b/content/mesh/releases/release-notes-1.5.0.md index 6fb531e10..ccaf01080 100644 --- a/content/mesh/releases/release-notes-1.5.0.md +++ b/content/mesh/releases/release-notes-1.5.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.5.0" +title: Release Notes 1.5.0 draft: false toc: true -description: "Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided." +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1500 -categories: ["reference"] -docs: "DOCS-1487" +docs: DOCS-1487 +type: +- reference --- + ## NGINX Service Mesh Version 1.5.0 26 July 2022 diff --git a/content/mesh/releases/release-notes-1.6.0.md b/content/mesh/releases/release-notes-1.6.0.md index fa61f60d2..88dda8b0a 100644 --- a/content/mesh/releases/release-notes-1.6.0.md +++ b/content/mesh/releases/release-notes-1.6.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.6.0" +title: Release Notes 1.6.0 draft: false toc: true -description: "Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided." +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1600 -categories: ["reference"] -docs: "DOCS-1486" +docs: DOCS-1486 +type: +- reference --- + ## NGINX Service Mesh Version 1.6.0 01 November 2022 diff --git a/content/mesh/releases/release-notes-1.7.0.md b/content/mesh/releases/release-notes-1.7.0.md index 78f47e84e..b1b9e9e47 100644 --- a/content/mesh/releases/release-notes-1.7.0.md +++ b/content/mesh/releases/release-notes-1.7.0.md @@ -1,13 +1,18 @@ --- -title: "Release Notes 1.7.0" +title: Release Notes 1.7.0 draft: false toc: true -description: "Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided." +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1700 -categories: ["reference"] -docs: "DOCS-1483" +docs: DOCS-1483 +type: +- reference --- + ## NGINX Service Mesh Version 1.7.0 14 February 2023 diff --git a/content/mesh/releases/release-notes-2.0.0.md b/content/mesh/releases/release-notes-2.0.0.md index c553cb625..91f47385f 100644 --- a/content/mesh/releases/release-notes-2.0.0.md +++ b/content/mesh/releases/release-notes-2.0.0.md @@ -1,14 +1,18 @@ --- -title: "Release Notes 2.0.0" -date: 2023-04-25 +title: Release Notes 2.0.0 draft: false toc: true -description: "Release information for F5 NGINX Service Mesh, a configurable, low‑latency infrastructure layer designed to handle a high volume of network‑based interprocess communication among application infrastructure services using application programming interfaces (APIs). Lists of new features and known issues are provided." +description: Release information for F5 NGINX Service Mesh, a configurable, low‑latency + infrastructure layer designed to handle a high volume of network‑based interprocess + communication among application infrastructure services using application programming + interfaces (APIs). Lists of new features and known issues are provided. weight: -1800 -categories: ["reference"] -docs: "DOCS-1485" +docs: DOCS-1485 +type: +- reference --- + ## NGINX Service Mesh Version 2.0.0 25 April 2023 diff --git a/content/mesh/support/_index.md b/content/mesh/support/_index.md index 68da3ce0c..8f0922116 100644 --- a/content/mesh/support/_index.md +++ b/content/mesh/support/_index.md @@ -1,10 +1,8 @@ --- title: Support weight: 600 -description: "Contact Support and troubleshoot F5 NGINX Service Mesh." +description: Contact Support and troubleshoot F5 NGINX Service Mesh. draft: false -menu: - docs: - parent: NGINX Service Mesh url: /nginx-service-mesh/support/ --- + diff --git a/content/mesh/support/contact-support.md b/content/mesh/support/contact-support.md index 9c7f97524..735344235 100644 --- a/content/mesh/support/contact-support.md +++ b/content/mesh/support/contact-support.md @@ -1,13 +1,14 @@ --- -title: "Where to Go for Support" +title: Where to Go for Support weight: 100 -description: "Learn where to go for F5 NGINX Service Mesh support." -categories: ["support"] +description: Learn where to go for F5 NGINX Service Mesh support. toc: true draft: false -docs: "DOCS-718" +docs: DOCS-718 +type: [] --- + Thank you for your interest in F5 NGINX Service Mesh. NGINX Service Mesh can be installed via helm charts, or by [downloading nginx-meshctl](https://github.com/nginxinc/nginx-service-mesh/releases/latest). diff --git a/content/mesh/tutorials/_index.md b/content/mesh/tutorials/_index.md index 010b67119..641c2bb9d 100644 --- a/content/mesh/tutorials/_index.md +++ b/content/mesh/tutorials/_index.md @@ -1,9 +1,7 @@ --- title: Tutorials weight: 200 -description: "Walkthrough docs for using F5 NGINX Service Mesh." -menu: - docs: - parent: NGINX Service Mesh +description: Walkthrough docs for using F5 NGINX Service Mesh. url: /nginx-service-mesh/tutorials/ --- + diff --git a/content/mesh/tutorials/deploy-example-app.md b/content/mesh/tutorials/deploy-example-app.md index a660c163d..4aa2e0aee 100644 --- a/content/mesh/tutorials/deploy-example-app.md +++ b/content/mesh/tutorials/deploy-example-app.md @@ -1,14 +1,15 @@ --- -title: "Deploy an Example App with NGINX Service Mesh" -date: 2020-02-20T19:43:59Z +title: Deploy an Example App with NGINX Service Mesh draft: false toc: true -description: "This topic provides a walkthrough of deploying an App with F5 NGINX Service Mesh." +description: This topic provides a walkthrough of deploying an App with F5 NGINX Service + Mesh. weight: 100 -categories: ["tutorials"] -docs: "DOCS-720" +docs: DOCS-720 +type: [] --- + ## Overview In this tutorial, we will use the `bookinfo` example app Deployment. diff --git a/content/mesh/tutorials/kic/deploy-with-kic.md b/content/mesh/tutorials/kic/deploy-with-kic.md index f15019680..22920b47e 100644 --- a/content/mesh/tutorials/kic/deploy-with-kic.md +++ b/content/mesh/tutorials/kic/deploy-with-kic.md @@ -1,13 +1,15 @@ --- -title: "Deploy with NGINX Ingress Controller" -description: "This topic describes how to install and use F5 NGINX Ingress Controller with NGINX Service Mesh" +title: Deploy with NGINX Ingress Controller +description: This topic describes how to install and use F5 NGINX Ingress Controller + with NGINX Service Mesh weight: 200 draft: false toc: true -categories: ["tutorials"] -docs: "DOCS-721" +docs: DOCS-721 +type: [] --- + ## Overview You can deploy NGINX Ingress Controller for Kubernetes with NGINX Service Mesh to control both ingress and [egress](#enable-egress) traffic. diff --git a/content/mesh/tutorials/kic/egress-walkthrough.md b/content/mesh/tutorials/kic/egress-walkthrough.md index b5c829d35..401a969ac 100644 --- a/content/mesh/tutorials/kic/egress-walkthrough.md +++ b/content/mesh/tutorials/kic/egress-walkthrough.md @@ -1,12 +1,14 @@ --- -title: "Configure a Secure Egress Route with NGINX Ingress Controller" -description: "This topic provides a walkthrough of how to securely route egress traffic through F5 NGINX Ingress Controller for Kubernetes with NGINX Service Mesh." +title: Configure a Secure Egress Route with NGINX Ingress Controller +description: This topic provides a walkthrough of how to securely route egress traffic + through F5 NGINX Ingress Controller for Kubernetes with NGINX Service Mesh. weight: 210 -categories: ["tutorials"] toc: true -docs: "DOCS-722" +docs: DOCS-722 +type: [] --- + ## Overview Learn how to create internal routes in F5 NGINX Ingress Controller to securely route egress traffic to non-meshed services. diff --git a/content/mesh/tutorials/kic/ingress-udp-walkthrough.md b/content/mesh/tutorials/kic/ingress-udp-walkthrough.md index 4854da3ea..73744cb8a 100644 --- a/content/mesh/tutorials/kic/ingress-udp-walkthrough.md +++ b/content/mesh/tutorials/kic/ingress-udp-walkthrough.md @@ -1,12 +1,14 @@ --- -title: "Expose a UDP Application with NGINX Ingress Controller" -description: "This topic describes the steps to deploy F5 NGINX Ingress Controller for Kubernetes, to expose a UDP application within NGINX Service Mesh." +title: Expose a UDP Application with NGINX Ingress Controller +description: This topic describes the steps to deploy F5 NGINX Ingress Controller + for Kubernetes, to expose a UDP application within NGINX Service Mesh. weight: 230 -categories: ["tutorials"] toc: true -docs: "DOCS-841" +docs: DOCS-841 +type: [] --- + ## Overview Follow this tutorial to deploy the NGINX Ingress Controller with NGINX Service Mesh and an example UDP application. diff --git a/content/mesh/tutorials/kic/ingress-walkthrough.md b/content/mesh/tutorials/kic/ingress-walkthrough.md index c4705c112..a16ccd2da 100644 --- a/content/mesh/tutorials/kic/ingress-walkthrough.md +++ b/content/mesh/tutorials/kic/ingress-walkthrough.md @@ -1,12 +1,14 @@ --- -title: "Expose an Application with NGINX Ingress Controller" -description: "This topic provides a walkthrough of deploying F5 NGINX Ingress Controller for Kubernetes to expose an application within NGINX Service Mesh." +title: Expose an Application with NGINX Ingress Controller +description: This topic provides a walkthrough of deploying F5 NGINX Ingress Controller + for Kubernetes to expose an application within NGINX Service Mesh. weight: 220 -categories: ["tutorials"] toc: true -docs: "DOCS-723" +docs: DOCS-723 +type: [] --- + ## Overview Follow this tutorial to deploy the F5 NGINX Ingress Controller with NGINX Service Mesh and an example application. diff --git a/content/mesh/tutorials/observability.md b/content/mesh/tutorials/observability.md index 93c7e3a9c..42b8bd340 100644 --- a/content/mesh/tutorials/observability.md +++ b/content/mesh/tutorials/observability.md @@ -1,13 +1,15 @@ --- -title: "Install NGINX Service Mesh with Basic Observability" +title: Install NGINX Service Mesh with Basic Observability draft: false toc: true -description: "This topic provides a walkthrough of deploying F5 NGINX Service Mesh with basic observability components." +description: This topic provides a walkthrough of deploying F5 NGINX Service Mesh + with basic observability components. weight: 90 -categories: ["tutorials"] -docs: "DOCS-886" +docs: DOCS-886 +type: [] --- + ## Overview In this tutorial, we will install F5 NGINX Service Mesh with some basic observability components. These components include Prometheus for collecting metrics, Grafana for visualizing metrics, and the OpenTelemetry Collector and Jaeger for collecting traces. These deployments are meant for demo purposes only, and are not recommended for production environments. diff --git a/content/mesh/tutorials/ratelimit-walkthrough.md b/content/mesh/tutorials/ratelimit-walkthrough.md index 01ed4279a..4b76a18e4 100644 --- a/content/mesh/tutorials/ratelimit-walkthrough.md +++ b/content/mesh/tutorials/ratelimit-walkthrough.md @@ -1,13 +1,14 @@ --- -title: "Configure Rate Limiting" -description: "Learn how to configure rate limiting between workloads." +title: Configure Rate Limiting +description: Learn how to configure rate limiting between workloads. draft: false toc: true weight: 140 -categories: ["tutorials"] -docs: "DOCS-724" +docs: DOCS-724 +type: [] --- + ## Overview Rate limiting allows you to limit the number of HTTP requests a user can make in a given period to protect your application from being overwhelmed with traffic. diff --git a/content/mesh/tutorials/trafficsplit-deployments.md b/content/mesh/tutorials/trafficsplit-deployments.md index cfbedbd6e..4ee0b3c79 100644 --- a/content/mesh/tutorials/trafficsplit-deployments.md +++ b/content/mesh/tutorials/trafficsplit-deployments.md @@ -1,12 +1,14 @@ --- -title: "Deployments using Traffic Splitting" -description: "This topic provides a guide for using traffic splits with different deployment strategies." +title: Deployments using Traffic Splitting +description: This topic provides a guide for using traffic splits with different deployment + strategies. weight: 110 -categories: ["tutorials"] toc: true -docs: "DOCS-725" +docs: DOCS-725 +type: [] --- + ## Overview You can use traffic splitting for most deployment scenarios, including canary, blue-green, A/B testing, and so on. The ability to control traffic flow to different versions of an application makes it easy to roll out a new application version with minimal effort and interruption to production traffic. diff --git a/content/nap-dos/deployment-guide/_index.md b/content/nap-dos/deployment-guide/_index.md index ff74352e2..42dbf2de7 100644 --- a/content/nap-dos/deployment-guide/_index.md +++ b/content/nap-dos/deployment-guide/_index.md @@ -1,10 +1,8 @@ --- description: Learn how to deploy NGINX App Protect DoS. -menu: - docs: - parent: NGINX App Protect DoS Documentation. title: Deployment Guide weight: 100 url: /nginx-app-protect-dos/deployment-guide/ --- + diff --git a/content/nap-dos/deployment-guide/installing-nginx-plus-with-dos-and-waf-on-amazon-web-services.md b/content/nap-dos/deployment-guide/installing-nginx-plus-with-dos-and-waf-on-amazon-web-services.md index 01c590f28..38993459c 100644 --- a/content/nap-dos/deployment-guide/installing-nginx-plus-with-dos-and-waf-on-amazon-web-services.md +++ b/content/nap-dos/deployment-guide/installing-nginx-plus-with-dos-and-waf-on-amazon-web-services.md @@ -4,13 +4,14 @@ description: Install F5 NGINX Plus, NGINX App Protect WAF + DoS on Amazon Web Se behavioral DoS detection and mitigation that works seamlessly in DevOps environments for your apps running on CentOS, RHEL, Debian and Ubuntu Linux OS. docs: DOCS-1204 -doctypes: -- task title: NGINX App Protect WAF + DoS AMIs on Amazon EC2 toc: true weight: 110 +type: +- how-to --- + NGINX, Inc. participates in the Amazon Web Services (AWS) Partner Network as a Standard Technology Partner. We offer Amazon Machine Images (AMIs) for use in the Amazon Elastic Compute Cloud (EC2), available at the AWS Marketplace for several operating systems, including Amazon Linux, Red Hat Enterprise Linux, and Ubuntu. The AMIs contain combination of the following components: diff --git a/content/nap-dos/deployment-guide/learn-about-deployment.md b/content/nap-dos/deployment-guide/learn-about-deployment.md index f2b35d160..270146426 100644 --- a/content/nap-dos/deployment-guide/learn-about-deployment.md +++ b/content/nap-dos/deployment-guide/learn-about-deployment.md @@ -1,13 +1,14 @@ --- description: Learn about F5 NGINX App Protect DoS Deployment. docs: DOCS-666 -doctypes: -- task title: NGINX App Protect DoS Deployment toc: true weight: 100 +type: +- how-to --- + ## Overview F5 NGINX App Protect DoS provides behavioral protection against DoS for your web applications.

diff --git a/content/nap-dos/directives-and-policy/_index.md b/content/nap-dos/directives-and-policy/_index.md index c4cc3e3ea..0d66fcde8 100644 --- a/content/nap-dos/directives-and-policy/_index.md +++ b/content/nap-dos/directives-and-policy/_index.md @@ -1,10 +1,8 @@ --- description: Learn about the Directives and Policy attributes necessary to configure F5 NGINX App Protect DoS. -menu: - docs: - parent: NGINX App Protect DoS Documentation. title: Directives and Policy weight: 120 url: /nginx-app-protect-dos/directives-and-policy/ --- + diff --git a/content/nap-dos/monitoring/_index.md b/content/nap-dos/monitoring/_index.md index 2c5f1da8c..8485a67c4 100644 --- a/content/nap-dos/monitoring/_index.md +++ b/content/nap-dos/monitoring/_index.md @@ -1,10 +1,8 @@ --- description: Documentation explaining how to monitor, generate logs for, and debug F5 NGINX App Protect DoS. -menu: - docs: - parent: NGINX App Protect DoS Documentation. title: Monitoring weight: 130 url: /nginx-app-protect-dos/monitoring/ --- + diff --git a/content/nap-dos/monitoring/access-log.md b/content/nap-dos/monitoring/access-log.md index 85185e723..9fd18d0c6 100644 --- a/content/nap-dos/monitoring/access-log.md +++ b/content/nap-dos/monitoring/access-log.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect DoS Request Log Mechanism. docs: DOCS-668 -doctypes: -- task title: NGINX App Protect DoS Access Log Request Mechanism toc: true weight: 160 +type: +- how-to --- + ## Access Logs Access Log is NGINX’s request log mechanism. It is controlled by the following two directives.
diff --git a/content/nap-dos/monitoring/live-activity-monitoring.md b/content/nap-dos/monitoring/live-activity-monitoring.md index d8a5b0b80..924ad0711 100644 --- a/content/nap-dos/monitoring/live-activity-monitoring.md +++ b/content/nap-dos/monitoring/live-activity-monitoring.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect DoS Live Activity Monitoring. docs: DOCS-1389 -doctypes: -- task title: NGINX App Protect DoS Live Activity Monitoring toc: true weight: 140 +type: +- how-to --- + {{< img src="/dashboard/dos-tab.png" alt="NGINX App Protect DoS Dashboard" >}} ## Overview diff --git a/content/nap-dos/monitoring/operation-log.md b/content/nap-dos/monitoring/operation-log.md index dbfae5bc9..391d801db 100644 --- a/content/nap-dos/monitoring/operation-log.md +++ b/content/nap-dos/monitoring/operation-log.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect DoS Operation Log. docs: DOCS-669 -doctypes: -- task title: NGINX App Protect DoS Operation Log toc: true weight: 180 +type: +- how-to --- + ## Overview The operation logs consists of system operational and health events. The events are sent to the NGINX error log and are distinguished by the `APP_PROTECT_DOS` prefix followed by JSON body. The log level depends on the event: success is usually `notice` while failure is `error`. The timestamp is inherent in the error log. diff --git a/content/nap-dos/monitoring/security-log.md b/content/nap-dos/monitoring/security-log.md index ca40a57f2..478ece510 100644 --- a/content/nap-dos/monitoring/security-log.md +++ b/content/nap-dos/monitoring/security-log.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect DoS Security Log. docs: DOCS-670 -doctypes: -- task title: NGINX App Protect DoS Security Log toc: true weight: 140 +type: +- how-to --- + ## Overview Security logs contain information about the status of the protected objects. It gives a general picture about each protected object in terms of traffic intensity, health of the backend server, learning and mitigations. diff --git a/content/nap-dos/monitoring/types-of-logs.md b/content/nap-dos/monitoring/types-of-logs.md index dbe488cbf..f5b836435 100644 --- a/content/nap-dos/monitoring/types-of-logs.md +++ b/content/nap-dos/monitoring/types-of-logs.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect DoS Logs Overview. docs: DOCS-671 -doctypes: -- task title: NGINX App Protect DoS Logs Overview toc: true weight: 130 +type: +- how-to --- + There are 4 types of logs corresponding to App Protect DoS: - [Security Log](#security-log): The general picture of the site and how App Protect DoS processed it, including anomalies and signatures found. diff --git a/content/nap-dos/releases/_index.md b/content/nap-dos/releases/_index.md index 33ea5b259..7ac8e5f15 100644 --- a/content/nap-dos/releases/_index.md +++ b/content/nap-dos/releases/_index.md @@ -1,9 +1,7 @@ --- description: Stay up-to-date with the latest F5 NGINX App Protect DoS release. -menu: - docs: - parent: NGINX App Protect DoS Documentation. title: Releases weight: 220 url: /nginx-app-protect-dos/releases/ --- + diff --git a/content/nap-dos/troubleshooting-guide/_index.md b/content/nap-dos/troubleshooting-guide/_index.md index 6ef2f6d32..ccc6eeebc 100644 --- a/content/nap-dos/troubleshooting-guide/_index.md +++ b/content/nap-dos/troubleshooting-guide/_index.md @@ -1,9 +1,7 @@ --- description: Learn how to troubleshoot your F5 NGINX App Protect DoS deployment. -menu: - docs: - parent: NGINX App Protect DoS Documentation. title: Troubleshooting Guide weight: 200 url: /nginx-app-protect-dos/troubleshooting-guide/ --- + diff --git a/content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md b/content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md index 2e84a793a..6787bf1b6 100644 --- a/content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md +++ b/content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect DoS Troubleshooting Guide. docs: DOCS-675 -doctypes: -- task title: NGINX App Protect DoS Troubleshooting Guide toc: true weight: 200 +type: +- how-to --- + ## Overview This Troubleshooting Guide is intended to provide guidance to customers in the detection and correction of programming issues in F5 NGINX App Protect DoS. It may also be useful to IT. diff --git a/content/nap-waf/_index.md b/content/nap-waf/_index.md index bddd99112..1562ab180 100644 --- a/content/nap-waf/_index.md +++ b/content/nap-waf/_index.md @@ -1,13 +1,14 @@ --- -description: | - Modern app security solution that works seamlessly in DevOps environments. +description: 'Modern app security solution that works seamlessly in DevOps environments. + Request your [free 30-day trial](https://www.nginx.com/free-trial-request/) today. -linkTitle: F5 NGINX App Protect WAF -menu: docs + + ' title: F5 NGINX App Protect WAF weight: 100 url: /nginx-app-protect-waf/ cascade: - logo: "NGINX-App-Protect-WAF-product-icon.svg" + logo: NGINX-App-Protect-WAF-product-icon.svg --- + diff --git a/content/nap-waf/v4/_index.md b/content/nap-waf/v4/_index.md index 4e6c5d6b3..14b683550 100644 --- a/content/nap-waf/v4/_index.md +++ b/content/nap-waf/v4/_index.md @@ -1,9 +1,7 @@ --- description: F5 NGINX App Protect WAF v4 documentation. -menu: - docs: - parent: F5 NGINX App Protect WAF Documentation. title: Version 4 and Earlier weight: 100 url: /nginx-app-protect-waf/v4/ --- + diff --git a/content/nap-waf/v4/admin-guide/_index.md b/content/nap-waf/v4/admin-guide/_index.md index ee20b96c0..02c42cc18 100644 --- a/content/nap-waf/v4/admin-guide/_index.md +++ b/content/nap-waf/v4/admin-guide/_index.md @@ -1,10 +1,8 @@ --- -description: Learn how to deploy, upgrade, and manage F5 NGINX App Protect WAF and App - Protect Signatures. Versions 4 and earlier. -menu: - docs: - parent: v4 and earlier +description: Learn how to deploy, upgrade, and manage F5 NGINX App Protect WAF and + App Protect Signatures. Versions 4 and earlier. title: Administration Guides weight: 100 url: /nginx-app-protect-waf/v4/admin-guide/ --- + diff --git a/content/nap-waf/v4/admin-guide/install-nms.md b/content/nap-waf/v4/admin-guide/install-nms.md index 9020cba28..33375a29d 100644 --- a/content/nap-waf/v4/admin-guide/install-nms.md +++ b/content/nap-waf/v4/admin-guide/install-nms.md @@ -2,13 +2,14 @@ description: Learn how to get more from F5 NGINX App Protect WAF with the NGINX Management Suite Security Monitoring and Instance Manager modules. docs: DOCS-1126 -doctypes: -- task title: Using NGINX App Protect WAF with NGINX Management Suite toc: true weight: 100 +type: +- how-to --- + ## Overview [F5 NGINX Management Suite Instance Manager]({{< relref "/nms/about.md#instance-manager" >}}) provides a centralized interface where you can create, modify, and publish policies, attack signatures, and threat campaigns for NGINX App Protect WAF. You can use Instance Manager to deploy configuration updates to one, some, or all your NGINX App Protect WAF data plane instances simultaneously. diff --git a/content/nap-waf/v4/admin-guide/upgrade-nap-waf.md b/content/nap-waf/v4/admin-guide/upgrade-nap-waf.md index 7bbb4cab6..c6fcbcf80 100644 --- a/content/nap-waf/v4/admin-guide/upgrade-nap-waf.md +++ b/content/nap-waf/v4/admin-guide/upgrade-nap-waf.md @@ -1,12 +1,12 @@ --- -title: "Upgrade NGINX App Protect WAF on Managed Instances" -description: "How to Upgrade F5 NGINX App Protect WAF on managed NGINX instances" +title: Upgrade NGINX App Protect WAF on Managed Instances +description: How to Upgrade F5 NGINX App Protect WAF on managed NGINX instances weight: 300 toc: true -tags: [ "NGINX Management Suite" ] -docs: "DOCS-1198" +docs: DOCS-1198 --- + ## Overview Learn how to upgrade F5 NGINX App Protect on your managed NGINX instances using NGINX Instance Manager. This guide covers the steps to update both the NGINX Management Suite server and NGINX App Protect on the data plane, ensuring your security policies and configurations are up-to-date. diff --git a/content/nap-waf/v4/configuration-guide/_index.md b/content/nap-waf/v4/configuration-guide/_index.md index 672aa2fe9..03e3929f5 100644 --- a/content/nap-waf/v4/configuration-guide/_index.md +++ b/content/nap-waf/v4/configuration-guide/_index.md @@ -1,9 +1,6 @@ --- description: Learn how to configure F5 NGINX App Protect WAF. Versions 4 and earlier. -menu: - docs: - parent: v4 and earlier title: Configuration Guides weight: 400 url: /nginx-app-protect-waf/v4/configuration-guide/ ---- \ No newline at end of file +--- diff --git a/content/nap-waf/v4/configuration-guide/configuration.md b/content/nap-waf/v4/configuration-guide/configuration.md index 291bf59be..3b5ed4261 100644 --- a/content/nap-waf/v4/configuration-guide/configuration.md +++ b/content/nap-waf/v4/configuration-guide/configuration.md @@ -1,13 +1,14 @@ --- description: F5 NGINX App Protect WAF security features. docs: DOCS-647 -doctypes: -- task title: NGINX App Protect WAF Configuration Guide toc: true weight: 200 +type: +- how-to --- + ## Overview This guide explains the F5 NGINX App Protect WAF security features and how to use them. This guide also assumes that you have some familiarity with various Layer 7 (L7) Hypertext Transfer Protocol (HTTP) concepts, such as Uniform Resource Identifier (URI)/Uniform Resource Locator (URL), method, header, cookie, status code, request, response, and parameters. diff --git a/content/nap-waf/v4/declarative-policy/_index.md b/content/nap-waf/v4/declarative-policy/_index.md index 3da55814c..4a5d81728 100644 --- a/content/nap-waf/v4/declarative-policy/_index.md +++ b/content/nap-waf/v4/declarative-policy/_index.md @@ -1,9 +1,8 @@ --- -description: Learn about F5 NGINX App Protect WAF Policies Reference. Versions 4 and earlier. -menu: - docs: - parent: v4 and earlier +description: Learn about F5 NGINX App Protect WAF Policies Reference. Versions 4 and + earlier. title: Declarative Policy weight: 720 url: /nginx-app-protect-waf/v4/declarative-policy/ --- + diff --git a/content/nap-waf/v4/logging-overview/_index.md b/content/nap-waf/v4/logging-overview/_index.md index 4cc4dabd8..a77289853 100644 --- a/content/nap-waf/v4/logging-overview/_index.md +++ b/content/nap-waf/v4/logging-overview/_index.md @@ -1,9 +1,7 @@ --- -description: Documentation explaining how to monitor, generate logs for, and debug F5 NGINX App Protect WAF. Versions 4 and earlier. -menu: - docs: - parent: v4 and earlier +description: Documentation explaining how to monitor, generate logs for, and debug + F5 NGINX App Protect WAF. Versions 4 and earlier. title: Logging Overview weight: 800 url: /nginx-app-protect-waf/v4/logging-overview/ ---- \ No newline at end of file +--- diff --git a/content/nap-waf/v4/logging-overview/access-log.md b/content/nap-waf/v4/logging-overview/access-log.md index 1ec864d30..e363bdf47 100644 --- a/content/nap-waf/v4/logging-overview/access-log.md +++ b/content/nap-waf/v4/logging-overview/access-log.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect WAF Access Log Request Mechanism. docs: DOCS-910 -doctypes: -- concept title: NGINX App Protect WAF Access Log toc: true weight: 550 +type: +- concept --- + ## Access Logs Access log is NGINX's request log mechanism. It is controlled by two directives. diff --git a/content/nap-waf/v4/logging-overview/debug-logs.md b/content/nap-waf/v4/logging-overview/debug-logs.md index 0414de45d..ff8a327de 100644 --- a/content/nap-waf/v4/logging-overview/debug-logs.md +++ b/content/nap-waf/v4/logging-overview/debug-logs.md @@ -1,13 +1,14 @@ --- description: Learn about the NGINX App Protect WAF Debug Log. docs: DOCS-913 -doctypes: -- concept title: NGINX App Protect WAF Debug Log toc: true weight: 540 +type: +- concept --- + ## Debug Logs Debug log settings determine the minimum log level and the internal App Protect components included in the log. diff --git a/content/nap-waf/v4/logging-overview/logs-overview.md b/content/nap-waf/v4/logging-overview/logs-overview.md index 3fefc8a0c..94d5da8d8 100644 --- a/content/nap-waf/v4/logging-overview/logs-overview.md +++ b/content/nap-waf/v4/logging-overview/logs-overview.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect WAF Logs Overview. docs: DOCS-911 -doctypes: -- concept title: NGINX App Protect WAF Logs Overview toc: true weight: 510 +type: +- concept --- + ## Overview There are 3 types of logs that F5 NGINX App Protect on NGINX generates: diff --git a/content/nap-waf/v4/logging-overview/operation-logs.md b/content/nap-waf/v4/logging-overview/operation-logs.md index ad001c3bf..8996677ff 100644 --- a/content/nap-waf/v4/logging-overview/operation-logs.md +++ b/content/nap-waf/v4/logging-overview/operation-logs.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect WAF Operation Log. docs: DOCS-912 -doctypes: -- concept title: NGINX App Protect WAF Operation Log toc: true weight: 530 +type: +- concept --- + ### Overview The operation logs consists of system operational and health events. The events are sent to the NGINX error log and are distinguished by the **APP_PROTECT** prefix followed by JSON body. The log level depends on the event: success is usually **Notice** while failure is **Error**. The timestamp is inherent in the error log. diff --git a/content/nap-waf/v4/logging-overview/security-log.md b/content/nap-waf/v4/logging-overview/security-log.md index cf34473cb..6fab73688 100644 --- a/content/nap-waf/v4/logging-overview/security-log.md +++ b/content/nap-waf/v4/logging-overview/security-log.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect WAF Security Log. docs: DOCS-915 -doctypes: -- concept title: NGINX App Protect WAF Security Log toc: true weight: 520 +type: +- concept --- + ## Security Logs ### Security Logs Overview diff --git a/content/nap-waf/v4/releases/_index.md b/content/nap-waf/v4/releases/_index.md index 369b86033..9eddf7604 100644 --- a/content/nap-waf/v4/releases/_index.md +++ b/content/nap-waf/v4/releases/_index.md @@ -1,9 +1,7 @@ --- -description: Stay up-to-date with the latest F5 NGINX App Protect WAF and NGINX App Protect WAF. Versions 4 and earlier. -menu: - docs: - parent: v4 and earlier +description: Stay up-to-date with the latest F5 NGINX App Protect WAF and NGINX App + Protect WAF. Versions 4 and earlier. title: Releases weight: 2000 url: /nginx-app-protect-waf/v4/releases/ ---- \ No newline at end of file +--- diff --git a/content/nap-waf/v4/troubleshooting-guide/_index.md b/content/nap-waf/v4/troubleshooting-guide/_index.md index d8655b829..51bb71bb9 100644 --- a/content/nap-waf/v4/troubleshooting-guide/_index.md +++ b/content/nap-waf/v4/troubleshooting-guide/_index.md @@ -1,9 +1,8 @@ --- -description: Learn about the F5 NGINX App Protect WAF Troubleshooting Guide. Versions 4 and earlier. -menu: - docs: - parent: v4 and earlier +description: Learn about the F5 NGINX App Protect WAF Troubleshooting Guide. Versions + 4 and earlier. title: Troubleshooting Guide weight: 1100 url: /nginx-app-protect-waf/v5/troubleshooting-guide/ --- + diff --git a/content/nap-waf/v4/troubleshooting-guide/troubleshooting.md b/content/nap-waf/v4/troubleshooting-guide/troubleshooting.md index a62b7b90b..264223c2d 100644 --- a/content/nap-waf/v4/troubleshooting-guide/troubleshooting.md +++ b/content/nap-waf/v4/troubleshooting-guide/troubleshooting.md @@ -1,13 +1,14 @@ --- description: Learn about the F5 NGINX App Protect WAF Troubleshooting Guide. docs: DOCS-665 -doctypes: -- concept title: NGINX App Protect WAF Troubleshooting Guide toc: true weight: 400 +type: +- concept --- + ## Overview This Troubleshooting Guide is intended to provide guidance to customers in the detection and correction of programming issues in F5 NGINX App Protect. It may also be useful to IT in resolving any installation or configuration problems.
diff --git a/content/nap-waf/v5/_index.md b/content/nap-waf/v5/_index.md index 5c50a48a7..4d0aced21 100644 --- a/content/nap-waf/v5/_index.md +++ b/content/nap-waf/v5/_index.md @@ -1,9 +1,7 @@ --- description: F5 NGINX App Protect WAF v5 documentation. -menu: - docs: - parent: NGINX App Protect WAF Documentation. title: Version 5 weight: 200 url: /nginx-app-protect-waf/v5/ --- + diff --git a/content/nap-waf/v5/admin-guide/_index.md b/content/nap-waf/v5/admin-guide/_index.md index 34e455b2c..9714dcbe4 100644 --- a/content/nap-waf/v5/admin-guide/_index.md +++ b/content/nap-waf/v5/admin-guide/_index.md @@ -1,10 +1,8 @@ --- -description: Learn how to deploy, upgrade, and manage F5 NGINX App Protect WAF v5 and App - Protect Signatures. -menu: - docs: - parent: v5 +description: Learn how to deploy, upgrade, and manage F5 NGINX App Protect WAF v5 + and App Protect Signatures. title: Administration Guides weight: 100 url: /nginx-app-protect-waf/v5/admin-guide/ --- + diff --git a/content/nap-waf/v5/configuration-guide/_index.md b/content/nap-waf/v5/configuration-guide/_index.md index 464f28e1e..027661c26 100644 --- a/content/nap-waf/v5/configuration-guide/_index.md +++ b/content/nap-waf/v5/configuration-guide/_index.md @@ -1,9 +1,6 @@ --- description: Learn how to configure F5 NGINX App Protect WAF v5. -menu: - docs: - parent: v5 title: Configuration Guides weight: 400 url: /nginx-app-protect-waf/v5/configuration-guide/ ---- \ No newline at end of file +--- diff --git a/content/nap-waf/v5/configuration-guide/configuration.md b/content/nap-waf/v5/configuration-guide/configuration.md index 8feb6634d..726a604d1 100644 --- a/content/nap-waf/v5/configuration-guide/configuration.md +++ b/content/nap-waf/v5/configuration-guide/configuration.md @@ -1,14 +1,15 @@ --- -description: This guide explains the F5 NGINX App Protect WAF security features and how - to use them. +description: This guide explains the F5 NGINX App Protect WAF security features and + how to use them. docs: DOCS-1368 -doctypes: -- task title: NGINX App Protect WAF Configuration Guide toc: true weight: 200 +type: +- how-to --- + ## Overview This guide explains the F5 NGINX App Protect WAF security features and how to use them. This guide also assumes that you have some familiarity with various Layer 7 (L7) Hypertext Transfer Protocol (HTTP) concepts, such as Uniform Resource Identifier (URI)/Uniform Resource Locator (URL), method, header, cookie, status code, request, response, and parameters. diff --git a/content/nap-waf/v5/declarative-policy/_index.md b/content/nap-waf/v5/declarative-policy/_index.md index 483dc8b5f..9adac65d0 100644 --- a/content/nap-waf/v5/declarative-policy/_index.md +++ b/content/nap-waf/v5/declarative-policy/_index.md @@ -1,9 +1,7 @@ --- description: Learn about F5 NGINX App Protect WAF v5 Policies Reference. -menu: - docs: - parent: v5 title: Declarative Policy weight: 720 url: /nginx-app-protect-waf/v5/declarative-policy/ --- + diff --git a/content/nap-waf/v5/declarative-policy/policy.md b/content/nap-waf/v5/declarative-policy/policy.md index 2f5288cb8..b77f487c0 100644 --- a/content/nap-waf/v5/declarative-policy/policy.md +++ b/content/nap-waf/v5/declarative-policy/policy.md @@ -1,13 +1,12 @@ --- description: '' -doctypes: -- reference -tags: -- docs -title: "NGINX App Protect WAF Declarative Policy" +title: NGINX App Protect WAF Declarative Policy toc: false weight: 300 -docs: "DOCS-1644" +docs: DOCS-1644 +type: +- reference --- + {{< include "nap-waf/policy.html" >}} diff --git a/content/nap-waf/v5/logging-overview/_index.md b/content/nap-waf/v5/logging-overview/_index.md index 9ee8cb049..15401b776 100644 --- a/content/nap-waf/v5/logging-overview/_index.md +++ b/content/nap-waf/v5/logging-overview/_index.md @@ -1,9 +1,7 @@ --- -description: Documentation explaining how to monitor, generate logs for, and debug F5 NGINX App Protect WAF v5. -menu: - docs: - parent: v5 +description: Documentation explaining how to monitor, generate logs for, and debug + F5 NGINX App Protect WAF v5. title: Logging Overview weight: 800 url: /nginx-app-protect-waf/v5/logging-overview/ ---- \ No newline at end of file +--- diff --git a/content/nap-waf/v5/logging-overview/access-log.md b/content/nap-waf/v5/logging-overview/access-log.md index e652e45f0..d4f4ba17a 100644 --- a/content/nap-waf/v5/logging-overview/access-log.md +++ b/content/nap-waf/v5/logging-overview/access-log.md @@ -1,13 +1,14 @@ --- -description: "Learn about the F5 NGINX App Protect WAF Access Log Request Mechanism." -doctypes: -- concept -title: "NGINX App Protect WAF Access Log" +description: Learn about the F5 NGINX App Protect WAF Access Log Request Mechanism. +title: NGINX App Protect WAF Access Log toc: true weight: 550 -docs: "DOCS-1641" +docs: DOCS-1641 +type: +- concept --- + ## Access Logs Access log is NGINX's request log mechanism. It is controlled by two directives. diff --git a/content/nap-waf/v5/logging-overview/logs-overview.md b/content/nap-waf/v5/logging-overview/logs-overview.md index 090301692..d67294ce3 100644 --- a/content/nap-waf/v5/logging-overview/logs-overview.md +++ b/content/nap-waf/v5/logging-overview/logs-overview.md @@ -1,13 +1,14 @@ --- description: Learn the types of logs available in F5 NGINX App Protect WAF v5. docs: DOCS-1374 -doctypes: -- concept title: NGINX App Protect WAF Logs Overview toc: true weight: 1010 +type: +- concept --- + ## Log Types Logs in F5 NGINX App Protect WAF v5 can be accessed and configured similarly to NGINX App Protect WAF, though there are some differences in the process. diff --git a/content/nap-waf/v5/logging-overview/security-log.md b/content/nap-waf/v5/logging-overview/security-log.md index 312169929..0e9bb2288 100644 --- a/content/nap-waf/v5/logging-overview/security-log.md +++ b/content/nap-waf/v5/logging-overview/security-log.md @@ -1,13 +1,14 @@ --- -description: "Learn about the F5 NGINX App Protect WAF Security Log." -doctypes: -- concept -title: "NGINX App Protect WAF Security Log" +description: Learn about the F5 NGINX App Protect WAF Security Log. +title: NGINX App Protect WAF Security Log toc: true weight: 520 -docs: "DOCS-1642" +docs: DOCS-1642 +type: +- concept --- + ## Security Logs ### Security Logs Overview diff --git a/content/nap-waf/v5/releases/_index.md b/content/nap-waf/v5/releases/_index.md index e4d0291a8..c1fa198cf 100644 --- a/content/nap-waf/v5/releases/_index.md +++ b/content/nap-waf/v5/releases/_index.md @@ -1,9 +1,7 @@ --- -description: Stay up-to-date with the latest F5 NGINX App Protect WAF and NGINX App Protect WAF v5 release. -menu: - docs: - parent: v5 +description: Stay up-to-date with the latest F5 NGINX App Protect WAF and NGINX App + Protect WAF v5 release. title: Releases weight: 2000 url: /nginx-app-protect-waf/v5/releases/ ---- \ No newline at end of file +--- diff --git a/content/nap-waf/v5/troubleshooting-guide/_index.md b/content/nap-waf/v5/troubleshooting-guide/_index.md index b2bbef02d..2fab045f5 100644 --- a/content/nap-waf/v5/troubleshooting-guide/_index.md +++ b/content/nap-waf/v5/troubleshooting-guide/_index.md @@ -1,9 +1,7 @@ --- description: Learn about the F5 NGINX App Protect WAF v5 Troubleshooting Guide. -menu: - docs: - parent: v5 title: Troubleshooting weight: 1100 url: /nginx-app-protect-waf/v5/troubleshooting-guide/ --- + diff --git a/content/nap-waf/v5/troubleshooting-guide/troubleshooting.md b/content/nap-waf/v5/troubleshooting-guide/troubleshooting.md index 076a749cf..d0354dddf 100644 --- a/content/nap-waf/v5/troubleshooting-guide/troubleshooting.md +++ b/content/nap-waf/v5/troubleshooting-guide/troubleshooting.md @@ -1,13 +1,14 @@ --- -description: "Learn about the F5 NGINX App Protect WAF Troubleshooting Guide." -doctypes: -- concept -title: "NGINX App Protect WAF Troubleshooting Guide" +description: Learn about the F5 NGINX App Protect WAF Troubleshooting Guide. +title: NGINX App Protect WAF Troubleshooting Guide toc: true weight: 400 -docs: "DOCS-1645" +docs: DOCS-1645 +type: +- concept --- + ## Overview This Troubleshooting Guide is intended to provide guidance to customers in the detection and correction of programming issues in F5 NGINX App Protect WAF. It may also be useful to IT in resolving any installation or configuration problems.
diff --git a/content/nginx-one/about.md b/content/nginx-one/about.md index 18ef02cd2..c0c89a09f 100644 --- a/content/nginx-one/about.md +++ b/content/nginx-one/about.md @@ -1,16 +1,15 @@ --- description: '' docs: DOCS-1392 -doctypes: -- reference -tags: -- docs title: About toc: true weight: 10 +type: +- reference --- + The F5 NGINX One Console makes it easy to manage NGINX instances across locations and environments. The console lets you monitor and control your NGINX fleet from one place—you can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more. ## Benefits and key features diff --git a/content/nginx-one/api/api-reference-guide.md b/content/nginx-one/api/api-reference-guide.md index da2406461..fe5e411de 100644 --- a/content/nginx-one/api/api-reference-guide.md +++ b/content/nginx-one/api/api-reference-guide.md @@ -1,14 +1,12 @@ --- -description: "" +description: '' docs: DOCS-1398 -doctypes: - - reference -type: redoc -tags: - - api +type: +- reference title: API reference guide toc: false weight: null --- + {{< openapi spec="./nginx-one/api/one.json" >}} diff --git a/content/nginx-one/api/authentication.md b/content/nginx-one/api/authentication.md index b9b4cfafd..d9425d5c4 100644 --- a/content/nginx-one/api/authentication.md +++ b/content/nginx-one/api/authentication.md @@ -1,15 +1,14 @@ --- description: '' docs: DOCS-1397 -doctypes: -- task -tags: -- docs title: Authentication toc: true weight: 10 +type: +- how-to --- + In this guide, we'll show you how to authenticate API requests with F5 Distributed Cloud and the F5 NGINX One Console. There are two options for authentication: API Token or API Certificate. Both methods ensure secure access to your data. ## Getting ready diff --git a/content/nginx-one/changelog.md b/content/nginx-one/changelog.md index a5727ac26..e612198a3 100644 --- a/content/nginx-one/changelog.md +++ b/content/nginx-one/changelog.md @@ -1,15 +1,14 @@ --- -description: "" +description: '' docs: DOCS-1394 -doctypes: - - reference -tags: - - docs title: Changelog toc: true weight: 99999 +type: +- reference --- +