Skip to content

Latest commit

 

History

History
98 lines (91 loc) · 2.89 KB

develop.md

File metadata and controls

98 lines (91 loc) · 2.89 KB
Raw

Developer guide

How to build

This section is about building on the local host, e.g. for debug purpose. Your GOPATH environment variable should be set. After cloning it into the $GOPATH/src/sigs.k8s.io directory you can build an image by the following command:

make local-image

After that you'll take localhost:5000/scheduler-plugins/kube-scheduler:latest and localhost:5000/scheduler-plugins/controller:latest images.

Your source code has to be located at $GOPATH/src/sigs.k8s.io, if you would like to change some type definition of the interfaces and regenerate their implementation by running

hack/update-codegen.sh

command. If you would like to build just the binaries you can do it by

make

command. If you changed the branch or added new dependency you might need to regenerate vendor directory, for this you can use

make autogen

command.

How to debug

By default debug information is stripped, to keep it in the binary you need to remove -w command line option from ldflags in the Makefile. You can run all unit tests by make unit-test command or if you would like to run exact unit test

GOFLAGS="-v" go test ./pkg/util/podgroup.go ./pkg/util/constants.go ./pkg/util/podgroup_test.go

-v in GOFLAGS was used for verbosity You can also run integration test locally, but etcd port 2379 on your system should be free.

make integration-test

How to start

If you would like to start produced kube-scheduler image you can use it in your static kube-scheduler manifests or any kind of deployment spec as following:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: schedulingplugin
  namespace: kube-system
spec:
  replicas: 1
  selector:
    matchLabels:
      component: scheduler
      tier: control-plane
  template:
    metadata:
      labels:
        component: scheduler
        tier: control-plane
    spec:
      nodeSelector:
        node-role.kubernetes.io/master: ""
      containers:
        - image: localhost:5000/scheduler-plugins/kube-scheduler:latest
          imagePullPolicy: Never
          command:
          - /bin/kube-scheduler
          - --authentication-kubeconfig=/etc/kubernetes/scheduler.conf
          - --authorization-kubeconfig=/etc/kubernetes/scheduler.conf
          - --config=/etc/kubernetes/configs/scheduler-config.yaml
          - -v=9
          name: schedulingplugin
          securityContext:
            privileged: true
          volumeMounts:
          - mountPath: /etc/kubernetes
            name: etckubernetes
      hostNetwork: false
      hostPID: false
      volumes:
      - hostPath:
          path: /etc/kubernetes/
          type: Directory
        name: etckubernetes

Where example for scheduler-config.yaml, could be taken from manifests/*/scheduler-config.yaml.

Before submitting

In addition to starting integration and unit tests, check formatting

make verify-gofmt