agentleFS
MicrosoftKnown publishermicrosoft/aspire-skills/opencode/v1/aspire-deployment/SKILL.md

aspire-deployment

Skill93 starsChanged 27 days agoMITView on GitHub

**WORKFLOW SKILL** — Deploy Aspire apps from AppHost models to Docker Compose, Kubernetes, Azure, AWS, or preview Radius. WHEN: \"deploy Aspire app\", \"publish Aspire artifacts\", \"deploy to Azure Container Apps\", \"generate Kubernetes artifacts\", \"deploy to Radius\", \"tear down Aspire deployment\". INVOKES: aspire CLI, Aspire docs, target cloud/container CLIs. FOR SINGLE OPERATIONS: use generic Azure, Kubernetes, Docker, AWS, or Radius tools only when no Aspire AppHost exists.

  • Reads credentials

3 other projects use a version of this, 3 of them edited.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

43 rules. 21 are common, 1 is distinctive, and 21 are very specific to this project.

  • 21

    Common

    Most of the 3 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 21

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Keep this as one skill with target-specific references.

    line 16
  2. Very specific:

    If Aspire markers are present but this skill was not automatically invoked, switch to this skill before continuing.

    line 29
  3. Common:

    Before adding target packages, editing the AppHost, or using an unfamiliar deployment API, use Aspire docs:

    line 35
  4. Common:

    When you need exact C# or TypeScript API shape, use API docs too.

    line 49
  5. Common:

    Do not invent package names, builder methods, overloads, or deployment commands.

    line 57
  6. Common:

    Use Aspire deployment targets and CLI commands first:

    line 65
  7. Common:

    Use target-specific tooling only after Aspire has generated artifacts or when the target docs call for it:

    line 76
  8. Common:

    Do not ask for target selection when the user already chose a target such as Docker Compose, Kubernetes, Azure Container Apps, Azure App …

    line 87
  9. Common:

    If the user did not explicitly choose a deployment target and the AppHost does not already contain exactly one deployment environment, ask …

    line 89
  10. Distinctive:

    Do not offer preview Radius as a default choice.

    line 104
  11. Common:

    If the user explicitly asked to deploy now, continue through preflight and deployment, but still surface any target choice, …

    line 113
  12. Very specific:

    Before publish or deploy, verify that Aspire.AppHost.Sdk and the hosting packages use compatible versions in the project's selected release …

    line 121
  13. Very specific:

    use .Services instead of hosting context .ServiceProvider.

    line 129
  14. Very specific:

    use AddConnectionString instead of PublishAsConnectionString.

    line 130
  15. Very specific:

    Start with aspire ls to list AppHosts in the current scope, then use aspire.config.json, AppHost project files, or aspire ps if more …

    line 136
  16. Very specific:

    If no AppHost exists, stop deployment work and invoke the aspireify skill to initialize/wire the AppHost before continuing.

    line 137
  17. Common:

    Prefer Aspire CLI commands for discovery and state inspection.

    line 139
  18. Common:

    If the user named Docker Compose, Kubernetes, Azure Container Apps, Azure App Service, Azure Kubernetes Service (AKS), or AWS, load that …

    line 141
  19. Common:

    If they only said "deploy", inspect existing AppHost target environment resources.

    line 142
  20. Common:

    If exactly one target environment already exists, use it and state what was detected.

    line 143
  21. Common:

    If multiple targets exist, none exists, or the user says only "Azure", ask where to deploy using the choices above.

    line 144
  22. Common:

    Search and get the target deployment docs.

    line 155
  23. Common:

    Search API docs before editing AppHost code.

    line 156
  24. Very specific:

    Run the target's aspire add ...

    line 158
  25. Common:

    Add the deployment environment resource to the AppHost.

    line 159
  26. Very specific:

    Do not add explicit compute-environment assignment for the common single-environment case.

    line 160
  27. Common:

    Add only the target-specific customization APIs the deployment needs, such as endpoint exposure, Helm settings, Compose file customization, …

    line 161
  28. Very specific:

    Run aspire publish --list-steps or aspire deploy --list-steps.

    line 169
  29. Very specific:

    Use aspire publish -o <scratch-or-output-path> when artifact review is requested.

    line 170
  30. Very specific:

    Treat published artifacts as a preview/handoff.

    line 171
  31. Very specific:

    Run aspire deploy when the user asked to deploy and preflight is complete.

    line 174
  32. Very specific:

    Run a named step with aspire do <step> only when the user asked for a specific pipeline step.

    line 175
  33. Very specific:

    Run aspire destroy to execute the selected AppHost/environment's target destroy pipeline.

    line 178
  34. Very specific:

    Use --yes only when the user or CI workflow already made teardown intent explicit.

    line 180
  35. Very specific:

    Prefer aspire destroy over target-native delete commands unless you are troubleshooting failed teardown or cleaning up unmanaged leftovers.

    line 181
  36. Very specific:

    Use target output, aspire describe, cloud CLI, Docker Compose, kubectl, or endpoint checks appropriate to the target.

    line 183
  37. Common:

    After destroy, verify target resources are removed or record any leftovers that require manual cleanup.

    line 184
  38. Common:

    Search the AppHost for deployment environment resources:

    line 188
  39. Common:

    Use this table only for orientation.

    line 200
  40. Very specific:

    Use aspire secret list for AppHost user secrets when appropriate, but do not print secret values.

    line 214
  41. Very specific:

    When running unattended (CI, scripted, agent-driven), append --non-interactive to every Aspire CLI invocation that may prompt — most …

    line 229
  42. Very specific:

    Prefer surfacing prompt-driving values up front (target subscription/region/resource group, parameters, secrets, registry credentials) so …

    line 231
  43. Very specific:

    If .agents/skills/aspire-deployment/SKILL.md exists (dropped by aspire agent init), prefer it over this plugin skill — it is the …

    line 247

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Aspire Deployment

