Skip to content

Commit 8ab5c52

Browse files
eve-brightalexnbAlexicaWright
authored
♻️ restructure addition docs (#145)
* ♻️ restructure addition docs * fix image for approved agent * there is no cog icon anymore, I think it was replaced with the table row's menu * just typos * repaired the link * Fix example service variable definitions * just typos * fixed broken link * Put the sentence " If CONFIG_INSTANCE_n_QUERY_LOG_PORT is not set, the feature is treated as disabled. The rest of NOM still works." to the description of CONFIG_INSTANCE_n_QUERY_LOG_PORT. Then moved "The location of server log configuration ..." including the IMPORTANT section to "Query log collection" on the page "Neo4j instance requirements" including adjusting the links from CONFIG_INSTANCE_n_LOG_CONFIG_PATH to point there. * it should be clear that the rest would work * Apply suggestions from code review Co-authored-by: Jessica Wright <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica Wright <[email protected]> * editorial changes as suggested --------- Co-authored-by: Alexander Bouriakov <[email protected]> Co-authored-by: Jessica Wright <[email protected]>
1 parent 28c61c2 commit 8ab5c52

File tree

11 files changed

+443
-458
lines changed

11 files changed

+443
-458
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
* xref:addition/index.adoc[]
2727
** xref:addition/instance-requirements.adoc[]
2828
** xref:addition/agent-installation/index.adoc[]
29+
*** xref:addition/agent-installation/agent-install.adoc[]
2930
*** xref:addition/agent-installation/manual.adoc[]
3031
*** xref:addition/agent-installation/self-registered.adoc[]
31-
*** xref:addition/agent-installation/install-packaged.adoc[]
3232
*** xref:addition/agent-installation/agent-config-file.adoc[]
3333
*** xref:addition/agent-installation/agent-self-signed-certificates.adoc[]
3434
** xref:addition/docker/index.adoc[]
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
= Install agent
2+
3+
* Download platform specific binary: https://neo4j.com/download-center/#ops-manager[Download]
4+
+
5+
[NOTE]
6+
====
7+
In certain environments, downloading agents is not an option.
8+
Therefore, NOM agent binaries are also bundled with Neo4j packages.
9+
NOM agent packages can be found in the `products` folder in the Neo4j home directory.
10+
These binaries have support for the Neo4j version that they are bundled with.
11+
====
12+
13+
* Extract the archive
14+
15+
* This step is only required if using *SELinux*.
16+
To permanently change the SELinux context of the agent binary, run the following commands:
17+
+
18+
[source, terminal, role=noheader]
19+
----
20+
sudo semanage fcontext -a -t bin_t <EXTRACTED_DIRECTORY_PATH>/bin/agent
21+
sudo restorecon -v <EXTRACTED_DIRECTORY_PATH>/bin/agent
22+
----
23+
+
24+
<EXTRACTED_DIRECTORY_PATH> should be replaced with the path to the extracted directory.
25+
26+
* Add the `bin` folder in the extracted directory to `PATH`
27+
28+
* To verify the installation, run the following command:
29+
+
30+
[source, terminal, role=noheader]
31+
----
32+
agent version
33+
----
34+
+
35+
Which should output:
36+
+
37+
[source, terminal, role=noheader]
38+
----
39+
<agent name> <agent version> <agent revision>
40+
----

modules/ROOT/pages/addition/agent-installation/index.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ NOM agents should be installed for every host in the managed estate:
99
* An agent can and should manage all instances on a single host even if they are members of different DBMSs.
1010

1111
== NOM agent setup process
12-
* Register agent with NOM server [xref:./manual.adoc#register[Manual]] [xref:./self-registered.adoc#register[Self-Registered]]
13-
* Install agent on Neo4j instance host [xref:./manual.adoc#install[Manual]] [xref:./self-registered.adoc#install[Self-Registered]]
14-
* Configure agent [xref:./manual.adoc#configure[Manual]] [xref:./self-registered.adoc#configure[Self-Registered]]
12+
* Install agent on Neo4j instance host [xref:./agent-install.adoc[Install]]
13+
* Register agent with NOM server [xref:./manual.adoc#register[Manual]]
1514
* Run agent [xref:./manual.adoc#running-agent[Manual]] [xref:./self-registered.adoc#running-agent[Self-Registered]]
16-
* Verify agent setup [xref:./manual.adoc#verify[Manual]] [xref:./self-registered.adoc#verify[Self-Registered]]
15+
* Verify agent setup [xref:./manual.adoc#verify[Manual]] [xref:./self-registered.adoc#verify[Self-Registered]]
16+
* Configuration reference [xref:./manual.adoc#configuration[Manual]] [xref:./self-registered.adoc#configuration[Self-Registered]]

modules/ROOT/pages/addition/agent-installation/install-packaged.adoc

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)