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
A Kubernetes worker that pulls from a Kafka queue and performs a whitewater-detect-secrets scan.
2
+
A Kubernetes worker that pulls from a Kafka queue and performs a [detect-secrets](https://github.com/IBM/detect-secrets) scan.
3
3
4
4
Adapted from [this Kubernetes tutorial](https://kubernetes.io/docs/tasks/job/fine-parallel-processing-work-queue/) and [this IBM Event Streams code sample](https://github.com/ibm-messaging/event-streams-samples/tree/master/kafka-python-console-sample).
Copy file name to clipboardExpand all lines: docs/adding-a-new-detector.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Adding a new type of detector to detect-secrets-suite is a multi-stage process.
20
20
21
21
For detailed instructions on developing a new secret detector, see:
22
22
23
-
-[`IBM/detect-secrets` CONTRIBUTING.md - Process for Adding a New Secret Detector to whitewater-detect-secrets](https://github.com/IBM/detect-secrets/blob/master/CONTRIBUTING.md#process-for-adding-a-new-secret-detector-to-whitewater-detect-secrets)
23
+
-[`IBM/detect-secrets` CONTRIBUTING.md - Process for Adding a New Secret Detector to detect-secrets](https://github.com/IBM/detect-secrets/blob/master/CONTRIBUTING.md#process-for-adding-a-new-secret-detector-to-detect-secrets)
24
24
-[`IBM/detect-secrets-stream` CONTRIBUTING.md - Process for Supporting a New Secret Type in detect-secrets-stream](../CONTRIBUTING.md#process-for-supporting-a-new-secret-type-in-detect-secrets-stream)
25
25
26
26
Please open one or more PRs using the instructions above.
Copy file name to clipboardExpand all lines: kustomize_envs/dev/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# local end 2 end test
2
2
3
-
This doc describes how to use `skaffold` to run a detect-secrets-stream instance in a local kube env and run some end 2 end test.
3
+
This document describes how to use [`skaffold`](https://skaffold.dev/docs/references/cli/) to run a detect-secrets-stream instance in a local Kubernetes environment and run some end to end tests.
4
4
5
5
## Dependencies
6
6
@@ -10,11 +10,11 @@ This doc describes how to use `skaffold` to run a detect-secrets-stream instance
10
10
-`kustomize_envs/dev/secret_manual/app.key` stores the private key for this test Github App
11
11
-`APP_ID` in `kustomize_envs/dev/secret_manual/env.txt` stores the Github App ID
12
12
- a kafka queue named `diff-scan`
13
-
- You can request a free kafka instance in your own IBM Cloud account. Service link: https://cloud.ibm.com/catalog/services/event-streams. Once created, generate a queue named `diff-scan` in the kafka instance. **TODO** parameterize queue name
13
+
- You can request a free Kafka instance in your own IBM Cloud account. The service can be found [here](https://cloud.ibm.com/catalog/services/event-streams). Once created, generate a queue named `diff-scan` in the kafka instance. **TODO** parameterize queue name
14
14
15
15
### ondemand provision
16
16
17
-
The resource below would be automatically provisioned when you run skaffold
17
+
The resources below will be automatically provisioned when you run [`skaffold`](https://skaffold.dev/docs/references/cli/):
18
18
19
19
- postgres
20
20
- vault
@@ -46,7 +46,7 @@ kind delete cluster
46
46
47
47
## Execute test
48
48
49
-
The ingest script reads payload from `kustomize_envs/dev/test/ingest.payload.json`, you can edit that file to customize the payload such as which repo and which commit to ingest.
49
+
The ingest script reads payloads from `kustomize_envs/dev/test/ingest.payload.json`; you can edit this file to customize the payload, such as which repo and which commit to ingest.
0 commit comments