Configure Multiple Schedulers

Kubernetes ships with a default scheduler that is described here. If the default scheduler does not suit your needs you can implement your own scheduler. Not just that, you can even run multiple schedulers simultaneously alongside the default scheduler and instruct Kubernetes what scheduler to use for each of your pods. Let’s learn how to run multiple schedulers in Kubernetes with an example.

A detailed description of how to implement a scheduler is outside the scope of this document. Please refer to the kube-scheduler implementation in pkg/scheduler in the Kubernetes source directory for a canonical example.

Before you begin

You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using minikube or you can use one of these Kubernetes playgrounds:

To check the version, enter kubectl version.

Package the scheduler

Package your scheduler binary into a container image. For the purposes of this example, let’s just use the default scheduler (kube-scheduler) as our second scheduler as well. Clone the Kubernetes source code from GitHub and build the source.

  1. git clone https://github.com/kubernetes/kubernetes.git
  2. cd kubernetes
  3. make

Create a container image containing the kube-scheduler binary. Here is the Dockerfile to build the image:

  1. FROM busybox
  2. ADD ./_output/local/bin/linux/amd64/kube-scheduler /usr/local/bin/kube-scheduler

Save the file as Dockerfile, build the image and push it to a registry. This example pushes the image to Google Container Registry (GCR). For more details, please read the GCR documentation.

  1. docker build -t gcr.io/my-gcp-project/my-kube-scheduler:1.0 .
  2. gcloud docker -- push gcr.io/my-gcp-project/my-kube-scheduler:1.0

Define a Kubernetes Deployment for the scheduler

Now that we have our scheduler in a container image, we can just create a pod config for it and run it in our Kubernetes cluster. But instead of creating a pod directly in the cluster, let’s use a Deployment for this example. A Deployment manages a Replica Set which in turn manages the pods, thereby making the scheduler resilient to failures. Here is the deployment config. Save it as my-scheduler.yaml:

admin/sched/my-scheduler.yaml Configure Multiple Schedulers - 图1

  1. apiVersion: v1
  2. kind: ServiceAccount
  3. metadata:
  4.   name: my-scheduler
  5.   namespace: kube-system
  6. ---
  7. apiVersion: rbac.authorization.k8s.io/v1
  8. kind: ClusterRoleBinding
  9. metadata:
  10.   name: my-scheduler-as-kube-scheduler
  11. subjects:
  12. - kind: ServiceAccount
  13.   name: my-scheduler
  14.   namespace: kube-system
  15. roleRef:
  16.   kind: ClusterRole
  17.   name: system:kube-scheduler
  18.   apiGroup: rbac.authorization.k8s.io
  19. ---
  20. apiVersion: rbac.authorization.k8s.io/v1
  21. kind: ClusterRoleBinding
  22. metadata:
  23.   name: my-scheduler-as-volume-scheduler
  24. subjects:
  25. - kind: ServiceAccount
  26.   name: my-scheduler
  27.   namespace: kube-system
  28. roleRef:
  29.   kind: ClusterRole
  30.   name: system:volume-scheduler
  31.   apiGroup: rbac.authorization.k8s.io
  32. ---
  33. apiVersion: apps/v1
  34. kind: Deployment
  35. metadata:
  36.   labels:
  37.     component: scheduler
  38.     tier: control-plane
  39.   name: my-scheduler
  40.   namespace: kube-system
  41. spec:
  42.   selector:
  43.     matchLabels:
  44.       component: scheduler
  45.       tier: control-plane
  46.   replicas: 1
  47.   template:
  48.     metadata:
  49.       labels:
  50.         component: scheduler
  51.         tier: control-plane
  52.         version: second
  53.     spec:
  54.       serviceAccountName: my-scheduler
  55.       containers:
  56.       - command:
  57.         - /usr/local/bin/kube-scheduler
  58.         - --address=0.0.0.0
  59.         - --leader-elect=false
  60.         - --scheduler-name=my-scheduler
  61.         image: gcr.io/my-gcp-project/my-kube-scheduler:1.0
  62.         livenessProbe:
  63.           httpGet:
  64.             path: /healthz
  65.             port: 10251
  66.           initialDelaySeconds: 15
  67.         name: kube-second-scheduler
  68.         readinessProbe:
  69.           httpGet:
  70.             path: /healthz
  71.             port: 10251
  72.         resources:
  73.           requests:
  74.             cpu: '0.1'
  75.         securityContext:
  76.           privileged: false
  77.         volumeMounts: []
  78.       hostNetwork: false
  79.       hostPID: false
  80.       volumes: []

An important thing to note here is that the name of the scheduler specified as an argument to the scheduler command in the container spec should be unique. This is the name that is matched against the value of the optional spec.schedulerName on pods, to determine whether this scheduler is responsible for scheduling a particular pod.

Note also that we created a dedicated service account my-scheduler and bind the cluster role system:kube-scheduler to it so that it can acquire the same privileges as kube-scheduler.

Please see the kube-scheduler documentation for detailed description of other command line arguments.

Run the second scheduler in the cluster

