diff --git a/.circleci/config.yml b/.circleci/config.yml index 90f8e97cd..5d2dc1737 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -132,7 +132,7 @@ jobs: - *test_kube_dashboard test: - working_directory: /go/src/github.com/reactiveops/polaris/ + working_directory: /go/src/github.com/fairwindsops/polaris/ docker: - image: circleci/golang:1.12 steps: @@ -144,7 +144,7 @@ jobs: - *test_binary_dashboard release_binary: - working_directory: /go/src/github.com/reactiveops/polaris/ + working_directory: /go/src/github.com/fairwindsops/polaris/ docker: - image: circleci/golang:1.12 steps: @@ -158,7 +158,7 @@ jobs: - *release_deploy_configs release_images: - working_directory: /go/src/github.com/reactiveops/polaris/ + working_directory: /go/src/github.com/fairwindsops/polaris/ docker: - image: quay.io/reactiveops/ci-images:v8.0-stretch steps: diff --git a/.goreleaser.yml b/.goreleaser.yml index 5e8b0132d..b78f46a69 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -21,7 +21,7 @@ changelog: - '^test:' brew: github: - owner: reactiveops + owner: FairwindsOps name: homebrew-tap folder: Formula description: Open Source Best Practices for Kubernetes diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d17ef679..2c1132ea5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ * Added `--set-exit-code-on-error` and `--set-exit-code-below-score` flags to better support CI/CD # 0.2.1 -* [Fix](https://github.com/reactiveops/polaris/issues/146): Fixed logic on RunAsNonRoot check to incorporate settings in podSpec +* [Fix](https://github.com/FairwindsOps/polaris/issues/146): Fixed logic on RunAsNonRoot check to incorporate settings in podSpec # 0.2.0 * Added `--output-format` flag for better CI/CD support @@ -16,23 +16,23 @@ * Show error message if no kubeconfig is set # 0.1.5 -* [Fix](https://github.com/reactiveops/polaris/issues/125): ignore limits/requests for initContainers -* [Fix](https://github.com/reactiveops/polaris/issues/132): support custom base path +* [Fix](https://github.com/FairwindsOps/polaris/issues/125): ignore limits/requests for initContainers +* [Fix](https://github.com/FairwindsOps/polaris/issues/132): support custom base path # 0.1.4 -* [Fix](https://github.com/reactiveops/polaris/issues/116): details pages getting template errors -* [Fix](https://github.com/reactiveops/polaris/issues/114): support all auth providers -* [Fix](https://github.com/reactiveops/polaris/issues/112): Ignore readiness probe for initContainers +* [Fix](https://github.com/FairwindsOps/polaris/issues/116): details pages getting template errors +* [Fix](https://github.com/FairwindsOps/polaris/issues/114): support all auth providers +* [Fix](https://github.com/FairwindsOps/polaris/issues/112): Ignore readiness probe for initContainers # 0.1.3 -* [Fix](https://github.com/reactiveops/polaris/issues/109): dashboard not updating when running persistently +* [Fix](https://github.com/FairwindsOps/polaris/issues/109): dashboard not updating when running persistently # 0.1.2 * Stored all third-party assets (e.g. Charts.js) to local files to support offline dashboard viewing * Fix: custom configs in `ConfigMap` not respected # 0.1.1 -* [Fix](https://github.com/reactiveops/polaris/issues/93): missing `config.yaml` and dashboard assets in binary releases +* [Fix](https://github.com/FairwindsOps/polaris/issues/93): missing `config.yaml` and dashboard assets in binary releases * Added some tests and better error handling # 0.1.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bac8abba..c99d6e47e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Issues, whether bugs, tasks, or feature requests are essential for keeping Polar This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). Please review this document before contributing to this project. ## Sign the CLA -Before you can contribute, you will need to sign the [Contributor License Agreement](https://cla-assistant.io/reactiveops/polaris). +Before you can contribute, you will need to sign the [Contributor License Agreement](https://cla-assistant.io/fairwinds/polaris). ## Project Structure @@ -15,7 +15,7 @@ Polaris is built on top of [controller-runtime](https://github.com/kubernetes-si ## Getting Started -We label issues with the ["good first issue" tag](https://github.com/reactiveops/polaris/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up. +We label issues with the ["good first issue" tag](https://github.com/FairwindsOps/polaris/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up. ## Setting Up Your Development Environment ### Prerequisites @@ -23,8 +23,8 @@ We label issues with the ["good first issue" tag](https://github.com/reactiveops * If you want to see the local changes you make on a Polaris dashboard, you will need access to a Kubernetes cluster defined in `~/.kube/config` ### Installation -* Install the project with `go get github.com/reactiveops/polaris` -* Change into the polaris directory which is installed at `$GOPATH/src/github.com/reactiveops/polaris` +* Install the project with `go get github.com/fairwindsops/polaris` +* Change into the polaris directory which is installed at `$GOPATH/src/github.com/fairwindsops/polaris` * See the dashboard with `go run main.go --dashboard`, then open http://localhost:8080/ * See the audit data `go run main.go --audit`. This command shows the audit information on the command line. @@ -76,12 +76,12 @@ it needs to be a minor or major release in order to prevent breaking the Helm ch ### Minor/Major releases Minor and major releases need to change both this repository and the -[Helm chart repo](https://github.com/reactiveops/charts/). +[Helm chart repo](https://github.com/FairwindsOps/charts/). The steps are: -1. Modify the [Helm chart](https://github.com/reactiveops/charts/stable/polaris) +1. Modify the [Helm chart](https://github.com/FairwindsOps/charts/stable/polaris) 1. Clone the helm charts repo - 1. `git clone https://github.com/reactiveops/charts` + 1. `git clone https://github.com/FairwindsOps/charts` 2. `git checkout -b yourname/update-polaris` 1. Bump the version number in: 1. stable/polaris/README.md diff --git a/Dockerfile b/Dockerfile index df8218fa0..263c49cb2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ FROM golang:1.12.4 AS build-env -WORKDIR /go/src/github.com/reactiveops/polaris/ +WORKDIR /go/src/github.com/fairwindsops/polaris/ COPY . . RUN go get -u github.com/gobuffalo/packr/v2/packr2 @@ -11,7 +11,7 @@ RUN apk --no-cache add ca-certificates RUN addgroup -S polaris && adduser -u 1200 -S polaris -G polaris USER 1200 -COPY --from=build-env /go/src/github.com/reactiveops/polaris/polaris . +COPY --from=build-env /go/src/github.com/fairwindsops/polaris/polaris . WORKDIR /opt/app diff --git a/LICENSE b/LICENSE index 394f00f7e..6c9c09704 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2019 ReactiveOps + Copyright 2019 FairwindsOps Inc Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 131800c40..d69d3aef4 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,12 @@ 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@fairwinds.com` +**Want to learn more?** Fairwinds 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 ``` -kubectl apply -f https://github.com/reactiveops/polaris/releases/latest/download/dashboard.yaml +kubectl apply -f https://github.com/FairwindsOps/polaris/releases/latest/download/dashboard.yaml kubectl port-forward --namespace polaris svc/polaris-dashboard 8080:80 ``` With the port forwarding in place, you can open http://localhost:8080 in your browser to view the dashboard. @@ -56,39 +56,39 @@ or run against local YAML files. ### kubectl #### Dashboard ``` -kubectl apply -f https://github.com/reactiveops/polaris/releases/latest/download/dashboard.yaml +kubectl apply -f https://github.com/FairwindsOps/polaris/releases/latest/download/dashboard.yaml kubectl port-forward --namespace polaris svc/polaris-dashboard 8080:80 ``` #### Webhook ``` -kubectl apply -f https://github.com/reactiveops/polaris/releases/latest/download/webhook.yaml +kubectl apply -f https://github.com/FairwindsOps/polaris/releases/latest/download/webhook.yaml ``` ### Helm -Start by adding the ReactiveOps Helm repo: +Start by adding the Fairwinds Helm repo: ``` -helm repo add reactiveops-stable https://charts.reactiveops.com/stable +helm repo add fairwinds-stable https://charts.fairwinds.com/stable ``` #### Dashboard ``` -helm upgrade --install polaris reactiveops-stable/polaris --namespace polaris +helm upgrade --install polaris fairwinds-stable/polaris --namespace polaris kubectl port-forward --namespace polaris svc/polaris-dashboard 8080:80 ``` #### Webhook ``` -helm upgrade --install polaris reactiveops-stable/polaris --namespace polaris \ +helm upgrade --install polaris fairwinds-stable/polaris --namespace polaris \ --set webhook.enable=true --set dashboard.enable=false ``` ### Local Binary #### Installation -Binary releases are available on the [releases page](https://github.com/reactiveops/polaris/releases) or can be installed with [Homebrew](https://brew.sh/): +Binary releases are available on the [releases page](https://github.com/FairwindsOps/polaris/releases) or can be installed with [Homebrew](https://brew.sh/): ``` -brew tap reactiveops/tap -brew install reactiveops/tap/polaris +brew tap FairwindsOps/tap +brew install FairwindsOps/tap/polaris polaris --version ``` @@ -127,7 +127,7 @@ polaris --audit --audit-path ./deploy/ \ ## Configuration -Polaris supports a wide range of validations covering a number of Kubernetes best practices. Here's a sample configuration file that includes all currently supported checks. The [default configuration](https://github.com/reactiveops/polaris/blob/master/examples/config.yaml) contains a number of those checks. This repository also includes a sample [full configuration file](https://github.com/reactiveops/polaris/blob/master/examples/config-full.yaml) that enables all available checks. +Polaris supports a wide range of validations covering a number of Kubernetes best practices. Here's a sample configuration file that includes all currently supported checks. The [default configuration](https://github.com/FairwindsOps/polaris/blob/master/examples/config.yaml) contains a number of those checks. This repository also includes a sample [full configuration file](https://github.com/FairwindsOps/polaris/blob/master/examples/config-full.yaml) that enables all available checks. Each check can be assigned a `severity`. Only checks with a severity of `error` or `warning` will be validated. The results of these validations are visible on the dashboard. In the case of the validating webhook, only failures with a severity of `error` will result in a change being rejected. diff --git a/main.go b/main.go index fc9c873c5..ad34c674d 100644 --- a/main.go +++ b/main.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -23,11 +23,11 @@ import ( "net/http" "os" - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/dashboard" - "github.com/reactiveops/polaris/pkg/kube" - "github.com/reactiveops/polaris/pkg/validator" - fwebhook "github.com/reactiveops/polaris/pkg/webhook" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/dashboard" + "github.com/fairwindsops/polaris/pkg/kube" + "github.com/fairwindsops/polaris/pkg/validator" + fwebhook "github.com/fairwindsops/polaris/pkg/webhook" "github.com/sirupsen/logrus" appsv1 "k8s.io/api/apps/v1" extensionsv1beta1 "k8s.io/api/extensions/v1beta1" diff --git a/pkg/config/config.go b/pkg/config/config.go index 18f268e42..c8a75e479 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go index 23720459a..8a6f2c376 100644 --- a/pkg/config/config_test.go +++ b/pkg/config/config_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/pkg/config/severity.go b/pkg/config/severity.go index ca61f2532..f1ddc9d7f 100644 --- a/pkg/config/severity.go +++ b/pkg/config/severity.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/pkg/dashboard/dashboard.go b/pkg/dashboard/dashboard.go index 7e33c6a88..425958296 100644 --- a/pkg/dashboard/dashboard.go +++ b/pkg/dashboard/dashboard.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -23,9 +23,9 @@ import ( packr "github.com/gobuffalo/packr/v2" "github.com/gorilla/mux" - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/kube" - "github.com/reactiveops/polaris/pkg/validator" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/kube" + "github.com/fairwindsops/polaris/pkg/validator" "github.com/sirupsen/logrus" "gitlab.com/golang-commonmark/markdown" ) diff --git a/pkg/dashboard/helpers.go b/pkg/dashboard/helpers.go index 2165369cc..0f748366b 100644 --- a/pkg/dashboard/helpers.go +++ b/pkg/dashboard/helpers.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ package dashboard import ( "fmt" - "github.com/reactiveops/polaris/pkg/validator" + "github.com/fairwindsops/polaris/pkg/validator" "strings" ) diff --git a/pkg/kube/resources_test.go b/pkg/kube/resources_test.go index f57a9f3cd..734eb6820 100644 --- a/pkg/kube/resources_test.go +++ b/pkg/kube/resources_test.go @@ -1,7 +1,7 @@ package kube import ( - "github.com/reactiveops/polaris/test" + "github.com/fairwindsops/polaris/test" "github.com/stretchr/testify/assert" "testing" "time" diff --git a/pkg/validator/container.go b/pkg/validator/container.go index 65ec9f61e..b43fe93b2 100644 --- a/pkg/validator/container.go +++ b/pkg/validator/container.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -18,8 +18,8 @@ import ( "fmt" "strings" - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/validator/messages" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/validator/messages" corev1 "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/api/resource" ) diff --git a/pkg/validator/container_test.go b/pkg/validator/container_test.go index 6f3995556..5c9fcccdc 100644 --- a/pkg/validator/container_test.go +++ b/pkg/validator/container_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -17,7 +17,7 @@ package validator import ( "testing" - conf "github.com/reactiveops/polaris/pkg/config" + conf "github.com/fairwindsops/polaris/pkg/config" "github.com/stretchr/testify/assert" corev1 "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/api/resource" diff --git a/pkg/validator/controller.go b/pkg/validator/controller.go index 67f791ba4..d242c6d54 100644 --- a/pkg/validator/controller.go +++ b/pkg/validator/controller.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -15,8 +15,8 @@ package validator import ( - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/kube" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/kube" appsv1 "k8s.io/api/apps/v1" corev1 "k8s.io/api/core/v1" ) diff --git a/pkg/validator/fullaudit.go b/pkg/validator/fullaudit.go index e484d8346..55a5edb76 100644 --- a/pkg/validator/fullaudit.go +++ b/pkg/validator/fullaudit.go @@ -3,8 +3,8 @@ package validator import ( "time" - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/kube" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/kube" ) const ( diff --git a/pkg/validator/fullaudit_test.go b/pkg/validator/fullaudit_test.go index d8b9951a1..34ef15f7b 100644 --- a/pkg/validator/fullaudit_test.go +++ b/pkg/validator/fullaudit_test.go @@ -3,9 +3,9 @@ package validator import ( "testing" - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/kube" - "github.com/reactiveops/polaris/test" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/kube" + "github.com/fairwindsops/polaris/test" "github.com/stretchr/testify/assert" ) diff --git a/pkg/validator/pod.go b/pkg/validator/pod.go index 2c4e33e5f..1b0021c81 100644 --- a/pkg/validator/pod.go +++ b/pkg/validator/pod.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -15,8 +15,8 @@ package validator import ( - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/pkg/validator/messages" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/pkg/validator/messages" corev1 "k8s.io/api/core/v1" ) diff --git a/pkg/validator/pod_test.go b/pkg/validator/pod_test.go index 7126a96bb..7e53901eb 100644 --- a/pkg/validator/pod_test.go +++ b/pkg/validator/pod_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -17,8 +17,8 @@ package validator import ( "testing" - conf "github.com/reactiveops/polaris/pkg/config" - "github.com/reactiveops/polaris/test" + conf "github.com/fairwindsops/polaris/pkg/config" + "github.com/fairwindsops/polaris/test" "github.com/stretchr/testify/assert" ) diff --git a/pkg/validator/resource.go b/pkg/validator/resource.go index 3ac533005..aa8afca60 100644 --- a/pkg/validator/resource.go +++ b/pkg/validator/resource.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -15,7 +15,7 @@ package validator import ( - conf "github.com/reactiveops/polaris/pkg/config" + conf "github.com/fairwindsops/polaris/pkg/config" "github.com/sirupsen/logrus" ) diff --git a/pkg/validator/types.go b/pkg/validator/types.go index f0fc0ca7e..8cc76ccc6 100644 --- a/pkg/validator/types.go +++ b/pkg/validator/types.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/pkg/webhook/validator.go b/pkg/webhook/validator.go index b46d71fe5..4539a4edf 100644 --- a/pkg/webhook/validator.go +++ b/pkg/webhook/validator.go @@ -1,4 +1,4 @@ -// Copyright 2019 ReactiveOps +// Copyright 2019 FairwindsOps Inc // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -20,8 +20,8 @@ import ( "net/http" "os" - conf "github.com/reactiveops/polaris/pkg/config" - validator "github.com/reactiveops/polaris/pkg/validator" + conf "github.com/fairwindsops/polaris/pkg/config" + validator "github.com/fairwindsops/polaris/pkg/validator" "github.com/sirupsen/logrus" admissionregistrationv1beta1 "k8s.io/api/admissionregistration/v1beta1" appsv1 "k8s.io/api/apps/v1" diff --git a/test/.open.swp b/test/.open.swp index 248867a7e..f085d9d30 100644 Binary files a/test/.open.swp and b/test/.open.swp differ