
Skill
documentdb-local-deployment
run Azure DocumentDB locally for development
Description
Best practices for running Azure DocumentDB locally for development — choosing between the Gateway Docker image and the psql-only image, docker-compose setup, connection config (port 10260, TLS, SCRAM-SHA-256), env-driven configuration, sample-data management (`SKIP_INIT_DATA` / `INIT_DATA_PATH`), port bindings, and dev/prod parity via versioned seed and schema scripts. Use when setting up a new local dev environment, writing sample apps, building integration tests, or diagnosing local connection problems.
SKILL.md
Local Deployment & Developer Workflow — Azure DocumentDB
Image choices:
- Gateway (
ghcr.io/microsoft/documentdb/documentdb-local:latest) — MongoDB wire protocol on port 10260. Use this for app development. - psql-only (
mcr.microsoft.com/cosmosdb/ubuntu/documentdb-oss:...) — raw PostgreSQL on port 9712. Use only for direct SQL inspection.
Rules
- local-choose-deployment-method — Pick the simplest local option (Gateway, Compose, psql-only, or source) that matches the interface your app actually uses.
- local-docker-compose-setup — Reproducible local stack via
docker-compose.yml: pinned images,host.docker.internal,restart: unless-stopped. - local-connection-config — Connect on port 10260 with
--tls,--tlsAllowInvalidCertificates, and SCRAM-SHA-256 for the self-signed local cert. - local-env-driven-config — Drive connection URI and TLS relaxation from env vars; never default
tlsAllowInvalidCertificates=truein code. - local-sample-data-management — Use
SKIP_INIT_DATA+INIT_DATA_PATHwith vetted seed scripts; don't ship the built-insampledbbeyond local demos. - local-ports-and-bindings — Bind published ports to
127.0.0.1and expose only what you use (10260 for Mongo, 9712 for psql). - local-prod-parity — Same connection abstraction and versioned index/seed scripts across local and Azure DocumentDB; integration-test against the real container.
More skills from the documentdb-agent-kit repository
View all 17 skillsdocumentdb-azure-deployment
deploy Azure DocumentDB clusters
Jul 12AzureBicepCLIDatabase +2documentdb-connection
configure MongoDB connections for DocumentDB
Jul 12AzureDatabasePerformancedocumentdb-data-modeling
design Azure DocumentDB data models
Aug 1AzureData ModelingDatabaseMongoDBdocumentdb-driver
implement Azure DocumentDB driver best practices
Jul 12AzureDatabaseMongoDBSDKdocumentdb-full-text-search
implement full-text search in Azure DocumentDB
Jul 15AzureDatabaseSearchdocumentdb-high-availability
configure high availability for DocumentDB
Jul 12AzureDatabaseOperationsPerformance
More from Azure (Microsoft)
View publisherazure-arg-external-evaluation-policy-author
author and test Azure Resource Graph policies
azure-policy
Jul 12AzureComplianceGovernancePolicyazure-blueprints-migration
migrate Azure Blueprints to Template Specs
azure-blueprints
Jul 12AzureDeploymentInfrastructure as CodeMigrationapiview-feedback-resolution
resolve APIView feedback on Azure SDKs
azure-sdk-tools
Jul 12API DevelopmentAzureCode ReviewDocumentationazsdk-common-live-and-recorded-tests
deploy resources and run Azure SDK tests
azure-sdk-tools
Jul 12AzureDeploymentSDKTestingazsdk-common-prepare-release-plan
manage Azure SDK release plan work items
azure-sdk-tools
Jul 12AzureGitHubProject ManagementSDKazsdk-common-sdk-release
release Azure SDK packages
azure-sdk-tools
Jul 12AzureCI/CDDeploymentSDK