Skip to content

Commit b017ae6

Browse files
rseedorffrfelber
authored andcommitted
Updating Helm Docs
Signed-off-by: Robert Seedorff <Robert.Seedorff@iteratec.com>
1 parent a37b572 commit b017ae6

44 files changed

Lines changed: 1006 additions & 472 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

demo-targets/bodgeit/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,6 @@ The bodgeit `scanType` can be deployed via helm:
5959
helm upgrade --install bodgeit secureCodeBox/bodgeit
6060
```
6161

62-
## Contributing
63-
64-
Contributions are welcome and extremely helpful 🙌
65-
Please have a look at [Contributing](./CONTRIBUTING.md)
66-
67-
## Community
68-
69-
You are welcome, please join us on... 👋
70-
71-
- [GitHub][scb-github]
72-
- [Slack][scb-slack]
73-
- [Twitter][scb-twitter]
74-
75-
secureCodeBox is an official [OWASP][scb-owasp] project.
76-
7762
## Values
7863

7964
| Key | Type | Default | Description |
@@ -101,6 +86,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
10186
| service.type | string | `"ClusterIP"` | |
10287
| tolerations | list | `[]` | |
10388

89+
## Contributing
90+
91+
Contributions are welcome and extremely helpful 🙌
92+
Please have a look at [Contributing](./CONTRIBUTING.md)
93+
94+
## Community
95+
96+
You are welcome, please join us on... 👋
97+
98+
- [GitHub][scb-github]
99+
- [Slack][scb-slack]
100+
- [Twitter][scb-twitter]
101+
102+
secureCodeBox is an official [OWASP][scb-owasp] project.
103+
104104
## License
105105
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
106106

demo-targets/dummy-ssh/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,6 @@ The dummy-ssh `scanType` can be deployed via helm:
6262
helm upgrade --install dummy-ssh secureCodeBox/dummy-ssh
6363
```
6464

65-
## Contributing
66-
67-
Contributions are welcome and extremely helpful 🙌
68-
Please have a look at [Contributing](./CONTRIBUTING.md)
69-
70-
## Community
71-
72-
You are welcome, please join us on... 👋
73-
74-
- [GitHub][scb-github]
75-
- [Slack][scb-slack]
76-
- [Twitter][scb-twitter]
77-
78-
secureCodeBox is an official [OWASP][scb-owasp] project.
79-
8065
## Values
8166

8267
| Key | Type | Default | Description |
@@ -99,6 +84,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
9984
| service.type | string | `"ClusterIP"` | |
10085
| tolerations | list | `[]` | |
10186

87+
## Contributing
88+
89+
Contributions are welcome and extremely helpful 🙌
90+
Please have a look at [Contributing](./CONTRIBUTING.md)
91+
92+
## Community
93+
94+
You are welcome, please join us on... 👋
95+
96+
- [GitHub][scb-github]
97+
- [Slack][scb-slack]
98+
- [Twitter][scb-twitter]
99+
100+
secureCodeBox is an official [OWASP][scb-owasp] project.
101+
102102
## License
103103
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
104104

demo-targets/http-webhook/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,6 @@ The http-webhook `scanType` can be deployed via helm:
5656
helm upgrade --install http-webhook secureCodeBox/http-webhook
5757
```
5858

59-
## Contributing
60-
61-
Contributions are welcome and extremely helpful 🙌
62-
Please have a look at [Contributing](./CONTRIBUTING.md)
63-
64-
## Community
65-
66-
You are welcome, please join us on... 👋
67-
68-
- [GitHub][scb-github]
69-
- [Slack][scb-slack]
70-
- [Twitter][scb-twitter]
71-
72-
secureCodeBox is an official [OWASP][scb-owasp] project.
73-
7459
## Values
7560

7661
| Key | Type | Default | Description |
@@ -106,6 +91,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
10691
| serviceAccount.name | string | `""` | |
10792
| tolerations | list | `[]` | |
10893

94+
## Contributing
95+
96+
Contributions are welcome and extremely helpful 🙌
97+
Please have a look at [Contributing](./CONTRIBUTING.md)
98+
99+
## Community
100+
101+
You are welcome, please join us on... 👋
102+
103+
- [GitHub][scb-github]
104+
- [Slack][scb-slack]
105+
- [Twitter][scb-twitter]
106+
107+
secureCodeBox is an official [OWASP][scb-owasp] project.
108+
109109
## License
110110
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
111111

demo-targets/juice-shop/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,6 @@ The juice-shop `scanType` can be deployed via helm:
5959
helm upgrade --install juice-shop secureCodeBox/juice-shop
6060
```
6161

