Realtime Compute for Apache Flink:Use Flink Skills to manage workspaces

Install Node.js and Python

Skills are installed through the npx skills CLI, which requires Node.js 18 or later. The internal scripts are implemented in Python and require Python 3.6 or later.

node --version    # Requires >= 18
python3 --version # Requires >= 3.6

If not installed, choose the installation method for your operating system:

# macOS
brew install node python@3.9

# Ubuntu/Debian
sudo apt-get install nodejs npm python3 python3-pip

# CentOS/RHEL
sudo yum install nodejs python3 python3-pip

Configure Alibaba Cloud credentials

Skills obtain Alibaba Cloud AccessKey credentials through the default credentials provider chain. We recommend that you use environment variables to inject credentials, which avoids hardcoding credentials in command lines or scripts.

export ALIBABA_CLOUD_ACCESS_KEY_ID="your-access-key-id"
export ALIBABA_CLOUD_ACCESS_KEY_SECRET="your-access-key-secret"
export ALIBABA_CLOUD_REGION_ID="cn-beijing"

For production environments, we recommend that you use RAM roles or STS temporary credentials to prevent long-term AccessKey leaks.

Prepare RAM permissions

Grant the minimum required permissions to the RAM user that the Skills use. Do not use your Alibaba Cloud account AccessKey directly.

Permissions required by alibabacloud-flink-instance-manage

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "stream:CreateVvpInstance",
        "stream:DescribeVvpInstances",
        "stream:CreateVvpNamespace",
        "stream:DescribeVvpNamespaces",
        "stream:QueryTagVvpResources"
      ],
      "Resource": [
        "acs:stream:*:*:vvpinstance/*",
        "acs:stream:*:*:vvpinstance/*/vvpnamespace/*"
      ]
    }
  ]
}

Permissions required by alibabacloud-flink-workspace-ops

Workspace-level operations such as job deployment, Session Cluster management, and SQL validation require you to grant the RAM user a developer or administrator role for the corresponding workspace through the console member management. For more information about role permissions, see Manage workspace members.

Install Skills

# Install to the current project (recommended for project-level sharing)
npx skills add aliyun/alibabacloud-aiops-skills --skill alibabacloud-flink-instance-manage --agent claude-code -y --full-depth
npx skills add aliyun/alibabacloud-aiops-skills --skill alibabacloud-flink-workspace-ops --agent claude-code -y --full-depth
npx skills add aliyun/alibabacloud-aiops-skills --skill alibabacloud-flink-knowledge --agent claude-code -y --full-depth

# Or install globally (append -g for all projects)
npx skills add aliyun/alibabacloud-aiops-skills --skill alibabacloud-flink-instance-manage --agent claude-code -y --full-depth -g

Project-level installation path: <project>/.claude/skills/. Global installation path: ~/.claude/skills/.

If npx skills add times out due to network issues when cloning the repository, you can clone the repository manually and install from the local path:

git clone https://github.com/aliyun/alibabacloud-aiops-skills.git ~/.agents/alibabacloud-aiops-skills
npx skills add ~/.agents/alibabacloud-aiops-skills/skills/analyticscomputing/sc/alibabacloud-flink-instance-manage --agent claude-code -y
npx skills add ~/.agents/alibabacloud-aiops-skills/skills/analyticscomputing/sc/alibabacloud-flink-workspace-ops --agent claude-code -y
npx skills add ~/.agents/alibabacloud-aiops-skills/skills/analyticscomputing/sc/alibabacloud-flink-knowledge --agent claude-code -y

Install Python dependencies for Skills

cd .claude/skills/alibabacloud-flink-instance-manage
pip3 install -r assets/requirements.txt

cd ../alibabacloud-flink-workspace-ops
pip3 install -r assets/requirements.txt

If pip reports a PEP 668 error on macOS, use a virtual environment or append the --break-system-packages parameter.

Verify the installation

Restart Claude Code and view the available Skill list to confirm that all three Flink Skills are recognized.

/skills

The output should include alibabacloud-flink-instance-manage, alibabacloud-flink-workspace-ops, and alibabacloud-flink-knowledge.

Usage examples

Describe your intent in natural language directly in the conversation. Claude Code automatically matches the corresponding Skill and executes the operation.

Instance management (alibabacloud-flink-instance-manage)

# Query all Flink instances in the China (Beijing) region
Query my Flink instances in cn-beijing

# Create a Flink instance
Create a Flink instance named demo-vvp in cn-beijing

# Query available zones
Which zones are available in cn-hangzhou?

Workspace operations (alibabacloud-flink-workspace-ops)

# Create a SQL draft
Create a SQL draft named hello-flink in workspace my-workspace with the content SELECT 1

# Deploy and start a job
Deploy the draft I just created and start the job

# Diagnose a job
Diagnose the recently failed job in workspace my-workspace

# Manage Session Clusters
Create a Session Cluster named dev-cluster in workspace my-workspace

Knowledge queries (alibabacloud-flink-knowledge)

# Query product parameters
What engine versions does Realtime Compute for Apache Flink support?

# Generate Flink SQL
Generate a CDAS SQL statement for full-database sync from MySQL CDC to Paimon

# Checkpoint restore guidance
How do I restore a job from a savepoint after an upgrade? What should I be aware of?

# Troubleshooting
What could cause a checkpoint timeout? How do I troubleshoot it?

For operations that modify resources, such as creation, deployment, start, stop, and deletion, the Skill automatically appends the --confirm safety confirmation parameter. For irreversible operations such as deletion, you must explicitly express the deletion intent in natural language before the Skill executes the operation.