Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 3.61 KB

README.md

File metadata and controls

90 lines (64 loc) · 3.61 KB
Raw

pod-reaper

Provide namespace scheduling and manual startup

Screenshot

This component was created to help manage a Kubernetes cluster shared by different teams. Assumptions are:

  • each team has one or more namespaces where their pods run
  • don't want to pay for 24/7 operation
  • for most namespaces there's a core CI window of 8h each weekday
  • occasionally teams would like to use their environments after hours

This solution is a k8s pod which runs in the background:

  • it "stops" namespaces by setting a zero limit and deleting pods
  • it "starts" namespaces by removing the zero limit
  • namespaces are stopped 8h after the last scheduled or manual start

The UI served by the k8s pod allows the following:

  • click ">" to manually start a namespace or extend for another 8 hours
  • set optional weekday start time for namespace
  • set memory limit for namespace (min 10G, max 100G)

Running

To build and run the docker container, use make run then go to http://localhost:8080 for the UI.

Configuration

The container can be configured using environment variables:

Variable Default Description
IGNORED_NAMESPACES kube-system,kube-public,kube-node-lease,podreaper,docker Reaper will ignore these namespaces
ZONE_ID UTC Time Zone used by UI
NAMESPACE_TICK 11s How often to update namespace data for UI
NAMESPACES_TICK 17s How often to check for new namespaces
RANGER_TICK 41s How often to check limit ranges
CLOCK_TICK 13s How often to update UI clock
REAPER_TICK 29s How often to check if pods need to be reaped

Deployment

# namespace needs to be created before applying
kubectl create ns podreaper

# deploys pod as well as service account, cluster role
# and cluster role binding which allow it to make changes to the
# other namespaces
kubectl apply -f deploy.yaml -n podreaper

# to access the ui on http://localhost:8080
kubectl port-forward deployment/podreaper 8080:8080 -n podreaper

Development

Install front end modules

cd frontend
npm install

Note: In order to use the kubernetes backend you must have a working cluster and kubeconfig defined.

  1. Create namespace for config kubectl create ns podreaper
  2. Run the back end using make backend-dev
  3. Run the front end using make frontend-dev
  4. Go to http://localhost:3000 in your browser to test. The UI will automatically reload when front end code is changed.

For front end unit tests run make frontend-test.

Links