BLACKSHIELD

Public Documentation

Customer docs for onboarding, trust, and day-2 operations.

Use these guides to launch quickly, complete security reviews, run reliable operations, and solve common issues independently.

Create workspaceRead onboarding guideView after-login checklistDeploy scanner clientsOpen trust center overviewOpen questionnaire packSet up AI assistant workflowsCheck support SLAFix common ingest issuesPartner Program

Need Fast Help?

Start here to resolve the most common onboarding and ingestion blockers.

Open troubleshooting

Security Review?

Use the trust center and questionnaire pack to answer legal and security due-diligence requests.

Open trust center package

Escalation

For urgent production incidents, include workspace details, job IDs, and timestamps in your support request.

Contact support

Developer Quick Starts

Copy the fastest deployment path for your environment.

Start with a working snippet, copy the command or file, then open the full guide only if you need deeper rollout detail.

Browse all deployment guides

GitHub Actions

GitHub Actions workflow

Drop one workflow into the repository and run Trivy, Semgrep, TruffleHog, and Syft in parallel.

.github/workflows/security-scan.yml
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/github-security-scan.sh)

GitLab CI

GitLab CI pipeline

Add one security stage that scans merge requests, default-branch builds, and scheduled pipelines.

.gitlab-ci.yml
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/gitlab-ci.sh)

GitHub Deploy Gate

GitHub Actions deploy gate

Drop in one workflow that evaluates the hosted Rego decision API before production deploys and prints the reasons inline.

.github/workflows/deploy-guardrails.yml
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/github-policy-guardrails.sh)

GitLab Deploy Gate

GitLab deploy gate job

Add one reusable deploy job that checks allow, warn, or deny outcomes against your tenant policy pack before release.

.gitlab/deploy-guardrails.yml
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/gitlab-policy-guardrails.sh)

AWS Lambda

AWS cloud scanner source

Bootstrap the AWS CDK project locally, then deploy the tenant-owned cloud posture scanner without rewriting the commands.

deploy/aws-cloud-scanner/
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/aws-cloud-scanner.sh)
cd deploy/aws-cloud-scanner

GCP Cloud Run

GCP cloud scanner source

Bootstrap the Terraform module locally, then deploy the cloud scanner to your target projects and regions with the same commands shown in the guide.

deploy/gcp-cloud-scanner/
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/gcp-cloud-scanner.sh)
cd deploy/gcp-cloud-scanner

Kubernetes

Helm chart source

Pull the Helm chart source locally, review the templates, and install the cluster scanner from your own repository.

deploy/helm/secplatform-k8s-scanner/
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/k8s-scanner-helm.sh)
cd deploy/helm/secplatform-k8s-scanner

SaaS on AWS

AWS SaaS scanner source

Bootstrap the AWS CDK project locally, then deploy the tenant-owned Lambda scanner without rewriting the commands.

deploy/aws-saas-scanner/
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/aws-saas-scanner.sh)
cd deploy/aws-saas-scanner

SaaS on GCP

GCP SaaS scanner source

Bootstrap the Terraform module locally, then deploy the Cloud Run Job scanner with the same commands shown in the guide.

