Skip to content

Commit 34893c9

Browse files
committed
Update Patchman agent documentation to reflect Imunify integration
## Summary Update Patchman agent documentation to reflect that `imunify-patchman` (v1.0.9+) is now delivered as part of Imunify360, not as a standalone product. ## Changes ### Main Documentation - **Reorganized installation instructions**: Made Imunify360 integration the primary/recommended installation method - Moved `Installing imunify-antivirus with Patchman support` to the top as the main installation section - Removed outdated standalone `imunify-patchman` installation instructions ### Legacy Documentation - Created a **new "Legacy Reference: patchman-client (Older Agent)"** section at the end - Moved all old `patchman-client` documentation here (standalone repo, auto-updates, uninstall procedures) - Added clear deprecation warning explaining this is for older agents only - Directed users to use `imunify-patchman` v1.0.9+ for new installations ### Clarified - Updated changelog command to reference `imunify-patchman` instead of `patchman-client` - Title changed from "Agent (patchman-client)" to "Agent" to reflect current focus ## Why Based on product changes: - `imunify-patchman` is now distributed via Imunify repositories - Customers should be guided to use the integrated Imunify installation path - Old patchman-client documentation is maintained as reference for existing customers still on legacy versions ## Related - Patchman Engineering Lead decision: Keep legacy docs as reference, guide customers to v1.0.9+ - Reference: [Gradual roll-out documentation](/update/#gradual-roll-out)
1 parent 7ad7ca5 commit 34893c9

2 files changed

Lines changed: 681 additions & 66 deletions

File tree

docs/patchman/agent/README.md

Lines changed: 74 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,47 @@
1-
# Agent (patchman-client)
1+
# Agent
22

33
[[TOC]]
44

