Skip to content

Commit

Permalink
chore(docs): update install docs with helm
Browse files Browse the repository at this point in the history
Signed-off-by: daemon1024 <barun1024@gmail.com>
  • Loading branch information
daemon1024 committed Oct 18, 2023
1 parent c4270dd commit c645789
Showing 1 changed file with 12 additions and 19 deletions.
31 changes: 12 additions & 19 deletions getting-started/deployment_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,22 @@ Check the [KubeArmor support matrix](support_matrix.md) to verify if your platfo

## Install KubeArmor
```
curl -sfL http://get.kubearmor.io/ | sudo sh -s -- -b /usr/local/bin
karmor install
helm repo add kubearmor https://kubearmor.github.io/charts
helm repo update kubearmor
helm upgrade --install kubearmor-operator kubearmor/kubearmor-operator -n kubearmor --create-namespace
kubectl apply -f https://raw.githubusercontent.com/kubearmor/KubeArmor/main/pkg/KubeArmorOperator/config/samples/sample-config.yml
```

<details>
<summary>Output of karmor install</summary>
You can find more details about helm related values and configurations [here](https://github.com/kubearmor/KubeArmor/tree/main/deployments/helm/KubeArmorOperator).

## Install kArmor CLI (Optional)

```
aws@pandora:~$ karmor install
Auto Detected Environment : docker
CRD kubearmorpolicies.security.kubearmor.com ...
CRD kubearmorhostpolicies.security.kubearmor.com ...
Service Account ...
Cluster Role Bindings ...
KubeArmor Relay Service ...
KubeArmor Relay Deployment ...
KubeArmor DaemonSet ...
KubeArmor Policy Manager Service ...
KubeArmor Policy Manager Deployment ...
KubeArmor Host Policy Manager Service ...
KubeArmor Host Policy Manager Deployment ...
curl -sfL http://get.kubearmor.io/ | sudo sh -s -- -b /usr/local/bin
# 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.
```
</details>

> **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.
## Deploy test nginx app

Expand Down Expand Up @@ -82,7 +75,7 @@ command terminated with exit code 126
</details>

<details>
<summary><h4>Get policy violations notifications</h4></summary>
<summary><h4>Get policy violations notifications using kArmor CLI</h4></summary>

```
karmor logs -n default --json
Expand Down

0 comments on commit c645789

Please sign in to comment.