You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: archetypes/concept.md
+1-8Lines changed: 1 addition & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,15 +22,11 @@ This guide provides an overview of <concept>, which is used <for/in> <action 1>,
22
22
23
23
It is an example of a <otherconcept>, and is closely related to <thirdconcept>.
24
24
25
-
---
26
-
27
25
## Background
28
26
29
27
[//]: #"Explain what the concept is. If possible, relate it to another commonly known concept or software."
30
28
[//]: #"This relates the new idea to the reader using their existing knowledge, helping their understanding of it and thus what its purpose is in context."
31
29
32
-
---
33
-
34
30
## Use cases
35
31
36
32
[//]: #"Name the individual use case sections after the actual use case itself, e.g 'Route traffic between applications'"
@@ -56,7 +52,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
56
52
57
53
### Use case 2
58
54
59
-
---
60
55
61
56
## Conclusion
62
57
@@ -65,8 +60,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
65
60
[//]: #"Since each use case provides links to additional documents, you may not need to link to more,"
66
61
[//]: #"or even include the final 'See also' section."
67
62
68
-
---
69
-
70
63
## See also
71
64
72
-
[//]: #"Link to related documents, such as concepts, reference material or similar use cases."
65
+
[//]: #"Link to related documents, such as reference material or task instructions."
Copy file name to clipboardExpand all lines: archetypes/default.md
+2-15Lines changed: 2 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,6 @@ nd-product:
20
20
21
21
This guide explains how to <X> with <Y>. In involves the use of <A>, <B> and <C>, demonstrating how <X> works with an example <Z>.
22
22
23
-
---
24
-
25
23
## Before you begin
26
24
27
25
[//]: #"List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -34,8 +32,6 @@ To complete this guide, you will need the following prerequisites:
34
32
35
33
[//]: #"Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
36
34
37
-
---
38
-
39
35
## Step 1
40
36
41
37
[//]: #"Explain the initial step: this is usually creating or configuring a resource. Sub-steps may not be necessary, depending on complexity."
@@ -51,38 +47,29 @@ To complete this guide, you will need the following prerequisites:
51
47
52
48
[//]: #"Sub-steps are ways of breaking steps into even smaller sections. Each step or sub-step should focus on one thing at a time: a user should be able to stop at the end of section and come back afterwards without leaving their software in a non-functional state."
53
49
54
-
---
55
-
56
50
### Sub-step 2
57
51
58
52
[//]: #"A useful final sub-step for a given section is some kind of verification or testing, so the reader is confident the steps have been successful."
59
53
60
-
---
61
-
62
54
## Step 2
63
55
64
56
[//]: #"Explain any additional steps required. If the how-to guide involves multiple components, each component can have its own step for delineation."
65
57
66
58
### Sub-step 1
67
59
68
-
---
69
60
70
61
### Sub-step 2
71
62
72
-
---
73
63
74
64
## Step 3
75
65
76
66
[//]: #"The final step of a how-to guide is usually a final test, and summarizes all of the previous steps taken to accomplish the purpose of the guide."
77
67
78
68
### Sub-step 1
79
69
80
-
---
81
70
82
71
### Sub-step 2
83
72
84
-
---
85
-
86
-
## See also
73
+
## Next steps
87
74
88
-
[//]: #"Link to related documents, such as concepts, reference material or similar use cases."
75
+
[//]: #"Link to the most common use cases after this specific instruction. For example. configuration usually follows installation."
Copy file name to clipboardExpand all lines: archetypes/tutorial.md
+2-17Lines changed: 2 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,8 +29,6 @@ By the end of the tutorial, you should have enough working knowledge of <thing>
29
29
30
30
<thing> is a common use for <product>: it enables the ability to use <feature 1>, <feature 2> and <feature 3>, which are important when configuring <product> for <usecase>.
31
31
32
-
---
33
-
34
32
## Before you begin
35
33
36
34
[//]: #"List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -43,8 +41,6 @@ To complete this guide, you will need the following prerequisites:
43
41
44
42
[//]: #"Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
45
43
46
-
---
47
-
48
44
## Step 1
49
45
50
46
[//]: #"The text immediately following a heading in a tutorial should likely explain a concept to build a mental model of what the reader is about to do."
@@ -61,8 +57,6 @@ The first thing required for setting up <thing> is <step name>. This is the <ser
61
57
62
58
Starting from the <top/left> of the diagram, you can see that <thing> is connected to <otherthing>: this relationship is established when configuring <parameter> as part of <filename>.
63
59
64
-
---
65
-
66
60
### Sub-step 1
67
61
68
62
[//]: #"The sub-steps of a tutorial should show the exact steps a reader should take to accomplish an action, and what to expect when doing so."
@@ -87,34 +81,25 @@ To verify the creation of <component>, you can also inspect information about it
87
81
<the output of that command, possibly truncated and with changed IPs or domains>
88
82
```
89
83
90
-
---
91
-
92
84
### Sub-step 2
93
85
94
-
---
95
-
96
86
## Step 2
97
87
98
88
[//]: #"Explain any additional steps required. If the tutorial involves multiple components, each component can have its own step for delineation."
99
89
100
-
---
101
-
102
90
### Sub-step 1
103
91
104
-
---
105
92
106
93
### Sub-step 2
107
94
108
-
---
109
95
110
96
## Conclusion
111
97
112
98
[//]: #"Summarize everything that the reader will have learned and accomplished by the end of this tutorial."
113
99
[//]: #"It should fulfill the promise made by the introductory paragraph at the top of the document."
114
100
[//]: #"You may wish to link to another tutorial as the next logical step, but that could also be part of the 'See also' section."
115
101
116
-
---
117
102
118
-
## See also
103
+
## Next steps
119
104
120
-
[//]: #"Link to related documents, such as concepts, reference material or similar use cases."
105
+
[//]: #"Link to related documents, such as concepts, reference material or specific use cases."
Copy file name to clipboardExpand all lines: content/agent/configuration/configuration-overview.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,11 +51,11 @@ server:
51
51
host: <FQDN>
52
52
grpcPort: 443
53
53
backoff: # note: default values are prepopulated
54
-
initial_interval: 100ms # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
55
-
randomization_factor: 0.10 # Add the appropriate float value here, e.g., 0.10
56
-
multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
57
-
max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
58
-
max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
54
+
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
55
+
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
56
+
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
57
+
max_interval: 1m # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
58
+
max_elapsed_time: 0 # Add the appropriate duration value here, for example, "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
59
59
# tls options
60
60
tls:
61
61
# enable tls in the nginx-agent setup for grpcs
@@ -89,11 +89,11 @@ metrics:
89
89
collection_interval: 15s
90
90
mode: aggregated
91
91
backoff: # note: default values are prepopulated
92
-
initial_interval: 100ms # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
93
-
randomization_factor: 0.10 # Add the appropriate float value here, e.g., 0.10
94
-
multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
95
-
max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
96
-
max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
92
+
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
93
+
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
94
+
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
95
+
max_interval: 1m # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
96
+
max_elapsed_time: 0 # Add the appropriate duration value here, for example, "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
97
97
98
98
# OSS NGINX default config path
99
99
# path to aux file dirs can also be added
@@ -193,7 +193,7 @@ If you are upgrading from an older version, update your configuration accordingl
193
193
|`--features`|`NGINX_AGENT_FEATURES`| Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]*|
194
194
|`--ignore-directives`|| Specifies a comma-separated list of directives to ignore for sensitive info.|
195
195
|`--instance-group`|`NGINX_AGENT_INSTANCE_GROUP`| Sets the instance's group value. |
Copy file name to clipboardExpand all lines: content/amplify/faq/nginx-amplify-agent.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ If you don't see the new system or NGINX in the web interface, or (some) metrics
82
82
83
83
3. NGINX Amplify Agent is running under the same user as your NGINX worker processes.
84
84
85
-
4. The NGINX instance is started with an absolute path. Currently, NGINX Amplify Agent **can't** detect NGINX instances launched with a relative path (e.g., "./nginx").
85
+
4. The NGINX instance is started with an absolute path. Currently, NGINX Amplify Agent **can't** detect NGINX instances launched with a relative path (for example, "./nginx").
86
86
87
87
5. The [user ID that is used by NGINX Amplify Agent and NGINX ]({{< ref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#overriding-the-effective-user-id" >}}), can run *ps(1)* to see all system processes. If *ps(1)* is restricted for non-privileged users, NGINX Amplify Agent won't be able to find and properly detect the NGINX master process.
Copy file name to clipboardExpand all lines: content/amplify/nginx-amplify-agent/configuration-analysis.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ docs: DOCS-961
8
8
9
9
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]({{< ref "/amplify/user-interface/analyzer.md" >}})) documentation.
10
10
11
-
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.
11
+
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 — for example, a master process restarts, or the NGINX config is edited, an update is sent to the Amplify backend.
12
12
13
13
{{< note >}} NGINX Amplify Agent never sends the raw unprocessed config files to the backend system. In addition, the following directives in the NGINX configuration are never analyzed — and their parameters aren't exported to the SaaS backend:
0 commit comments