Skip to content

Commit 5ae58f5

Browse files
authored
Update keploy-karaf.md
Signed-off-by: Sarthak Shyngle <[email protected]>
1 parent 619ae3b commit 5ae58f5

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,21 @@ keywords:
1414

1515
## Step 1: Download Required JARs and Keploy Version
1616

17-
Use Keploy's One click to install latest keploy binary -
17+
### Pre-requisites
18+
- Linux kernel **5.15 or higher**
19+
- Tested with distributions:
20+
- **Fedora 40+**
21+
- **Ubuntu 22.04+**
22+
- **Debian 12+**
23+
24+
### Install Keploy Binary
25+
Use Keploy's one-click installation to download and install the latest Keploy binary:
1826

1927
```bash
20-
curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh
28+
curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh
2129
```
2230

31+
### Download Required JARs
2332
Use `wget` to download the necessary JAR files:
2433

2534
- [io.keploy.agent-2.0.1.jar](https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/io.keploy.agent-2.0.1.jar)
@@ -32,9 +41,10 @@ wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/io.keploy.a
3241
wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/org.jacoco.agent-0.8.12-runtime.jar
3342
```
3443

44+
3545
## Step 2: Configure Apache Karaf
3646

37-
### Update `JAVA_OPTS` for Linux/Mac in `setenv` File
47+
### Update `JAVA_OPTS` for Linux in `setenv` File:
3848

3949
1. Navigate to the `bin` directory of your Apache Karaf installation.
4050
2. Open the `setenv` file for editing.
@@ -45,26 +55,6 @@ wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/org.jacoco.
4555
export JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/org.jacoco.agent-0.8.12-runtime.jar=address=*,port=36320,destfile=jacoco-it.exec,output=tcpserver"
4656
```
4757

48-
### Update `JAVA_OPTS` for Windows in `setenv.bat` File
49-
50-
1. Navigate to the `bin` directory of your Apache Karaf installation.
51-
2. Open the `setenv.bat` file for editing.
52-
3. Add the paths of the downloaded agents under the `JAVA_OPTS` section. For example:
53-
54-
```bat
55-
set JAVA_OPTS=-javaagent:/path/to/io.keploy.agent-2.0.1.jar
56-
set JAVA_OPTS=%JAVA_OPTS% -javaagent:/path/to/org.jacoco.agent-0.8.12-runtime.jar=address=*,port=36320,destfile=jacoco-it.exec,output=tcpserver
57-
```
58-
59-
### Set Environment Variables as Java System Properties on Windows
60-
61-
On Windows, all environment variables should be passed as `-D` system properties for Java. Update the `JAVA_OPTS` section in `setenv.bat` to include the required variables. For example:
62-
63-
```bat
64-
set JAVA_OPTS=%JAVA_OPTS% -DAPI_KEY=xRp5nyiQ+B6yltBUpw==
65-
set JAVA_OPTS=%JAVA_OPTS% -DKEPLOY_MODE=RECORD
66-
set JAVA_OPTS=%JAVA_OPTS% -javaagent:/path/to/org.jacoco.agent-0.8.12-runtime.jar=address=*,port=36320,destfile=jacoco-it.exec,output=tcpserver
67-
```
6858

6959
Replace the placeholder values with actual paths and keys as needed.
7060

0 commit comments

Comments
 (0)