Deploy SchedulerX in a Kubernetes cluster

Prerequisites

• You have created a Kubernetes cluster (a Container Service for Kubernetes (ACK) cluster or a self-managed Kubernetes cluster). For more information, see Create a Kubernetes cluster.

• You have activated Task Scheduling.

• You have created a Kubernetes application in the MSE SchedulerX console. For more information, see Create an application.

In the Create Application dialog box, set Application Type to Kubernetes application and set Version to Professional Edition.

Step 1: Configure a service account

SchedulerX K8s tasks require a service account for authentication and authorization. By default, tasks run under the schedulerx service account within the target namespace.

In your Kubernetes cluster, you need to apply the schedulerx-serviceaccount.yaml configuration for each namespace where you intend to schedule pods or jobs. The following sample YAML contains the required role and binding.

apiVersion: v1
kind: ServiceAccount
metadata:
  name: schedulerx
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: schedulerx-role
rules:
  - apiGroups: [""]
    resources: ["pods"]
    verbs: ["create","delete","get","list","patch","update","watch"]
  - apiGroups: [""]
    resources: ["pods/log"]
    verbs: ["get","list","watch"]
  - apiGroups: [""]
    resources: ["configmaps"]
    verbs: ["create","delete","get","list","patch","update"]
  - apiGroups: [""]
    resources: ["events"]
    verbs: ["watch"]
  - apiGroups: ["batch"]
    resources: ["jobs","cronjobs"]
    verbs: ["create","delete","get","list","patch","update","watch"]
---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: schedulerx-binding
subjects:
  - kind: ServiceAccount
    name: schedulerx
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: schedulerx-role

If you need to schedule tasks across namespaces, use a ClusterRole and a ClusterRoleBinding.

apiVersion: v1
kind: ServiceAccount
metadata:
  name: schedulerx
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: schedulerx-cluster-role
rules:
  - apiGroups: [""]
    resources: ["pods"]
    verbs: ["create","delete","get","list","patch","update","watch"]
  - apiGroups: [""]
    resources: ["pods/log"]
    verbs: ["get","list","watch"]
  - apiGroups: [""]
    resources: ["configmaps"]
    verbs: ["create","delete","get","list","patch","update"]
  - apiGroups: [""]
    resources: ["events"]
    verbs: ["watch"]
  - apiGroups: ["batch"]
    resources: ["jobs","cronjobs"]
    verbs: ["create","delete","get","list","patch","update","watch"]
---
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: schedulerx-cluster-binding
subjects:
  - kind: ServiceAccount
    name: schedulerx
    namespace: <NAMESPACE1>
  - kind: ServiceAccount
    name: schedulerx
    namespace: <NAMESPACE2>
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: schedulerx-cluster-role

Step 2: Install schedulerx-agent.yaml

The following is the configuration of the schedulerx-agent.yaml file.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: schedulerx-agent
  labels:
    app: schedulerx-agent
spec:
  replicas: 1
  selector:
    matchLabels:
      app: schedulerx-agent
  template:
    metadata:
      labels:
        app: schedulerx-agent
    spec:
      serviceAccountName: schedulerx
      containers:
      - name: schedulerx-agent
        image: schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-amd64
        imagePullPolicy: Always
        resources:
          requests:
            cpu: 500m
        env:
          - name: "SCHEDULERX_ENDPOINT"
            value: "${SCHEDULERX_ENDPOINT}"
          - name: "SCHEDULERX_NAMESPACE"
            value: "${SCHEDULERX_NAMESPACE}"
          - name: "SCHEDULERX_GROUPID"
            value: "${SCHEDULERX_GROUPID}"
          - name: "SCHEDULERX_APPKEY"
            value: "${SCHEDULERX_APPKEY}"
          - name: "SCHEDULERX_STARTER_MODE"
            value: "pod"
        livenessProbe: 
          exec: 
            command: ["/bin/bash","/root/health.sh"]
          timeoutSeconds: 30
          initialDelaySeconds: 30

Prerequisites

• You have created a Kubernetes cluster (a Container Service for Kubernetes (ACK) cluster or a self-managed Kubernetes cluster). For more information, see Create a Kubernetes cluster.

• You have activated Task Scheduling.

• You have created an application of the Kubernetes application type in the MSE SchedulerX console. For more information, see Create an application.

• You have installed Helm.

Step 1: Download the SchedulerX Helm chart

Run the following command to download the SchedulerX Helm chart:

wget https://schedulerx2.oss-cn-hangzhou.aliyuncs.com/helm/schedulerxchart-2.0.0.tgz

Step 2: Install the SchedulerX Helm chart

1. Get the application access parameters from Task Scheduling.

   1. Log on to the MSE SchedulerX console.

   2. (This legacy step can be ignored.)

   3. In the top navigation bar, select a region.

   4. (This step is consolidated into the following one.)

   5. On the Application Management page, click Access configuration in the Actions column. In the upper-left corner of the Access configuration page, select k8s.

2. Run the following installation command.

   Note

   • Replace the access parameters in the installation command with those of your target application.

   • The image address in the access configuration is the public X86_64 image by default. Select an image address that matches the region and architecture of your cluster nodes.

   helm install  schedulerxchart schedulerxchart-2.0.0.tgz \
   --set SCHEDULERX_ENDPOINT=<your_endpoint>\
   ,SCHEDULERX_NAMESPACE=<your_namespace_id>\
   ,SCHEDULERX_GROUPID=<your_group_id>\
   ,SCHEDULERX_APPKEY=****\
   ,SCHEDULERX_AGENT_IMAGE=schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-amd64

   The following output is displayed after the installation:

   NAME: schedulerxchart
   LAST DEPLOYED: xxx
   NAMESPACE: default
   STATUS: deployed
   REVISION: 1
   TEST SUITE: None

   SchedulerX agent image variables

   Architecture	Region	Description
   X86_64	Chinese mainland	schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-amd64
   	Outside the Chinese mainland	schedulerx-registry.ap-southeast-1.cr.aliyuncs.com/schedulerx2/agent:latest-amd64
   ARM64	Chinese mainland	schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-arm64
   	Outside the Chinese mainland	schedulerx-registry.ap-southeast-1.cr.aliyuncs.com/schedulerx2/agent:latest-arm64

   SchedulerX agent env variables

   Parameter	Description
   ${SCHEDULERX_ENDPOINT}	The region and corresponding endpoint where your application is deployed. Example: addr-sh-internal.edas.aliyun.com. For more information, see Endpoint list.
   ${SCHEDULERX_NAMESPACE}	The namespace ID. You can obtain it on the Namespaces page in the MSE SchedulerX console.
   ${SCHEDULERX_GROUPID}	The GroupId (application ID). You can obtain it on the Application Management page in the MSE SchedulerX console.
   ${SCHEDULERX_APPKEY}	The AppKey (application key). You can obtain it on the Application Management page in the MSE SchedulerX console.
   SCHEDULERX_AGENT_IMAGE	The image address.

   After the installation is complete, you can view the instance in the MSE SchedulerX console.

Prerequisites

• Create a Kubernetes cluster (a Container Service for Kubernetes (ACK) cluster or a self-managed Kubernetes cluster). For more information, see Create a Kubernetes cluster.

• You have activated Task Scheduling.

• In the MSE SchedulerX console, create an application of the Kubernetes application type. For more information, see Create an application.

Connect to SchedulerX

For information about SDK integration, see Connect a Spring Boot application to SchedulerX.

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>${schedulerx2.version}</version>
</dependency>	
<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-plugin-kubernetes</artifactId>
  <version>${schedulerx2-plugin-kubernetes.version}</version>
</dependency>