艾文·卡夫卡设置
- 作者仓库星标 0
- 作者仓库 skills-registry
- 领域
- 通用
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @tomevault-io · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- Python
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 命令执行
- 读取环境变量
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
步骤2:创建Kafka服务并导出环境变量
按顺序遵循 SERVICE_CREATION_AVN.md 第 1-4 部分: 选择服务名称(如果缺少) - 如果客户未提供服务名称,请使用 AskQuestion : `aiven-kafka-service-test` `Other`(如果选择,要求客户提供其自定义服务名称) 选择区域 - 使用 AskQuestion 询问用户,将他们的选择映射到表中的 EXACT `CLOUD_NAME` SERVICE_CREATION_AVN.md。
第 3 步:创建并运行工作示例
强制:此步骤不是可选的。 Kafka服务运行并导出环境变量后,您必须创建一个工作的生产者/消费者示例,编译/安装它,生成测试数据,并端到端运行它。除非用户明确请求 Python,否则默认语言为 Java。
第 4 步:拆解信息
不要自动运行拆卸。相反,通知用户准备好后如何清理:完成演示后,您可以通过运行以下命令来关闭服务:```bash bash scripts/teardown.sh "$KAFKA_SERVICE" ```
# Aiven Kafka Setup (avn CLI)
End-to-end workflow for creating an Apache Kafka service on **Aiven** using the `avn` CLI,
with SASL_SSL authentication, Avro Schema Registry, and a **working** Java or Python
producer/consumer example that reads from CSV and writes to Kafka.
> **IMPORTANT**: This skill ALWAYS creates a fully working example (Java by default).
> Steps 1–3 are all mandatory. Never stop after creating the service — you MUST also
> build the example project, generate test data, and run the producer + consumer
> end-to-end.
---
## Step 1: Prerequisites
### 1.1 Verify avn CLI login
Run the following to check if the user is logged in:
```bash
avn user info
```
**If the command fails**, inspect the error and guide the user accordingly:
```
If the error contains "Expired db token":
Your Aiven login token expired. Please run:
avn user login <your-email>
If the error contains "ERROR: Not logged in" or "UserError: not authenticated":
You are not logged in to the Aiven CLI. Please run:
avn user login <your-email>
If you are a new user, create an account via:
https://console.aiven.io/login
Then confirm when you are logged in.
```
**STOP and wait** for the user to confirm login before proceeding.
### 1.2 Required tools
Verify the following are installed:
- `avn` (Aiven CLI) - At least version 4.7.0 or later is required.
- `jq` (JSON processing)
- For Java: `java` (17+), `mvn`
- For Python: `python3` (3.9+), `pip`
Before creating a service, ask the customer to confirm they have enough credits (they can check with):
```bash
avn project details --json
```
Use the AskQuestion tool to collect this confirmation without interrupting the flow.
**AI Agent MUST NOT check credits itself.** Only the customer should run the credit-check command and confirm.
**Missing Requirements Policy:**
- If a library or CLI tool (like `avn`) is missing, advise the user on how to install it (e.g., `python3 -m pip install aiven-client` for `avn`). However, check first if `python3` is available before suggesting a `pip` command.
- If a core language runtime (`python3` or `java`) is requested but missing, **interrupt the flow immediately**. Do NOT advise the user on how to install programming languages.
---
## Step 2: Create the Kafka Service and Export Environment Variables
Follow **[SERVICE_CREATION_AVN.md](SERVICE_CREATION_AVN.md)** sections 1–4 in order:
1. **Choose a service name (if missing)** — if the customer did not provide a service name, use AskQuestion with:
- `aiven-kafka-service-test`
- `Other` (if selected, ask the customer to provide their custom service name)
2. **Choose a region** — ask the user with AskQuestion, mapping their choice to the **EXACT** `CLOUD_NAME` from the table in **[SERVICE_CREATION_AVN.md](SERVICE_CREATION_AVN.md)**.
3. **Choose a plan** — default `developer-2-1d`; **never** use `free-0` or `startup-2`.
4. **Run the setup script** — a single command creates the service, tags it with
`AI-skill-generated=true`, creates users and ACLs, registers the schema,
extracts all connection details, and writes them to `env.sh`.
- If service creation returns `Payment method is not set and there is not enough credits for the service`,
the script fails fast and the flow must stop immediately.
5. **Source `env.sh`** — loads `KAFKA_HOST`, `KAFKA_PORT`, `SCHEMA_REGISTRY_URL`,
`AVNADMIN_PASS`, `PRODUCER_PASSWORD`, `CONSUMER_PASSWORD` into the shell.
```bash
bash scripts/setup_aiven_kafka.sh <name> <CLOUD_NAME> <plan> 4.1
source env.sh
```
> **CRITICAL**: Do NOT read or cat `env.sh` in the agent context — it contains
> passwords. Only `source` it and verify passwords by `${#VAR}` (length).
---
## Step 3: Create and Run the Working Example
> **MANDATORY**: This step is NOT optional. After the Kafka service is running and
> environment variables are exported, you MUST create a working producer/consumer
> example, compile/install it, generate test data, and run it end-to-end.
> **Default language is Java** unless the user explicitly requests Python.
### 3.1 Ask the user which language to use
Use the AskQuestion tool:
```
Prompt: "Which language for the producer/consumer example?"
Options:
- Java (default, recommended)
- Python
```
If the user requests a language other than Java or Python, warn them:
> "Results with languages other than Java or Python are unpredictable. It is recommended
> to use Java or Python for reliable results."
**If the user does not answer or skips**, default to **Java**.
### 3.2 Copy templates into the workspace
The templates live under this skill's `templates/` directory. They MUST be copied to
the **workspace root** so the run scripts can find them at the expected relative paths.
```bash
# Copy from the skill directory into the workspace root
cp -r <SKILL_DIR>/templates/ <WORKSPACE_ROOT>/templates/
cp -r <SKILL_DIR>/scripts/ <WORKSPACE_ROOT>/scripts/
```
After copying, verify the files exist:
```bash
ls templates/order.avsc
ls templates/producer_consumer_java/Producer.java # if Java
ls templates/producer_consumer_python/producer.py # if Python
ls scripts/run_producer.sh scripts/run_consumer.sh
```
### 3.3 Generate test data
Run the data generator (no external dependencies):
```bash
python3 scripts/generate_orders.py
```
This creates `orders.csv` with 20 rows in the format `id,user_id,product,price`.
**Verify it was created:**
```bash
wc -l orders.csv # should show 21 (1 header + 20 data rows)
```
### 3.4 Build the project
#### Java (default)
Set up the Maven source tree and compile:
```bash
JAVA_DIR="templates/producer_consumer_java"
mkdir -p "$JAVA_DIR/src/main/java/com/aiven/demo"
cp "$JAVA_DIR/Producer.java" "$JAVA_DIR/src/main/java/com/aiven/demo/"
cp "$JAVA_DIR/Consumer.java" "$JAVA_DIR/src/main/java/com/aiven/demo/"
cp "$JAVA_DIR/Order.java" "$JAVA_DIR/src/main/java/com/aiven/demo/"
mvn -f "$JAVA_DIR/pom.xml" package -DskipTests
```
**Verify the JAR was created:**
```bash
ls "$JAVA_DIR/target/kafka-orders-demo-1.0-SNAPSHOT.jar"
```
If compilation fails, check that `java` (17+) and `mvn` are installed.
#### Python (if selected)
Install dependencies:
```bash
python3 -m pip install -r templates/producer_consumer_python/requirements.txt
```
**Verify the install succeeded:**
```bash
python3 -c "import confluent_kafka; print(confluent_kafka.version())"
```
### 3.5 Run the producer (start FIRST)
The producer MUST run **first** to publish messages into Kafka. The consumer reads
them afterwards (the consumer uses `auto.offset.reset=earliest`, so it will pick up
all messages from the beginning of the topic regardless of when it starts).
```bash
bash scripts/run_producer.sh <java|python>
```
Wait for the producer to finish (it will print "Done. Produced 20 messages.").
### 3.6 Run the consumer
After the producer has finished, start the consumer to read and process the messages:
```bash
bash scripts/run_consumer.sh <java|python>
```
The consumer will read all 20 messages (starting from the earliest offset), write
them to `orders_completed.csv`, and then exit (both Java and Python exit
automatically after consuming the expected 20 records).
### 3.7 Verify output
```bash
python3 scripts/verify_output.py
```
This checks that `orders_completed.csv` has 20 rows with correct columns and all
`completed_at` timestamps populated.
**If verification fails**, check:
- The producer finished successfully before the consumer was started
- Environment variables (`KAFKA_HOST`, `KAFKA_PORT`, etc.) are all set
- The `cert/ca.pem` file exists
- For Java: the JAR exists in `templates/producer_consumer_java/target/`
- For Python: `confluent_kafka` is installed
---
## Step 4: Teardown Information
**DO NOT** run teardown automatically. Instead, inform the user how to clean up when they are ready:
> When you're done with the demo, you can tear down the service by running:
>
> ```bash
> bash scripts/teardown.sh "$KAFKA_SERVICE"
> ```
>
> This will delete the Aiven Kafka service, remove the local `cert/` directory,
> and clean up generated CSV files.
For detailed `avn` CLI command reference and troubleshooting, see [reference.md](reference.md).
---
## File Reference
| File | Purpose |
|------|---------|
| [SERVICE_CREATION_AVN.md](SERVICE_CREATION_AVN.md) | Region/plan selection (interactive), then delegates to setup script |
| [reference.md](reference.md) | avn CLI cheat sheet, region map, troubleshooting |
| [templates/order.avsc](templates/order.avsc) | Avro schema for orders topic |
| [templates/producer_consumer_java/](templates/producer_consumer_java/) | Java Producer + Consumer + pom.xml |
| [templates/producer_consumer_python/](templates/producer_consumer_python/) | Python producer + consumer + requirements.txt |
| [scripts/generate_orders.py](scripts/generate_orders.py) | Generate orders.csv (20 rows) |
| [scripts/setup_aiven_kafka.sh](scripts/setup_aiven_kafka.sh) | Full setup: service, users, ACLs, schema, env.sh |
| [scripts/run_producer.sh](scripts/run_producer.sh) | Run producer (Java or Python) |
| [scripts/run_consumer.sh](scripts/run_consumer.sh) | Run consumer (Java or Python) |
| [scripts/verify_output.py](scripts/verify_output.py) | Validate orders_completed.csv |
| [scripts/teardown.sh](scripts/teardown.sh) | Delete service and clean up |
---
> Source: [Aiven-Open/aiven-skills-bundle](https://github.com/Aiven-Open/aiven-skills-bundle) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-22 -->
章节与文件索引
按说明文件中的顺序排列。
1.1 验证 avn CLI 登录
1.2 所需工具
步骤2:创建Kafka服务并导出环境变量
第 3 步:创建并运行工作示例
3.1 询问用户使用哪种语言
文件/命令 -> avn · java · mvn · python3 · pip · python3 -m pip install aiven-client · aiven-kafka-service-test · Other
内容校验值 -> 91f235b3a6f8
当前原文的自动摘译,尚未人工审校。
1.1 验证 avn CLI 登录
运行以下命令检查用户是否已登录: 如果命令失败,请检查错误并相应地指导用户: 停止并等待用户确认登录,然后再继续。
1.2 所需工具
验证是否已安装以下内容:
avn(Aiven CLI) - 至少需要 4.7.0 或更高版本。jq(JSON 处理) 对于 Java:java(17+)、mvn对于 Python:python3(3.9+)、pip步骤2:创建Kafka服务并导出环境变量
按顺序遵循 SERVICE_CREATION_AVN.md 第 1-4 部分: 选择服务名称(如果缺少) - 如果客户未提供服务名称,请使用 AskQuestion :
aiven-kafka-service-testOther(如果选择,要求客户提供其自定义服务名称) 选择区域 - 使用 AskQuestion 询问用户,将他们的选择映射到表中的确切CLOUD_NAMESERVICE_CREATION_AVN.md。3.1 询问用户使用哪种语言
使用 AskQuestion 工具:如果用户请求 Java 或 Python 以外的语言,请警告他们:“使用 Java 或 Python 以外的语言的结果是不可预测的。建议使用 Java 或 Python 以获得可靠的结果。”如果用户没有回答或跳过,则默认为 Java。