|
16 | 16 |
|
17 | 17 | <!-- toc --> |
18 | 18 |
|
| 19 | +- [Overview](#overview) |
19 | 20 | - [Purpose of this Project](#purpose-of-this-project) |
20 | 21 | - [Quickstart](#quickstart) |
21 | | -- [How Does it Work?](#how-does-it-work) |
| 22 | + - [Prerequisites](#prerequisites) |
| 23 | + - [Deployment](#deployment) |
| 24 | + - [Examples](#examples) |
| 25 | +- [How does it work?](#how-does-it-work) |
22 | 26 | - [Architecture](#architecture) |
23 | | -- [Roadmap](#roadmap) |
| 27 | +- [License](#license) |
| 28 | +- [Community](#community) |
| 29 | +- [Contributing](#contributing) |
| 30 | +- [Author Information](#author-information) |
24 | 31 |
|
25 | 32 | For additional documentation aspects please have a look at our: |
26 | 33 |
|
@@ -57,22 +64,45 @@ There is a german article about [Security DevOps – Angreifern (immer) einen Sc |
57 | 64 | kubectl create namespace securecodebox-system |
58 | 65 | helm -n securecodebox-system install securecodebox-operator ./operator/ |
59 | 66 |
|
60 | | -# Elasticsearch Persistence Provider Deployment |
61 | | -helm install persistence-elastic ./persistence/persistence-elastic/ |
62 | | - |
63 | 67 | # Deploy definitions for the integrated scanners |
64 | 68 | helm install amass ./integrations/amass/ |
65 | 69 | helm install kube-hunter ./integrations/kube-hunter/ |
66 | 70 | helm install nikto ./integrations/nikto |
67 | 71 | helm install nmap ./integrations/nmap/ |
68 | 72 | helm install ssh-scan ./integrations/ssh_scan/ |
69 | 73 | helm install sslyze ./integrations/sslyze/ |
| 74 | +helm install trivy ./integrations/trivy/ |
70 | 75 | helm install zap ./integrations/zap/ |
71 | 76 |
|
72 | | -# Now everything is installed. You can try deploying scans from the `operator/config/samples/` directory |
| 77 | +# Optional Deploy some Demo Apps for scanning |
| 78 | +helm install dummy-ssh ./demo-apps/dummy-ssh/ |
| 79 | + |
| 80 | +# Deploy secureCodeBox Hooks |
| 81 | +helm install add-attributes ./hooks/add-attributes/ |
| 82 | +helm install generic-webhook ./hooks/generic-webhook/ |
| 83 | + |
| 84 | +## Persistence Provider: Elasticsearch |
| 85 | +helm install persistence-elastic ./hooks/persistence-elastic/ |
| 86 | +``` |
73 | 87 |
|
| 88 | +### Examples |
| 89 | + |
| 90 | +```bash |
| 91 | +# Now everything is installed. You can try deploying scans from the `operator/config/samples/` directory |
| 92 | +## Localhost Scan Examples |
| 93 | +### E.g. localhost nmap scan |
| 94 | +kubectl apply -f operator/config/samples/execution_v1_scan/nmap_localhost.yaml |
| 95 | + |
| 96 | +kubectl apply -f operator/config/samples/execution_v1_scan/kube-hunter_in_cluster.yaml |
| 97 | +kubectl apply -f operator/config/samples/execution_v1_scan/trivy_mediawiki.yaml |
| 98 | +kubectl apply -f operator/config/samples/execution_v1_scan/trivy_juiceshop.yaml |
| 99 | +## Public Scan Examples |
74 | 100 | # E.g. www.securecodebox.io sslyze scan |
75 | | -kubectl apply apply -f operator/config/samples/execution_v1_scan/sslyze_securecodebox_io.yaml |
| 101 | +kubectl apply -f operator/config/samples/execution_v1_scan/amass_securecodebox_io.yaml |
| 102 | +kubectl apply -f operator/config/samples/execution_v1_scan/sslyze_securecodebox_io.yaml |
| 103 | +kubectl apply -f operator/config/samples/execution_v1_scan/nikto_securecodebox_io.yaml |
| 104 | + |
| 105 | +kubectl apply -f operator/config/samples/execution_v1_scan/ssh_iteratec_de.yaml |
76 | 106 | # Then get the current State of the Scan by running: |
77 | 107 | kubectl get scans |
78 | 108 | ``` |
|
0 commit comments