From 26016a9e855b0f4052189ed5454afd9048a1b562 Mon Sep 17 00:00:00 2001 From: Varun Sharma Date: Sun, 2 Mar 2025 14:52:16 -0800 Subject: [PATCH 1/6] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 7014c89..3dd527c 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ StepSecurity Harden-Runner addresses this gap by providing security monitoring t - [Why Choose Harden-Runner](#why-choose-harden-runner) - [Features and Capabilities](#features) - [Case Studies and Trusted Projects](#trusted-by-and-case-studies) +- [Environment Compatibility Matrix](#environment-compatibility-matrix) - [How It Works](docs/how-it-works.md) - [Known Limitations](docs/limitations.md) - [Join the Discussions](#discussions) @@ -146,6 +147,17 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris --- +## Environment Compatibility Matrix + +| Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode | Examples | +|------------------|---------------|--------------------------|-------------------|----------| +| GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/github-hosted.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/123456) | +| Self-hosted VM runners | ✅ Full support | Include agent in runner image | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/self-hosted-vm.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/789012) | +| Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/self-hosted-metal.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/345678) | +| Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/arc.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/901234) | +| RunsOn Runners | ✅ Full support | Pre-integrated | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/runson.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/567890) | +| StepSecurity Managed Runners | 🔜 Coming soon | Will be pre-integrated | No | [Join Waitlist](https://stepsecurity.io/waitlist) | + ## How It Works Want to know the technical details? Dive into the architecture of Harden-Runner and its integrations for GitHub-hosted and self-hosted runners in our [How Harden-Runner Works Documentation](docs/how-it-works.md). From 7898384a7c0ddcfff50b76c700ff892ea570b437 Mon Sep 17 00:00:00 2001 From: Varun Sharma Date: Sun, 2 Mar 2025 14:53:14 -0800 Subject: [PATCH 2/6] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3dd527c..516ebd5 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,8 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris ## Environment Compatibility Matrix +Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. + | Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode | Examples | |------------------|---------------|--------------------------|-------------------|----------| | GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/github-hosted.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/123456) | From e53f5ebd38a00424d3797aa3bad302387ca26836 Mon Sep 17 00:00:00 2001 From: Varun Sharma Date: Sun, 2 Mar 2025 14:54:40 -0800 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 516ebd5..64d13f0 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris ## Environment Compatibility Matrix -Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. +Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. For self-hosted runners, audit mode is deployed directly to the runner infrastructure without requiring any changes to your existing workflows. | Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode | Examples | |------------------|---------------|--------------------------|-------------------|----------| From 8bdb08e71c3600009c5e08aa100b747d7ebfd587 Mon Sep 17 00:00:00 2001 From: Varun Sharma Date: Thu, 6 Mar 2025 20:28:27 -0800 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64d13f0..41b5f95 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ Harden-Runner is designed to work seamlessly across a variety of runner environm | Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/self-hosted-metal.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/345678) | | Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/arc.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/901234) | | RunsOn Runners | ✅ Full support | Pre-integrated | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/runson.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/567890) | -| StepSecurity Managed Runners | 🔜 Coming soon | Will be pre-integrated | No | [Join Waitlist](https://stepsecurity.io/waitlist) | +| StepSecurity Managed Runners | 🔜 Coming soon | Will be pre-integrated | No | [Join Waitlist](https://www.stepsecurity.io/join-waitlist) | ## How It Works From 76e6651ae5ba059744afb90cc81a7227474b9c0f Mon Sep 17 00:00:00 2001 From: Varun Sharma Date: Sat, 8 Mar 2025 10:20:29 -0800 Subject: [PATCH 5/6] Update README.md --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 41b5f95..ea8d2e9 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ To integrate Harden-Runner, follow these steps: with: egress-policy: audit -**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secureworkflow) +**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secure-workflow)
Click to view the full Getting Started Guide @@ -151,14 +151,13 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. For self-hosted runners, audit mode is deployed directly to the runner infrastructure without requiring any changes to your existing workflows. -| Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode | Examples | -|------------------|---------------|--------------------------|-------------------|----------| -| GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/github-hosted.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/123456) | -| Self-hosted VM runners | ✅ Full support | Include agent in runner image | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/self-hosted-vm.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/789012) | -| Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/self-hosted-metal.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/345678) | -| Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/arc.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/901234) | -| RunsOn Runners | ✅ Full support | Pre-integrated | No | [Example Workflow](https://github.com/step-security/harden-runner/blob/main/examples/runson.yml) • [Insights](https://app.stepsecurity.io/github/example/repo/actions/runs/567890) | -| StepSecurity Managed Runners | 🔜 Coming soon | Will be pre-integrated | No | [Join Waitlist](https://www.stepsecurity.io/join-waitlist) | +| Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode | +|------------------|---------------|--------------------------|-------------------| +| GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes | +| Self-hosted VM runners | ✅ Full support | Include agent in runner image | No | +| Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No | +| Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No | +| RunsOn Runners | ✅ Full support | Pre-integrated | No | ## How It Works From b8927f9f8b46d0cad539a5d1f722570105a3ee71 Mon Sep 17 00:00:00 2001 From: Varun Sharma Date: Sat, 8 Mar 2025 10:42:19 -0800 Subject: [PATCH 6/6] Updates --- README.md | 5 +++-- docs/limitations.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ea8d2e9..c3ba5f8 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ StepSecurity Harden-Runner addresses this gap by providing security monitoring t - [How It Works](docs/how-it-works.md) - [Known Limitations](docs/limitations.md) - [Join the Discussions](#discussions) +- [Official Documentation](https://docs.stepsecurity.io/harden-runner) --- @@ -44,7 +45,7 @@ Learn how Harden-Runner works through the video below, which shows how it detect --- ## Getting Started -This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows. +This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows. For more details, refer to the [official documentation](https://docs.stepsecurity.io/harden-runner). ### **Step 1: Add Harden-Runner to Your Workflow** @@ -149,7 +150,7 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris ## Environment Compatibility Matrix -Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. For self-hosted runners, audit mode is deployed directly to the runner infrastructure without requiring any changes to your existing workflows. +Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. For self-hosted runners, audit mode is deployed directly to the runner infrastructure without requiring any changes to your existing workflows. For more details, refer to the [official documentation](https://docs.stepsecurity.io/harden-runner). | Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode | |------------------|---------------|--------------------------|-------------------| diff --git a/docs/limitations.md b/docs/limitations.md index 244361a..b952bbf 100644 --- a/docs/limitations.md +++ b/docs/limitations.md @@ -9,6 +9,6 @@ * Since ARC Harden Runner uses eBPF, only Linux jobs are supported. Windows and MacOS jobs are not supported. -### Self-Hosted VM Runners (e.g. on EC2) +### Self-Hosted VM (e.g. on EC2) and Bare-metal Runners -* Only Ubuntu VM is supported. Windows and MacOS jobs are not supported. \ No newline at end of file +* Only Linux jobs are supported. Windows and MacOS jobs are not supported. \ No newline at end of file