| name | volcengine-deploy |
| description | Deploy a local project directory or Git repository to Volcengine as a running, reachable cloud service. USE WHEN: deploy to Volcengine, deploy to 火山引擎/火山, deploy this repo/project, publish current code, launch the app, run it in the cloud, expose it as a service, deploy to ECS/VKE/veFaaS, run on ECS, push to VKE, deploy as serverless/FaaS, or the user wants the agent to choose a Volcengine hosting target. If the user only asks which Volcengine deployment target to choose, use `volcengine-prepare` skill first. Not for creating a single standalone resource — use `volcengine-cli` skill for that. |
| license | MIT |
Volcengine Deploy Skill
Deploy a local project directory or remote Git URL to Volcengine after the user chooses ECS / VKE / veFaaS and resource management (cli or iac). Keep deployment execution pragmatic: use volcengine-iac only when the user chooses Terraform/IaC or already has an IaC workflow; otherwise use ve CLI plus .volcengine/created-resources.json.
0. Prerequisites
Volcengine authentication is checked by the execution skill you call (volcengine-cli, volcengine-iac, or volcengine-vefaas). Accept either the required AK/SK env vars for that skill or an already configured CLI profile when that skill supports it; do not duplicate their hard env requirements here.
Check tools after the user chooses a path:
| Mode | Required tools |
|---|
| ECS | ve, git, jq, curl; ssh only if the user opens port 22; docker/docker compose only for Docker or compose packaging |
| VKE | ve, docker, kubectl, git, jq, curl |
| veFaaS | switch to/call the volcengine-vefaas skill, which checks vefaas, Node.js, auth, framework detection, and deploy commands |
tosutil is optional for ECS artifact transfer and TOS buckets. Do not add it as a hard prerequisite for volcengine-deploy; if it is absent, use SSH/scp when allowed or ask the user for an existing artifact URL.
If the user has not chosen a mode, run volcengine-prepare inline or ask for these decisions:
1. Deployment mode: ECS / VKE / veFaaS (recorded as `ecs` / `vke` / `vefaas`)
2. Resource strategy: new isolated project deploy-<repo>, or reuse existing resources
3. Resource management: CLI resource ledger / Terraform IaC (recorded as `cli` / `iac`)
Persistent local state lives under .volcengine/ in the repo root:
.volcengine/
deployment-plan.md # human-readable approval gate
deploy-choice.json
created-resources.json # CLI fast path only
iac-outputs.json
terraform/ # IaC-managed resources
Steps
This table is a navigation overview. Detailed rules live in the sections or reference files named in Details.
| # | Action | Details |
|---|
| 1 | Resolve target — Resolve local path or Git URL; record repo_name, repo_dir, and git_sha. | Stage 0 |
| 2 | Load or choose path — Load .volcengine/deploy-choice.json; if missing, use the volcengine-prepare skill, or ask for mode, resource strategy, and resource management. | Stage 0 |
| 3 | Create plan — Create/update .volcengine/deployment-plan.md in the user's original language. | references/deployment-plan-template.md |
| 4 | Show resources — Present every resource to create or reuse, such as VPC, ECS, VKE, RDS, Redis, CR, EIP, or dependencies. | references/deployment-plan-template.md |
| 5 | Validate gate — Require status: validated, populated Validation Proof, and approval: granted with non-empty approval_evidence before provisioning. | references/deployment-plan-template.md |
| 6 | Dispatch resource management — Use the volcengine-iac skill for Terraform/IaC; otherwise use ve CLI plus .volcengine/created-resources.json. | Resource management dispatch |
| 7 | Provision resources — Create or reuse resources; append each CLI-created resource to .volcengine/created-resources.json. | Resource ledger |
| 8 | Wire runtime config — Resolve config and secrets; never print secrets. | Environment and Dependency Wiring |
| 9 | Execute deployment — Run the selected case: ecs, vke, or use the volcengine-vefaas skill for vefaas. | Branch references |
| 10 | Verify success — Check public endpoint, health, logs, and one core behavior when possible. | Branch references |
| 11 | Handle failure — Print reverse-order CLI cleanup commands; never delete reused resources without confirmation. | Resource ledger |
| 12 | Report result — Print URL, health, acceptance, logs, resource records, cleanup path, and warnings. | Deployment summary |
1. Stage 0 — Resolve repo and choice
input="${1:-.}"
if [[ "$input" =~ ^(https?|git@) ]]; then
repo_name=$(basename "$input" .git)
work_dir="/tmp/volcengine-deploy/$repo_name"
mkdir -p "$work_dir"
if [ -d "$work_dir/src/.git" ]; then
git -C "$work_dir/src" pull --ff-only
else
git clone --depth 1 "$input" "$work_dir/src"
fi
repo_dir="$work_dir/src"
else
repo_dir=$(cd "${input:-.}" && pwd)
repo_name=$(basename "$repo_dir")
work_dir="$repo_dir/.volcengine"
mkdir -p "$work_dir"
fi
git_sha=$(cd "$repo_dir" && git rev-parse --short HEAD 2>/dev/null || echo "$(date +%s)")
Local directories are deployed in place and are not cloned. For Git URLs, use shallow clone first; if clone repeatedly fails, try an archive/subdirectory path or stop with a clear "not suitable for quick remote build" message. Do not claim a README/static mirror is the deployed application.
Load .volcengine/deploy-choice.json if present. It is produced by volcengine-prepare, which keeps the choice schema authoritative; volcengine-deploy only consumes the selected repo, region, mode, port, dependencies, database choice, resource strategy, project, and infra_management.
If .volcengine/deploy-choice.json is missing, run volcengine-prepare or ask only the missing decisions needed to create it. Do not maintain a second full choice schema in this skill.
After loading or creating the choice file, create or update .volcengine/deployment-plan.md; read references/deployment-plan-template.md first. The plan body must use the user's original language, list the expected resources, and gate provisioning on status: validated, approval: granted, and a non-empty approval_evidence.
If approval is pending, confirm before creating resources, using the same language as the user:
Deploying <repo_name> via <mode> in <region>.
Resource plan:
- <create|reuse> <resource type>: <name>, <purpose/exposure/cleanup>
Proceed? [y/N]
2. Resource ledger
Use the resource ledger only for CLI-created resources. IaC-created resources are tracked by Terraform state and exported through .volcengine/iac-outputs.json.
Every resource created by volcengine-deploy must be appended to .volcengine/created-resources.json immediately after creation. This is mandatory for cleanup and failure recovery.
Ledger entry:
{
"type": "eip",
"id": "eip-xxxx",
"name": "deploy-myapp-eip",
"region": "cn-beijing",
"project": "deploy-myapp",
"reused": false,
"created_at": "2026-05-29T00:00:00Z",
"delete_command": "ve vpc ReleaseEipAddress --AllocationId eip-xxxx"
}
Rules:
- New resources:
reused=false, include exact delete command.
- Reused resources:
reused=true, do not include them in destructive cleanup.
- If an EIP is created inline with an ECS instance and released with that instance, mark it as
dependent=true / cleanup_optional=true or omit it as an independent ledger item. Do not make cleanup fail just because the instance already released the EIP.
- On failure, print cleanup commands in reverse ledger order. There is currently no one-command cleanup runner; the user must review and run ledger
delete_command values manually. Do not silently delete unless the user confirms.
- Prefer creating or using an isolated Volcengine project named
deploy-<repo> for new resources, but confirm the project exists or can be created before passing that project name to resource creation. If project creation is unavailable, use default and isolate resources with names and tags.
3. Resource management dispatch
Deployment plan gate
Creating cloud resources costs money and is not freely reversible, so the plan frontmatter records two independent facts:
status: draft | validated — whether validation checks passed.approval: pending | granted — whether the user authorized creating resources.approval_evidence: a quote of the user's authorizing words; approval: granted is invalid while this is empty.
Create, modify, or reuse a resource only when all of these hold: status: validated, the Validation Proof section is populated with real checks and has no failed required check, approval: granted, and approval_evidence is non-empty. Otherwise stop and complete the gate first.
Rules:
approval_evidence must quote the user authorizing execution — "just deploy it", "open the resources for me", "go ahead". A configuration choice such as "use ecs" is selection, not spend authorization, and must not be used as evidence.- Never set
approval: granted without real authorizing words, and never set status: validated while a required decision or secret is missing or a check was not actually run — record an unrun check as deferred with its reason instead of faking a pass.
- If the user authorizes autonomous deployment ("deploy it for me", "资源也帮我开好", "go ahead and deploy"), show the resource plan once, set
approval: granted with that quote, then proceed without interrupting before each resource. Treat this as authorization only when the words clearly authorize deployment or resource creation, not mere mode selection.
- If the plan's core changes —
mode, region, infra_management, or the resource plan — reset status: draft, approval: pending, and approval_evidence: "", re-show the resource plan, and ask again.
Before provisioning, dispatch from infra_management in .volcengine/deploy-choice.json. volcengine-prepare owns the cli vs iac recommendation and the user's choice; this skill only consumes it.
infra_management | Action |
|---|
iac | Use volcengine-iac (see When using IaC below). |
cli | Use the ve CLI plus the resource ledger (see When using CLI below). |
If infra_management is missing or invalid, do not infer a default here. Return to volcengine-prepare, or ask the user to choose cli or iac, then update .volcengine/deploy-choice.json and refresh .volcengine/deployment-plan.md.
When using IaC:
- Call or switch to
volcengine-iac with .volcengine/deploy-choice.json.
- Run Terraform generation, validate, plan, and explicit apply confirmation under that skill.
- Consume
.volcengine/iac-outputs.json for VPC/subnet/security group/cluster/CR/database/cache outputs.
- Continue deployment packaging and runtime steps here: build/pull image, run Cloud Assistant, apply Kubernetes manifests, run migrations, and verify health.
When using CLI:
- Create resources directly with
ve.
- Append every created resource to
.volcengine/created-resources.json immediately.
- Print reverse-order cleanup commands on failure.
4. Environment and Dependency Wiring
Before starting ECS services or applying Kubernetes manifests, resolve runtime configuration:
- Read
.env.example, .env.sample, framework config, and dependency outputs from IaC/CLI provisioning.
- Split non-sensitive values into config and sensitive values into secrets. Treat connection strings, passwords, tokens, AK/SK, and session tokens as secrets.
- Ask the user for missing required values. Do not print secret values back to the user, do not write them to logs, and write generated local files with mode
0600.
- For ECS systemd, write
/opt/<repo>/.env before starting the service; the unit template reads it through EnvironmentFile=-/opt/<repo>/.env.
- For VKE, generate ConfigMap and Secret manifests from the resolved values. Never leave
<connection-string> placeholders in an applied Secret.
Managed dependency wiring must be completed before health checks:
- RDS database (
database_product=rds, engine mysql / postgresql / sqlserver): create or reuse the instance, database, and app account; use the private endpoint; build DATABASE_URL; add the ECS/VKE subnet CIDR or security group source to the database allowlist; run migrations explicitly when migration_paths is non-empty.
- AIDAP database (
database_product=aidap, engine supabase / postgresql): call volcengine-db-supabase to create or reuse the workspace, branch, app DB account/database, and return database/AIDAP env values before app health checks.
- Redis: create or reuse the instance and app account/password; use the private endpoint; build
REDIS_URL; add the ECS/VKE subnet CIDR or security group source to the Redis allowlist.
- If the user declines managed services for a detected dependency, state the persistence/scaling tradeoff and wire the chosen alternative into the same env/Secret path.
5. Branch dispatch
case "$deploy_mode" in
ecs) proceed_ecs ;;
vke) proceed_vke ;;
vefaas) run_vefaas_skill ;;
*) echo "Unknown deploy mode: $deploy_mode"; exit 2 ;;
esac
6. ECS branch
ECS is the default lightweight VM path. Public services must get an EIP so the user can access the service after deployment.
Select packaging from the repo shape: compose file -> compose on ECS; Dockerfile -> Docker on ECS; clear binary or single process -> binary + systemd; otherwise ask one focused start-command question.
Keep these hard boundaries in the main context:
- Use IaC outputs when
infra_management=iac; otherwise use the CLI ledger path and record every CLI-created resource immediately.
- Do not hardcode instance type or OS image. Query availability and avoid fuzzy image matches that return GPU, WebUI, marketplace, or unrelated images.
- If SSH 22 is not explicitly approved, keep it closed and use Cloud Assistant. If SSH is approved, restrict it to the current outbound IP when possible.
- Volcengine RunCommand is asynchronous. Poll invocation results before treating the command as successful.
- Generated one-time ECS passwords must not be printed or written to ledger/state.
- Validate listening port, local health/root path, public endpoint, logs, and one core app behavior where possible.
Read references/ecs-deploy-steps.md for the detailed ECS packaging, upload, Cloud Assistant, Docker mirror, architecture, health-gate, and cleanup workflow.
7. veFaaS branch
Do not duplicate veFaaS deployment details here. If the user chooses veFaaS, switch to/call the volcengine-vefaas skill with:
- repo path
- app name
- region
- detected framework/port if known
- environment variable notes
- any warning from prepare
Tell the user the volcengine-vefaas skill will run vefaas inspect, verify login, create/link the app, configure env vars if needed, deploy, and print domains.
If the volcengine-vefaas skill fails, return to this main deployment flow. Summarize the failure, then offer the user a choice:
- fix the veFaaS issue and retry,
- switch to ECS,
- switch to VKE.
8. VKE branch
Recommend volcengine-iac for VKE resource provisioning because cluster, node pool, CR, LB, and managed dependencies benefit from plan/diff/destroy safety. Use ve CLI plus the resource ledger when the user chooses CLI after seeing the tradeoff, for temporary validation, explicit user preference, or IaC fallback.
After choosing VKE, check docker, kubectl, ve, and terraform/jq if using IaC. Build for the node architecture, defaulting to linux/amd64 unless cluster data proves otherwise; inspect the pushed image platform before rollout.
Keep this ordered execution skeleton — these actions must be chained in sequence, and a later step run before an earlier one converges is the most common VKE failure:
- Provision or reuse VKE + CR (IaC outputs or CLI fast path).
- Wait for the cluster to be
Running, then fetch the kubeconfig (from IaC outputs or CreateKubeconfig).
- Verify addons:
core-dns present; prefer cr-credential-controller for private CR pulls.
- Build the image for the node architecture.
- Authenticate to CR, push the image, and inspect the pushed platform.
- Resolve env/Secret values and dependency outputs.
- Generate manifests from resolved values.
- Run migrations as a Kubernetes Job when migration paths exist.
- Apply, then wait for rollout and the LoadBalancer/EIP.
- Verify the public endpoint and one core app behavior.
Keep these hard boundaries in the main context:
- Use IaC outputs for VPC/subnets/security group/VKE/CR when available; otherwise create or reuse through the CLI fast path and record resources.
CreateKubeconfig before the cluster is Running returns OperationDenied — poll to Running first.- Confirm
core-dns before relying on in-cluster DNS.
- Prefer
cr-credential-controller for private Volcengine CR image pulls instead of storing registry passwords in app manifests.
- Re-read
Result.Username from GetAuthorizationToken for docker login; never invent a fallback username.
- Resolve ConfigMap/Secret values before applying workloads; never leave placeholders in applied Secret manifests.
- Run migrations as a Kubernetes Job when migration paths exist.
- Wait for rollout and LoadBalancer/EIP, then verify the public endpoint.
For managed dependencies, prefer managed Volcengine services when practical; otherwise state clearly when the plan is deploying stateful containers inside VKE.
Read references/vke-deploy-steps.md for the full VKE pipeline (cluster wait, kubeconfig, addon checks, CR auth/push, rollout, endpoint verify), with references/k8s-manifests.md for manifest templates and references/dockerfile-templates.md for image build templates.
9. Deployment summary
Print one access card:
volcengine-deploy — <repo_name> (<git_sha>)
Mode: <ecs|vke|vefaas>
Region: <region>
Project: <deploy-project or reused resources>
URL: <public endpoint>
Health: <checked URL/status>
Acceptance: <core app behavior checked, or reason only transport health was possible>
Resources: .volcengine/created-resources.json
IaC: <.volcengine/terraform + .volcengine/iac-outputs.json | n/a>
Logs: <journalctl / docker logs / kubectl logs / vefaas logs command>
Cleanup: <reverse-order cleanup commands or ledger path>
Notes: <credentials/env/migration warnings>
Do not add custom domain, HTTPS, dashboards, or cost cards unless the user asks; those are day-2 tasks.
10. Reference details
Use these references as needed:
11. Common failure modes
Common gotchas are intentionally kept as references so the main skill stays adaptive:
