You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The secureCodeBox operator is running on Kubernetes and is the core component of the complete secureCodeBox stack, responsible for managing all scans and resources.
| serviceAccount.name | string |`"securecodebox-operator"`| Name of the serviceAccount the operator uses to talk to the k8s api |
66
111
| telemetryEnabled | bool |`true`| The Operator sends anonymous telemetry data, to give the team an overview how much the secureCodeBox is used. Find out more at https://www.securecodebox.io/telemetry|
67
112
68
-
----------------------------------------------
69
-
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
_[OWASP secureCodeBox][scb-github]_ is an automated and scalable open source solution that can be used to integrate various *security vulnerability scanners* with a simple and lightweight interface. The _secureCodeBox_ mission is to support *DevSecOps* Teams to make it easy to automate security vulnerability testing in different scenarios.
34
+
35
+
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
36
+
37
+
The secureCodeBox project is running on [Kubernetes](https://kubernetes.io/). To install it you need [Helm](https://helm.sh), a package manager for Kubernetes. It is also possible to start the different integrated security vulnerability scanners based on a docker infrastructure.
38
+
39
+
### Quickstart with secureCodeBox on kubernetes
40
+
41
+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox project](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
42
+
43
+
## What is secureCodeBox Operator?
44
+
The secureCodeBox operator is running on Kubernetes and is the core component of the complete secureCodeBox stack, responsible for managing all scans and resources.
| customCACertificate | object |`{"certificate":"public.crt","existingCertificate":null}`| Setup for Custom CA certificates. These are automatically mounted into every secureCodeBox component (lurcher, parser & hooks). Requires that every namespace has a configmap with the CA certificate(s) |
82
+
| customCACertificate.certificate | string |`"public.crt"`| key in the configmap holding the certificate(s) |
83
+
| customCACertificate.existingCertificate | string |`nil`| name of the configMap holding the ca certificate(s), needs to be the same across all namespaces |
| minio.enabled | bool |`true`| Enable this to use minio as storage backend instead of a cloud bucket provider like AWS S3, Google Cloud Storage, DigitalOcean Spaces etc. |
| podSecurityContext | object |`{}`| Sets the securityContext on the operators pod level. See: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container|
| s3.authType | string |`"access-secret-key"`| Authentication method. Supports access-secret-key (used by most s3 endpoint) and aws-irsa (Used by AWS EKS IAM Role to Kubenetes Service Account Binding. Support for AWS IRSA is considered experimental in the secureCodeBox) |
99
+
| s3.awsStsEndpoint | string |`"https://sts.amazonaws.com"`| STS Endpoint used in AWS IRSA Authentication. Change this to the sts endpoint of your aws region. Only used when s3.authType is set to "aws-irsa" |
| securityContext | object |`{"allowPrivilegeEscalation":false,"capabilities":{"drop":["all"]},"privileged":false,"readOnlyRootFilesystem":true,"runAsNonRoot":true}`| Sets the securityContext on the operators container level. See: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod|
108
+
| securityContext.allowPrivilegeEscalation | bool |`false`| Ensure that users privileges cannot be escalated |
109
+
| securityContext.capabilities.drop[0]| string |`"all"`| This drops all linux privileges from the operator container. They are not required |
110
+
| securityContext.privileged | bool |`false`| Ensures that the operator container is not run in privileged mode |
111
+
| securityContext.readOnlyRootFilesystem | bool |`true`| Prevents write access to the containers file system |
112
+
| securityContext.runAsNonRoot | bool |`true`| Enforces that the Operator image is run as a non root user |
113
+
| serviceAccount.annotations | object |`{}`| Annotations of the serviceAccount the operator uses to talk to the k8s api |
114
+
| serviceAccount.labels | object |`{}`| Labels of the serviceAccount the operator uses to talk to the k8s api |
115
+
| serviceAccount.name | string |`"securecodebox-operator"`| Name of the serviceAccount the operator uses to talk to the k8s api |
116
+
| telemetryEnabled | bool |`true`| The Operator sends anonymous telemetry data, to give the team an overview how much the secureCodeBox is used. Find out more at https://www.securecodebox.io/telemetry|
117
+
118
+
## Contributing
119
+
120
+
Contributions are welcome and extremely helpful 🙌
121
+
Please have a look at [Contributing](./CONTRIBUTING.md)
122
+
123
+
## Community
124
+
125
+
You are welcome, please join us on... 👋
126
+
127
+
-[GitHub][scb-github]
128
+
-[Slack][scb-slack]
129
+
-[Twitter][scb-twitter]
130
+
131
+
secureCodeBox is an official [OWASP][scb-owasp] project.
_[OWASP secureCodeBox][scb-github]_ is an automated and scalable open source solution that can be used to integrate various *security vulnerability scanners* with a simple and lightweight interface. The _secureCodeBox_ mission is to support *DevSecOps* Teams to make it easy to automate security vulnerability testing in different scenarios.
34
+
35
+
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
36
+
37
+
The secureCodeBox project is running on [Kubernetes](https://kubernetes.io/). To install it you need [Helm](https://helm.sh), a package manager for Kubernetes. It is also possible to start the different integrated security vulnerability scanners based on a docker infrastructure.
38
+
39
+
### Quickstart with secureCodeBox on kubernetes
40
+
41
+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox project](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
42
+
43
+
## Supported Tags
44
+
-`latest` (represents the latest stable release build)
45
+
- tagged releases, e.g. `v2.7.0-alpha1`
46
+
47
+
## How to use this image
48
+
This `core` image is intended to work in combination with the OWASP secureCodeBox. For more informations details please take a look at the documentation page: https://docs.securecodebox.io/docs/getting-started/installation.
49
+
50
+
```bash
51
+
docker pull securecodebox/operator
52
+
```
53
+
54
+
## What is secureCodeBox Operator?
55
+
The secureCodeBox operator is running on Kubernetes and is the core component of the complete secureCodeBox stack, responsible for managing all scans and resources.
View [license information](https://github.com/secureCodeBox/secureCodeBox/blob/master/LICENSE) for the software contained in this image.
73
+
74
+
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
75
+
76
+
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
0 commit comments