5+
## Installation (Recommended)
6+
7+
The `imunify-patchman` agent is delivered as part of Imunify. Follow the installation instructions below to enable Patchman support.
8+
9+
### Installing imunify-antivirus with Patchman support
10+
11+
1. Find a license key on the [server add page](https://portal.patchman.co/servers/add/). It is displayed under the `During installation, enter the following license key:` section.
12+
13+
2. Install or update `imunify-antivirus`
14+
1. If imunify-antivirus is not yet installed on a server:
15+
```
16+
wget https://repo.imunify360.cloudlinux.com/defence360/imav-deploy.sh -O imav-deploy.sh
17+
bash imav-deploy.sh
18+
```
19+
2. If it is already installed, check if the version of imunify-antivirus is at least `8.5.6`
20+
```
21+
imunify-antivirus version
22+
8.5.6
23+
```
24+
If it's lower, then update imunify-antivirus using your system package manager.
25+
26+
3. Install the Patchman extension
27+
```
28+
imunify-antivirus patchman install
29+
```
30+
31+
4. Configure the license key (obtained in the first step)
32+
```
33+
imunify-antivirus patchman register '<regkey>'
34+
```
35+
36+
5. Enable the Patchman extension
37+
```
38+
imunify-antivirus config update '{"PATCHMAN": {"enable": true}}'
39+
```
40+
41+
6. Add the server in the Patchman portal on the [page with pending servers](https://portal.patchman.co/servers/add/multiple/)
42+
43+
* * *
44+
545
## Where can I find the software changelog?
646
747
### Online changelog
@@ -17,7 +57,7 @@ In addition to the above, the changelog for each software update is also availab
1757
Use the RPM package management utility with the following command:
1858
1959
```
20-
rpm -q --changelog patchman-client
60+
rpm -q --changelog imunify-patchman
2161
```
2262
2363
### Debian / Ubuntu
@@ -136,27 +176,35 @@ Upon release of the multithreading feature, the 'Absolute' setting will be used
136176
137177
* * *
138178
139-
## How do automatic agent updates work?
179+
* * *
180+
181+
## Legacy Reference: patchman-client (Older Agent)
182+
183+
:::warning
184+
**Deprecated Documentation** — This section covers the older `patchman-client` agent delivered from the standalone Patchman repository. It is kept for reference only. For new installations, use the `imunify-patchman` sections above. Customers on older versions of patchman-client can continue using it, but should plan to migrate to `imunify-patchman` (version 1.0.9+) for the latest features and updates.
185+
:::
186+
187+
### How automatic agent updates work (patchman-client)
140188
141189
:::tip
142-
If you have installed the package for [real-time scanning](/patchman/frequently_asked_questions/#real-time-scanning-what-is-it-and-how-do-i-configure-it), automatic updates will also apply to that package. If you dont have it installed yet, you need to manually install it first - Patchman cant automatically perform this installation for you, for security reasons.
190+
If you have installed the package for [real-time scanning](/patchman/frequently_asked_questions/#real-time-scanning-what-is-it-and-how-do-i-configure-it), automatic updates will also apply to that package. If you don't have it installed yet, you need to manually install it first - Patchman can't automatically perform this installation for you, for security reasons.
143191
:::
144192
145193
The Patchman agent is capable of performing unattended automated updates. This saves you time and effort whenever we release a new version, and ensures that all your servers are always running the latest version with both the newest features and the latest bugfixes.
146194
147-
### Configuring automatic updates
195+
#### Configuring automatic updates
148196
149-
#### Disabling automatic updates
197+
##### Disabling automatic updates
150198
151199
Automatic updates are switched on by default, and are available for agents with version 1.7.0-1 and higher.
152200
153201
If you do not wish to benefit from automatic updates, you can opt out through an option in the Portal. The option for controlling the automatic updates can be configured per server group. To disable automatic updates for a server group, navigate to "Server > Server groups", and then select the relevant server group in the list. Scroll down to "Miscellaneous settings" and deselect "Automatic updates".
154202
155203
![](/images/auto-update.png)
156204
157-
#### Repository name modifications
205+
##### Repository name modifications
158206
159-
By default we assume the repository is named "patchman", as will be the case if you use our installation script to install the repository on your system. If you decided to rename the repository definition, you can configure the alternative repository name by adding the following data to the file /etc/patchman/patchman.ini (create it if it does not yet exist):
207+
By default we assume the repository is named "patchman", as will be the case if you use our installation script to install the repository on your system. If you decided to rename the repository definition, you can configure the alternative repository name by adding the following data to the file /etc/patchman/patchman.ini (create it if it does not yet exist):
160208
161209
```
162210
[updates]
@@ -171,7 +219,7 @@ service patchman reload
171219
172220
Our update process will use the new repository name where appropriate.
173221
174-
### Under the hood: steps in automatic updating
222+
#### Under the hood: steps in automatic updating
175223
176224
As a system administrator you may want to know how the updates are performed. In particular, you may be interested to know what checks we perform to ensure successful updates, what rollback procedures are involved if an update fails, and how the validity of each update is verified. This section lists all the steps the agent takes including some background information regarding the how and why for each step.
177225
@@ -181,9 +229,9 @@ When building the updating procedure, our goal was to simulate the steps and che
181229
In the steps below, wherever actions are performed for the patchman-client package, they are repeated for the patchman-client-realtime package if (and only if) you have that installed.
182230
:::
183231
184-
#### CentOS/CloudLinux
232+
##### CentOS/CloudLinux
185233
186-
1. Clean the cached metadata for the patchman repository to ensure issuing an install command will result in new metadata being downloaded from our repository
234+
1. Clean the cached metadata for the patchman repository to ensure issuing an install command will result in new metadata being downloaded from our repository
187235
1. On CentOS 6 and 7:
188236
```
189237
yum clean all --disablerepo="*" --enablerepo="patchman"
@@ -192,7 +240,7 @@ In the steps below, wherever actions are performed for the patchman-client packa
192240
```
193241
dnf clean all --disablerepo="*" --enablerepo="patchman"
194242
```
195-
2. Download the most recent version of the patchman-client package into the cache directory (and parse the associated filename). If no new version is available, stop the update procedure.
243+
2. Download the most recent version of the patchman-client package into the cache directory (and parse the associated filename). If no new version is available, stop the update procedure.
196244
1. On CentOS 6 and 7:
197245
```
198246
yum install -y --downloadonly --downloaddir=<patchman tmp dir> patchman-client
@@ -209,7 +257,7 @@ In the steps below, wherever actions are performed for the patchman-client packa
209257
5. Parse the output from the rpm command to check whether the update succeeded.
210258
6. If the update is successful, the agent will restart itself after completion of the update procedure, ensuring the server is running the newly installed version afterwards.
211259
212-
#### Debian/Ubuntu
260+
##### Debian/Ubuntu
213261
214262
1. Read the filename that contains our repository definition and the path to the cache directory. This means parsing Dir, Dir::Etc, Dir::Etc::sourceparts, Dir::Cache and Dir::Cache::archives from:
215263
```
@@ -228,26 +276,24 @@ In the steps below, wherever actions are performed for the patchman-client packa
228276
apt-get -d install patchman-client
229277
```
230278
5. Determine the filename of the downloaded package using the cache directory and the filename from step 4.
231-
6. Install the downloaded package using dpkg. Since dpkg is not able to download any potentially missing dependencies, this step will automatically fail if any unforeseen dependency problems arise.
279+
6. Install the downloaded package using dpkg. Since dpkg is not able to download any potentially missing dependencies, this step will automatically fail if any unforeseen dependency problems arise.
232280
```
233281
dpkg -i /var/cache/apt/archives/patchman-client_1.2.3-1.deb
234282
```
235-
7. Parse the output from the dpkg command to check whether the update succeeded.
283+
7. Parse the output from the dpkg command to check whether the update succeeded.
236284
8. If the update is successful, the agent will restart itself after completion of the update procedure, ensuring the server is running the newly installed version afterwards.
237285
238286
:::tip
239287
In step 3, we used `apt-cache madison patchman-client` until version 1.14.0-1.
240288
:::
241289
242-
* * *
243-
244-
## Updating the Patchman agent
290+
### Updating the patchman-client agent (Legacy)
245291
246292
:::tip
247-
We strongly suggest using the auto-update feature, as described in [this article](https://patchman.atlassian.net/wiki/spaces/PT/pages/113410280). Relying on auto-update decreases maintenance and ensures you will always automatically use the most up-to-date version of the Patchman software.
293+
We strongly suggest using the auto-update feature, as described above. Relying on auto-update decreases maintenance and ensures you will always automatically use the most up-to-date version of the Patchman software.
248294
:::
249295
250-
The Patchman agent, running on the servers you add to the Portal, is updated regularly to resolve bugs and introduce new features. Updating the Patchman agent only requires you to update the package using your package manager. 
296+
The Patchman agent, running on the servers you add to the Portal, is updated regularly to resolve bugs and introduce new features. Updating the Patchman agent only requires you to update the package using your package manager.
251297
252298
We recommend adding the updating of the Patchman agent to your regular update schedule. However, if you need to manually update the agent, you can use the following commands:
253299
@@ -270,7 +316,7 @@ apt-get update
270316
apt-get install patchman-client
271317
```
272318
273-
After updating the agent, the service should restart automatically and you should see the new version number appear in the Portal (under Servers). 
319+
After updating the agent, the service should restart automatically and you should see the new version number appear in the Portal (under Servers).
274320
275321
On rare occasions customers reported that the agent refuses to stop, in that case a manual restart is required.
276322
@@ -280,17 +326,15 @@ service patchman restart
280326
281327
If the restart fails, there is probably a long-running task that prevents the agent from restarting immediately. The logfiles in /var/log/patchman/ will point out that the shutdown signal was received by the process, and will be processed as soon as possible. If the process hasn't restarted after 10 minutes, please contact [support@patchman.co](mailto:support@patchman.co) and send along the logfiles for further inspection.
282328
283-
Although we strive to maximize compatibility, we may occassionally drop support for outdated agent versions. Your agent will then not be able to connect to the Portal, meaning that new detections will not be reported and existing detections can't be resolved.
329+
Although we strive to maximize compatibility, we may occassionally drop support for outdated agent versions. Your agent will then not be able to connect to the Portal, meaning that new detections will not be reported and existing detections can't be resolved.
284330
285-
* * *
286-
287-
## Uninstalling the Patchman agent
331+
### Uninstalling patchman-client (Legacy)
288332
289333
Patchman is installed on your system using the standard package manager. This means that you can easily uninstall the software using this package manager.
290334
291-
### CentOS / CloudLinux
335+
#### CentOS / CloudLinux
292336
293-
Use the yum package management utility with the following command:
337+
Use the yum package management utility with the following command:
294338
295339
```
296340
yum remove patchman-client
@@ -302,52 +346,16 @@ or
302346
dnf remove patchman-client
303347
```
304348
305-
### Debian / Ubuntu
349+
#### Debian / Ubuntu
306350
307351
Use the apt package management utility with the following command:
308352
309353
```
310354
apt-get remove patchman-client
311355
```
312356
313-
### Cancelling the server license
357+
#### Cancelling the server license
314358
315-
Make sure to cancel the server license in the Patchman Portal. We strongly suggest you do this **_after_** the removal of the software from your system, because if the software is still running it may automatically request a new license on your account (according to the standard installation procedure).
359+
Make sure to cancel the server license in the Patchman Portal. We strongly suggest you do this **_after_** the removal of the software from your system, because if the software is still running it may automatically request a new license on your account (according to the standard installation procedure).
316360
317361
In the Patchman Portal, go to the server configuration page under Servers. If your plan requires advance notice for cancelling servers, click the red Cancel button to cancel your license and deactivate it per the renewal date. Otherwise, click the red Delete button to immediately remove the server license from your account. This will make sure you are no longer billed for this server.
318-
319-
* * *
320-
321-
### Installing imunify-antivirus with Patchman support
322-
323-
1. Find a license key on the [server add page](https://portal.patchman.co/servers/add/). It is displayed under the `During installation, enter the following license key:` section.
324-
325-
2. Install or update `imunify-antivirus`
326-
1. If imunify-antivirus is not yet installed on a server:
327-
```
328-
wget https://repo.imunify360.cloudlinux.com/defence360/imav-deploy.sh -O imav-deploy.sh
329-
bash imav-deploy.sh
330-
```
331-
2. If it is already installed, check if the version of imunify-antivirus is at least `8.5.6`
332-
```
333-
imunify-antivirus version
334-
8.5.6
335-
```
336-
If it's lower, then update imunify-antivirus using your system package manager.
337-
338-
3. Install the Patchman extension
339-
```
340-
imunify-antivirus patchman install
341-
```
342-
343-
4. Configure the license key (obtained in the first step)
344-
```
345-
imunify-antivirus patchman register '<regkey>'
346-
```
347-
348-
5. Enable the Patchman extension
349-
```
350-
imunify-antivirus config update '{"PATCHMAN": {"enable": true}}'
351-
```
352-
353-
6. Add the server in the Patchman portal on the [page with pending servers](https://portal.patchman.co/servers/add/multiple/)

0 commit comments

Comments
 (0)