contributor-guide.md

Contributor Guide

Required Tools

• Git
• Go 1.16+
• Docker
• kubectl
• kind v0.10.0+

Build and Run

Build descheduler.

cd $GOPATH/src/sigs.k8s.io
git clone https://github.com/kubernetes-sigs/descheduler.git
cd descheduler
make

Run descheduler.

./_output/bin/descheduler --kubeconfig <path to kubeconfig> --policy-config-file <path-to-policy-file> --v 1

View all CLI options.

./_output/bin/descheduler --help

Run Tests

GOOS=linux make dev-image
kind create cluster --config hack/kind_config.yaml
kind load docker-image <image name>
kind get kubeconfig > /tmp/admin.conf
export KUBECONFIG=/tmp/admin.conf
make test-unit
make test-e2e

Run Helm Tests

Run the helm test for a particular descheduler release by setting below variables,

HELM_IMAGE_REPO="descheduler"
HELM_IMAGE_TAG="helm-test"
HELM_CHART_LOCATION="./charts/descheduler"

The helm tests runs as part of descheduler CI. But, to run it manually from the descheduler root,

make test-helm

Miscellaneous

See the hack directory for additional tools and scripts used for developing the descheduler.