starboard

package module
Version: v0.10.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

README

Starboard logo

Kubernetes-native security toolkit.

GitHub Release GitHub Build Actions Coverage Status Go Report Card License GitHub All Releases Docker Pulls Starboard Docker Pulls Starboard Operator

Introduction

Starboard integrates security tools into the Kubernetes environment, so that users can find and view the risks that relate to different resources in a Kubernetes-native way. Starboard provides custom resources definitions and a Go module to work with a range of existing security scanners, as well as a kubectl-compatible command, the Octant plugin, and the Lens extension that make security reports available through familiar Kubernetes tools.

Starboard Overview

Starboard can be run in two different modes:

  • 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.
  • As an 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.

NOTE Even though manual scanning through the command-line is useful, the fact that it's not automated makes it less suitable with numerous Kubernetes workloads. Therefore, the operator provides a better option for these scenarios, constantly monitoring built-in Kubernetes resources, such as Deployments, and running appropriate scanners against the underlying deployment descriptors.

You can read more about the motivations and use cases in this blog and join our discussions.

Status

This project is incubating and the APIs are not considered stable.

Documentation

The official documentation, which provides detailed installation, configuration, and quick start guides, is available at https://aquasecurity.github.io/starboard/.

Try the getting started guide to install the Starboard command and generate your first vulnerability report.

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.md for information about setting up your development environment, and the contribution workflow that we expect.
  • See ROADMAP.md for tentative features in a 1.0 release.
  • Join our discussions.

Starboard is an Aqua Security open source project.
Learn about our open source work and portfolio here.
Contact us about any matter by opening a GitHub Discussion here.

Source Files

Directories

Path Synopsis
cmd
itest
helper
The helper package provides builders to instantiate Kubernetes objects used in integration tests.
The helper package provides builders to instantiate Kubernetes objects used in integration tests.
matcher
The matcher package provides domain-specific Gomega matchers.
The matcher package provides domain-specific Gomega matchers.
pkg
apis/aquasecurity/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.
cmd
configauditreport
The configauditreport package provides primitives for working with Kubernetes workload configuration checkers.
The configauditreport package provides primitives for working with Kubernetes workload configuration checkers.
docker
This docker package provides primitives for working with Docker.
This docker package provides primitives for working with Docker.
ext
generated/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
generated/clientset/versioned/typed/aquasecurity/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
generated/clientset/versioned/typed/aquasecurity/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
kube
Package kube provides primitives for working with Kubernetes objects.
Package kube provides primitives for working with Kubernetes objects.
kubebench
Package kubebench provides primitives for working with CIS Kubernetes benchmarks.
Package kubebench provides primitives for working with CIS Kubernetes benchmarks.
kubehunter
Package kubehunter provides primitives for working with KubeHunter.
Package kubehunter provides primitives for working with KubeHunter.
plugin
Package plugin aggregates plugins for Starboard.
Package plugin aggregates plugins for Starboard.
plugin/aqua
Package aqua provides primitives for working with Aqua Enterprise scanner.
Package aqua provides primitives for working with Aqua Enterprise scanner.
plugin/aqua/client
Package client provides an HTTP client for selected Aqua Enterprise API endpoints.
Package client provides an HTTP client for selected Aqua Enterprise API endpoints.
plugin/aqua/scanner/api
Package api provides primitives for getting vulnerability reports via Aqua Enterprise API
Package api provides primitives for getting vulnerability reports via Aqua Enterprise API
plugin/aqua/scanner/cli
Package cli provides primitives for getting vulnerability reports by executing the scannercli command.
Package cli provides primitives for getting vulnerability reports by executing the scannercli command.
plugin/conftest
Package conftest provides primitives for working with Conftest.
Package conftest provides primitives for working with Conftest.
plugin/polaris
Package polaris provides primitives for working with Polaris.
Package polaris provides primitives for working with Polaris.
plugin/trivy
Package trivy provides primitives for working with Trivy.
Package trivy provides primitives for working with Trivy.
report
Package report provides primitives for generating HTML reports.
Package report provides primitives for generating HTML reports.
report/templates
Package templates provides code generated from *.qtpl templates.
Package templates provides code generated from *.qtpl templates.
runner
Package runner provides primitives to run tasks as Kubernetes Jobs.
Package runner provides primitives to run tasks as Kubernetes Jobs.
starboard
Package starboard provides primitives for working with Starboard toolkit.
Package starboard provides primitives for working with Starboard toolkit.
vulnerabilityreport
Package vulnerabilityreport provides primitives for working with vulnerability scanners.
Package vulnerabilityreport provides primitives for working with vulnerability scanners.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL