Skip to content

Commit

Permalink
update documents
Browse files Browse the repository at this point in the history
Signed-off-by: Jaehyun Nam <[email protected]>
  • Loading branch information
nam-jaehyun committed Mar 11, 2022
1 parent 36e2f75 commit a97df0d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions contribution/testing_guide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Testing Guide

There are two ways to check the functionalities of KubeArmor: 1) testing kubeArmor in manual and 2) using the testing framework.
There are two ways to check the functionalities of KubeArmor: 1) testing kubeArmor manually and 2) using the testing framework.

# 1. Test KubeArmor in manual
# 1. Test KubeArmor manually

## 1.1. Run 'kubectl proxy' in background

Expand Down Expand Up @@ -73,7 +73,7 @@ $ kubectl -n [namespace name] exec -it [pod name] -- bash -c [command]
--msgPath string Output location for messages, {path|stdout|none} (default "none")
```
Note that you will see alerts and logs generated right after `karmor` runs logs; thus, we recommend to run the above command in other terminal to see logs live and in an interactive way to avoid any kind of interference.
Note that you will see alerts and logs generated right after `karmor` runs logs; thus, we recommend to run the above command in other terminal to see logs live.
# 2. Test KubeArmor using the auto-testing framework
Expand Down Expand Up @@ -174,7 +174,7 @@ The auto-testing framework operates based on two things: microservices and testc
- The case that KubeArmor is running as a daemonset in Kubernetes
Run the auto-testing framework
Run the testing framework
```text
$ cd KubeArmor/tests
Expand Down
2 changes: 1 addition & 1 deletion getting-started/kubearmor_vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The recipe installs `kubearmor` as systemd process and `karmor` cli tool to mana

2. Download release tarball from KubeArmor releases for the version you want
```
wget https://github.com/daemon1024/KubeArmor/releases/download/v${VER}/kubearmor_${VER}_linux-amd64.tar.gz
wget https://github.com/KubeArmor/KubeArmor/releases/download/v${VER}/kubearmor_${VER}_linux-amd64.tar.gz
```

3. Unpack the tarball to the root directory:
Expand Down

0 comments on commit a97df0d

Please sign in to comment.