What you will find in these docs

The section map, role-based starting points, and key terms.

These docs are organized into ten sections, ordered roughly from "what is this?" to "look up the exact flag I need."

The section map

Find your starting point by role

Role
Focus
Start here

Security leader

Evaluating Seal; reviewing the Dashboard and reports

DevOps engineer

Setting up integrations; operating the platform side day to day

Developer

Integrating the Seal CLI; applying Sealing Rules

Security analyst

Day-to-day triage, notifications, and reports for leadership

The DevOps guide also covers DevSecOps and platform engineers; everyone responsible for the platform side of operating Seal in your organization.

Key terms

Seal uses a precise vocabulary across these docs. The most common terms you will encounter:

  • A sealed package is a drop-in replacement for a public package version, with security fixes backported in.

  • A Sealing Rule tells Seal which package to replace and with which sealed version.

  • A Seal Project is the entity inside the Seal Platform that represents one of your codebases or build pipelines.

  • The package discovery mode of a Seal Project determines how Seal sees your packages: source code, CLI, artifact server, or imported manifest.

  • A deployment method is how Seal is integrated into your environment, for example the Seal CLI in CI/CD, or the Seal Artifact Server as a configured remote.

  • The CLI fix mode is the mode the Seal CLI runs in: local mode (rules from a .seal-actions.yml file in your source), remote mode (rules from the Seal Platform UI), or all mode (every vulnerable package replaced automatically).

The full vocabulary is in the Glossary.

Last updated