Use this skill when the task is to publish, preview, validate, deploy, or tear down an Aspire application deployment. This skill owns Aspire deployment routing. Do not start with a generic Azure, Docker, Kubernetes, Helm, or Bicep workflow until you have checked whether the workspace is an Aspire app.

Aspire deployment starts from the AppHost model. Treat aspire deploy, aspire publish, aspire destroy, aspire do, and the deployment environment resources in the AppHost as the primary path. Use stable SDK/hosting packages from the project's release family and matching preview builds for preview-only integrations such as Kubernetes and Radius.

Keep this as one skill with target-specific references. Load only the reference files that match the target you discover or the user requests.

Routing precedence

This skill wins over generic cloud deployment skills when both conditions are true:

  1. The user asks to deploy, publish, generate deployment artifacts, create Bicep/Helm/Compose/CDK output, host on Azure or AWS, deploy to Azure, AWS, Kubernetes, Docker Compose, or Radius, tear down deployed resources, or validate a deployment.
  2. The workspace has Aspire markers:
    • Aspire workspace configuration
    • C# or TypeScript AppHost files
    • an AppHost project
    • AppHost code using Aspire distributed application builder APIs

If Aspire markers are present but this skill was not automatically invoked, switch to this skill before continuing. Prefer Aspire CLI commands such as aspire ls, aspire config list, aspire ps, and aspire describe for workspace orientation.

Guiding principles

Use Aspire docs before changing deployment code

Before adding target packages, editing the AppHost, or using an unfamiliar deployment API, use Aspire docs:

aspire docs search "deploy with Aspire"
aspire docs search "Docker Compose deployment"
aspire docs search "Kubernetes deployment"
aspire docs search "Azure Container Apps deployment"
aspire docs search "Azure App Service deployment"
aspire docs search "Azure Kubernetes Service deployment"
aspire docs search "Radius deployment"
aspire docs get "deploy-to-azure-kubernetes-service-aks"
aspire docs get "<slug-from-search-results>"

When you need exact C# or TypeScript API shape, use API docs too. Search both languages when you are not sure which AppHost language the repo uses:

aspire docs api search "<deployment API or concept>" --language csharp
aspire docs api search "<deployment API or concept>" --language typescript
aspire docs api get "<id-from-api-search>"

