Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit 0aec8b9

Browse files
committed
Added some more quickstart documentation
1 parent 806bbb7 commit 0aec8b9

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,18 @@
1616

1717
<!-- toc -->
1818

19+
- [Overview](#overview)
1920
- [Purpose of this Project](#purpose-of-this-project)
2021
- [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)
2226
- [Architecture](#architecture)
23-
- [Roadmap](#roadmap)
27+
- [License](#license)
28+
- [Community](#community)
29+
- [Contributing](#contributing)
30+
- [Author Information](#author-information)
2431

2532
For additional documentation aspects please have a look at our:
2633

@@ -57,22 +64,45 @@ There is a german article about [Security DevOps – Angreifern (immer) einen Sc
5764
kubectl create namespace securecodebox-system
5865
helm -n securecodebox-system install securecodebox-operator ./operator/
5966

60-
# Elasticsearch Persistence Provider Deployment
61-
helm install persistence-elastic ./persistence/persistence-elastic/
62-
6367
# Deploy definitions for the integrated scanners
6468
helm install amass ./integrations/amass/
6569
helm install kube-hunter ./integrations/kube-hunter/
6670
helm install nikto ./integrations/nikto
6771
helm install nmap ./integrations/nmap/
6872
helm install ssh-scan ./integrations/ssh_scan/
6973
helm install sslyze ./integrations/sslyze/
74+
helm install trivy ./integrations/trivy/
7075
helm install zap ./integrations/zap/
7176

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+
```
7387

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
74100
# 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
76106
# Then get the current State of the Scan by running:
77107
kubectl get scans
78108
```

0 commit comments

Comments
 (0)