62-
## Contributing
63-
64-
Contributions are welcome and extremely helpful 🙌
65-
Please have a look at [Contributing](./CONTRIBUTING.md)
66-
67-
## Community
68-
69-
You are welcome, please join us on... 👋
70-
71-
- [GitHub][scb-github]
72-
- [Slack][scb-slack]
73-
- [Twitter][scb-twitter]
74-
75-
secureCodeBox is an official [OWASP][scb-owasp] project.
76-
7762
## Values
7863

7964
| Key | Type | Default | Description |
@@ -101,6 +86,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
10186
| service.type | string | `"ClusterIP"` | |
10287
| tolerations | list | `[]` | |
10388

89+
## Contributing
90+
91+
Contributions are welcome and extremely helpful 🙌
92+
Please have a look at [Contributing](./CONTRIBUTING.md)
93+
94+
## Community
95+
96+
You are welcome, please join us on... 👋
97+
98+
- [GitHub][scb-github]
99+
- [Slack][scb-slack]
100+
- [Twitter][scb-twitter]
101+
102+
secureCodeBox is an official [OWASP][scb-owasp] project.
103+
104104
## License
105105
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
106106

demo-targets/old-wordpress/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,6 @@ The old-wordpress `scanType` can be deployed via helm:
5656
helm upgrade --install old-wordpress secureCodeBox/old-wordpress
5757
```
5858

59-
## Contributing
60-
61-
Contributions are welcome and extremely helpful 🙌
62-
Please have a look at [Contributing](./CONTRIBUTING.md)
63-
64-
## Community
65-
66-
You are welcome, please join us on... 👋
67-
68-
- [GitHub][scb-github]
69-
- [Slack][scb-slack]
70-
- [Twitter][scb-twitter]
71-
72-
secureCodeBox is an official [OWASP][scb-owasp] project.
73-
7459
## Values
7560

7661
| Key | Type | Default | Description |
@@ -93,6 +78,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
9378
| service.type | string | `"ClusterIP"` | |
9479
| tolerations | list | `[]` | |
9580

81+
## Contributing
82+
83+
Contributions are welcome and extremely helpful 🙌
84+
Please have a look at [Contributing](./CONTRIBUTING.md)
85+
86+
## Community
87+
88+
You are welcome, please join us on... 👋
89+
90+
- [GitHub][scb-github]
91+
- [Slack][scb-slack]
92+
- [Twitter][scb-twitter]
93+
94+
secureCodeBox is an official [OWASP][scb-owasp] project.
95+
9696
## License
9797
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
9898

demo-targets/swagger-petstore/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,6 @@ The swagger-petstore `scanType` can be deployed via helm:
5757
helm upgrade --install swagger-petstore secureCodeBox/swagger-petstore
5858
```
5959

60-
## Contributing
61-
62-
Contributions are welcome and extremely helpful 🙌
63-
Please have a look at [Contributing](./CONTRIBUTING.md)
64-
65-
## Community
66-
67-
You are welcome, please join us on... 👋
68-
69-
- [GitHub][scb-github]
70-
- [Slack][scb-slack]
71-
- [Twitter][scb-twitter]
72-
73-
secureCodeBox is an official [OWASP][scb-owasp] project.
74-
7560
## Values
7661

