Skip to content

Commit

Permalink
add roadmap, changelog, links
Browse files Browse the repository at this point in the history
  • Loading branch information
rbren committed May 14, 2019
1 parent 6ec83e7 commit 6c45b15
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 1.0.0
* Dashboard fully functional
* Validating webhook functional, but still considered beta
* Checks:
* Health
* readiness probe missing
* liveness probe missing
* Images
* tag not specified
* pull policy not always
* Networking
* host network set
* host port set
* Resources
* cpu/memory requests missing
* cpu/memory limits missing
* cpu/memory ranges exceeded
* Security
* security capabilities
* host IPC set
* host PID set
* not read-only fs
* privilege escalation allowed
* run as root allowed
* run as privileged
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,13 @@ Polaris validation checks fall into several different categories:

## License
Apache License 2.0

## Contributing
PRs welcome! Check out the [Contributing Guidlines](CONTRIBUTING.md),
[Code of Conduct](CODE_OF_CONDUCT.md), and [Roadmap](ROADMAP.md) for more information.

## Further Information
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 `[email protected]` or [visit our website](https://reactiveops.com)
28 changes: 28 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Polaris Roadmap
We plan to continue expanding the list of checks available to Polaris users,
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
### Validating Webhook
The validating webhook rejects incoming workloads if they cause `error`-level
issues, as defined by the Polaris configuration.

The webhook server is currently functional, but largely untested. Because
the validating webhook has the potential to cause headaches for users,
we have marked it as `beta` for now.

We will continue to gather feedback here and will move the webhook out of `beta`
when we feel it's ready.

#### TODO
* Pass `warning`-level messages back to `kubectl` if possible (may require changes
to core k8s or `kubectl`)

## Checks
These are checks that we plan to implement. If you have requests or ideas, let us know!

### Images
* List of allowed/disallowed registries

0 comments on commit 6c45b15

Please sign in to comment.