Skip to content

Commit

Permalink
Add badges
Browse files Browse the repository at this point in the history
Signed-off-by: Jose Fuentes <jsfuentescastillo@gmail.com>
  • Loading branch information
j-fuentes committed Dec 5, 2019
1 parent 49adbe4 commit 359ad95
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
@@ -1,3 +1,12 @@
<p align="center">
<a href="https://prow.build-infra.jetstack.net/?job=post-preflight-release-canary">
<!-- prow build badge, godoc, and go report card-->
<img alt="Build Status" src="https://prow.build-infra.jetstack.net/badge.svg?jobs=post-preflight-release-canary">
</a>
<a href="https://godoc.org/github.com/jetstack/preflight"><img src="https://godoc.org/github.com/jetstack/preflight?status.svg"></a>
<a href="https://goreportcard.com/report/github.com/jetstack/preflight"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/jetstack/preflight" /></a>
</p>

# Jetstack Preflight

Preflight is a tool to automatically perform Kubernetes cluster configuration checks using [Open Policy Agent (OPA)](https://www.openpolicyagent.org/).
Expand All @@ -10,7 +19,7 @@ Preflight is a tool to automatically perform Kubernetes cluster configuration ch
- [Preflight Packages](#preflight-packages)
- [Install Preflight](#install-preflight)
- [Use Preflight locally](#use-preflight-locally)
- [Get periodic reports by running Preflight as a CronJob](#get-periodic-reports-by-running-preflight-as-a-cronjob)
- [Preflight In-Cluster with periodic checks](#preflight-in-cluster-with-periodic-checks)

<!-- markdown-toc end -->

Expand Down Expand Up @@ -77,6 +86,6 @@ If you want to visualice the report in your browser, you can access [preflight.j

You can give it a try without even running the tool, since we provide some report examples ([gke.json](./examples/reports/gke.json), [pods.json](./examples/reports/pods.json)) ready to be loaded in [preflight.jetstack.io](https://preflight.jetstack.io/).

### Get periodic reports by running Preflight as a CronJob
### Preflight In-Cluster with periodic checks

See [Installation Manual: Preflight In-Cluster](./docs/installation_manual_in_cluster.md).
1 change: 1 addition & 0 deletions api/common.go
@@ -1,3 +1,4 @@
// Package api provides types for Preflight reports and some common helpers.
package api

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/datagatherer/datagatherer.go
@@ -1,3 +1,4 @@
// Package datagatherer provides the DataGatherer interface.
package datagatherer

// DataGatherer is the interface for Data Gatherers. Data Gatherers are in charge of fetching data from a certain cloud provider API or Kubernetes component.
Expand Down
1 change: 1 addition & 0 deletions pkg/datagatherer/eks/eks.go
@@ -1,3 +1,4 @@
// Package eks provides a datagatherer for EKS.
package eks

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/datagatherer/gke/gke.go
@@ -1,3 +1,4 @@
// Package gke provides a datagatherer for GKE.
package gke

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/datagatherer/k8s/client.go
@@ -1,3 +1,4 @@
// Package k8s provides datagatherers for different parts of the Kubernetes API.
package k8s

import (
Expand Down

0 comments on commit 359ad95

Please sign in to comment.