In order to run your scheduler in a Kubernetes cluster, just create the deployment specified in the config above in a Kubernetes cluster:

  1. kubectl create -f my-scheduler.yaml

Verify that the scheduler pod is running:

  1. kubectl get pods --namespace=kube-system
  1. NAME                                           READY     STATUS    RESTARTS   AGE
  2. ....
  3. my-scheduler-lnf4s-4744f                       1/1       Running   0          2m
  4. ...

You should see a “Running” my-scheduler pod, in addition to the default kube-scheduler pod in this list.

Enable leader election

To run multiple-scheduler with leader election enabled, you must do the following:

First, update the following fields in your YAML file:

  • --leader-elect=true
  • --lock-object-namespace=<lock-object-namespace>
  • --lock-object-name=<lock-object-name>

Note: The control plane creates the lock objects for you, but the namespace must already exist. You can use the kube-system namespace.

If RBAC is enabled on your cluster, you must update the system:kube-scheduler cluster role. Add your scheduler name to the resourceNames of the rule applied for endpoints and leases resources, as in the following example:

  1. kubectl edit clusterrole system:kube-scheduler

admin/sched/clusterrole.yaml Configure Multiple Schedulers - 图2

  1. apiVersion: rbac.authorization.k8s.io/v1
  2. kind: ClusterRole
  3. metadata:
  4.   annotations:
  5.     rbac.authorization.kubernetes.io/autoupdate: "true"
  6.   labels:
  7.     kubernetes.io/bootstrapping: rbac-defaults
  8.   name: system:kube-scheduler
  9. rules:
  10.   - apiGroups:
  11.       - coordination.k8s.io
  12.     resources:
  13.       - leases
  14.     verbs:
  15.       - create
  16.   - apiGroups:
  17.       - coordination.k8s.io
  18.     resourceNames:
  19.       - kube-scheduler
  20.       - my-scheduler
  21.     resources:
  22.       - leases
  23.     verbs:
  24.       - get
  25.       - update
  26.   - apiGroups:
  27.       - ""
  28.     resourceNames:
  29.       - kube-scheduler
  30.       - my-scheduler
  31.     resources:
  32.       - endpoints
  33.     verbs:
  34.       - delete
  35.       - get
  36.       - patch
  37.       - update

Specify schedulers for pods

Now that our second scheduler is running, let’s create some pods, and direct them to be scheduled by either the default scheduler or the one we just deployed. In order to schedule a given pod using a specific scheduler, we specify the name of the scheduler in that pod spec. Let’s look at three examples.

  • Pod spec without any scheduler name

    admin/sched/pod1.yaml Configure Multiple Schedulers - 图3

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4.   name: no-annotation
    5.   labels:
    6.     name: multischeduler-example
    7. spec:
    8.   containers:
    9.   - name: pod-with-no-annotation-container
    10.     image: k8s.gcr.io/pause:2.0

    When no scheduler name is supplied, the pod is automatically scheduled using the default-scheduler.

    Save this file as pod1.yaml and submit it to the Kubernetes cluster.

    1. kubectl create -f pod1.yaml

  • Pod spec with default-scheduler

    admin/sched/pod2.yaml Configure Multiple Schedulers - 图4

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4.   name: annotation-default-scheduler
    5.   labels:
    6.     name: multischeduler-example
    7. spec:
    8.   schedulerName: default-scheduler
    9.   containers:
    10.   - name: pod-with-default-annotation-container
    11.     image: k8s.gcr.io/pause:2.0

    A scheduler is specified by supplying the scheduler name as a value to spec.schedulerName. In this case, we supply the name of the default scheduler which is default-scheduler.

    Save this file as pod2.yaml and submit it to the Kubernetes cluster.

    1. kubectl create -f pod2.yaml

  • Pod spec with my-scheduler

    admin/sched/pod3.yaml Configure Multiple Schedulers - 图5

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4.   name: annotation-second-scheduler
    5.   labels:
    6.     name: multischeduler-example
    7. spec:
    8.   schedulerName: my-scheduler
    9.   containers:
    10.   - name: pod-with-second-annotation-container
    11.     image: k8s.gcr.io/pause:2.0

    In this case, we specify that this pod should be scheduled using the scheduler that we deployed - my-scheduler. Note that the value of spec.schedulerName should match the name supplied to the scheduler command as an argument in the deployment config for the scheduler.

    Save this file as pod3.yaml and submit it to the Kubernetes cluster.

    1. kubectl create -f pod3.yaml

    Verify that all three pods are running.

    1. kubectl get pods

Verifying that the pods were scheduled using the desired schedulers

In order to make it easier to work through these examples, we did not verify that the pods were actually scheduled using the desired schedulers. We can verify that by changing the order of pod and deployment config submissions above. If we submit all the pod configs to a Kubernetes cluster before submitting the scheduler deployment config, we see that the pod annotation-second-scheduler remains in “Pending” state forever while the other two pods get scheduled. Once we submit the scheduler deployment config and our new scheduler starts running, the annotation-second-scheduler pod gets scheduled as well.

Alternatively, one could just look at the “Scheduled” entries in the event logs to verify that the pods were scheduled by the desired schedulers.

  1. kubectl get events