starboard

README

Kubernetes-native security toolkit.

Introduction

There are lots of security tools in the cloud native world, created by Aqua and by others, for identifying and informing users about security issues in Kubernetes workloads and infrastructure components. However powerful and useful they might be, they tend to sit alongside Kubernetes, with each new product requiring users to learn a separate set of commands and installation steps in order to operate them and find critical security information.

Starboard attempts to integrate heterogeneous security tools by incorporating their outputs into Kubernetes CRDs (Custom Resource Definitions) and from there, making security reports accessible through the Kubernetes API. This way users can find and view the risks that relate to different resources in what we call a Kubernetes-native way.

Starboard provides:

• Automated vulnerability scanning for Kubernetes workloads.
• Automated configuration audits for Kubernetes resources with predefined rules or custom Open Policy Agent (OPA) policies.
• Automated infrastructures scanning and compliance checks with CIS Benchmarks published by the Center for Internet Security (CIS).
• Automated compliance report - NSA, CISA Kubernetes Hardening Kubernetes Guidance v1.0
• Penetration test results for a Kubernetes cluster.
• Custom Resource Definitions and a Go module to work with and integrate a range of security scanners.
• The Octant Plugin and the Lens Extension that make security reports available through familiar Kubernetes interfaces.

Starboard can be used:

• As a Kubernetes operator to automatically update security reports in response to workload and other changes on a Kubernetes cluster - for example, initiating a vulnerability scan when a new Pod is started or running CIS Benchmarks when a new Node is added.

• As a command, so you can trigger scans and view the risks in a kubectl-compatible way or as part of your CI/CD pipeline.

  

Status

Although we are trying to keep new releases backward compatible with previous versions, this project is still incubating, and some APIs and Custom Resource Definitions may change.

Documentation

The official Documentation provides detailed installation, configuration, troubleshooting, and quick start guides.

Learn how to install the Starboard command From the Binary Releases and follow the Getting Started guide to generate your first vulnerability and configuration audit reports.

You can install the Starboard Operator with Static YAML Manifests and follow the Getting Started guide to see how vulnerability and configuration audit reports are generated automatically.

Read more about the motivations for the project in the Starboard: The Kubernetes-Native Toolkit for Unifying Security blog.

Contributing

At this early stage we would love your feedback on the overall concept of Starboard. Over time, we'd love to see contributions integrating different security tools so that users can access security information in standard, Kubernetes-native ways.

• See Contributing for information about setting up your development environment, and the contribution workflow that we expect.
• See Roadmap for tentative features in a 1.0.0 release.

---

Starboard is an Aqua Security open source project.
Learn about our Open Source Work and Portfolio.
Join the community, and talk to us about any matter in GitHub Discussions or Slack.

Documentation

Index

• func GetCISKubeBenchReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetClusterComplianceDetailReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetClusterComplianceReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetClusterConfigAuditReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetClusterVulnerabilityReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetConfigAuditReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetKubeHunterReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func GetNSASpecV10() (v1alpha1.ClusterComplianceReport, error)
• func GetVulnerabilityReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)
• func PoliciesConfigMap() (corev1.ConfigMap, error)

Functions

func GetCISKubeBenchReportsCRD

func GetCISKubeBenchReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetClusterComplianceDetailReportsCRD

func GetClusterComplianceDetailReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetClusterComplianceReportsCRD

func GetClusterComplianceReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetClusterConfigAuditReportsCRD

func GetClusterConfigAuditReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetClusterVulnerabilityReportsCRD

func GetClusterVulnerabilityReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetConfigAuditReportsCRD

func GetConfigAuditReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetKubeHunterReportsCRD

func GetKubeHunterReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func GetNSASpecV10

func GetNSASpecV10() (v1alpha1.ClusterComplianceReport, error)

func GetVulnerabilityReportsCRD

func GetVulnerabilityReportsCRD() (apiextensionsv1.CustomResourceDefinition, error)

func PoliciesConfigMap

func PoliciesConfigMap() (corev1.ConfigMap, error)