7762
| Key | Type | Default | Description |
@@ -100,6 +85,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
10085
| swaggerHostOverride | string | `"http://swagger-petstore.demo-targets.svc"` | |
10186
| tolerations | list | `[]` | |
10287

88+
## Contributing
89+
90+
Contributions are welcome and extremely helpful 🙌
91+
Please have a look at [Contributing](./CONTRIBUTING.md)
92+
93+
## Community
94+
95+
You are welcome, please join us on... 👋
96+
97+
- [GitHub][scb-github]
98+
- [Slack][scb-slack]
99+
- [Twitter][scb-twitter]
100+
101+
secureCodeBox is an official [OWASP][scb-owasp] project.
102+
103103
## License
104104
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
105105

demo-targets/unsafe-https/docs/README.ArtifactHub.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,6 @@ The unsafe-https `scanType` can be deployed via helm:
5858
helm upgrade --install unsafe-https secureCodeBox/unsafe-https
5959
```
6060

61-
## Contributing
62-
63-
Contributions are welcome and extremely helpful 🙌
64-
Please have a look at [Contributing](./CONTRIBUTING.md)
65-
66-
## Community
67-
68-
You are welcome, please join us on... 👋
69-
70-
- [GitHub][scb-github]
71-
- [Slack][scb-slack]
72-
- [Twitter][scb-twitter]
73-
74-
secureCodeBox is an official [OWASP][scb-owasp] project.
75-
7661
## Values
7762

7863
| Key | Type | Default | Description |
@@ -95,6 +80,21 @@ secureCodeBox is an official [OWASP][scb-owasp] project.
9580
| service.type | string | `"ClusterIP"` | |
9681
| tolerations | list | `[]` | |
9782

83+
## Contributing
84+
85+
Contributions are welcome and extremely helpful 🙌
86+
Please have a look at [Contributing](./CONTRIBUTING.md)
87+
88+
## Community
89+
90+
You are welcome, please join us on... 👋
91+
92+
- [GitHub][scb-github]
93+
- [Slack][scb-slack]
94+
- [Twitter][scb-twitter]
95+
96+
secureCodeBox is an official [OWASP][scb-owasp] project.
97+
9898
## License
9999
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
100100

hooks/cascading-scans/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Otherwise your changes will be reverted/overriden automaticaly due to the build
3434

3535
## What is "Cascading Scans" Hook about?
3636
The Cascading Scans Hook can be used to orchestrate security scanners based on defined rule sets.
37-
The so called `CascadingRules` consist of a `matches section which contains one or multiple rules which are compared against `findings`. When a `finding` matches a `rule` the `scanSpec` section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language can be used to reference fields of the finding.
37+
The so called `CascadingRules` consist of a `matches` section which contains one or multiple rules which are compared against `findings`. When a `finding` matches a `rule` the `scanSpec` section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language can be used to reference fields of the finding.
3838

3939
<-- Todo: should be replaced with an valid docs.secureCodeBox.io link as soon as all ADRs are added there -->
4040
This Hook is based on the ADR https://github.com/secureCodeBox/secureCodeBox/blob/main/docs/adr/adr_0003.md
@@ -58,7 +58,7 @@ Installing the `Cascading Scans` hook will add a `ReadOnly Hook` to your namespa
5858
```bash
5959
kubectl get ScanCompletionHooks
6060
NAME TYPE IMAGE
61-
dssh ReadOnly docker.io/securecodebox/hook-declarative-subsequent-scans:latest
61+
dssh ReadOnly docker.io/securecodebox/hook-cascading-scans:latest
6262
```
6363

6464
### CascadingScan Rules

