Skip to content

Commit

Permalink
Add Sonobuoy plugins page (#1070)
Browse files Browse the repository at this point in the history
Signed-off-by: jonasrosland <jrosland@vmware.com>
  • Loading branch information
jonasrosland authored and johnSchnake committed Jan 27, 2020
1 parent 5fd8991 commit f8c047f
Show file tree
Hide file tree
Showing 9 changed files with 74 additions and 0 deletions.
1 change: 1 addition & 0 deletions site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ page_gen:
collections:
- contributors
- casestudies
- plugin-list

versioning: true
latest: v0.17.1
Expand Down
28 changes: 28 additions & 0 deletions site/_includes/plugins.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<div class="section section-card section-card-offset-top promo-cards">
<div class="section-content">
<div class="row">
{% for plugin in site.plugin-list %}
<div class="col-md">
<div class="card card-light mb-3 mb-md-0 shadow-sm">
<div class="card-body match-height">
{% if plugin.link.size > 0 %}
<h5><a href="{{ plugin.link }}" class="dark">{{ plugin.title }}</a></h5>
{% else %}
<h5>{{ plugin.title }}</h5>
{% endif %}
<p>{{ plugin.content }}</p>
</div>
</div>
</div>
{% if limit > 0 and forloop.index >= limit %}
{% break %}
{% endif %}
{% assign row = forloop.index | modulo: 3 %}
{% if row == 0 %}
</div>
<div class="row mt-4">
{% endif %}
{% endfor %}
</div>
</div>
</div>
1 change: 1 addition & 0 deletions site/_includes/site-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<li class="blog"><a href="/blog" title="Blog Posts">Blog</a></li>
<li class="community"><a href="/community" title="Community">Community</a></li>
<li class="docs"><a href="/docs">Documentation</a></li>
<li class="plugins"><a href="/plugins">Plugins</a></li>
<li class="resources"><a href="/resources" title="Resources">Resources</a></li>
</ul>
<div class="nav-mobile-link">
Expand Down
5 changes: 5 additions & 0 deletions site/_plugin-list/01-cis-benchmark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: CIS Benchmarks
link: https://github.com/vmware-tanzu/sonobuoy-plugins/tree/master/cis-benchmarks
---
This plugin utilizes the kube-bench implementation of the CIS security benchmarks. It is technically two plugins; one to run the checks on the master nodes and another to run the checks on the worker nodes.
5 changes: 5 additions & 0 deletions site/_plugin-list/02-e2e-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: End-to-End Testing
link: https://sonobuoy.io/docs/master/e2eplugin/
---
The Kubernetes end-to-end testing plugin (the e2e plugin) is used to run tests which are maintained by the upstream Kubernetes community in the [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes/tree/master/cluster/images/conformance) repo.
5 changes: 5 additions & 0 deletions site/_plugin-list/03-systemd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Systemd-logs
link: https://github.com/vmware-tanzu/sonobuoy-plugins/tree/master/systemd-logs
---
Gather log information from systemd, by chrooting into the node's filesystem and running journalctl. Used by Sonobuoy for gathering host logs in a Kubernetes cluster.
5 changes: 5 additions & 0 deletions site/_plugin-list/04-kube-hunter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Kube-hunter
link: https://github.com/vmware-tanzu/sonobuoy-plugins/tree/master/kube-hunter
---
This plugin runs Aqua Security’s kube-hunter. It increases awareness and visibility of security issues in Kubernetes environments.
6 changes: 6 additions & 0 deletions site/_plugin-list/05-who-can.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Who-can
---
This plugin utilizes the kubectl-who-can project from AquaSecurity to produce a report that shows which subjects have RBAC permissions to perform actions (verbs) against resources in the cluster.

This plugin is currently being created.
18 changes: 18 additions & 0 deletions site/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: page
title: Plugins
description: Sonobuoy Plugins
id: plugins
---

Sonobuoy was always designed to facilitate third-party plugins in order to accommodate custom testing requirements, and recently, the work on Sonobuoy made some advanced plugins possible to create.

Read more about the first Sonobuoy plugins [here][1].

<div class="section section-background-{{ page.backgrounds.team }}">
<div class="section-content">
{% include plugins.html %}
</div>
</div>

[1]: https://sonobuoy.io/cis-benchmark-plugin/

0 comments on commit f8c047f

Please sign in to comment.