Skip to content

Commit

Permalink
Fix documentation on bot list, custom namespace and publication. (nus…
Browse files Browse the repository at this point in the history
  • Loading branch information
ariscahyadi authored Apr 17, 2023
1 parent 59e3d2c commit 72eb315
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 10 deletions.
4 changes: 2 additions & 2 deletions Octo-App/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ First, create bot in specific node with this following format `setBotNode
setBotNode dynamic-bot-1 octobot-wk-1 nusncl1/healthcare-web-bot:latest python -u ./main.py -r patient
botname : dynamic-bot-1
nodename: octobot-wk-1
http://localhost:12321/api/v1/namespaces/default/pods
http://localhost:12321/api/v1/namespaces/octobot/pods
bot successfully in designated node
```

Expand All @@ -80,7 +80,7 @@ dynamic-bot-1 still terminating
....
botname : dynamic-bot-1
nodename: octobot-wk-2
http://localhost:12321/api/v1/namespaces/default/pods
http://localhost:12321/api/v1/namespaces/octobot/pods
bot successfully in designated node
```

Expand Down
11 changes: 7 additions & 4 deletions Octo-Bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,19 @@ please check each of the type of bot documentation below:
6. [TCP Sync attack bot for simulating DDoS using Python Scapy](synflood-attack-bot/README.md)
7. [File Transfer using SSH Protocol](file-transfer-bot/README.md)
8. [Customized web browsing for banking web application](banking-web-application-bot/README.md)
9. [Human-behave web browsing for banking web application](banking-web-app-human-bot/README.md)
10. [SSH client for simulating/testing SSH connection](ssh-connection-bot/README.md)
11. [Windows file sharing bot using SMB protocol](windows-share-smb-bot/README.md)

All the bots are also publish in [DockerHub](https://hub.docker.com/repositories/nusncl1/) to be pulled easier from the
orchestrator.

But in order to setup automatic build in the DockerHub when there is any changes
in the master branch of the Github repository, please follow this steps:
- Create repository in the Dockerhub with the same as in the Github
But in order to set up automatic build in the DockerHub when there is any changes
in the master branch of the GitHub repository, please follow this steps:
- Create repository in the Dockerhub with the same as in the GitHub
- In the `Builds Settings` section please check and do these sub-steps:

- Status Github Repository should be `Connected`
- Status GitHub Repository should be `Connected`
- Choose the name of repository name
- Add `BUILD RULES` by clicking `+` character
- Source Type `Branch`, Source `master`, Docker Tag `latest`, Dockerfile location `Octo-Bot/<botname>/`
Expand Down
8 changes: 4 additions & 4 deletions Octo-Play/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ main.py:~$ setBotNumbers 2
main.py:~$ addExecutor worker-1 busybox ping 8.8.8.8
main.py:~$ writeFile test5.yaml
main.py:~$ runFile test5.yaml
http://localhost:8001/apis/apps/v1/namespaces/default/deployments
http://localhost:8001/apis/apps/v1/namespaces/octobot/deployments
Success with status code 201
```

Expand Down Expand Up @@ -103,7 +103,7 @@ Please use this command to run the file in batch:

```console
main.py:~$ runFile test5.yaml test6.yaml test7.yaml
http://localhost:12321/apis/apps/v1/namespaces/default/deployments Success with status code 201
http://localhost:12321/apis/apps/v1/namespaces/default/deployments Success with status code 201
http://localhost:12321/apis/apps/v1/namespaces/default/deployments Success with status code 201
http://localhost:12321/apis/apps/v1/namespaces/octobot/deployments Success with status code 201
http://localhost:12321/apis/apps/v1/namespaces/octobot/deployments Success with status code 201
http://localhost:12321/apis/apps/v1/namespaces/octobot/deployments Success with status code 201
```
16 changes: 16 additions & 0 deletions Octo-Pro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,22 @@ worker-node Ready <none> 47h v1.16.0 10.0.0.215 <none> Ubunt
...
```

### Create Namespace for OctoBot
Create our own custom namespace for OctoBot with this following command:

```console
ncl@orchestrator:~/OctoBot/Octo-Pro$ kubectl create namespace octobot
namespace "octobot" created
```

Check namespace for OctoBot with this following command:

```console
ncl@orchestrator:~/OctoBot/Octo-Pro$ kubectl get namespaces
NAME STATUS ACTIVE
octobot Active 1m
```

### (Optional) Re-configure Broken Node or Failed Provisioning
If one of the node have some problem, use `config.sh` script with this following
to reconfigure the node without to do full installation:
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ CLI (command-line interface) or API (application programming interface).

1. [OctoBot: Human Activity Orchestration System for Cybersecurity Experiment and Exercise](https://ieeexplore.ieee.org/abstract/document/9458202)
2. [OctoBot: An Open-Source Orchestration System for a Wide Range Network Activity Generation](https://ieeexplore.ieee.org/abstract/document/9484537)
3. [Design and Implementation of Human-behave Bot for Realistic Web Browsing Activity Generation](https://informs-sim.org/wsc22papers/070.pdf)

## Credits

Expand Down

0 comments on commit 72eb315

Please sign in to comment.