Skip to content

Commit

Permalink
Merge branch 'wl/config-URL' of https://github.com/FairwindsOps/polaris
Browse files Browse the repository at this point in the history
… into wl/config-URL
  • Loading branch information
willfairwinds committed Jul 29, 2019
2 parents baa6521 + a6525fc commit f493c38
Show file tree
Hide file tree
Showing 17 changed files with 338 additions and 39 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

---
name: Bug report
about: Let us know about an unexpected error, a crash, or an incorrect behavior.

---
### Installation Process
<!---
Did you install polaris on your local machine, or in a kubernetes cluster? Did you use kubectl, helm, brew, a GitHub release, or the source code? Let us know below.
-->

### Polaris Version
<!---
If you are using polaris locally, run `polaris --version` to show the version, and paste the result between the ``` marks below.
If you are not running the latest version of Polaris, please try upgrading because your issue may have already been fixed.
-->

```
...
```

### Expected Behavior
<!--
What should have happened?
-->

### Actual Behavior
<!--
What actually happened?
-->

### Steps to Reproduce
<!--
Please list the full steps required to reproduce the issue, for example:
1. `polaris --audit --output-format score`
-->

### Additional Context
<!--
Are there anything atypical about your situation that we should know?
-->

### References
<!--
Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example:
- #6017
-->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Other
about: For misc. tasks like research or continued conversation
title: ''
labels: ''
assignees: ''

---


3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# x.x.x (next release)

# 0.3.1
* Changed dashboard branding to refer to new org name Fairwinds

# 0.3.0
* Added `--set-exit-code-on-error` and `--set-exit-code-below-score` flags to better support CI/CD

Expand Down
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,8 @@ go test ./pkg/... -v -coverprofile cover.out

## Creating a New Issue

If you've encountered an issue that is not already reported, please create an issue that contains the following:
If you've encountered an issue that is not already reported, please create a [new issue](https://github.com/FairwindsOps/polaris/issues), choose `Bug Report`, `Feature Request` or `Misc.` and follow the instructions in the template.

- Clear description of the issue
- Steps to reproduce it
- Appropriate labels

## Creating a Pull Request

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
[![Version][version-image]][version-link] [![CircleCI][circleci-image]][circleci-link] [![Go Report Card][goreport-image]][goreport-link]
</div>

[version-image]: https://img.shields.io/static/v1.svg?label=Version&message=0.3.0&color=239922
[version-link]: https://github.com/reactiveops/polaris
[version-image]: https://img.shields.io/static/v1.svg?label=Version&message=0.3.1&color=239922
[version-link]: https://github.com/FairwindsOps/polaris

[goreport-image]: https://goreportcard.com/badge/github.com/reactiveops/polaris
[goreport-link]: https://goreportcard.com/report/github.com/reactiveops/polaris
[goreport-image]: https://goreportcard.com/badge/github.com/FairwindsOps/polaris
[goreport-link]: https://goreportcard.com/report/github.com/FairwindsOps/polaris

[circleci-image]: https://circleci.com/gh/reactiveops/polaris.svg?style=svg
[circleci-link]: https://circleci.com/gh/reactiveops/polaris.svg
[circleci-image]: https://circleci.com/gh/FairwindsOps/polaris.svg?style=svg
[circleci-link]: https://circleci.com/gh/FairwindsOps/polaris.svg

Polaris helps keep your cluster healthy. It runs a variety of checks to ensure that
Kubernetes deployments are configured using best practices, helping you avoid
Expand All @@ -22,7 +22,7 @@ problems in the future. Polaris can be run in a few different modes:
- An experimental validating webhook that can prevent any future deployments that do not live up to a configured standard.
- A command-line audit that can be incorporated into your CI/CD pipeline

**Want to learn more?** ReactiveOps holds [office hours on Zoom](https://zoom.us/j/242508205) the first Friday of every month, at 12pm Eastern. You can also reach out via email at `opensource@reactiveops.com`
**Want to learn more?** ReactiveOps holds [office hours on Zoom](https://zoom.us/j/242508205) the first Friday of every month, at 12pm Eastern. You can also reach out via email at `opensource@fairwinds.com`

## Quickstart

Expand Down Expand Up @@ -197,7 +197,7 @@ PRs welcome! Check out the [Contributing Guidelines](CONTRIBUTING.md),
A history of changes to this project can be viewed in the [Changelog](CHANGELOG.md)

If you'd like to learn more about Polaris, or if you'd like to speak with
a Kubernetes expert, you can contact `info@reactiveops.com` or [visit our website](https://reactiveops.com)
a Kubernetes expert, you can contact `info@fairwinds.com` or [visit our website](https://fairwinds.com)

## License
Apache License 2.0
22 changes: 14 additions & 8 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,16 @@ as well as the project's overall functionality.
If you have ideas for a new check, or for new Polaris features,
you can submit a pull request for this file, or open an issue in GitHub.

## Features
## Q3 2019
Below is a list of work we plan to get done this quarter. Some more details can be found under
[Future Work](#future_work), or
[in the milestone](https://github.com/FairwindsOps/polaris/milestone/1)
* Rule exceptions - we'd like to provide a way of overriding Polaris checks on individual controllers, e.g. through annotations
* More controller types - we plan to implement checks for more than just deployments
* Image repo checks - we plan to provide a check that ensures all repos conform to a set of user-defined patterns
* OPA integration (investigate only) - we plan to investigate the potential use of OPA to let users define custom Polaris checks

## Future Work
### Validating Webhook
The validating webhook rejects incoming workloads if they cause `error`-level
issues, as defined by the Polaris configuration.
Expand All @@ -21,7 +30,7 @@ when we feel it's ready.
* Pass `warning`-level messages back to `kubectl` if possible (may require changes
to core k8s or `kubectl`)

## Ability to override checks
### Ability to override checks
We plan to add the ability to override Polaris checks for particular namespaces
and workloads. This may be something that is set in the Polaris configuration,
or an annotation that can be added to the resource definition.
Expand All @@ -30,12 +39,9 @@ This is important, as certain workloads have good reason to skip particular Pola
checks - for instance, the `dns-controller` deployment in `kube-system` needs to have
the host network configured.

## Checks
These are checks that we plan to implement. If you have requests or ideas,
let us know! You can submit a pull request for this file, or open an issue in GitHub.

### Images
* List of allowed/disallowed registries
### Images Registries Check
We'd like to allow users to restrict images to a list of allowed/disallowed registries.
We'll likely allow patterns, e.g. `*.dkr.ecr.*.amazonaws.com`

### New controller types
Currently we only look at Deployments. We plan to also validate these types of controllers:
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import (

const (
// Version represents the current release version of Polaris
Version = "0.3.0"
Version = "0.3.1"
)

func main() {
Expand Down
13 changes: 3 additions & 10 deletions pkg/dashboard/assets/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,17 @@ body {
}

.navbar .logo {
width: 250px;
height: 80px;
}

.navbar span.oss-text {
color: #23103A;
display: block;
font-size: 11px;
margin-bottom: 3px;
.navbar .fw-logo {
height: 64px;
}

.navbar a {
text-decoration: none;
}

.navbar .ro-logo {
height: 50px;
}

.card {
margin: 25px 20px;
padding: 20px;
Expand Down
50 changes: 50 additions & 0 deletions pkg/dashboard/assets/images/fw-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkg/dashboard/assets/images/oss-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed pkg/dashboard/assets/images/ro-logo.png
Binary file not shown.
2 changes: 1 addition & 1 deletion pkg/dashboard/templates/footer.gohtml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{define "footer"}}
<div class="footer">
<a href="https://reactiveops.com?source=polaris" target="_blank">&copy;2019 ReactiveOps Inc.</a>
<a href="https://fairwinds.com?source=polaris" target="_blank">&copy;2019 FairwindsOps Inc.</a>
</div>
{{end}}
2 changes: 1 addition & 1 deletion pkg/dashboard/templates/head.gohtml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<base href="{{ .BasePath }}">
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>ReactiveOps Polaris</title>
<title>Fairwinds Polaris</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">

Expand Down
5 changes: 2 additions & 3 deletions pkg/dashboard/templates/navbar.gohtml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
<img class="logo" src="static/images/polaris-logo.png" alt="Polaris" />
</a>
<div class="navbar-right">
<a href="https://reactiveops.com?source=polaris" target="_blank">
<span class="oss-text">An Open Source Project By</span>
<img class="ro-logo" src="static/images/ro-logo.png" alt="ReactiveOps" />
<a href="https://fairwinds.com?source=polaris" target="_blank">
<img class="fw-logo" src="static/images/oss-logo.png" alt="Fairwinds" />
</a>
</div>
</div>
Expand Down
Loading

0 comments on commit f493c38

Please sign in to comment.