SchedulerX:Connect to SchedulerX using an agent

Step 1: Download and extract the agent

If the machine has a public IP address, download the agent directly:

wget https://schedulerx2.oss-cn-hangzhou.aliyuncs.com/agent/schedulerxAgent-<version>.tar

Replace <version> with the version number from the table below (for example, 1.13.2). Then extract the archive:

tar -xf schedulerxAgent-<version>.tar

Step 2: Configure the agent

Open schedulerxAgent/conf/agent.properties and set the following parameters:

# Required. Endpoint address for your region.
# Full list: https://www.alibabacloud.com/help/en/schedulerx/schedulerx-serverless/getting-started/endpoints
endpoint=<your-endpoint>

# Required. Namespace ID from the Namespace page in the SchedulerX console.
namespace=<your-namespace-id>

# Required. Application ID from the Application Management page in the SchedulerX console.
groupId=<your-application-id>

# Required. Application key from the Application Management page in the SchedulerX console.
appKey=<your-application-key>

Step 3: Start the agent

Run the startup script from the schedulerxAgent/bin/ directory:

cd schedulerxAgent/bin/
./start.sh

To set a specific heap size, use one of the memory-configured scripts instead:

Step 4: Verify the deployment

Check the agent log for the startup confirmation message:

tail -f ~/logs/schedulerx/worker.log

The log path is ${user.home}/logs/schedulerx/worker.log. To find the user.home value, run ps aux | grep java. For example, if the admin user started the agent, the log path is /home/admin/logs/schedulerx/worker.log. If the root user started the agent, the log path is /root/logs/schedulerx/worker.log.

When the log contains Schedulerx Worker started, the agent is running and connected to SchedulerX.

Stop the agent

To stop a running agent:

cd schedulerxAgent/bin/
./stop.sh

Step 1: Select an image

Choose the image that matches your network environment and CPU architecture:

Step 2: Run the container

docker run -d \
  --env SCHEDULERX_ENDPOINT="<your-endpoint>" \
  --env SCHEDULERX_NAMESPACE="<your-namespace-id>" \
  --env SCHEDULERX_GROUPID="<your-application-id>" \
  --env SCHEDULERX_APPKEY="<your-application-key>" \
  <image-id>

Step 3: Verify the deployment

Check the container logs for the startup confirmation:

docker logs <container-id>

When the log contains Schedulerx Worker started, the agent is running.

Step 1: Create the manifest

Save the following YAML as schedulerx-agent.yaml. Replace the environment variable values with your actual configuration:

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:
      containers:
      - name: schedulerx-agent
        image: schedulerx-registry.cn-hangzhou.cr.aliyuncs.com/schedulerx2/agent:latest-amd64
        imagePullPolicy: Always
        resources:
          requests:
            cpu: 500m
        env:
          # Required. Endpoint address for your region.
          # See https://www.alibabacloud.com/help/en/schedulerx/schedulerx-serverless/getting-started/endpoints
          - name: "SCHEDULERX_ENDPOINT"
            value: "<your-endpoint>"
          # Required. Namespace ID from the Namespace page in the SchedulerX console.
          - name: "SCHEDULERX_NAMESPACE"
            value: "<your-namespace-id>"
          # Required. Application ID from the Application Management page.
          - name: "SCHEDULERX_GROUPID"
            value: "<your-application-id>"
          # Required. Application key from the Application Management page.
          - name: "SCHEDULERX_APPKEY"
            value: "<your-application-key>"
          # Required for Kubernetes deployments.
          - name: "SCHEDULERX_STARTER_MODE"
            value: "pod"
        livenessProbe:
          exec:
            command: ["/bin/bash", "/root/health.sh"]
          timeoutSeconds: 30
          initialDelaySeconds: 30

Placeholder	Description	Where to find it
<your-endpoint>	Region-specific endpoint address. Example: addr-sh-internal.edas.aliyun.com	Endpoint list
<your-namespace-id>	Namespace ID	Namespace page in the SchedulerX console.
<your-application-id>	Application ID	Application Management page in the SchedulerX console.
<your-application-key>	Application key	Application Management page in the SchedulerX console.

Step 2: Apply the manifest

kubectl apply -f schedulerx-agent.yaml

Step 3: Verify the deployment

Check the pod logs for the startup confirmation:

kubectl logs -l app=schedulerx-agent

When the log contains Schedulerx Worker started, the agent is running. The liveness probe at /root/health.sh automatically monitors the agent and restarts it if it becomes unresponsive.