Do not invent package names, builder methods, overloads, or deployment commands. API shapes differ between C# and TypeScript AppHosts.

Prefer Aspire-native deployment

Deploy the resources declared in the AppHost, not the AppHost process itself. For Docker Compose, configure the Compose environment and let Aspire generate services for those resources; do not replace this with an AppHost Dockerfile or Compose service.

Use Aspire deployment targets and CLI commands first:

aspire publish --list-steps
aspire deploy --list-steps
aspire publish
aspire deploy
aspire destroy
aspire do <step>

Use target-specific tooling only after Aspire has generated artifacts or when the target docs call for it:

  • Docker Compose: inspect generated aspire-output/docker-compose.yaml and .env*; Aspire can also run docker compose up through aspire deploy.
  • Kubernetes: inspect generated Helm chart output; use Helm/kubectl when applying published artifacts yourself.
  • Azure: use aspire add <azure-target>, aspire publish, and aspire deploy through the AppHost deployment environment.
  • AWS: use aspire add aws to add the integration, inspect generated CDK/CloudFormation output, and follow the AWS integrations repository guidance.
  • Radius: treat Aspire.Hosting.Radius as preview. Use integration/docs search to verify the package and API, then model AddRadiusEnvironment(...).WithNamespace(...).

Ask where to deploy only when ambiguous

Do not ask for target selection when the user already chose a target such as Docker Compose, Kubernetes, Azure Container Apps, Azure App Service, Azure Kubernetes Service (AKS), or AWS. Use the chosen target and continue with its reference.

If the user did not explicitly choose a deployment target and the AppHost does not already contain exactly one deployment environment, ask where they want to deploy before adding integrations, editing the AppHost, publishing artifacts, or deploying. Use a single multiple-choice question:

Where do you want to deploy this Aspire app?

Show these choices:

ChoiceAspire add commandUse when
Docker Composeaspire add dockerThe user wants local/server container deployment artifacts for Docker or Podman.
Kubernetesaspire add kubernetesThe user has an existing Kubernetes cluster and wants Helm/Kubernetes artifacts or direct cluster deployment.
Azure Container Appsaspire add azure-appcontainersThe user wants an Azure-managed container platform for distributed apps and services.
Azure App Serviceaspire add azure-appserviceThe user wants Azure website hosting for web apps/APIs that fit the App Service model.
Azure Kubernetes Service (AKS)aspire add azure-kubernetesThe user wants Aspire to provision and deploy to Azure-managed Kubernetes.
AWSaspire add awsThe user wants Aspire to publish/deploy through the AWS Aspire integrations and AWS CDK.

Do not offer preview Radius as a default choice. Use it when the user explicitly requests Radius or the AppHost already contains a Radius environment.

If the user says only "Azure", ask again with just the Azure choices: Azure Container Apps, Azure App Service, or Azure Kubernetes Service (AKS). If the AppHost already contains exactly one deployment environment and the user did not ask to change targets, use that target and tell the user what was detected.

Ask before creating cloud resources when intent is not explicit

Cloud deploys can create billable resources. If the user asked for a plan, preview, validation, or "make this deployable", stop after the deployment plan/artifacts and ask before running the command that provisions resources.

If the user explicitly asked to deploy now, continue through preflight and deployment, but still surface any target choice, subscription/resource group ambiguity, or missing parameter decisions before provisioning.

Keep Azure deployment Aspire-native

The Azure deployment path in this skill is aspire add <azure-target>, AppHost environment configuration, aspire publish, and aspire deploy. Do not route Azure deployment work through a separate Azure deployment tool or generated infrastructure workflow.

Keep Aspire packages on one release family

Before publish or deploy, verify that Aspire.AppHost.Sdk and the hosting packages use compatible versions in the project's selected release family. Preview-only integrations need compatible preview builds selected by aspire add or integration docs. The CLI version does not make incompatible hosting packages safe; mixed graphs can fail at startup with MissingMethodException or TypeLoadException.

