Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify vuln docs #700

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 3 additions & 27 deletions docs/services/vulnerabilities/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,14 @@
---
tags: [salsa, slsa, supply-chain, vulnerabilities, explanation]
description: Nais provides a set of services to help you secure your software supply chain and manage vulnerabilities in your workloads.
---

# Vulnerability insights and management

Nais provides a set of tools and services to help you secure your software supply chain and manage vulnerabilities in your workloads:
Nais provides what you need to secure your software supply chain and manage vulnerabilities in your workloads.

<div class="grid cards" markdown>
Get started by using our [GitHub Actions](how-to/sbom.md) to generate SBOMs and attestations for your workloads.

- [**Attestation**][Attestation] (nais/docker-build-push)
Once this is in place, you can use the [Console](../../operate/console.md) to view and manage vulnerabilities in your workloads.

GitHub action that helps to secure a supply chain for software artifacts.

- [**Vulnerability Insights**][Insights]

Tools to manage vulnerabilities in your workloads.

</div>

## Getting started with vulnerability insights

The setup of vulnerability insights for an workload is straightforward and only requires you to add the [nais/docker-build-push][Attestation] action to your GitHub workflow.
Once added, the action will automatically generate a signed attestation, including a SBOM
(Software Bill of Materials) for your container image and its dependencies.
This is bundled as an attestation and pushed to your container registry along with your image and plays a key role in providing proof that the software supply chain follows secure processes.

## Acknowledge vulnerabilities

Nais continuously monitors deployed container images in the cluster.
When a new image is detected, Nais automatically uploads its SBOM to [Dependency-track][Insights] for vulnerability analysis.

The results of the Dependency-track analysis, including vulnerability insights, can then be viewed in the Nais Console.
The [Nais Console][Insights] provides a platform for viewing and managing vulnerabilities at the team level.

[Attestation]: how-to/attestation.md
[Insights]: how-to/insight.md
4 changes: 0 additions & 4 deletions docs/services/vulnerabilities/how-to/.pages

This file was deleted.

16 changes: 0 additions & 16 deletions docs/services/vulnerabilities/how-to/console.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/services/vulnerabilities/how-to/dependencytrack.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/services/vulnerabilities/how-to/insight.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,3 @@ If you want to push to another registry, you can use the [nais/attest-sign](http
sbom: my-image.json # optional
# ... other options removed for readability
```

### Attestation

The action automatically generates a signed attestation with the help of [Trivy](https://github.com/aquasecurity/trivy-action) and [cosign](https://github.com/sigstore/cosign).
The attestation envelope includes a SBOM (Software Bill of Materials) for your container image and its dependencies.

The SBOM is uploaded to the same registry alongside your image.