deploy/gcp-saas-scanner/
bash
bash <(curl -fsSL https://stg-blackshield.chaplau.com/source-bundles/gcp-saas-scanner.sh)
cd deploy/gcp-saas-scanner

Guide Collections

Trust and Governance

Buyer-facing proof of how BlackShield handles access control, evidence, data rights, control coverage, and offboarding in the actual product.

15-20 minutes

Onboard Your Workspace

Create your workspace, first administrator, and integration keys so your team can start ingesting findings safely.

Audience: Workspace owners and first tenant administrators

Read guide

30-45 minutes

After Login: First-Day Next Steps

Use this day-one checklist to move from an empty workspace to validated findings and clear ownership.

Audience: New tenant admins and security leads

Read guide

10-15 minutes

Ingest Your First Findings

Run your first scan, submit findings, and confirm data quality before expanding to more integrations.

Audience: Security engineers, CI owners, and integration engineers

Read guide

Ongoing, daily review recommended

Review and Prioritize Findings

Prioritize remediation using risk, exploitability, ownership, and tenant policy tuning so teams fix what matters first.

Audience: Security triage teams, engineering leads, and service owners

Read guide

First 30 days

What To Do After First Findings

Convert initial findings into a repeatable security program with clear metrics, ownership, and reporting.

Audience: Security program owners and engineering managers

Read guide

2 minutes

Deploy the Pipeline Scanner

Embed Trivy, Semgrep, TruffleHog, and Syft into every commit with a single workflow file. Works with GitHub Actions, GitLab CI, and Bitbucket Pipelines.

Audience: DevOps engineers, platform engineers, and security engineers

Read guide

3 minutes

Gate Deploys with Hosted Rego Guardrails

Add a lightweight CI step that sends deploy context to your tenant and gets an allow, warn, or deny decision back without self-hosting OPA.

Audience: Platform engineers, release managers, and security engineers

Read guide

5 minutes

Deploy the Cloud Scanner on AWS

Scan your AWS environment for misconfigurations with Prowler, deployed as a Lambda container on EventBridge Scheduler — no EC2, no always-on compute.

Audience: Cloud engineers, security engineers, platform teams

Read guide

5 minutes

Deploy the Cloud Scanner on GCP

Scan GCP project posture with Prowler via a serverless Cloud Run Job triggered by Cloud Scheduler. One Terraform apply deploys to any number of projects and regions.

Audience: Cloud engineers, security engineers, platform teams

Read guide

2 minutes

Deploy the Kubernetes Scanner

Scan cluster posture with kube-bench (CIS benchmarks), kubescape, and Kyverno policy telemetry. One Helm chart install, one kubectl secret — done.

Audience: Platform engineers, Kubernetes administrators, security engineers

Read guide

5 minutes

Deploy the SaaS Scanner

Discover over-privileged OAuth grants, stale app access, and shadow AI tool sprawl across Google Workspace, Microsoft 365, and GitHub. Runs entirely inside your tenant boundary.

Audience: Security engineers, identity and access management teams, platform engineers

Read guide

3 minutes

Deploy the VM and Host Scanner

Ingest OSSEC and Wazuh host intrusion detection alerts into the platform for correlation with cloud and container findings. Works with Docker Compose, systemd, or ECS Fargate.

Audience: Security operations teams, infrastructure engineers

Read guide

10-15 minutes

What Data BlackShield Uses, Stores, and Shares

BlackShield should tell customers exactly which record categories exist in the workspace, which ones appear in tenant-admin screens, and which legal documents cover processor and privacy commitments.

Audience: Security buyers, legal teams, privacy teams, and procurement stakeholders

Read guide

12-18 minutes

What Security Buyers Should Expect from BlackShield

BlackShield should earn trust with concrete product controls: authenticated workspace access, rate-limited sensitive actions, exportable audit evidence, and self-service admin workflows for identity, API keys, and tenant deletion.

Audience: Security buyers, procurement leads, legal teams, and risk stakeholders

Read guide

15-20 minutes

How to Answer Security Reviews About BlackShield

Answer buyer questionnaires by pointing to concrete BlackShield controls: identity setup, API key governance, audit exports, compliance evidence, and tenant self-service deletion.

Audience: Security buyers, procurement teams, legal reviewers, and revenue teams supporting due diligence

Read guide

15 minutes

What Happens to Your Data When You Leave BlackShield

BlackShield should tell customers exactly how offboarding works: open `/tenant-rights`, confirm the workspace snapshot, collect any needed audit or report exports, then run the tenant deletion flow with a typed confirmation phrase.

Audience: Compliance, legal, procurement, and platform operations teams

Read guide

10 minutes

Incident Response and Customer Notifications

Understand incident severity, escalation flow, and communication expectations so your team can respond quickly.

Audience: Security leads, operations teams, and customer success teams

Read guide

8-12 minutes

Availability, Support, and SLAs

Review uptime targets, support response commitments, and escalation channels by plan tier.

Audience: Operations, support, procurement, and service owners

Read guide

15-20 minutes

Executive Reporting Pack: MTTR, Risk Trends, and SLA

Build leadership-ready remediation reporting with MTTR, critical/high backlog, SLA performance, and ownership rollups tied to CIS and NIST governance language.

Audience: Security leaders, engineering managers, tenant admins, and customer-facing stakeholders

Read guide

10-15 minutes

How BlackShield Shows Control Coverage, Gaps, and Evidence

BlackShield turns mapped findings into a benchmark heatmap, service rollups, control drill-down, and a CSV export so customers can prove where coverage exists and where gaps still need work.

Audience: Security leads, auditors, tenant admins, service owners, and buyers validating control visibility

Read guide

12-20 minutes

Disaster Recovery and Business Continuity

Plan recovery objectives, failover validation, and communication steps before a major service disruption.

Audience: Platform operations teams and business continuity owners

Read guide

10 minutes

What BlackShield Secures for You and What Your Team Owns

BlackShield owns the product controls in the platform; your team owns the way you configure identities, keys, scan scope, and operational approvals inside your workspace.

Audience: Security architects, compliance owners, procurement reviewers, and platform administrators

Read guide

12-15 minutes

How BlackShield Protects APIs and Tenant Boundaries (OWASP API Top 10: 2023)

BlackShield protects its APIs with authenticated access, role checks, rate limits on sensitive flows, and audit trails for evidence access and administrative changes.

Audience: Security architects, AppSec reviewers, buyers, and compliance stakeholders

Read guide

15-20 minutes

How BlackShield Controls Access to Your Workspace

BlackShield gives tenant admins a concrete identity surface: configure Google, Okta, or Azure AD, validate OIDC before enabling it, map groups to roles, rotate SCIM tokens, and review identity audit activity.

Audience: IT admins, security operations teams, workspace owners, and procurement reviewers validating access control

Read guide

10-15 minutes

How BlackShield Produces Audit-Ready Evidence

BlackShield gives authorized users a concrete audit workflow: filter events by action, actor, and time range, then export CSV or JSON evidence while recording the export itself in the audit trail.

Audience: Security admins, compliance teams, auditors, and buyers validating accountability

Read guide

10-15 minutes

How to Export or Delete Your BlackShield Data (GDPR/CCPA)

Today, BlackShield gives tenant admins a self-service account snapshot and workspace deletion flow in `/tenant-rights`; if your process requires evidence before deletion, capture it from `/audit` and `/reports` first.

Audience: Tenant admins, privacy officers, legal stakeholders, and buyers reviewing customer data control

Read guide

20-30 minutes

Enable AI Shim and MCP Tooling

Connect your preferred AI provider and MCP client so teams can run assisted triage and secure review workflows.

Audience: Security platform admins and integration engineers

Read guide

10-15 minutes

Troubleshooting and Platform Limits

Resolve common ingestion, authentication, and throughput issues quickly with a repeatable troubleshooting flow.

Audience: Tenant admins, DevOps teams, and scanner operators

Read guide
Public Docs | BlackShield