SchedulerX:Deploy SchedulerX in a Kubernetes cluster

Method 1: Deploy SchedulerX by using a Deployment

Prerequisites

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

• SchedulerX is activated.

• A Kubernetes application is created in the SchedulerX console. For more information, see Create an application.

Step 1: Configure a service account

A service account provides an identity for validation and authorization when a Kubernetes job is scheduled by using SchedulerX. By default, the service account of the namespace to which the Kubernetes job belongs is used.

You need to run schedulerx-serviceaccount.yaml only once in the required namespace of the Kubernetes cluster. If you want to schedule only pods or jobs that belong to the current namespace, run the following 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

If you want to schedule jobs across namespaces, you must call the ClusterRole and ClusterRoleBinding API operations.

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 the SchedulerX agent

The following sample code shows the configurations of schedulerx-agent.yaml:

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: registry.cn-hangzhou.aliyuncs.com/schedulerx/agent:latest-amd64
        imagePullPolicy: Always
        resources:
          limits:
            cpu: 200m
          requests:
            cpu: 200m
        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: (Recommended) Deploy SchedulerX by using a SchedulerX Helm package

Prerequisites

• An ACK cluster or a self-managed Kubernetes cluster is created. For more information, see Create an ACK managed cluster.

• SchedulerX is activated.

• A Kubernetes application is created in the SchedulerX console. For more information, see Create an application.

• The Helm package management tool is installed.

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 access parameters of the application in the SchedulerX console.

   1. Log on to the SchedulerX console.

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

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

   4. On the Applications page, click Access configuration in the Actions column. In the upper-left corner of the Access configuration panel, select k8s from the drop-down list.

2. Run the following installation commands:

   Note

   • Replace the access parameters in the commands with the access parameters of the application that you want to schedule.

   • By default, the image address in the access configuration is the address of the image of the AMD architecture on the Internet. Specify an image address based on the region where your machine resides and the 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=registry.cn-hangzhou.aliyuncs.com/schedulerx/agent:latest-amd64

   The following figure shows the installation process.

   

   The following table describes the valid values of image.

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

   The following table describes the variables contained in env.

   Variable	Description
   ${SCHEDULERX_ENDPOINT}	ENDPOINT specifies the endpoint matched with the region where your application is deployed. Example: addr-sh-internal.edas.aliyun.com. For more information, see Endpoints.
   ${SCHEDULERX_NAMESPACE}	NAMESPACE specifies the ID of the namespace to which the application belongs. You can view the namespace ID on the Namespace page in the SchedulerX console.
   ${SCHEDULERX_GROUPID}	GROUPID specifies the application ID. You can view the application ID on the Application Management page in the SchedulerX console.
   ${SCHEDULERX_APPKEY}	APPKEY specifies the application key. You can view the application key on the Application Management page in the SchedulerX console.
   SCHEDULERX_AGENT_IMAGE	The URL of the image.

   After you install the package, you can view the instance in the SchedulerX console.

Method 3: Deploy SchedulerX by using SchedulerX SDK for Java

Prerequisites

• An ACK cluster or a self-managed Kubernetes cluster is created. For more information, see Create an ACK managed cluster.

• SchedulerX is activated.

• A Kubernetes application is created in the SchedulerX console. For more information, see Create an application.

Connect your application to SchedulerX

Use SchedulerX SDK for Java to connect your application to SchedulerX. For more information, 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>

Create a Kubernetes job

Before you can run one of the following scripts, create a Kubernetes job in the Create task panel of the Task Management page. For more information, see Job management.