mirror of
https://github.com/FairwindsOps/polaris.git
synced 2026-08-23 22:26:34 +00:00
Robert Brennan
1a8fb44b78
* first pass * fix up homepage * more work * housekeeping * add script to modify home link * add check docs * build docs site * Create CNAME * fix path to check-docs * update from template * fix logo in readme * fix link * remove logspam * remove old folders * fix all links * fix up readme * change up Insights description * add customization docs * phrasing * title * titles * titles * change webhook docs * refresh template * rebuild site * refresh from template repo * phrasing * add tagline * update readme\, add readme sync script * fix logo * rebuild * fix readme script * rebuild
53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
# Dashboard
|
||
|
||
The Polaris dashboard can be installed on a cluster using kubectl or Helm. It
|
||
can also be run locally, connecting to your cluster using the credentials stored in your `KUBECONFIG`.
|
||
|
||
The dashboard is a good way to understand what workloads inside your cluster or Infrastructure as Code
|
||
don't conform to best practices.
|
||
|
||
## Installation
|
||
|
||
### kubectl
|
||
```bash
|
||
kubectl apply -f https://github.com/fairwindsops/polaris/releases/latest/download/dashboard.yaml
|
||
kubectl port-forward --namespace polaris svc/polaris-dashboard 8080:80
|
||
```
|
||
### Helm
|
||
```bash
|
||
helm repo add fairwinds-stable https://charts.fairwinds.com/stable
|
||
helm upgrade --install polaris fairwinds-stable/polaris --namespace polaris
|
||
kubectl port-forward --namespace polaris svc/polaris-dashboard 8080:80
|
||
```
|
||
|
||
### Local Binary
|
||
You'll need a valid `KUBECONFIG` set up for the dashboard to connect to your cluster.
|
||
|
||
Binary releases can be dowloaded from the [releases page](https://github.com/fairwindsops/polaris/releases)
|
||
or can be installed with [Homebrew](https://brew.sh/):
|
||
```bash
|
||
brew tap reactiveops/tap
|
||
brew install reactiveops/tap/polaris
|
||
polaris dashboard --port 8080
|
||
```
|
||
|
||
You can also point the dashboard to the local filesystem, instead of a live cluster:
|
||
```bash
|
||
polaris dashboard --port 8080 --audit-path=./deploy/
|
||
```
|
||
|
||
### Local Docker container
|
||
|
||
```
|
||
docker run -d -p8080:8080 -v ~/.kube/config:/opt/app/config:ro quay.io/fairwinds/polaris:1.2 polaris dashboard --kubeconfig /opt/app/config
|
||
```
|
||
|
||
## Using the Dashboard
|
||
The Polaris dashboard is a way to get a simple visual overview of the current state of your Kubernetes workloads as well as a roadmap for what can be improved. The dashboard provides a cluster wide overview as well as breaking out results by category, namespace, and workload.
|
||
|
||
<p align="center">
|
||
<img src="/img/dashboard-screenshot.png" alt="Polaris Dashboard" width="550"/>
|
||
</p>
|
||
|
||
Our default standards in Polaris are rather high, so don’t be surprised if your score is lower than you might expect. A key goal for Polaris was to set a high standard and aim for great configuration by default. If the defaults we’ve included are too strict, it’s easy to adjust the configuration as part of the deployment configuration to better suit your workloads.
|