SchedulerX:Deploy SchedulerX in a Kubernetes cluster

Method 1: Deploy SchedulerX using a deployment (Recommended)

Prerequisites

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

• You have activated SchedulerX.

• You have created an application of the Kubernetes type in the Distributed Task Scheduling Platform console. For more information, see Create an application.

Step 1: Configure the ServiceAccount

SchedulerX Kubernetes tasks rely on a ServiceAccount for authentication and authorization. By default, Kubernetes tasks run using the SchedulerX ServiceAccount of the namespace.

In the Kubernetes cluster and in the corresponding namespace, you need to run schedulerx-serviceaccount.yaml only once. To isolate namespaces and schedule pods or Jobs only within the target namespace, run the following sample YAML code.

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

To schedule across namespaces, use ClusterRole and 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 configuration of schedulerx-agent.yaml is as follows.

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

Method 2: Deploy SchedulerX using a Helm package

Prerequisites

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

• You have activated SchedulerX.

• You have created an application of the Kubernetes type in the Distributed Task Scheduling Platform console. For more information, see Create an application.

• You have installed the Helm package manager.

Step 1: Download the SchedulerX Helm package

Run the following command to download the SchedulerX Helm package.

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

Step 2: Install the SchedulerX Helm package

1. Obtain the connection parameters for the application from the Distributed Task Scheduling Platform console.

   1. Log on to the Distributed Task Scheduling Platform.

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

   3. In the navigation pane on the left side, click Application Management.

   4. On the Application Management page, find the application and click Connection Settings in the Actions column. In the upper-left corner of the Connection Settings page, select Kubernetes.

2. Run the following installation command.

   Note

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

   • The default registry address in the connection settings is for an amd64 image on the public network. Select the appropriate registry address based on the region and architecture of your machine.

   helm install  schedulerxchart schedulerxchart-2.0.0.tgz \
   --set SCHEDULERX_ENDPOINT=acm.aliyun.com\
   ,SCHEDULERX_NAMESPACE=f856c3f8-a15c-4a7e-9b4e-f812a9f8****\
   ,SCHEDULERX_GROUPID=k8s-test3\
   ,SCHEDULERX_APPKEY=****\
   ,SCHEDULERX_AGENT_IMAGE=schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-amd64

   The following figure shows a screenshot of the installation process.

   

   SchedulerX agent image variables

   Chip architecture	Region	Description
   x86_64	Regions in China	schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-amd64
   	Regions outside the Chinese mainland	schedulerx-registry.ap-southeast-1.cr.aliyuncs.com/schedulerx2/agent:latest-amd64
   arm64	Regions in China	schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-arm64
   	Regions outside the Chinese mainland	schedulerx-registry.ap-southeast-1.cr.aliyuncs.com/schedulerx2/agent:latest-arm64

   SchedulerX agent env variables

   Variable	Description
   ${SCHEDULERX_ENDPOINT}	The region where you deployed the application and its corresponding Endpoint. For example, addr-sh-internal.edas.aliyun.com. For more information, see List of Endpoints.
   ${SCHEDULERX_NAMESPACE}	The ID of the namespace. You can obtain it on the Namespaces page in the SchedulerX console.
   ${SCHEDULERX_GROUPID}	The ID of the application. You can obtain it on the Application Management page in the SchedulerX console.
   ${SCHEDULERX_APPKEY}	The key of the application. You can obtain it on the Application Management page in the SchedulerX console.
   SCHEDULERX_AGENT_IMAGE	The registry address.

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

Method 3: Deploy SchedulerX using the Java SDK

Prerequisites

• You can create a Kubernetes cluster, which can be an ACK cluster or a self-managed Kubernetes cluster. For more information, see Create a Kubernetes cluster.

• Activate SchedulerX.

• You can create a K8s application in the Distributed Task Scheduling Platform. For more information, see Create Application.

Connect to SchedulerX

For information about how to connect using the SDK, 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>

What to do next: Create a Kubernetes task

To run the following scripts, you need to create a Kubernetes task on the Task Management page. For more information, see Task management.