Migrate obsolete 13.5 surfaces while editing deployment code:

  • use .Services instead of hosting context .ServiceProvider;
  • use AddConnectionString instead of PublishAsConnectionString; and
  • migrate deprecated Aspire.Hosting.GitHub.Models resources to Azure AI Foundry.

Default workflow

  1. Orient to the Aspire workspace.
    • Start with aspire ls to list AppHosts in the current scope, then use aspire.config.json, AppHost project files, or aspire ps if more context is needed.
    • If no AppHost exists, stop deployment work and invoke the aspireify skill to initialize/wire the AppHost before continuing.
    • Identify C# vs TypeScript AppHost.
    • Prefer Aspire CLI commands for discovery and state inspection.
  2. Clarify or infer the deployment target.
    • If the user named Docker Compose, Kubernetes, Azure Container Apps, Azure App Service, Azure Kubernetes Service (AKS), or AWS, load that target reference without asking again.
    • If they only said "deploy", inspect existing AppHost target environment resources.
    • If exactly one target environment already exists, use it and state what was detected.
    • If multiple targets exist, none exists, or the user says only "Azure", ask where to deploy using the choices above.
  3. Load target and app-type references.
    • Docker Compose: references/docker-compose.md
    • Kubernetes and Azure Kubernetes Service (AKS): references/kubernetes.md
    • Azure Container Apps/App Service/Azure Kubernetes Service (AKS): references/azure.md
    • AWS: references/aws.md
    • Radius preview: use current Aspire docs and API search for Aspire.Hosting.Radius; do not guess experimental API shapes.
    • JavaScript app resources: references/javascript.md
    • CI/CD or GitHub Actions automation: references/cicd.md
  4. Use Aspire docs search for current guidance.
    • Search and get the target deployment docs.
    • Search API docs before editing AppHost code.
  5. Apply the target code changes.
    • Run the target's aspire add ... command if the integration is missing.
    • Add the deployment environment resource to the AppHost.
    • Do not add explicit compute-environment assignment for the common single-environment case. Only disambiguate when the AppHost has multiple deployment environments. In C# this is usually WithComputeEnvironment(...); for TypeScript AppHosts, verify the current language-specific docs before assuming an equivalent.
    • Add only the target-specific customization APIs the deployment needs, such as endpoint exposure, Helm settings, Compose file customization, Azure site/container app customization, or AWS publish target overrides.
  6. Preflight the deployment model.
    • Confirm the target integration package exists in the AppHost.
    • Confirm the AppHost has the target environment resource.
    • Confirm compute resources are assigned to the target environment only when multiple compute environments exist. A single compute environment is the common case and can be inferred.
    • Inventory parameters, secrets, connection strings, external endpoints, container registries, and target-specific prerequisites.
    • For Azure or AWS, confirm auth, target account/subscription, region/location, and resource group/stack context.
  7. Preview before applying.
    • Run aspire publish --list-steps or aspire deploy --list-steps.
    • Use aspire publish -o <scratch-or-output-path> when artifact review is requested.
    • Treat published artifacts as a preview/handoff. aspire deploy resolves values and applies the deployment from the AppHost model; it does not consume a previously published output directory.
    • Summarize resources, endpoints, parameters, secrets, identities, and generated artifacts.
  8. Deploy or hand off.
    • Run aspire deploy when the user asked to deploy and preflight is complete.
    • Run a named step with aspire do <step> only when the user asked for a specific pipeline step.
    • For published artifacts, explain the target-native apply step.
  9. Destroy only when explicitly requested.
    • Run aspire destroy to execute the selected AppHost/environment's target destroy pipeline.
    • Confirm the AppHost, environment, target account/subscription/cluster, and destructive intent before running it.
    • Use --yes only when the user or CI workflow already made teardown intent explicit.
    • Prefer aspire destroy over target-native delete commands unless you are troubleshooting failed teardown or cleaning up unmanaged leftovers.
  10. Verify the outcome.
  • Use target output, aspire describe, cloud CLI, Docker Compose, kubectl, or endpoint checks appropriate to the target.
  • After destroy, verify target resources are removed or record any leftovers that require manual cleanup.