hooks/cascading-scans/docs/README.ArtifactHub.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You can find resources to help you get started on our [documentation website](ht
4242

4343
## What is "Cascading Scans" Hook about?
4444
The Cascading Scans Hook can be used to orchestrate security scanners based on defined rule sets.
45-
The so called `CascadingRules` consist of a `matches section which contains one or multiple rules which are compared against `findings`. When a `finding` matches a `rule` the `scanSpec` section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language can be used to reference fields of the finding.
45+
The so called `CascadingRules` consist of a `matches` section which contains one or multiple rules which are compared against `findings`. When a `finding` matches a `rule` the `scanSpec` section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language can be used to reference fields of the finding.
4646

4747
<-- Todo: should be replaced with an valid docs.secureCodeBox.io link as soon as all ADRs are added there -->
4848
This Hook is based on the ADR https://github.com/secureCodeBox/secureCodeBox/blob/main/docs/adr/adr_0003.md
@@ -55,21 +55,6 @@ The cascading-scans `scanType` can be deployed via helm:
5555
helm upgrade --install cascading-scans secureCodeBox/cascading-scans
5656
```
5757

58-
## Contributing
59-
60-
Contributions are welcome and extremely helpful 🙌
61-
Please have a look at [Contributing](./CONTRIBUTING.md)
62-
63-
## Community
64-
65-
You are welcome, please join us on... 👋
66-
67-
- [GitHub][scb-github]
68-
- [Slack][scb-slack]
69-
- [Twitter][scb-twitter]
70-
71-
secureCodeBox is an official [OWASP][scb-owasp] project.
72-
7358
## Requirements
7459

7560
Kubernetes: `>=v1.11.0-0`
@@ -81,7 +66,7 @@ Installing the `Cascading Scans` hook will add a `ReadOnly Hook` to your namespa
8166
```bash
8267
kubectl get ScanCompletionHooks
8368
NAME TYPE IMAGE
84-
dssh ReadOnly docker.io/securecodebox/hook-declarative-subsequent-scans:latest
69+
dssh ReadOnly docker.io/securecodebox/hook-cascading-scans:latest
8570
```
8671

8772
### CascadingScan Rules
@@ -184,6 +169,21 @@ zap-http zap-baseline-scan non-invasive medium
184169
| hook.image.tag | string | defaults to the charts version | The image Tag defaults to the charts version if not defined. |
185170
| hook.ttlSecondsAfterFinished | string | `nil` | Seconds after which the kubernetes job for the hook will be deleted. Requires the Kubernetes TTLAfterFinished controller: https://kubernetes.io/docs/concepts/workloads/controllers/ttlafterfinished/ |
186171

172+
## Contributing
173+
174+
Contributions are welcome and extremely helpful 🙌
175+
Please have a look at [Contributing](./CONTRIBUTING.md)
176+
177+
## Community
178+
179+
You are welcome, please join us on... 👋
180+
181+
- [GitHub][scb-github]
182+
- [Slack][scb-slack]
183+
- [Twitter][scb-twitter]
184+
185+
secureCodeBox is an official [OWASP][scb-owasp] project.
186+
187187
## License
188188
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
189189

hooks/cascading-scans/docs/README.DockerHub-Hook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ docker pull securecodebox/hook-cascading-scans
5353

5454
## What is "Cascading Scans" Hook about?
5555
The Cascading Scans Hook can be used to orchestrate security scanners based on defined rule sets.
56-
The so called `CascadingRules` consist of a `matches section which contains one or multiple rules which are compared against `findings`. When a `finding` matches a `rule` the `scanSpec` section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language can be used to reference fields of the finding.
56+
The so called `CascadingRules` consist of a `matches` section which contains one or multiple rules which are compared against `findings`. When a `finding` matches a `rule` the `scanSpec` section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language can be used to reference fields of the finding.
5757

5858
<-- Todo: should be replaced with an valid docs.secureCodeBox.io link as soon as all ADRs are added there -->
5959
This Hook is based on the ADR https://github.com/secureCodeBox/secureCodeBox/blob/main/docs/adr/adr_0003.md

0 commit comments

Comments
 (0)