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
Copy file name to clipboardExpand all lines: docs/security-testing-orchestration/get-started/onboarding-guide.md
+45-27Lines changed: 45 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,8 @@ redirect_from:
11
11
---
12
12
13
13
```mdx-code-block
14
-
import set_up_harness_19 from './static/set-up-harness-for-sto-19.png'
15
14
import set_up_harness_20 from './static/set-up-harness-for-sto-20.png'
16
-
import set_up_harness_20_NEW from './static/setup-tutorial-create-base-pipeline-select-module.png'
15
+
import set_up_harness_20_NEW from './static/set_up_harness_20_NEW.png'
17
16
import set_up_harness_21 from './static/set-up-harness-for-sto-21.png'
18
17
import set_up_harness_22 from './static/set-up-harness-for-sto-22.png'
19
18
import set_up_harness_23 from './static/set-up-harness-for-sto-23.png'
@@ -92,16 +91,25 @@ You need Administrative privileges at the Account level (Account Admin role) to
92
91
93
92
You need a Harness build infrastructure to run scans in STO. First, review the supported build infrastructures in [What's supported in Harness STO](/docs/security-testing-orchestration/whats-supported). Then select the infrastructure you want to use:
94
93
95
-
-[Harness Cloud build infrastructure](#use-harness-cloud-build-infrastructure-for-sto) This is the simplest option. No initial setup is required.
96
-
-[Local Kubernetes build infrastructure](#install-a-kubernetes-delegate-for-sto) Recommended when you want to run ephemeral builds-at-scale in your own infrastructure.
97
-
-[Local Docker build infrastructure](#install-a-local-docker-delegate-for-sto) Recommended for small, limited builds, such as a one-off build on your local machine.
#### Use Harness Cloud build infrastructure for STO
96
+
This is the simplest option. Not initial setup is required. Run your pipelines on Harness-hosted VMs preconfigured with tools, packages, and settings commonly used in CI pipelines.
100
97
101
-
With Harness Cloud, you can run builds in isolation on Harness-hosted VMs that are preconfigured with tools, packages, and settings commonly used in CI pipelines. Harness hosts, maintains, and upgrades these machines so that you can focus on building software instead of maintaining build infrastructure. No initial setup is required.
For more information, go to [Use Harness Cloud build infrastructure](/docs/continuous-integration/use-ci/set-up-build-infrastructure/use-harness-cloud-build-infrastructure).
100
+
Recommended when you want to run ephemeral builds-at-scale in your own infrastructure.
Recommended for small, limited builds, such as a one-off build on your local machine.
105
+
106
+
:::note
107
+
108
+
Kubernetes and Docker infrastructures might also require a Docker-in-Docker background step in your pipeline. For more information, go to [Docker-in-Docker requirements for STO](/docs/security-testing-orchestration/sto-techref-category/security-step-settings-reference#docker-in-docker-requirements-for-sto).
109
+
110
+
:::
111
+
112
+
<!--
105
113
106
114
#### Install a Kubernetes delegate for STO
107
115
@@ -165,6 +173,8 @@ A local runner build infrastructure is recommended for small, limited builds, su
165
173
166
174
For more information, go to [Set up a local runner build infrastructure](/docs/continuous-integration/use-ci/set-up-build-infrastructure/define-a-docker-build-infrastructure) in the CI documentation.
167
175
176
+
-->
177
+
168
178
169
179
### Create secrets for your Git and DockerHub access credentials
170
180
@@ -251,35 +261,37 @@ To do the STO tutorials, point the connector at the following repo: <https://git
251
261
252
262
</details>
253
263
254
-
## Create a base pipeline for STO
264
+
## Next steps
255
265
256
-
The following procedure creates a pipeline with the STO functionality required to run scans on your repos, images, and instances. Once you set up this pipeline, you can clone it to a new pipeline and update the pipeline to set up your scans.
266
+
Now that you've set up Harness, you're ready to start using STO.
257
267
258
-
This workflow is covered in [Your first STO pipeline](/tutorials/security-tests/your-first-sto-pipeline).
268
+
A good next step is to go through [Your first STO pipeline](/tutorials/security-tests/your-first-sto-pipeline). This tutorial covers the basic concepts of STO. You'll set up a standalone pipeline with one scanner, run scans, analyze the results, and learn how to investigate and fix detected vulnerabilities.
259
269
260
-
### Add a Security Test stage
270
+
The [STO tutorials](/tutorials/security-tests) also include a set of quickstarts and end-to-end workflows that show you how to create pipelines that you can apply to a wide variety of security-related use cases.
261
271
262
-
1. In the Pipeline Studio, select **Home** > **Projects** and choose the project where you want to create the pipeline.
272
+
Happy scanning!
263
273
264
-
<!--import set-up-harness-19 from './static/set-up-harness-for-sto-19.png' -->
274
+
<!--
265
275
266
-
```mdx-code-block
267
-
<img src={set_up_harness_19} alt="Choose the project" height="50%" width="75%" />
268
-
```
276
+
## Create a base pipeline for STO
277
+
278
+
The following procedure creates a pipeline with the STO functionality required to run scans on your repos, images, and instances. This pipeline uses [Bandit](https://github.com/PyCQA/bandit), an open-source tool designed to find common security issues in Python code. Once you set up this pipeline, you can clone it to a new pipeline and update the pipeline to set up your scans.
279
+
280
+
This workflow is covered in [Your first STO pipeline](/tutorials/security-tests/your-first-sto-pipeline).
<img src={set_up_harness_20_NEW} alt="Choose the STO module" height="50%" width="50%" />
277
290
```
278
-
-->
291
+
279
292
280
293
3. In Create New Pipeline:
281
-
1. Select **Pipelines** > **Create a Pipeline**.
282
-
2. In Create new Pipeline > Name, enter **sto-pipeline-base**.
294
+
1. For Name, enter **sto-pipeline-base**.
283
295
3. Select **Start**.
284
296
285
297
```mdx-code-block
@@ -289,8 +301,10 @@ This workflow is covered in [Your first STO pipeline](/tutorials/security-tests/
289
301
4. In About your Stage:
290
302
1. Select **Add Stage** and then **Security Tests**.
291
303
2. Stage Name = **securityTestStage**
292
-
3. Connector = The connector you created in [Create a Codebase Connector](#create-a-codebase-connector).
293
-
4. Select **Set Up Stage**.
304
+
3. Configure Codebase:
305
+
1. Select **Third-party Git provider** (if this option is available)
306
+
2. Connector = The connector you created in [Create a Codebase Connector](#create-a-codebase-connector)
307
+
3. Repository Name = **dvpwa**
294
308
295
309
```mdx-code-block
296
310
<img src={set_up_harness_22} alt="Set up the stage" height="50%" width="50%" />
@@ -326,7 +340,7 @@ In the **Execution** tab, do the following:
326
340
```mdx-code-block
327
341
<img src={set_up_harness_25} alt="Configure the background step" height="75%" width="75%" />
328
342
```
329
-
-->
343
+
330
344
331
345
### Add a Bandit scanner step
332
346
@@ -336,7 +350,7 @@ import set_up_harness_26 from './static/configure-bandit-step.png'
336
350
```
337
351
338
352
339
-
1. In the Execution tab, select **Add Step**and then**Bandit**.
353
+
1. In the Execution tab, select **Add Step** > **Security Tests** > **Bandit**.
340
354
2. Configure the step as follows:
341
355
1. Scan Mode = **`Orchestration`**
342
356
2. Target Name = `**dvpwa**`
@@ -361,8 +375,12 @@ import set_up_harness_26 from './static/configure-bandit-step.png'
361
375
2. Select Git Branch, enter **master** for the branch name, and then select **Run Pipeline**.
362
376
3. When the pipeline finishes, select the **Security Tests** tab to see the dashboard.
363
377
378
+
379
+
364
380
# Congratulations!
365
381
366
382
You now have the build infrastructure, connectors, and pipeline required to build a pipeline and run security scans. You can simply clone the pipeline you just created and configure new pipelines based on your security requirements.
The following workflows and [tutorials](/tutorials/security-tests) are available. Harness recommends you do them in this order.
10
+
The following workflows and [tutorials](/tutorials/security-tests) are available.
11
11
12
-
1.[Set up Harness for STO](/docs/security-testing-orchestration/get-started/onboarding-guide) This is a good primer if you're new to Harness. It guides you through the process of setting up your connectors, delegate, and build infrastructure. Then it guides you through the process of setting up a simple standalone STO pipeline.
12
+
- Getting started:
13
+
14
+
-[Set up Harness for STO](/docs/security-testing-orchestration/get-started/onboarding-guide) This is a good primer if you're new to Harness. It guides you through the process of setting up the connectors, delegate, and infrastructure needed to run STO scans.
13
15
14
-
2.[Your first STO pipeline](/tutorials/security-tests/your-first-sto-pipeline) This tutorial covers the basic concepts of STO. You'll set up a standalone pipeline with one scanner, run scans, analyze the results, and learn how to investigate and fix detected vulnerabilities.
16
+
-[Your first STO pipeline](/tutorials/security-tests/your-first-sto-pipeline) This tutorial covers the basic concepts of STO. You'll set up a standalone pipeline with one scanner, run scans, analyze the results, and learn how to investigate and fix detected vulnerabilities.
17
+
18
+
- Quickstarts:
19
+
20
+
-[SAST code scans using Semgrep](/tutorials/security-tests/sast-scan-semgrep) This "quick-start" tutorial shows you how to scan your codebases using [Semgrep](https://semgrep.dev), which can scan a [wide variety of languages](https://semgrep.dev/docs/supported-languages/) and includes a [free version](https://semgrep.dev/pricing/).
21
+
22
+
-[Container image scans with Aqua Trivy](/tutorials/security-tests/container-scan-aqua-trivy) This "quick-start" tutorial shows you how to scan your container images using [Aqua Trivy](https://www.aquasec.com/products/trivy/), a popular open-source scanning tool.
23
+
24
+
-[Trigger automated scans using GitLab merge requests](/tutorials/security-tests/gitlab-ci-integration) This tutorial shows how you can set up a STO pipeline that runs a build and scans a code repository automatically in response to a Git event.
25
+
26
+
- Integrated end-to-end workflows:
15
27
16
-
3.[SAST code scans using Semgrep](/tutorials/security-tests/sast-scan-semgrep) This "quick-start" tutorial shows you how to scan your codebases using [Semgrep](https://semgrep.dev), which can scan a [wide variety of languages](https://semgrep.dev/docs/supported-languages/) and includes a [free version](https://semgrep.dev/pricing/).
28
+
-[Create a build-scan-push pipeline (STO only)](/tutorials/security-tests/build-scan-push-sto-only) Set up an end-to-end STO pipeline that scans your codebase. Then it builds an image and scans it. If the image scan detects no critical issues, the pipeline pushes the image to your registry.
17
29
18
-
4.[Container image scans with Aqua Trivy](/tutorials/security-tests/container-scan-aqua-trivy) This "quick-start" tutorial shows you how to scan your container images using [Aqua Trivy](https://www.aquasec.com/products/trivy/), a popular open-source scanning tool.
30
+
-[Create a build-scan-push pipeline (STO and CI)](/tutorials/security-tests/build-scan-push-sto-ci) Set up an end-to-end STO/CI pipeline that scans your codebase, builds/pushes a test image, and then scans it. If there are no critical issues, the pipeline builds/pushes a prod image.
19
31
20
-
5.[Trigger automated scans using GitLab merge requests](/tutorials/security-tests/gitlab-ci-integration) This tutorial shows how you can set up a STO pipeline that runs a build and scans a code repository automatically in response to a Git event.
<>Set up an end-to-end STO/CI pipeline that scans your codebase, builds/pushes a test image, and then scans it. If there are no critical issues, the pipeline builds a prod image and pushes it to your registry. </>
112
+
<>Set up an end-to-end STO/CI pipeline that scans your codebase, builds/pushes a test image, and then scans it. If there are no critical issues, the pipeline builds/pushes a prod image. </>
Copy file name to clipboardExpand all lines: tutorials/security-tests/build-scan-push-sto-ci.md
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -106,7 +106,23 @@ Do the following:
106
106
107
107
6. In the Pipeline Editor, go to **Infrastructure** and select **Cloud**, **Linux**, and **AMD64** for the infrastructure, OS, and architecture.
108
108
109
-
You can also use a [Kubernetes](/docs/category/set-up-kubernetes-cluster-build-infrastructures) or [Docker](/docs/continuous-integration/use-ci/set-up-build-infrastructure/define-a-docker-build-infrastructure) infrastructure, but these require additional work to set up.
109
+
You can also use a Kubernetes or Docker build infrastructure, but these require additional work to set up. For more information, go to [Set up a build infrastructure for STO](/docs/security-testing-orchestration/get-started/onboarding-guide#set-up-a-build-infrastructure-for-sto).
110
+
111
+
:::note
112
+
113
+
The following step is required for Kubernetes or Docker infrastructures only. If you're using Harness Cloud, go to [Scan the code](#scan-the-code).
114
+
115
+
:::
116
+
117
+
118
+
### Add a Docker-in-Docker background step
119
+
120
+
```mdx-code-block
121
+
import StoDinDRequirements from '/docs/security-testing-orchestration/sto-techref-category/shared/dind-bg-step.md';
Copy file name to clipboardExpand all lines: tutorials/security-tests/build-scan-push-sto-only.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,7 +102,22 @@ Do the following:
102
102
103
103
6. In the Pipeline Editor, go to **Infrastructure** and select **Cloud**, **Linux**, and **AMD64** for the infrastructure, OS, and architecture.
104
104
105
-
You can also use a [Kubernetes](/docs/category/set-up-kubernetes-cluster-build-infrastructures) or [Docker](/docs/continuous-integration/use-ci/set-up-build-infrastructure/define-a-docker-build-infrastructure) infrastructure, but these require additional work to set up.
105
+
You can also use a Kubernetes or Docker build infrastructure, but these require additional work to set up. For more information, go to [Set up a build infrastructure for STO](/docs/security-testing-orchestration/get-started/onboarding-guide#set-up-a-build-infrastructure-for-sto).
106
+
107
+
:::note
108
+
109
+
The following step is required for Kubernetes or Docker infrastructures only. If you're using Harness Cloud, go to [Add the codebase scan step](#add-the-codebase-scan-step).
110
+
111
+
:::
112
+
113
+
### Add a Docker-in-Docker background step
114
+
115
+
```mdx-code-block
116
+
import StoDinDRequirements from '/docs/security-testing-orchestration/sto-techref-category/shared/dind-bg-step.md';
Copy file name to clipboardExpand all lines: tutorials/security-tests/container-scan-aqua-trivy.md
+7-13Lines changed: 7 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,24 +47,16 @@ Do the following:
47
47
48
48
3. In the Pipeline Editor, go to **Infrastructure** and select **Cloud**, **Linux**, and **AMD64** for the infrastructure, OS, and architecture.
49
49
50
-
You can also use a [Kubernetes](/docs/category/set-up-kubernetes-cluster-build-infrastructures) or [Docker](/docs/continuous-integration/use-ci/set-up-build-infrastructure/define-a-docker-build-infrastructure) infrastructure, but these require additional work to set up.
50
+
You can also use a Kubernetes or Dockerbuild infrastructure, but these require additional work to set up. For more information, go to [Set up a build infrastructure for STO](/docs/security-testing-orchestration/get-started/onboarding-guide#set-up-a-build-infrastructure-for-sto).
51
51
52
-
<!--
53
-
4. Set up your codebase:
52
+
:::note
54
53
55
-
1. Select **Codebase** (right menu).
56
-
57
-
2. Select your codebase connector.
58
-
59
-
3. Select **Runtime Input** as the value type for the repository name. You will specify the repo when you run the pipeline.
The following step is required only for Kubernetes or Docker infrastructures. If you're using Harness Cloud, go to [Add the Aqua-Trivy scan step](#add-the-aqua-trivy-scan-step).
64
55
56
+
:::
65
57
66
-
### Add the Docker-in-Docker background step
67
58
59
+
### Add a Docker-in-Docker background step
68
60
69
61
```mdx-code-block
70
62
import StoDinDRequirements from '/docs/security-testing-orchestration/sto-techref-category/shared/dind-bg-step.md';
@@ -73,6 +65,8 @@ import StoDinDRequirements from '/docs/security-testing-orchestration/sto-techre
0 commit comments