@@ -15,34 +15,76 @@ our certification levels, see
1515
1616## Getting Started
1717
18+ ### Obtaining install package
19+
20+ The latest Conjur Inspect install package may either be downloaded from
21+ [ Releases] ( https://github.com/cyberark/conjur-inspect/releases ) or copied
22+ from a Conjur Enterprise Appliance container image (version 13.5 or later)
23+ with the following commands:
24+
25+ 1 . First, create a container instance using the Conjur Enterprise Appliance
26+ image. This doesn't need to be a configured Conjur instance, only a running
27+ container using the image:
28+
29+ ``` sh
30+ docker run -d --name conjur registry.tld/conjur-appliance:< version>
31+ ```
32+
33+ 2 . List the available Conjur Inspect install packages with the command:
34+
35+ ``` sh
36+ docker exec -it conjur ls -la /opt/conjur/conjur-inspect
37+ ```
38+
39+ This will output a file listing similar to:
40+
41+ ``` sh
42+ -rw-r--r-- 1 root root 32989 Oct 22 14:19 conjur-inspect_0.4.0_linux_386.tar.gz
43+ -rw-r--r-- 1 root root 32991 Oct 22 14:19 conjur-inspect_0.4.0_linux_amd64.tar.gz
44+ -rw-r--r-- 1 root root 32991 Oct 22 14:19 conjur-inspect_0.4.0_linux_arm64.tar.gz
45+ ```
46+
47+ 3 . Select the correct file based on your host system architecture and copy it
48+ to the host with the command:
49+
50+ ``` sh
51+ docker cp conjur:/opt/conjur/conjur-inspect/conjur-inspect_0.4.0_linux_amd64.tar.gz .
52+ ```
53+
54+ 4 . Remove the temporary Conjur container with the command:
55+
56+ ``` sh
57+ docker rm -f conjur
58+ ```
59+
1860### Installing
1961
20- To install Conjur Inspect, download the latest version for your system
21- architecture from [ Releases] ( https://github.com/cyberark/conjur-inspect/releases )
22- to your target host machine. This is the machine or VM where the Conjur
23- Enterprise container will run.
62+ To install Conjur Inspect, copy the install package for your system
63+ architecture to your target host machine. This is the machine or VM where the
64+ Conjur Enterprise container will run.
2465
2566Extract the tool from the gzip archive:
67+
2668``` sh-session
27- $ tar -xvf conjur-inspect-0.3 .0_amd64.tgz
69+ $ tar -xvf conjur-inspect-0.4 .0_amd64.tgz
2870```
2971
3072Or install it from one of the system packages:
3173
32- ```
33- yum install conjur-inspect_0.3 .0_amd64.rpm
74+ ``` sh
75+ yum install conjur-inspect_0.4 .0_amd64.rpm
3476```
3577
36- ```
37- apt install conjur-inspect_0.3 .0_386.deb
78+ ``` sh
79+ apt install conjur-inspect_0.4 .0_386.deb
3880```
3981
4082### Running
4183
4284Run Conjur Inspect with the following command as the same system user that will
4385run the Conjur container:
4486
45- ```
87+ ``` sh-session
4688$ conjur-inspect
4789```
4890
@@ -99,10 +141,20 @@ INFO - core file size (blocks, -c): 0
99141
100142Available options and flags may be view by running:
101143
102- ` ` `
144+ ` ` ` sh
103145conjur-inspect --help
104146` ` `
105147
148+ # # Gathering container specific inspection data
149+
150+ To gather inspection data for a Conjur Enterprise container that is already
151+ running, include the ` --container-id` argument with either the container name
152+ or ID. For example:
153+
154+ ` ` ` sh
155+ conjur-inspect --container-id conjur
156+ ` ` `
157+
106158# # Raw data report
107159
108160In addition to the output report, ` conjur-inspect` records the raw inspection
0 commit comments