AppHost target detection

Search the AppHost for deployment environment resources:

TargetAspire add commandIntegrationAppHost environment concept
Docker Composeaspire add dockerDocker hostingDocker Compose environment
Kubernetesaspire add kubernetesKubernetes hostingKubernetes environment
Azure Container Appsaspire add azure-appcontainersAzure Container Apps hostingAzure Container Apps environment
Azure App Serviceaspire add azure-appserviceAzure App Service hostingAzure App Service environment
Azure Kubernetes Service (AKS)aspire add azure-kubernetesAzure Kubernetes hostingAzure Kubernetes Service (AKS) environment
AWSaspire add awsAWS hostingAWS CDK environment
Radius (preview)Discover with aspire integration search radiusAspire.Hosting.RadiusRadius environment

Use this table only for orientation. Before editing code, verify the current API in Aspire docs for the AppHost language.

Parameter and secret preflight

Parameters are deployment inputs. They may be supplied by configuration files, user secrets, environment variables, command-line args, interactive prompts, or CI/CD secret stores depending on the target and command.

Before deployment, report:

  • Parameter name from AppHost parameter APIs, including config-backed parameters
  • Whether it is secret
  • Expected provider syntax such as Parameters__name; for parameter names with dashes, use underscores in environment variables, for example registry-endpoint becomes Parameters__registry_endpoint
  • Where it flows, such as a project environment variable, connection string, Key Vault secret, Helm Secret, Compose .env, or Azure app setting
  • Whether a value appears configured or missing

Use aspire secret list for AppHost user secrets when appropriate, but do not print secret values. For deployment artifacts, inspect generated placeholders and mappings, not raw secret content.

Target references

  • references/docker-compose.md - Docker Compose target, generated files, environment variables, cleanup.
  • references/kubernetes.md - Kubernetes and Azure Kubernetes Service (AKS) target selection, Helm output, registry requirements, kubectl/Helm checks.
  • references/azure.md - Azure target selection, Azure settings, Container Apps, App Service, and Azure Kubernetes Service (AKS).
  • references/aws.md - AWS target selection, AWS CDK prerequisites, publish/deploy workflow, and AWS integration docs.
  • references/javascript.md - JavaScript app deployment models, including Vite/static assets, Node/SSR servers, Next.js, and gateway/backend serving patterns.
  • references/cicd.md - CI/CD and GitHub Actions workflow guidance for Aspire publish/deploy, parameters, secrets, registry auth, and cloud auth.
  • references/preflight.md - Common preflight, preview, parameter, destroy, and validation checklist.
  • aspire-13-5-breaking-changes.md - 13.5 package, API, and CLI migration rules.

Agent execution

When running unattended (CI, scripted, agent-driven), append --non-interactive to every Aspire CLI invocation that may prompt — most importantly aspire publish, aspire deploy, and aspire destroy. For aspire destroy, also pass --yes only after the user has explicitly confirmed teardown intent (or a CI workflow already encodes that intent).

Prefer surfacing prompt-driving values up front (target subscription/region/resource group, parameters, secrets, registry credentials) so the unattended run does not stall. See references/preflight.md for the full preflight checklist.

Handoff Rules

ScenarioRoute To
Start, stop, wait, or restart the AppHost / its resourcesaspire-orchestration skill
Logs, traces, metrics, dashboard for a running or deployed appaspire-monitoring skill
AppHost authoring — adding integrations, wiring resources, environment setupaspireify skill
Deployed-app diagnostics — App Insights, ACA logs, AKS Container Insightsazure-diagnostics skill (azure-skills)

Never hand deployment off to azure-skills. Aspire handles publish, deploy, and destroy end-to-end across Docker Compose / Kubernetes / Azure / AWS via the AppHost model.

Project-Local Skill Override

If .agents/skills/aspire-deployment/SKILL.md exists (dropped by aspire agent init), prefer it over this plugin skill — it is the authoritative project-local version with content version-aligned to the consumer's Aspire CLI. This plugin skill is the always-on safety net for repos that have not yet run aspire agent init.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.