Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 3.3 KB

README.md

File metadata and controls

86 lines (67 loc) · 3.3 KB
Raw

Kubernetes Mutating Webhook for Defaulting AllowPrivilegeEscalation

Build Status Go Report Codecov Container Image License

Controls the nil behavior of the field allowPrivilegeEscalation in the SecurityContext object. Useful in cases where the PSP admission controller isn't enabled or available. With PSP this behavior is managed via the *bool type field defaultAllowPrivilegeEscalation in a PodSecurityPolicy resource.

TODO:

  • find a better way to test Fiber handlers
  • tests for config and health packages
  • webhook should self-manage CA bundle
  • Github Actions with test and coverage badges
  • improve makefile
  • release CI upon tagging
  • publish container image
  • flesh out deploy yaml, add Kustomize support
  • provide install instructions
  • docs showing behavior
  • refactor make target kubectl-install-build to run in container
  • investigate supporting versions v1 and v1beta1 of the AdmissionReview API
  • bump Certificate included in deployment to api version v1

🏁 Quickstart

Prerequisites

  • Kubernetes version: >= v1.16
  • RBAC permissions for the install: ClusterRole cluster-admin
  • Installed on cluster: cert-manager

Install

With kustomize:

# kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- github.com/marshallford/default-allow-privilege-escalation/deploy?ref=vX.Y.Z

Manually with kubectl:

kubectl apply -f https://github.com/marshallford/default-allow-privilege-escalation/releases/latest/download/kubectl-install.yaml

⚙️ Configure

Example config.yaml:

logging:
  level: info
server:
  tls:
    enabled: true
app:
  default: false # default behavior for nil allowPrivilegeEscalation

🤖 Hack

Test

make lint
make test
make coverage

Build

make build
make docker-build # builds container image

Run

make run
make docker-run # runs container image