Skip to content

Commit 2ae64db

Browse files
authored
fix(docs): use github markdown formatting for notes
Signed-off-by: Barun Acharya <[email protected]>
1 parent 6949c66 commit 2ae64db

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

getting-started/deployment_guide.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ curl -sfL http://get.kubearmor.io/ | sudo sh -s -- -b /usr/local/bin
2121
# sudo access is needed to install it in /usr/local/bin directory. But, if you prefer not to use sudo, you can install it in a different directory which is in your PATH.
2222
```
2323

24-
> **Note**: kArmor CLI provides a Developer Friendly way to interact with KubeArmor Telemetry. You can stream KubeArmor telemetry independently of kArmor CLI tool and integrate it with your chosen SIEM (Security Information and Event Management) solutions. [Here's a guide]((https://github.com/kubearmor/kubearmor-relay-server/blob/main/README.md#streaming-kubearmor-telemetry-to-external-siem-tools)) on how to achieve this integration. This guide assumes you have kArmor CLI to access KubeArmor Telemetry but you can view it on your SIEM tool once integrated.
24+
> [!NOTE]
25+
> kArmor CLI provides a Developer Friendly way to interact with KubeArmor Telemetry. You can stream KubeArmor telemetry independently of kArmor CLI tool and integrate it with your chosen SIEM (Security Information and Event Management) solutions. [Here's a guide](https://github.com/kubearmor/kubearmor-relay-server/blob/main/README.md#streaming-kubearmor-telemetry-to-external-siem-tools) on how to achieve this integration. This guide assumes you have kArmor CLI to access KubeArmor Telemetry but you can view it on your SIEM tool once integrated.
2526
2627
## Deploy test nginx app
2728

@@ -30,7 +31,8 @@ kubectl create deployment nginx --image=nginx
3031
POD=$(kubectl get pod -l app=nginx -o name)
3132
```
3233

33-
> Note: `$POD` is used to refer to the target nginx pod in many cases below.
34+
> [!NOTE]
35+
> `$POD` is used to refer to the target nginx pod in many cases below.
3436
3537
## Sample policies
3638

0 commit comments

Comments
 (0)