diff --git a/site/_config.yml b/site/_config.yml index 816e1990a..18064f33e 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -170,6 +170,7 @@ page_gen: collections: - contributors - casestudies + - plugin-list versioning: true latest: v0.17.1 diff --git a/site/_includes/plugins.html b/site/_includes/plugins.html new file mode 100644 index 000000000..b9be22bfd --- /dev/null +++ b/site/_includes/plugins.html @@ -0,0 +1,28 @@ +
+
+
+ {% for plugin in site.plugin-list %} +
+
+
+ {% if plugin.link.size > 0 %} +
{{ plugin.title }}
+ {% else %} +
{{ plugin.title }}
+ {% endif %} +

{{ plugin.content }}

+
+
+
+ {% if limit > 0 and forloop.index >= limit %} + {% break %} + {% endif %} + {% assign row = forloop.index | modulo: 3 %} + {% if row == 0 %} +
+
+ {% endif %} + {% endfor %} +
+
+
diff --git a/site/_includes/site-header.html b/site/_includes/site-header.html index a7800b394..21fb1176a 100644 --- a/site/_includes/site-header.html +++ b/site/_includes/site-header.html @@ -8,6 +8,7 @@
  • Blog
  • Community
  • Documentation
    • +
  • Plugins
  • Resources
    • diff --git a/site/_plugin-list/01-cis-benchmark.md b/site/_plugin-list/01-cis-benchmark.md new file mode 100644 index 000000000..fdbacfe7b --- /dev/null +++ b/site/_plugin-list/01-cis-benchmark.md @@ -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. diff --git a/site/_plugin-list/02-e2e-testing.md b/site/_plugin-list/02-e2e-testing.md new file mode 100644 index 000000000..5d27bdc17 --- /dev/null +++ b/site/_plugin-list/02-e2e-testing.md @@ -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. diff --git a/site/_plugin-list/03-systemd.md b/site/_plugin-list/03-systemd.md new file mode 100644 index 000000000..6ec193250 --- /dev/null +++ b/site/_plugin-list/03-systemd.md @@ -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. diff --git a/site/_plugin-list/04-kube-hunter.md b/site/_plugin-list/04-kube-hunter.md new file mode 100644 index 000000000..99ed7140f --- /dev/null +++ b/site/_plugin-list/04-kube-hunter.md @@ -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. diff --git a/site/_plugin-list/05-who-can.md b/site/_plugin-list/05-who-can.md new file mode 100644 index 000000000..452af5705 --- /dev/null +++ b/site/_plugin-list/05-who-can.md @@ -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. diff --git a/site/plugins.md b/site/plugins.md new file mode 100644 index 000000000..f61f07e46 --- /dev/null +++ b/site/plugins.md @@ -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]. + +
    +
    + {% include plugins.html %} +
    +
    + +[1]: https://sonobuoy.io/cis-benchmark-plugin/