Skip to content

Commit ca3874c

Browse files
committed
Removed unnecessary metadata keys and standardized the remaining ones
1 parent 4dd3142 commit ca3874c

File tree

641 files changed

+2345
-2587
lines changed

Some content is hidden

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

641 files changed

+2345
-2587
lines changed

content/agent/_index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "NGINX Agent"
3-
description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance."
4-
linkTitle: "NGINX Agent"
5-
menu: docs
2+
title: NGINX Agent
3+
description: NGINX Agent is a companion daemon for your NGINX Open Source or NGINX
4+
Plus instance.
65
url: /nginx-agent/
76
cascade:
8-
logo: "NGINX-product-icon.png"
9-
---
7+
logo: NGINX-product-icon.png
8+
---

content/agent/configuration/_index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: "Configuration"
3-
description: "Learn how to configure NGINX Agent."
4-
linkTitle: "Configuration"
5-
weight: "400"
6-
menu: docs
2+
title: Configuration
3+
description: Learn how to configure NGINX Agent.
4+
weight: '400'
75
url: /nginx-agent/configuration/
8-
---
6+
---

content/agent/configuration/configuration-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Basic configuration"
2+
title: Basic configuration
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1229"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1229
7+
type:
8+
- how-to
109
---
1110

11+
1212
The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
1313

1414
{{<note>}}

content/agent/configuration/configure-nginx-agent-features.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: "Features configuration"
2+
title: Features configuration
33
draft: false
44
weight: 150
55
toc: true
6-
tags: [ "docs" ]
7-
categories: ["configuration"]
8-
doctypes: ["task"]
6+
type:
7+
- how-to
98
---
109

10+
1111
## Overview
1212

1313
This guide describes the F5 NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file.

content/agent/configuration/configure-nginx-agent-group.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Add NGINX users to nginx-agent Group"
2+
title: Add NGINX users to nginx-agent Group
33
draft: false
44
weight: 300
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-933"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-933
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
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`.

content/agent/configuration/encrypt-communication.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
22
title: Encrypt communication
3-
tags:
4-
- docs
53
toc: true
64
weight: 200
7-
docs: "DOCS-802"
5+
docs: DOCS-802
86
---
97

8+
109
## Overview
1110

1211
Follow the steps in this guide to encrypt communication between NGINX Agent and Instance Manager with TLS.

content/agent/configuration/health-checks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: "Health checks"
2+
title: Health checks
33
draft: false
44
weight: 400
55
toc: true
6-
tags: [ "docs" ]
7-
categories: ["configuration"]
8-
doctypes: ["task"]
6+
type:
7+
- how-to
98
---
109

10+
1111
## Overview
1212

1313
The REST API includes a health endpoint to verify the status of NGINX Agent.

content/agent/contribute/_index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: "Contribute"
3-
description: "Learn about the NGINX Agent community and contribute to the project."
4-
linkTitle: "Contribute"
5-
menu: docs
6-
weight: "500"
2+
title: Contribute
3+
description: Learn about the NGINX Agent community and contribute to the project.
4+
weight: '500'
75
url: /nginx-agent/contribute/
8-
---
6+
---

content/agent/contribute/community.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Community and contribution"
2+
title: Community and contribution
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1087"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1087
7+
type:
8+
- how-to
109
---
1110

11+
1212
# Community
1313

1414
- Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts.

content/agent/contribute/dev-environment-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Development environment setup"
2+
title: Development environment setup
33
draft: false
44
weight: 200
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1088"
8-
categories: ["development"]
9-
doctypes: ["task"]
6+
docs: DOCS-1088
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Learn how to setup a Development Environment for NGINX Agent.
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Installation and upgrade"
3-
description: "Learn how to install, upgrade, and uninstall NGINX Agent."
4-
menu: docs
2+
title: Installation and upgrade
3+
description: Learn how to install, upgrade, and uninstall NGINX Agent.
54
weight: 300
65
url: /nginx-agent/installation-upgrade/
7-
---
6+
---
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Container environments"
3-
description: "Learn how to build and run NGINX Agent docker images."
4-
menu: docs
2+
title: Container environments
3+
description: Learn how to build and run NGINX Agent docker images.
54
weight: 800
65
ur: /nginx-agent/installation-upgrade/container-environments/
7-
---
6+
---

content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Build container images"
2+
title: Build container images
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
categories: ["configuration"]
8-
doctypes: ["task"]
9-
docs: "DOCS-1410"
6+
docs: DOCS-1410
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
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.

content/agent/installation-upgrade/container-environments/docker-support.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
22
title: Container support and troubleshooting
3-
categories:
4-
- installation
53
draft: false
6-
tags:
7-
- docs
84
toc: true
95
weight: 200
10-
docs: "DOCS-909"
6+
docs: DOCS-909
7+
type: []
118
---
129

10+
1311
## Overview
1412

1513
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.

content/agent/installation-upgrade/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Getting started"
2+
title: Getting started
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1089"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1089
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which NGINX Agent will report.

content/agent/installation-upgrade/installation-github.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Installation from GitHub release"
2+
title: Installation from GitHub release
33
draft: false
44
weight: 200
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1090"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1090
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Learn how to install NGINX Agent from a GitHub Release.

content/agent/installation-upgrade/installation-oss.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Installation from NGINX repository"
2+
title: Installation from NGINX repository
33
draft: false
44
weight: 300
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1216"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1216
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Learn how to install NGINX Agent from the NGINX Open Source repository.

content/agent/installation-upgrade/installation-plus.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Installation from NGINX Plus repository"
2+
title: Installation from NGINX Plus repository
33
draft: false
44
weight: 400
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1217"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1217
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Learn how to install NGINX Agent from NGINX Plus repository

content/agent/installation-upgrade/uninstall.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Uninstall NGINX Agent package"
2+
title: Uninstall NGINX Agent package
33
draft: false
44
weight: 700
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1230"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1230
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Learn how to uninstall NGINX Agent from your system.

content/agent/installation-upgrade/upgrade.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Upgrade NGINX Agent package"
2+
title: Upgrade NGINX Agent package
33
draft: false
44
weight: 600
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1227"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1227
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
Learn how to upgrade NGINX Agent.

content/agent/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Overview"
2+
title: Overview
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1091"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1091
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables:

content/agent/technical-specifications.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Technical specifications"
2+
title: Technical specifications
33
draft: false
44
weight: 200
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1092"
8-
categories: ["development"]
9-
doctypes: ["task"]
6+
docs: DOCS-1092
7+
type:
8+
- how-to
109
---
1110

11+
1212
## Overview
1313

1414
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.

0 commit comments

Comments
 (0)