mirror of
https://github.com/FairwindsOps/polaris.git
synced 2026-05-08 02:06:53 +00:00
1fed099b53
* pretty output * add colors * better nocolor * fix up main title * delint * remove double negative * update docs
68 lines
3.1 KiB
Markdown
68 lines
3.1 KiB
Markdown
<div align="center" class="no-border">
|
|
<img src="/img/polaris-logo.png" alt="Polaris Logo">
|
|
<br>
|
|
<h3>Best Practices for Kubernetes Workload Configuration</h3>
|
|
<a href="https://github.com/FairwindsOps/polaris">
|
|
<img src="https://img.shields.io/static/v1.svg?label=Version&message=3.1.6&color=239922">
|
|
</a>
|
|
<a href="https://goreportcard.com/report/github.com/FairwindsOps/polaris">
|
|
<img src="https://goreportcard.com/badge/github.com/FairwindsOps/polaris">
|
|
</a>
|
|
<a href="https://circleci.com/gh/FairwindsOps/polaris.svg">
|
|
<img src="https://circleci.com/gh/FairwindsOps/polaris.svg?style=svg">
|
|
</a>
|
|
<a href="https://insights.fairwinds.com/gh/FairwindsOps/polaris">
|
|
<img src="https://insights.fairwinds.com/v0/gh/FairwindsOps/polaris/badge.svg">
|
|
</a>
|
|
</div>
|
|
|
|
Fairwinds' Polaris keeps your clusters sailing smoothly. It runs a variety of checks to ensure that
|
|
Kubernetes pods and controllers are configured using best practices, helping you avoid
|
|
problems in the future.
|
|
|
|
Polaris can be run in three different modes:
|
|
* As a [dashboard](/dashboard), so you can audit what's running inside your cluster.
|
|
* As an [admission controller](/admission-controller), so you can automatically reject workloads that don't adhere to your organization's policies.
|
|
* As a [command-line tool](/infrastructure-as-code), so you can test local YAML files, e.g. as part of a CI/CD process.
|
|
|
|
<p align="center">
|
|
<img src="/img/architecture.svg" alt="Polaris Architecture" width="550"/>
|
|
</p>
|
|
|
|
**Want to learn more?** Reach out on [the Slack channel](https://fairwindscommunity.slack.com/messages/polaris) ([request invite](https://join.slack.com/t/fairwindscommunity/shared_invite/zt-e3c6vj4l-3lIH6dvKqzWII5fSSFDi1g)), send an email to `opensource@fairwinds.com`, or join us for [office hours on Zoom](https://fairwindscommunity.slack.com/messages/office-hours)
|
|
|
|
|
|
|
|
## Integration with Fairwinds Insights
|
|
<p align="center">
|
|
<img src="/img/FW_Insights_Polaris.svg" alt="Fairwinds Insights" width="550"/>
|
|
</p>
|
|
|
|
[Fairwinds Insights](https://www.fairwinds.com/fairwinds-polaris-upgrade)
|
|
is a platform for auditing Kubernetes clusters and enforcing policy. If you'd like to:
|
|
* manage Polaris across a fleet of clusters
|
|
* track findings over time
|
|
* send results to services like Slack and Datadog
|
|
* add additional checks from tools like
|
|
[Trivy](https://github.com/aquasecurity/trivy),
|
|
[Goldilocks](https://github.com/FairwindsOps/goldilocks/), and
|
|
[OPA](https://www.openpolicyagent.org)
|
|
|
|
you can sign up for a [free account here](https://insights.fairwinds.com?source=polaris).
|
|
|
|
## Contributing
|
|
PRs welcome! Check out the [Contributing Guidelines](/contributing) and [Code of Conduct](/code-of-conduct) for more information.
|
|
|
|
## Further Information
|
|
A history of changes to this project can be viewed in the [Changelog](/changelog)
|
|
|
|
If you'd like to learn more about Polaris, or if you'd like to speak with
|
|
a Kubernetes expert, you can contact `info@fairwinds.com` or [visit our website](https://fairwinds.com)
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
<img src="/img/dashboard-screenshot.png" alt="Polaris Dashboard" width="550"/>
|
|
</p>
|
|
|