usr_unknown/pulumi-dokploy
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases 2 Wiki Activity
Files
a0acdd1c82955e707643c572a2adade834c1471e
pulumi-dokploy/provider/cmd/pulumi-resource-dokploy/schema.json
T
max-voitcov 73386ba0ff
build / build (push) Failing after 11m22s
Details
release / plugin (push) Failing after 31m35s
Details
release / sdks (push) Has been skipped
Details
Bridge what Dokploy v0.30 added, and let the docs through 
Six new resources from terraform-provider-dokploy v0.2.0 -- Network,
DnsProvider, VaultProvider, Schedule, VolumeBackup and Libsql -- plus the new
properties on Domain (`enabled`), Compose (`serviceNetworks`, `createEnvFile`,
`icon`) and Application. Verified with `pulumi up` against a live v0.30.2
instance: create, preview-clean, and destroy.

The upstream provider also now refuses a volume Mount with no `volumeName`,
which Dokploy would otherwise turn into an anonymous Docker volume recreated
on every deploy. That surfaces here at preview time, before anything exists.

Two things made that fix nearly invisible to Pulumi users, so this commit
fixes the second one: the bridge resolves the upstream `docs/` through the Go
module cache, where a locally `replace`d dependency never lands, so tfgen was
emitting every resource with no description at all. UpstreamRepoPath now
points at the checkout and all 445 inputs carry documentation -- with names
rendered per language, so Python readers see `volume_name` where TypeScript
readers see `volumeName`.
2026-08-26 00:46:32 +03:00

7085 lines
445 KiB
JSON
Raw Blame History

{
"name": "dokploy",
"displayName": "Dokploy",
"description": "A Pulumi package for creating and managing Dokploy resources",
"keywords": [
"pulumi",
"dokploy",
"paas",
"docker",
"deployment",
"category/cloud",
"category/infrastructure"
],
"homepage": "https://gitea.coolify.vojtkov.dev/usr_unknown/pulumi-dokploy",
"license": "MPL-2.0",
"attribution": "This Pulumi package is based on the [`dokploy` Terraform Provider](https://github.com/maxvojtkov/terraform-provider-dokploy).",
"repository": "https://gitea.coolify.vojtkov.dev/usr_unknown/pulumi-dokploy",
"pluginDownloadURL": "https://gitea.coolify.vojtkov.dev/usr_unknown/pulumi-dokploy/releases/download/v${VERSION}",
"publisher": "maxvojtkov",
"meta": {
"moduleFormat": "(.*)(?:/[^/]*)"
},
"language": {
"csharp": {
"packageReferences": {
"Pulumi": "3.*"
},
"compatibility": "tfbridge20",
"rootNamespace": "Maxvojtkov",
"respectSchemaVersion": true
},
"go": {
"importBasePath": "github.com/maxvojtkov/pulumi-dokploy/sdk/go/dokploy",
"generateResourceContainerTypes": true,
"generateExtraInputTypes": true,
"respectSchemaVersion": true
},
"nodejs": {
"packageName": "@maxvojtkov/pulumi-dokploy",
"packageDescription": "A Pulumi package for creating and managing Dokploy resources. Based on terraform-provider-dokploy: version v0.2.0",
"readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/maxvojtkov/terraform-provider-dokploy)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-dokploy` repo](https://gitea.coolify.vojtkov.dev/usr_unknown/pulumi-dokploy/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-dokploy` repo](https://github.com/maxvojtkov/terraform-provider-dokploy/issues).",
"dependencies": {
"@pulumi/pulumi": "^3.0.0"
},
"devDependencies": {
"@types/node": "^18",
"typescript": "^4.6.0"
},
"compatibility": "tfbridge20",
"disableUnionOutputTypes": true,
"respectSchemaVersion": true
},
"python": {
"packageName": "pulumi_dokploy",
"requires": {
"pulumi": "\u003e=3.0.0,\u003c4.0.0"
},
"readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/maxvojtkov/terraform-provider-dokploy)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-dokploy` repo](https://gitea.coolify.vojtkov.dev/usr_unknown/pulumi-dokploy/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-dokploy` repo](https://github.com/maxvojtkov/terraform-provider-dokploy/issues).",
"compatibility": "tfbridge20",
"respectSchemaVersion": true,
"pyproject": {
"enabled": true
}
}
},
"config": {
"variables": {
"apiKey": {
"type": "string",
"description": "API token generated in Dokploy under *Settings \u003e Profile \u003e API/CLI*. May also be set with the `DOKPLOY_API_KEY` environment variable.",
"defaultInfo": {
"environment": [
"DOKPLOY_API_KEY"
]
},
"secret": true
},
"host": {
"type": "string",
"description": "Base URL of the Dokploy instance, for example `https://dokploy.example.com`. A trailing `/api` is optional. May also be set with the `DOKPLOY_HOST` environment variable.",
"defaultInfo": {
"environment": [
"DOKPLOY_HOST"
]
}
},
"insecureSkipVerify": {
"type": "boolean",
"description": "Skip TLS certificate verification. Only use this for instances behind a self-signed certificate. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e."
},
"timeoutSeconds": {
"type": "integer",
"description": "Per-request timeout in seconds. Defaults to \u003cspan pulumi-lang-nodejs=\"`60`\" pulumi-lang-dotnet=\"`60`\" pulumi-lang-go=\"`60`\" pulumi-lang-python=\"`60`\" pulumi-lang-yaml=\"`60`\" pulumi-lang-java=\"`60`\" pulumi-lang-hcl=\"`60`\"\u003e`60`\u003c/span\u003e. May also be set with the `DOKPLOY_TIMEOUT_SECONDS` environment variable.",
"defaultInfo": {
"environment": [
"DOKPLOY_TIMEOUT_SECONDS"
]
}
}
}
},
"types": {
"dokploy:index/getProjectEnvironment:getProjectEnvironment": {
"properties": {
"id": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object",
"required": [
"id",
"isDefault",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"dokploy:index/getProjectsProject:getProjectsProject": {
"properties": {
"defaultEnvironmentId": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object",
"required": [
"defaultEnvironmentId",
"description",
"id",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"dokploy:index/getServersServer:getServersServer": {
"properties": {
"id": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"name": {
"type": "string"
},
"serverStatus": {
"type": "string"
}
},
"type": "object",
"required": [
"id",
"ipAddress",
"name",
"serverStatus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
}
},
"provider": {
"description": "The provider type for the dokploy package. By default, resources use package-wide configuration\nsettings, however an explicit `Provider` instance may be created and passed during resource\nconstruction to achieve fine-grained programmatic control over provider settings. See the\n[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.\n",
"properties": {
"apiKey": {
"type": "string",
"description": "API token generated in Dokploy under *Settings \u003e Profile \u003e API/CLI*. May also be set with the `DOKPLOY_API_KEY` environment variable.",
"secret": true
},
"host": {
"type": "string",
"description": "Base URL of the Dokploy instance, for example `https://dokploy.example.com`. A trailing `/api` is optional. May also be set with the `DOKPLOY_HOST` environment variable."
},
"insecureSkipVerify": {
"type": "boolean",
"description": "Skip TLS certificate verification. Only use this for instances behind a self-signed certificate. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e."
},
"timeoutSeconds": {
"type": "integer",
"description": "Per-request timeout in seconds. Defaults to \u003cspan pulumi-lang-nodejs=\"`60`\" pulumi-lang-dotnet=\"`60`\" pulumi-lang-go=\"`60`\" pulumi-lang-python=\"`60`\" pulumi-lang-yaml=\"`60`\" pulumi-lang-java=\"`60`\" pulumi-lang-hcl=\"`60`\"\u003e`60`\u003c/span\u003e. May also be set with the `DOKPLOY_TIMEOUT_SECONDS` environment variable."
}
},
"inputProperties": {
"apiKey": {
"type": "string",
"description": "API token generated in Dokploy under *Settings \u003e Profile \u003e API/CLI*. May also be set with the `DOKPLOY_API_KEY` environment variable.",
"defaultInfo": {
"environment": [
"DOKPLOY_API_KEY"
]
},
"secret": true
},
"host": {
"type": "string",
"description": "Base URL of the Dokploy instance, for example `https://dokploy.example.com`. A trailing `/api` is optional. May also be set with the `DOKPLOY_HOST` environment variable.",
"defaultInfo": {
"environment": [
"DOKPLOY_HOST"
]
}
},
"insecureSkipVerify": {
"type": "boolean",
"description": "Skip TLS certificate verification. Only use this for instances behind a self-signed certificate. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e."
},
"timeoutSeconds": {
"type": "integer",
"description": "Per-request timeout in seconds. Defaults to \u003cspan pulumi-lang-nodejs=\"`60`\" pulumi-lang-dotnet=\"`60`\" pulumi-lang-go=\"`60`\" pulumi-lang-python=\"`60`\" pulumi-lang-yaml=\"`60`\" pulumi-lang-java=\"`60`\" pulumi-lang-hcl=\"`60`\"\u003e`60`\u003c/span\u003e. May also be set with the `DOKPLOY_TIMEOUT_SECONDS` environment variable.",
"defaultInfo": {
"environment": [
"DOKPLOY_TIMEOUT_SECONDS"
]
}
}
},
"methods": {
"terraformConfig": "pulumi:providers:dokploy/terraformConfig"
}
},
"resources": {
"dokploy:index/application:Application": {
"description": "A Dokploy application: a single service built from a Git repository, a Docker image, or an uploaded artifact.\n\nDokploy's `application.create` endpoint accepts only a handful of fields, so this resource creates the application and then applies the rest of the configuration through `application.update`.\n\n\u003e Creating this resource does **not** deploy the application. Trigger a deployment from the Dokploy UI, the CLI, or a \u003cspan pulumi-lang-nodejs=\"`terraformData`\" pulumi-lang-dotnet=\"`TerraformData`\" pulumi-lang-go=\"`terraformData`\" pulumi-lang-python=\"`terraform_data`\" pulumi-lang-yaml=\"`terraformData`\" pulumi-lang-java=\"`terraformData`\" pulumi-lang-hcl=\"`terraform_data`\"\u003e`terraformData`\u003c/span\u003e provisioner calling `application.deploy`.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new application.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"autoDeploy": {
"type": "boolean",
"description": "Deploy automatically when the configured trigger fires.\n"
},
"bitbucketBranch": {
"type": "string",
"description": "Bitbucket branch to build.\n"
},
"bitbucketBuildPath": {
"type": "string",
"description": "Path within the Bitbucket repository to build from.\n"
},
"bitbucketId": {
"type": "string",
"description": "ID of the configured Bitbucket provider connection.\n"
},
"bitbucketOwner": {
"type": "string",
"description": "Bitbucket repository owner.\n"
},
"bitbucketRepository": {
"type": "string",
"description": "Bitbucket repository name.\n"
},
"bitbucketRepositorySlug": {
"type": "string",
"description": "Bitbucket repository slug.\n"
},
"branch": {
"type": "string",
"description": "GitHub branch to build.\n"
},
"buildArgs": {
"type": "string",
"description": "Docker build arguments in `KEY=value` format, one per line.\n"
},
"buildPath": {
"type": "string",
"description": "Path within the GitHub repository to build from.\n"
},
"buildRegistryId": {
"type": "string",
"description": "Registry used by a dedicated build server.\n"
},
"buildSecrets": {
"type": "string",
"description": "Docker build secrets in `KEY=value` format, one per line.\n",
"secret": true
},
"buildServerId": {
"type": "string",
"description": "Server that performs builds, when separate from the deploy server.\n"
},
"buildType": {
"type": "string",
"description": "How the application is built. Valid values: \u003cspan pulumi-lang-nodejs=\"`dockerfile`\" pulumi-lang-dotnet=\"`Dockerfile`\" pulumi-lang-go=\"`dockerfile`\" pulumi-lang-python=\"`dockerfile`\" pulumi-lang-yaml=\"`dockerfile`\" pulumi-lang-java=\"`dockerfile`\" pulumi-lang-hcl=\"`dockerfile`\"\u003e`dockerfile`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`herokuBuildpacks`\" pulumi-lang-dotnet=\"`HerokuBuildpacks`\" pulumi-lang-go=\"`herokuBuildpacks`\" pulumi-lang-python=\"`heroku_buildpacks`\" pulumi-lang-yaml=\"`herokuBuildpacks`\" pulumi-lang-java=\"`herokuBuildpacks`\" pulumi-lang-hcl=\"`heroku_buildpacks`\"\u003e`herokuBuildpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`paketoBuildpacks`\" pulumi-lang-dotnet=\"`PaketoBuildpacks`\" pulumi-lang-go=\"`paketoBuildpacks`\" pulumi-lang-python=\"`paketo_buildpacks`\" pulumi-lang-yaml=\"`paketoBuildpacks`\" pulumi-lang-java=\"`paketoBuildpacks`\" pulumi-lang-hcl=\"`paketo_buildpacks`\"\u003e`paketoBuildpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`nixpacks`\" pulumi-lang-dotnet=\"`Nixpacks`\" pulumi-lang-go=\"`nixpacks`\" pulumi-lang-python=\"`nixpacks`\" pulumi-lang-yaml=\"`nixpacks`\" pulumi-lang-java=\"`nixpacks`\" pulumi-lang-hcl=\"`nixpacks`\"\u003e`nixpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`static`\" pulumi-lang-dotnet=\"`Static`\" pulumi-lang-go=\"`static`\" pulumi-lang-python=\"`static`\" pulumi-lang-yaml=\"`static`\" pulumi-lang-java=\"`static`\" pulumi-lang-hcl=\"`static`\"\u003e`static`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`railpack`\" pulumi-lang-dotnet=\"`Railpack`\" pulumi-lang-go=\"`railpack`\" pulumi-lang-python=\"`railpack`\" pulumi-lang-yaml=\"`railpack`\" pulumi-lang-java=\"`railpack`\" pulumi-lang-hcl=\"`railpack`\"\u003e`railpack`\u003c/span\u003e.\n"
},
"cleanCache": {
"type": "boolean",
"description": "Discard the build cache on the next deployment.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createEnvFile": {
"type": "boolean",
"description": "Write the environment variables to a `.env` file in the container.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the application was created.\n"
},
"customGitBranch": {
"type": "string",
"description": "Branch to build for a custom Git remote.\n"
},
"customGitBuildPath": {
"type": "string",
"description": "Path within a custom Git repository to build from.\n"
},
"customGitSshKeyId": {
"type": "string",
"description": "SSH key used to clone a private custom Git remote.\n"
},
"customGitUrl": {
"type": "string",
"description": "Git remote URL, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerBuildStage": {
"type": "string",
"description": "Target stage for a multi-stage Docker build.\n"
},
"dockerContextPath": {
"type": "string",
"description": "Docker build context path.\n"
},
"dockerImage": {
"type": "string",
"description": "Docker image reference, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`docker`\" pulumi-lang-dotnet=\"`Docker`\" pulumi-lang-go=\"`docker`\" pulumi-lang-python=\"`docker`\" pulumi-lang-yaml=\"`docker`\" pulumi-lang-java=\"`docker`\" pulumi-lang-hcl=\"`docker`\"\u003e`docker`\u003c/span\u003e.\n"
},
"dockerfile": {
"type": "string",
"description": "Path to the Dockerfile, when \u003cspan pulumi-lang-nodejs=\"`buildType`\" pulumi-lang-dotnet=\"`BuildType`\" pulumi-lang-go=\"`buildType`\" pulumi-lang-python=\"`build_type`\" pulumi-lang-yaml=\"`buildType`\" pulumi-lang-java=\"`buildType`\" pulumi-lang-hcl=\"`build_type`\"\u003e`buildType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`dockerfile`\" pulumi-lang-dotnet=\"`Dockerfile`\" pulumi-lang-go=\"`dockerfile`\" pulumi-lang-python=\"`dockerfile`\" pulumi-lang-yaml=\"`dockerfile`\" pulumi-lang-java=\"`dockerfile`\" pulumi-lang-hcl=\"`dockerfile`\"\u003e`dockerfile`\u003c/span\u003e.\n"
},
"enableSubmodules": {
"type": "boolean",
"description": "Clone Git submodules when checking out the repository.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the application is enabled.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Runtime environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this application belongs to.\n"
},
"giteaBranch": {
"type": "string",
"description": "Gitea branch to build.\n"
},
"giteaBuildPath": {
"type": "string",
"description": "Path within the Gitea repository to build from.\n"
},
"giteaId": {
"type": "string",
"description": "ID of the configured Gitea provider connection.\n"
},
"giteaOwner": {
"type": "string",
"description": "Gitea repository owner.\n"
},
"giteaRepository": {
"type": "string",
"description": "Gitea repository name.\n"
},
"githubId": {
"type": "string",
"description": "ID of the configured GitHub provider connection.\n"
},
"gitlabBranch": {
"type": "string",
"description": "GitLab branch to build.\n"
},
"gitlabBuildPath": {
"type": "string",
"description": "Path within the GitLab repository to build from.\n"
},
"gitlabId": {
"type": "string",
"description": "ID of the configured GitLab provider connection.\n"
},
"gitlabOwner": {
"type": "string",
"description": "GitLab repository owner.\n"
},
"gitlabPathNamespace": {
"type": "string",
"description": "Full GitLab namespace path.\n"
},
"gitlabProjectId": {
"type": "integer",
"description": "Numeric GitLab project ID.\n"
},
"gitlabRepository": {
"type": "string",
"description": "GitLab repository name.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"herokuVersion": {
"type": "string",
"description": "Heroku buildpack stack version.\n"
},
"icon": {
"type": "string",
"description": "Icon shown next to the service in the Dokploy UI.\n"
},
"isPreviewDeploymentsActive": {
"type": "boolean",
"description": "Build a preview deployment for each pull request.\n"
},
"isStaticSpa": {
"type": "boolean",
"description": "Serve a static build as a single-page application.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the application.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"owner": {
"type": "string",
"description": "GitHub repository owner.\n"
},
"password": {
"type": "string",
"description": "Registry password, when pulling a private image.\n",
"secret": true
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"previewBuildArgs": {
"type": "string",
"description": "Build arguments applied to preview deployments.\n"
},
"previewBuildSecrets": {
"type": "string",
"description": "Build secrets applied to preview deployments.\n",
"secret": true
},
"previewCertificateType": {
"type": "string",
"description": "Certificate strategy for preview deployments. Valid values: \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`none`\" pulumi-lang-dotnet=\"`None`\" pulumi-lang-go=\"`none`\" pulumi-lang-python=\"`none`\" pulumi-lang-yaml=\"`none`\" pulumi-lang-java=\"`none`\" pulumi-lang-hcl=\"`none`\"\u003e`none`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"previewCustomCertResolver": {
"type": "string",
"description": "Traefik certificate resolver for preview deployments.\n"
},
"previewEnv": {
"type": "string",
"description": "Environment variables applied to preview deployments.\n"
},
"previewHttps": {
"type": "boolean",
"description": "Serve preview deployments over HTTPS.\n"
},
"previewLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Pull request labels that opt into preview deployments.\n"
},
"previewLimit": {
"type": "integer",
"description": "Maximum number of concurrent preview deployments.\n"
},
"previewPath": {
"type": "string",
"description": "Base path for preview deployments.\n"
},
"previewPort": {
"type": "integer",
"description": "Container port exposed by preview deployments.\n"
},
"previewRequireCollaboratorPermissions": {
"type": "boolean",
"description": "Only build previews for pull requests opened by users with repository collaborator permissions.\n"
},
"previewWildcard": {
"type": "string",
"description": "Wildcard domain used to expose preview deployments.\n"
},
"publishDirectory": {
"type": "string",
"description": "Directory served when \u003cspan pulumi-lang-nodejs=\"`buildType`\" pulumi-lang-dotnet=\"`BuildType`\" pulumi-lang-go=\"`buildType`\" pulumi-lang-python=\"`build_type`\" pulumi-lang-yaml=\"`buildType`\" pulumi-lang-java=\"`buildType`\" pulumi-lang-hcl=\"`build_type`\"\u003e`buildType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`static`\" pulumi-lang-dotnet=\"`Static`\" pulumi-lang-go=\"`static`\" pulumi-lang-python=\"`static`\" pulumi-lang-yaml=\"`static`\" pulumi-lang-java=\"`static`\" pulumi-lang-hcl=\"`static`\"\u003e`static`\u003c/span\u003e.\n"
},
"railpackVersion": {
"type": "string",
"description": "Railpack version.\n"
},
"registryId": {
"type": "string",
"description": "Registry used to push the built image.\n"
},
"registryUrl": {
"type": "string",
"description": "Registry URL, when pulling a private image.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"repository": {
"type": "string",
"description": "GitHub repository name.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackActive": {
"type": "boolean",
"description": "Keep previous images so deployments can be rolled back.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"rollbackRegistryId": {
"type": "string",
"description": "Registry used to store rollback images.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"sourceType": {
"type": "string",
"description": "Where the application's code or image comes from. Valid values: \u003cspan pulumi-lang-nodejs=\"`docker`\" pulumi-lang-dotnet=\"`Docker`\" pulumi-lang-go=\"`docker`\" pulumi-lang-python=\"`docker`\" pulumi-lang-yaml=\"`docker`\" pulumi-lang-java=\"`docker`\" pulumi-lang-hcl=\"`docker`\"\u003e`docker`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`github`\" pulumi-lang-dotnet=\"`Github`\" pulumi-lang-go=\"`github`\" pulumi-lang-python=\"`github`\" pulumi-lang-yaml=\"`github`\" pulumi-lang-java=\"`github`\" pulumi-lang-hcl=\"`github`\"\u003e`github`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitlab`\" pulumi-lang-dotnet=\"`Gitlab`\" pulumi-lang-go=\"`gitlab`\" pulumi-lang-python=\"`gitlab`\" pulumi-lang-yaml=\"`gitlab`\" pulumi-lang-java=\"`gitlab`\" pulumi-lang-hcl=\"`gitlab`\"\u003e`gitlab`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`bitbucket`\" pulumi-lang-dotnet=\"`Bitbucket`\" pulumi-lang-go=\"`bitbucket`\" pulumi-lang-python=\"`bitbucket`\" pulumi-lang-yaml=\"`bitbucket`\" pulumi-lang-java=\"`bitbucket`\" pulumi-lang-hcl=\"`bitbucket`\"\u003e`bitbucket`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitea`\" pulumi-lang-dotnet=\"`Gitea`\" pulumi-lang-go=\"`gitea`\" pulumi-lang-python=\"`gitea`\" pulumi-lang-yaml=\"`gitea`\" pulumi-lang-java=\"`gitea`\" pulumi-lang-hcl=\"`gitea`\"\u003e`gitea`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`drop`\" pulumi-lang-dotnet=\"`Drop`\" pulumi-lang-go=\"`drop`\" pulumi-lang-python=\"`drop`\" pulumi-lang-yaml=\"`drop`\" pulumi-lang-java=\"`drop`\" pulumi-lang-hcl=\"`drop`\"\u003e`drop`\u003c/span\u003e.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"subtitle": {
"type": "string",
"description": "Display subtitle shown in the Dokploy UI.\n"
},
"title": {
"type": "string",
"description": "Display title shown in the Dokploy UI.\n"
},
"triggerType": {
"type": "string",
"description": "What triggers an automatic GitHub deployment. Valid values: \u003cspan pulumi-lang-nodejs=\"`push`\" pulumi-lang-dotnet=\"`Push`\" pulumi-lang-go=\"`push`\" pulumi-lang-python=\"`push`\" pulumi-lang-yaml=\"`push`\" pulumi-lang-java=\"`push`\" pulumi-lang-hcl=\"`push`\"\u003e`push`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
},
"username": {
"type": "string",
"description": "Registry username, when pulling a private image.\n"
},
"watchPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Glob patterns that limit which changed paths trigger an automatic deployment.\n"
}
},
"required": [
"appName",
"applicationStatus",
"args",
"autoDeploy",
"bitbucketBuildPath",
"buildPath",
"buildSecrets",
"buildType",
"cleanCache",
"createEnvFile",
"createdAt",
"detachDokployNetwork",
"dockerfile",
"enableSubmodules",
"enabled",
"environmentId",
"giteaBuildPath",
"gitlabBuildPath",
"herokuVersion",
"isPreviewDeploymentsActive",
"isStaticSpa",
"name",
"networkIds",
"password",
"previewBuildSecrets",
"previewCertificateType",
"previewHttps",
"previewLabels",
"previewLimit",
"previewPath",
"previewPort",
"previewRequireCollaboratorPermissions",
"railpackVersion",
"replicas",
"rollbackActive",
"sourceType",
"triggerType",
"watchPaths"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new application.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"autoDeploy": {
"type": "boolean",
"description": "Deploy automatically when the configured trigger fires.\n"
},
"bitbucketBranch": {
"type": "string",
"description": "Bitbucket branch to build.\n"
},
"bitbucketBuildPath": {
"type": "string",
"description": "Path within the Bitbucket repository to build from.\n"
},
"bitbucketId": {
"type": "string",
"description": "ID of the configured Bitbucket provider connection.\n"
},
"bitbucketOwner": {
"type": "string",
"description": "Bitbucket repository owner.\n"
},
"bitbucketRepository": {
"type": "string",
"description": "Bitbucket repository name.\n"
},
"bitbucketRepositorySlug": {
"type": "string",
"description": "Bitbucket repository slug.\n"
},
"branch": {
"type": "string",
"description": "GitHub branch to build.\n"
},
"buildArgs": {
"type": "string",
"description": "Docker build arguments in `KEY=value` format, one per line.\n"
},
"buildPath": {
"type": "string",
"description": "Path within the GitHub repository to build from.\n"
},
"buildRegistryId": {
"type": "string",
"description": "Registry used by a dedicated build server.\n"
},
"buildSecrets": {
"type": "string",
"description": "Docker build secrets in `KEY=value` format, one per line.\n",
"secret": true
},
"buildServerId": {
"type": "string",
"description": "Server that performs builds, when separate from the deploy server.\n"
},
"buildType": {
"type": "string",
"description": "How the application is built. Valid values: \u003cspan pulumi-lang-nodejs=\"`dockerfile`\" pulumi-lang-dotnet=\"`Dockerfile`\" pulumi-lang-go=\"`dockerfile`\" pulumi-lang-python=\"`dockerfile`\" pulumi-lang-yaml=\"`dockerfile`\" pulumi-lang-java=\"`dockerfile`\" pulumi-lang-hcl=\"`dockerfile`\"\u003e`dockerfile`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`herokuBuildpacks`\" pulumi-lang-dotnet=\"`HerokuBuildpacks`\" pulumi-lang-go=\"`herokuBuildpacks`\" pulumi-lang-python=\"`heroku_buildpacks`\" pulumi-lang-yaml=\"`herokuBuildpacks`\" pulumi-lang-java=\"`herokuBuildpacks`\" pulumi-lang-hcl=\"`heroku_buildpacks`\"\u003e`herokuBuildpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`paketoBuildpacks`\" pulumi-lang-dotnet=\"`PaketoBuildpacks`\" pulumi-lang-go=\"`paketoBuildpacks`\" pulumi-lang-python=\"`paketo_buildpacks`\" pulumi-lang-yaml=\"`paketoBuildpacks`\" pulumi-lang-java=\"`paketoBuildpacks`\" pulumi-lang-hcl=\"`paketo_buildpacks`\"\u003e`paketoBuildpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`nixpacks`\" pulumi-lang-dotnet=\"`Nixpacks`\" pulumi-lang-go=\"`nixpacks`\" pulumi-lang-python=\"`nixpacks`\" pulumi-lang-yaml=\"`nixpacks`\" pulumi-lang-java=\"`nixpacks`\" pulumi-lang-hcl=\"`nixpacks`\"\u003e`nixpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`static`\" pulumi-lang-dotnet=\"`Static`\" pulumi-lang-go=\"`static`\" pulumi-lang-python=\"`static`\" pulumi-lang-yaml=\"`static`\" pulumi-lang-java=\"`static`\" pulumi-lang-hcl=\"`static`\"\u003e`static`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`railpack`\" pulumi-lang-dotnet=\"`Railpack`\" pulumi-lang-go=\"`railpack`\" pulumi-lang-python=\"`railpack`\" pulumi-lang-yaml=\"`railpack`\" pulumi-lang-java=\"`railpack`\" pulumi-lang-hcl=\"`railpack`\"\u003e`railpack`\u003c/span\u003e.\n"
},
"cleanCache": {
"type": "boolean",
"description": "Discard the build cache on the next deployment.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createEnvFile": {
"type": "boolean",
"description": "Write the environment variables to a `.env` file in the container.\n"
},
"customGitBranch": {
"type": "string",
"description": "Branch to build for a custom Git remote.\n"
},
"customGitBuildPath": {
"type": "string",
"description": "Path within a custom Git repository to build from.\n"
},
"customGitSshKeyId": {
"type": "string",
"description": "SSH key used to clone a private custom Git remote.\n"
},
"customGitUrl": {
"type": "string",
"description": "Git remote URL, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerBuildStage": {
"type": "string",
"description": "Target stage for a multi-stage Docker build.\n"
},
"dockerContextPath": {
"type": "string",
"description": "Docker build context path.\n"
},
"dockerImage": {
"type": "string",
"description": "Docker image reference, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`docker`\" pulumi-lang-dotnet=\"`Docker`\" pulumi-lang-go=\"`docker`\" pulumi-lang-python=\"`docker`\" pulumi-lang-yaml=\"`docker`\" pulumi-lang-java=\"`docker`\" pulumi-lang-hcl=\"`docker`\"\u003e`docker`\u003c/span\u003e.\n"
},
"dockerfile": {
"type": "string",
"description": "Path to the Dockerfile, when \u003cspan pulumi-lang-nodejs=\"`buildType`\" pulumi-lang-dotnet=\"`BuildType`\" pulumi-lang-go=\"`buildType`\" pulumi-lang-python=\"`build_type`\" pulumi-lang-yaml=\"`buildType`\" pulumi-lang-java=\"`buildType`\" pulumi-lang-hcl=\"`build_type`\"\u003e`buildType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`dockerfile`\" pulumi-lang-dotnet=\"`Dockerfile`\" pulumi-lang-go=\"`dockerfile`\" pulumi-lang-python=\"`dockerfile`\" pulumi-lang-yaml=\"`dockerfile`\" pulumi-lang-java=\"`dockerfile`\" pulumi-lang-hcl=\"`dockerfile`\"\u003e`dockerfile`\u003c/span\u003e.\n"
},
"enableSubmodules": {
"type": "boolean",
"description": "Clone Git submodules when checking out the repository.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the application is enabled.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Runtime environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this application belongs to.\n"
},
"giteaBranch": {
"type": "string",
"description": "Gitea branch to build.\n"
},
"giteaBuildPath": {
"type": "string",
"description": "Path within the Gitea repository to build from.\n"
},
"giteaId": {
"type": "string",
"description": "ID of the configured Gitea provider connection.\n"
},
"giteaOwner": {
"type": "string",
"description": "Gitea repository owner.\n"
},
"giteaRepository": {
"type": "string",
"description": "Gitea repository name.\n"
},
"githubId": {
"type": "string",
"description": "ID of the configured GitHub provider connection.\n"
},
"gitlabBranch": {
"type": "string",
"description": "GitLab branch to build.\n"
},
"gitlabBuildPath": {
"type": "string",
"description": "Path within the GitLab repository to build from.\n"
},
"gitlabId": {
"type": "string",
"description": "ID of the configured GitLab provider connection.\n"
},
"gitlabOwner": {
"type": "string",
"description": "GitLab repository owner.\n"
},
"gitlabPathNamespace": {
"type": "string",
"description": "Full GitLab namespace path.\n"
},
"gitlabProjectId": {
"type": "integer",
"description": "Numeric GitLab project ID.\n"
},
"gitlabRepository": {
"type": "string",
"description": "GitLab repository name.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"herokuVersion": {
"type": "string",
"description": "Heroku buildpack stack version.\n"
},
"icon": {
"type": "string",
"description": "Icon shown next to the service in the Dokploy UI.\n"
},
"isPreviewDeploymentsActive": {
"type": "boolean",
"description": "Build a preview deployment for each pull request.\n"
},
"isStaticSpa": {
"type": "boolean",
"description": "Serve a static build as a single-page application.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the application.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"owner": {
"type": "string",
"description": "GitHub repository owner.\n"
},
"password": {
"type": "string",
"description": "Registry password, when pulling a private image.\n",
"secret": true
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"previewBuildArgs": {
"type": "string",
"description": "Build arguments applied to preview deployments.\n"
},
"previewBuildSecrets": {
"type": "string",
"description": "Build secrets applied to preview deployments.\n",
"secret": true
},
"previewCertificateType": {
"type": "string",
"description": "Certificate strategy for preview deployments. Valid values: \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`none`\" pulumi-lang-dotnet=\"`None`\" pulumi-lang-go=\"`none`\" pulumi-lang-python=\"`none`\" pulumi-lang-yaml=\"`none`\" pulumi-lang-java=\"`none`\" pulumi-lang-hcl=\"`none`\"\u003e`none`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"previewCustomCertResolver": {
"type": "string",
"description": "Traefik certificate resolver for preview deployments.\n"
},
"previewEnv": {
"type": "string",
"description": "Environment variables applied to preview deployments.\n"
},
"previewHttps": {
"type": "boolean",
"description": "Serve preview deployments over HTTPS.\n"
},
"previewLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Pull request labels that opt into preview deployments.\n"
},
"previewLimit": {
"type": "integer",
"description": "Maximum number of concurrent preview deployments.\n"
},
"previewPath": {
"type": "string",
"description": "Base path for preview deployments.\n"
},
"previewPort": {
"type": "integer",
"description": "Container port exposed by preview deployments.\n"
},
"previewRequireCollaboratorPermissions": {
"type": "boolean",
"description": "Only build previews for pull requests opened by users with repository collaborator permissions.\n"
},
"previewWildcard": {
"type": "string",
"description": "Wildcard domain used to expose preview deployments.\n"
},
"publishDirectory": {
"type": "string",
"description": "Directory served when \u003cspan pulumi-lang-nodejs=\"`buildType`\" pulumi-lang-dotnet=\"`BuildType`\" pulumi-lang-go=\"`buildType`\" pulumi-lang-python=\"`build_type`\" pulumi-lang-yaml=\"`buildType`\" pulumi-lang-java=\"`buildType`\" pulumi-lang-hcl=\"`build_type`\"\u003e`buildType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`static`\" pulumi-lang-dotnet=\"`Static`\" pulumi-lang-go=\"`static`\" pulumi-lang-python=\"`static`\" pulumi-lang-yaml=\"`static`\" pulumi-lang-java=\"`static`\" pulumi-lang-hcl=\"`static`\"\u003e`static`\u003c/span\u003e.\n"
},
"railpackVersion": {
"type": "string",
"description": "Railpack version.\n"
},
"registryId": {
"type": "string",
"description": "Registry used to push the built image.\n"
},
"registryUrl": {
"type": "string",
"description": "Registry URL, when pulling a private image.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"repository": {
"type": "string",
"description": "GitHub repository name.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackActive": {
"type": "boolean",
"description": "Keep previous images so deployments can be rolled back.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"rollbackRegistryId": {
"type": "string",
"description": "Registry used to store rollback images.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"sourceType": {
"type": "string",
"description": "Where the application's code or image comes from. Valid values: \u003cspan pulumi-lang-nodejs=\"`docker`\" pulumi-lang-dotnet=\"`Docker`\" pulumi-lang-go=\"`docker`\" pulumi-lang-python=\"`docker`\" pulumi-lang-yaml=\"`docker`\" pulumi-lang-java=\"`docker`\" pulumi-lang-hcl=\"`docker`\"\u003e`docker`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`github`\" pulumi-lang-dotnet=\"`Github`\" pulumi-lang-go=\"`github`\" pulumi-lang-python=\"`github`\" pulumi-lang-yaml=\"`github`\" pulumi-lang-java=\"`github`\" pulumi-lang-hcl=\"`github`\"\u003e`github`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitlab`\" pulumi-lang-dotnet=\"`Gitlab`\" pulumi-lang-go=\"`gitlab`\" pulumi-lang-python=\"`gitlab`\" pulumi-lang-yaml=\"`gitlab`\" pulumi-lang-java=\"`gitlab`\" pulumi-lang-hcl=\"`gitlab`\"\u003e`gitlab`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`bitbucket`\" pulumi-lang-dotnet=\"`Bitbucket`\" pulumi-lang-go=\"`bitbucket`\" pulumi-lang-python=\"`bitbucket`\" pulumi-lang-yaml=\"`bitbucket`\" pulumi-lang-java=\"`bitbucket`\" pulumi-lang-hcl=\"`bitbucket`\"\u003e`bitbucket`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitea`\" pulumi-lang-dotnet=\"`Gitea`\" pulumi-lang-go=\"`gitea`\" pulumi-lang-python=\"`gitea`\" pulumi-lang-yaml=\"`gitea`\" pulumi-lang-java=\"`gitea`\" pulumi-lang-hcl=\"`gitea`\"\u003e`gitea`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`drop`\" pulumi-lang-dotnet=\"`Drop`\" pulumi-lang-go=\"`drop`\" pulumi-lang-python=\"`drop`\" pulumi-lang-yaml=\"`drop`\" pulumi-lang-java=\"`drop`\" pulumi-lang-hcl=\"`drop`\"\u003e`drop`\u003c/span\u003e.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"subtitle": {
"type": "string",
"description": "Display subtitle shown in the Dokploy UI.\n"
},
"title": {
"type": "string",
"description": "Display title shown in the Dokploy UI.\n"
},
"triggerType": {
"type": "string",
"description": "What triggers an automatic GitHub deployment. Valid values: \u003cspan pulumi-lang-nodejs=\"`push`\" pulumi-lang-dotnet=\"`Push`\" pulumi-lang-go=\"`push`\" pulumi-lang-python=\"`push`\" pulumi-lang-yaml=\"`push`\" pulumi-lang-java=\"`push`\" pulumi-lang-hcl=\"`push`\"\u003e`push`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
},
"username": {
"type": "string",
"description": "Registry username, when pulling a private image.\n"
},
"watchPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Glob patterns that limit which changed paths trigger an automatic deployment.\n"
}
},
"requiredInputs": [
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Application resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new application.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"autoDeploy": {
"type": "boolean",
"description": "Deploy automatically when the configured trigger fires.\n"
},
"bitbucketBranch": {
"type": "string",
"description": "Bitbucket branch to build.\n"
},
"bitbucketBuildPath": {
"type": "string",
"description": "Path within the Bitbucket repository to build from.\n"
},
"bitbucketId": {
"type": "string",
"description": "ID of the configured Bitbucket provider connection.\n"
},
"bitbucketOwner": {
"type": "string",
"description": "Bitbucket repository owner.\n"
},
"bitbucketRepository": {
"type": "string",
"description": "Bitbucket repository name.\n"
},
"bitbucketRepositorySlug": {
"type": "string",
"description": "Bitbucket repository slug.\n"
},
"branch": {
"type": "string",
"description": "GitHub branch to build.\n"
},
"buildArgs": {
"type": "string",
"description": "Docker build arguments in `KEY=value` format, one per line.\n"
},
"buildPath": {
"type": "string",
"description": "Path within the GitHub repository to build from.\n"
},
"buildRegistryId": {
"type": "string",
"description": "Registry used by a dedicated build server.\n"
},
"buildSecrets": {
"type": "string",
"description": "Docker build secrets in `KEY=value` format, one per line.\n",
"secret": true
},
"buildServerId": {
"type": "string",
"description": "Server that performs builds, when separate from the deploy server.\n"
},
"buildType": {
"type": "string",
"description": "How the application is built. Valid values: \u003cspan pulumi-lang-nodejs=\"`dockerfile`\" pulumi-lang-dotnet=\"`Dockerfile`\" pulumi-lang-go=\"`dockerfile`\" pulumi-lang-python=\"`dockerfile`\" pulumi-lang-yaml=\"`dockerfile`\" pulumi-lang-java=\"`dockerfile`\" pulumi-lang-hcl=\"`dockerfile`\"\u003e`dockerfile`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`herokuBuildpacks`\" pulumi-lang-dotnet=\"`HerokuBuildpacks`\" pulumi-lang-go=\"`herokuBuildpacks`\" pulumi-lang-python=\"`heroku_buildpacks`\" pulumi-lang-yaml=\"`herokuBuildpacks`\" pulumi-lang-java=\"`herokuBuildpacks`\" pulumi-lang-hcl=\"`heroku_buildpacks`\"\u003e`herokuBuildpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`paketoBuildpacks`\" pulumi-lang-dotnet=\"`PaketoBuildpacks`\" pulumi-lang-go=\"`paketoBuildpacks`\" pulumi-lang-python=\"`paketo_buildpacks`\" pulumi-lang-yaml=\"`paketoBuildpacks`\" pulumi-lang-java=\"`paketoBuildpacks`\" pulumi-lang-hcl=\"`paketo_buildpacks`\"\u003e`paketoBuildpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`nixpacks`\" pulumi-lang-dotnet=\"`Nixpacks`\" pulumi-lang-go=\"`nixpacks`\" pulumi-lang-python=\"`nixpacks`\" pulumi-lang-yaml=\"`nixpacks`\" pulumi-lang-java=\"`nixpacks`\" pulumi-lang-hcl=\"`nixpacks`\"\u003e`nixpacks`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`static`\" pulumi-lang-dotnet=\"`Static`\" pulumi-lang-go=\"`static`\" pulumi-lang-python=\"`static`\" pulumi-lang-yaml=\"`static`\" pulumi-lang-java=\"`static`\" pulumi-lang-hcl=\"`static`\"\u003e`static`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`railpack`\" pulumi-lang-dotnet=\"`Railpack`\" pulumi-lang-go=\"`railpack`\" pulumi-lang-python=\"`railpack`\" pulumi-lang-yaml=\"`railpack`\" pulumi-lang-java=\"`railpack`\" pulumi-lang-hcl=\"`railpack`\"\u003e`railpack`\u003c/span\u003e.\n"
},
"cleanCache": {
"type": "boolean",
"description": "Discard the build cache on the next deployment.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createEnvFile": {
"type": "boolean",
"description": "Write the environment variables to a `.env` file in the container.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the application was created.\n"
},
"customGitBranch": {
"type": "string",
"description": "Branch to build for a custom Git remote.\n"
},
"customGitBuildPath": {
"type": "string",
"description": "Path within a custom Git repository to build from.\n"
},
"customGitSshKeyId": {
"type": "string",
"description": "SSH key used to clone a private custom Git remote.\n"
},
"customGitUrl": {
"type": "string",
"description": "Git remote URL, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerBuildStage": {
"type": "string",
"description": "Target stage for a multi-stage Docker build.\n"
},
"dockerContextPath": {
"type": "string",
"description": "Docker build context path.\n"
},
"dockerImage": {
"type": "string",
"description": "Docker image reference, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`docker`\" pulumi-lang-dotnet=\"`Docker`\" pulumi-lang-go=\"`docker`\" pulumi-lang-python=\"`docker`\" pulumi-lang-yaml=\"`docker`\" pulumi-lang-java=\"`docker`\" pulumi-lang-hcl=\"`docker`\"\u003e`docker`\u003c/span\u003e.\n"
},
"dockerfile": {
"type": "string",
"description": "Path to the Dockerfile, when \u003cspan pulumi-lang-nodejs=\"`buildType`\" pulumi-lang-dotnet=\"`BuildType`\" pulumi-lang-go=\"`buildType`\" pulumi-lang-python=\"`build_type`\" pulumi-lang-yaml=\"`buildType`\" pulumi-lang-java=\"`buildType`\" pulumi-lang-hcl=\"`build_type`\"\u003e`buildType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`dockerfile`\" pulumi-lang-dotnet=\"`Dockerfile`\" pulumi-lang-go=\"`dockerfile`\" pulumi-lang-python=\"`dockerfile`\" pulumi-lang-yaml=\"`dockerfile`\" pulumi-lang-java=\"`dockerfile`\" pulumi-lang-hcl=\"`dockerfile`\"\u003e`dockerfile`\u003c/span\u003e.\n"
},
"enableSubmodules": {
"type": "boolean",
"description": "Clone Git submodules when checking out the repository.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the application is enabled.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Runtime environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this application belongs to.\n"
},
"giteaBranch": {
"type": "string",
"description": "Gitea branch to build.\n"
},
"giteaBuildPath": {
"type": "string",
"description": "Path within the Gitea repository to build from.\n"
},
"giteaId": {
"type": "string",
"description": "ID of the configured Gitea provider connection.\n"
},
"giteaOwner": {
"type": "string",
"description": "Gitea repository owner.\n"
},
"giteaRepository": {
"type": "string",
"description": "Gitea repository name.\n"
},
"githubId": {
"type": "string",
"description": "ID of the configured GitHub provider connection.\n"
},
"gitlabBranch": {
"type": "string",
"description": "GitLab branch to build.\n"
},
"gitlabBuildPath": {
"type": "string",
"description": "Path within the GitLab repository to build from.\n"
},
"gitlabId": {
"type": "string",
"description": "ID of the configured GitLab provider connection.\n"
},
"gitlabOwner": {
"type": "string",
"description": "GitLab repository owner.\n"
},
"gitlabPathNamespace": {
"type": "string",
"description": "Full GitLab namespace path.\n"
},
"gitlabProjectId": {
"type": "integer",
"description": "Numeric GitLab project ID.\n"
},
"gitlabRepository": {
"type": "string",
"description": "GitLab repository name.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"herokuVersion": {
"type": "string",
"description": "Heroku buildpack stack version.\n"
},
"icon": {
"type": "string",
"description": "Icon shown next to the service in the Dokploy UI.\n"
},
"isPreviewDeploymentsActive": {
"type": "boolean",
"description": "Build a preview deployment for each pull request.\n"
},
"isStaticSpa": {
"type": "boolean",
"description": "Serve a static build as a single-page application.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the application.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"owner": {
"type": "string",
"description": "GitHub repository owner.\n"
},
"password": {
"type": "string",
"description": "Registry password, when pulling a private image.\n",
"secret": true
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"previewBuildArgs": {
"type": "string",
"description": "Build arguments applied to preview deployments.\n"
},
"previewBuildSecrets": {
"type": "string",
"description": "Build secrets applied to preview deployments.\n",
"secret": true
},
"previewCertificateType": {
"type": "string",
"description": "Certificate strategy for preview deployments. Valid values: \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`none`\" pulumi-lang-dotnet=\"`None`\" pulumi-lang-go=\"`none`\" pulumi-lang-python=\"`none`\" pulumi-lang-yaml=\"`none`\" pulumi-lang-java=\"`none`\" pulumi-lang-hcl=\"`none`\"\u003e`none`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"previewCustomCertResolver": {
"type": "string",
"description": "Traefik certificate resolver for preview deployments.\n"
},
"previewEnv": {
"type": "string",
"description": "Environment variables applied to preview deployments.\n"
},
"previewHttps": {
"type": "boolean",
"description": "Serve preview deployments over HTTPS.\n"
},
"previewLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Pull request labels that opt into preview deployments.\n"
},
"previewLimit": {
"type": "integer",
"description": "Maximum number of concurrent preview deployments.\n"
},
"previewPath": {
"type": "string",
"description": "Base path for preview deployments.\n"
},
"previewPort": {
"type": "integer",
"description": "Container port exposed by preview deployments.\n"
},
"previewRequireCollaboratorPermissions": {
"type": "boolean",
"description": "Only build previews for pull requests opened by users with repository collaborator permissions.\n"
},
"previewWildcard": {
"type": "string",
"description": "Wildcard domain used to expose preview deployments.\n"
},
"publishDirectory": {
"type": "string",
"description": "Directory served when \u003cspan pulumi-lang-nodejs=\"`buildType`\" pulumi-lang-dotnet=\"`BuildType`\" pulumi-lang-go=\"`buildType`\" pulumi-lang-python=\"`build_type`\" pulumi-lang-yaml=\"`buildType`\" pulumi-lang-java=\"`buildType`\" pulumi-lang-hcl=\"`build_type`\"\u003e`buildType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`static`\" pulumi-lang-dotnet=\"`Static`\" pulumi-lang-go=\"`static`\" pulumi-lang-python=\"`static`\" pulumi-lang-yaml=\"`static`\" pulumi-lang-java=\"`static`\" pulumi-lang-hcl=\"`static`\"\u003e`static`\u003c/span\u003e.\n"
},
"railpackVersion": {
"type": "string",
"description": "Railpack version.\n"
},
"registryId": {
"type": "string",
"description": "Registry used to push the built image.\n"
},
"registryUrl": {
"type": "string",
"description": "Registry URL, when pulling a private image.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"repository": {
"type": "string",
"description": "GitHub repository name.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackActive": {
"type": "boolean",
"description": "Keep previous images so deployments can be rolled back.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"rollbackRegistryId": {
"type": "string",
"description": "Registry used to store rollback images.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"sourceType": {
"type": "string",
"description": "Where the application's code or image comes from. Valid values: \u003cspan pulumi-lang-nodejs=\"`docker`\" pulumi-lang-dotnet=\"`Docker`\" pulumi-lang-go=\"`docker`\" pulumi-lang-python=\"`docker`\" pulumi-lang-yaml=\"`docker`\" pulumi-lang-java=\"`docker`\" pulumi-lang-hcl=\"`docker`\"\u003e`docker`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`github`\" pulumi-lang-dotnet=\"`Github`\" pulumi-lang-go=\"`github`\" pulumi-lang-python=\"`github`\" pulumi-lang-yaml=\"`github`\" pulumi-lang-java=\"`github`\" pulumi-lang-hcl=\"`github`\"\u003e`github`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitlab`\" pulumi-lang-dotnet=\"`Gitlab`\" pulumi-lang-go=\"`gitlab`\" pulumi-lang-python=\"`gitlab`\" pulumi-lang-yaml=\"`gitlab`\" pulumi-lang-java=\"`gitlab`\" pulumi-lang-hcl=\"`gitlab`\"\u003e`gitlab`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`bitbucket`\" pulumi-lang-dotnet=\"`Bitbucket`\" pulumi-lang-go=\"`bitbucket`\" pulumi-lang-python=\"`bitbucket`\" pulumi-lang-yaml=\"`bitbucket`\" pulumi-lang-java=\"`bitbucket`\" pulumi-lang-hcl=\"`bitbucket`\"\u003e`bitbucket`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitea`\" pulumi-lang-dotnet=\"`Gitea`\" pulumi-lang-go=\"`gitea`\" pulumi-lang-python=\"`gitea`\" pulumi-lang-yaml=\"`gitea`\" pulumi-lang-java=\"`gitea`\" pulumi-lang-hcl=\"`gitea`\"\u003e`gitea`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`drop`\" pulumi-lang-dotnet=\"`Drop`\" pulumi-lang-go=\"`drop`\" pulumi-lang-python=\"`drop`\" pulumi-lang-yaml=\"`drop`\" pulumi-lang-java=\"`drop`\" pulumi-lang-hcl=\"`drop`\"\u003e`drop`\u003c/span\u003e.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"subtitle": {
"type": "string",
"description": "Display subtitle shown in the Dokploy UI.\n"
},
"title": {
"type": "string",
"description": "Display title shown in the Dokploy UI.\n"
},
"triggerType": {
"type": "string",
"description": "What triggers an automatic GitHub deployment. Valid values: \u003cspan pulumi-lang-nodejs=\"`push`\" pulumi-lang-dotnet=\"`Push`\" pulumi-lang-go=\"`push`\" pulumi-lang-python=\"`push`\" pulumi-lang-yaml=\"`push`\" pulumi-lang-java=\"`push`\" pulumi-lang-hcl=\"`push`\"\u003e`push`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
},
"username": {
"type": "string",
"description": "Registry username, when pulling a private image.\n"
},
"watchPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Glob patterns that limit which changed paths trigger an automatic deployment.\n"
}
},
"type": "object"
}
},
"dokploy:index/certificate:Certificate": {
"description": "A TLS certificate uploaded to Dokploy, for domains that use \u003cspan pulumi-lang-nodejs=\"`certificateType \" pulumi-lang-dotnet=\"`CertificateType \" pulumi-lang-go=\"`certificateType \" pulumi-lang-python=\"`certificate_type \" pulumi-lang-yaml=\"`certificateType \" pulumi-lang-java=\"`certificateType \" pulumi-lang-hcl=\"`certificate_type \"\u003e`certificateType \u003c/span\u003e= \"custom\"`.\n\n\u003e The private key is stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"autoRenew": {
"type": "boolean",
"description": "Whether Dokploy should renew this certificate automatically.\n"
},
"certificateData": {
"type": "string",
"description": "PEM-encoded certificate chain.\n"
},
"certificatePath": {
"type": "string",
"description": "Path where Dokploy writes the certificate on disk.\n"
},
"name": {
"type": "string",
"description": "Display name of the certificate.\n"
},
"privateKey": {
"type": "string",
"description": "PEM-encoded private key.\n",
"secret": true
},
"serverId": {
"type": "string",
"description": "Server this certificate is installed on.\n"
}
},
"required": [
"autoRenew",
"certificateData",
"certificatePath",
"name",
"privateKey"
],
"inputProperties": {
"autoRenew": {
"type": "boolean",
"description": "Whether Dokploy should renew this certificate automatically.\n"
},
"certificateData": {
"type": "string",
"description": "PEM-encoded certificate chain.\n"
},
"name": {
"type": "string",
"description": "Display name of the certificate.\n"
},
"privateKey": {
"type": "string",
"description": "PEM-encoded private key.\n",
"secret": true
},
"serverId": {
"type": "string",
"description": "Server this certificate is installed on.\n"
}
},
"requiredInputs": [
"certificateData",
"privateKey"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Certificate resources.\n",
"properties": {
"autoRenew": {
"type": "boolean",
"description": "Whether Dokploy should renew this certificate automatically.\n"
},
"certificateData": {
"type": "string",
"description": "PEM-encoded certificate chain.\n"
},
"certificatePath": {
"type": "string",
"description": "Path where Dokploy writes the certificate on disk.\n"
},
"name": {
"type": "string",
"description": "Display name of the certificate.\n"
},
"privateKey": {
"type": "string",
"description": "PEM-encoded private key.\n",
"secret": true
},
"serverId": {
"type": "string",
"description": "Server this certificate is installed on.\n"
}
},
"type": "object"
}
},
"dokploy:index/compose:Compose": {
"description": "A Docker Compose or Docker Swarm stack managed by Dokploy.\n\nSet \u003cspan pulumi-lang-nodejs=\"`composeFile`\" pulumi-lang-dotnet=\"`ComposeFile`\" pulumi-lang-go=\"`composeFile`\" pulumi-lang-python=\"`compose_file`\" pulumi-lang-yaml=\"`composeFile`\" pulumi-lang-java=\"`composeFile`\" pulumi-lang-hcl=\"`compose_file`\"\u003e`composeFile`\u003c/span\u003e to manage the stack definition inline (with \u003cspan pulumi-lang-nodejs=\"`sourceType \" pulumi-lang-dotnet=\"`SourceType \" pulumi-lang-go=\"`sourceType \" pulumi-lang-python=\"`source_type \" pulumi-lang-yaml=\"`sourceType \" pulumi-lang-java=\"`sourceType \" pulumi-lang-hcl=\"`source_type \"\u003e`sourceType \u003c/span\u003e= \"raw\"`), or point the stack at a Git repository and set \u003cspan pulumi-lang-nodejs=\"`composePath`\" pulumi-lang-dotnet=\"`ComposePath`\" pulumi-lang-go=\"`composePath`\" pulumi-lang-python=\"`compose_path`\" pulumi-lang-yaml=\"`composePath`\" pulumi-lang-java=\"`composePath`\" pulumi-lang-hcl=\"`compose_path`\"\u003e`composePath`\u003c/span\u003e.\n\n\u003e Creating this resource does **not** deploy the stack.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker stack name. Generated by Dokploy when omitted. Changing it forces a new stack.\n"
},
"autoDeploy": {
"type": "boolean",
"description": "Deploy automatically when the configured trigger fires.\n"
},
"bitbucketBranch": {
"type": "string",
"description": "Bitbucket branch to deploy.\n"
},
"bitbucketId": {
"type": "string",
"description": "ID of the configured Bitbucket provider connection.\n"
},
"bitbucketOwner": {
"type": "string",
"description": "Bitbucket repository owner.\n"
},
"bitbucketRepository": {
"type": "string",
"description": "Bitbucket repository name.\n"
},
"bitbucketRepositorySlug": {
"type": "string",
"description": "Bitbucket repository slug.\n"
},
"branch": {
"type": "string",
"description": "GitHub branch to deploy.\n"
},
"command": {
"type": "string",
"description": "Custom `docker compose` command to run.\n"
},
"composeFile": {
"type": "string",
"description": "Inline Compose file contents. Used when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`raw`\" pulumi-lang-dotnet=\"`Raw`\" pulumi-lang-go=\"`raw`\" pulumi-lang-python=\"`raw`\" pulumi-lang-yaml=\"`raw`\" pulumi-lang-java=\"`raw`\" pulumi-lang-hcl=\"`raw`\"\u003e`raw`\u003c/span\u003e.\n"
},
"composePath": {
"type": "string",
"description": "Path to the Compose file within the repository.\n"
},
"composeStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"composeType": {
"type": "string",
"description": "Whether to run the stack with Docker Compose or Docker Swarm. Valid values: `docker-compose`, \u003cspan pulumi-lang-nodejs=\"`stack`\" pulumi-lang-dotnet=\"`Stack`\" pulumi-lang-go=\"`stack`\" pulumi-lang-python=\"`stack`\" pulumi-lang-yaml=\"`stack`\" pulumi-lang-java=\"`stack`\" pulumi-lang-hcl=\"`stack`\"\u003e`stack`\u003c/span\u003e.\n"
},
"createEnvFile": {
"type": "boolean",
"description": "Write the environment variables to a `.env` file next to the Compose file.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the stack was created.\n"
},
"customGitBranch": {
"type": "string",
"description": "Branch to deploy for a custom Git remote.\n"
},
"customGitSshKeyId": {
"type": "string",
"description": "SSH key used to clone a private custom Git remote.\n"
},
"customGitUrl": {
"type": "string",
"description": "Git remote URL, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e.\n"
},
"deleteVolumes": {
"type": "boolean",
"description": "Whether to delete the stack's Docker volumes when this resource is destroyed. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which preserves the data.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"enableSubmodules": {
"type": "boolean",
"description": "Clone Git submodules when checking out the repository.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this stack belongs to.\n"
},
"giteaBranch": {
"type": "string",
"description": "Gitea branch to deploy.\n"
},
"giteaId": {
"type": "string",
"description": "ID of the configured Gitea provider connection.\n"
},
"giteaOwner": {
"type": "string",
"description": "Gitea repository owner.\n"
},
"giteaRepository": {
"type": "string",
"description": "Gitea repository name.\n"
},
"githubId": {
"type": "string",
"description": "ID of the configured GitHub provider connection.\n"
},
"gitlabBranch": {
"type": "string",
"description": "GitLab branch to deploy.\n"
},
"gitlabId": {
"type": "string",
"description": "ID of the configured GitLab provider connection.\n"
},
"gitlabOwner": {
"type": "string",
"description": "GitLab repository owner.\n"
},
"gitlabPathNamespace": {
"type": "string",
"description": "Full GitLab namespace path.\n"
},
"gitlabProjectId": {
"type": "integer",
"description": "Numeric GitLab project ID.\n"
},
"gitlabRepository": {
"type": "string",
"description": "GitLab repository name.\n"
},
"icon": {
"type": "string",
"description": "Icon shown next to the stack in the Dokploy UI.\n"
},
"isolatedDeployment": {
"type": "boolean",
"description": "Run the stack on its own isolated Docker network.\n"
},
"isolatedDeploymentsVolume": {
"type": "boolean",
"description": "Prefix volume names for isolated deployments. Retained for backwards compatibility.\n"
},
"name": {
"type": "string",
"description": "Display name of the stack.\n"
},
"owner": {
"type": "string",
"description": "GitHub repository owner.\n"
},
"randomize": {
"type": "boolean",
"description": "Append a random suffix to service and volume names.\n"
},
"repository": {
"type": "string",
"description": "GitHub repository name.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"serviceNetworks": {
"type": "string",
"description": "Per-service Docker network attachments, as a JSON object mapping each service name in the stack to an array of network IDs.\n"
},
"sourceType": {
"type": "string",
"description": "Where the Compose file comes from. Valid values: \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`github`\" pulumi-lang-dotnet=\"`Github`\" pulumi-lang-go=\"`github`\" pulumi-lang-python=\"`github`\" pulumi-lang-yaml=\"`github`\" pulumi-lang-java=\"`github`\" pulumi-lang-hcl=\"`github`\"\u003e`github`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitlab`\" pulumi-lang-dotnet=\"`Gitlab`\" pulumi-lang-go=\"`gitlab`\" pulumi-lang-python=\"`gitlab`\" pulumi-lang-yaml=\"`gitlab`\" pulumi-lang-java=\"`gitlab`\" pulumi-lang-hcl=\"`gitlab`\"\u003e`gitlab`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`bitbucket`\" pulumi-lang-dotnet=\"`Bitbucket`\" pulumi-lang-go=\"`bitbucket`\" pulumi-lang-python=\"`bitbucket`\" pulumi-lang-yaml=\"`bitbucket`\" pulumi-lang-java=\"`bitbucket`\" pulumi-lang-hcl=\"`bitbucket`\"\u003e`bitbucket`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitea`\" pulumi-lang-dotnet=\"`Gitea`\" pulumi-lang-go=\"`gitea`\" pulumi-lang-python=\"`gitea`\" pulumi-lang-yaml=\"`gitea`\" pulumi-lang-java=\"`gitea`\" pulumi-lang-hcl=\"`gitea`\"\u003e`gitea`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`raw`\" pulumi-lang-dotnet=\"`Raw`\" pulumi-lang-go=\"`raw`\" pulumi-lang-python=\"`raw`\" pulumi-lang-yaml=\"`raw`\" pulumi-lang-java=\"`raw`\" pulumi-lang-hcl=\"`raw`\"\u003e`raw`\u003c/span\u003e.\n"
},
"suffix": {
"type": "string",
"description": "Suffix appended to generated resource names.\n"
},
"triggerType": {
"type": "string",
"description": "What triggers an automatic deployment. Valid values: \u003cspan pulumi-lang-nodejs=\"`push`\" pulumi-lang-dotnet=\"`Push`\" pulumi-lang-go=\"`push`\" pulumi-lang-python=\"`push`\" pulumi-lang-yaml=\"`push`\" pulumi-lang-java=\"`push`\" pulumi-lang-hcl=\"`push`\"\u003e`push`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n"
},
"watchPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Glob patterns that limit which changed paths trigger an automatic deployment.\n"
}
},
"required": [
"appName",
"autoDeploy",
"command",
"composeFile",
"composePath",
"composeStatus",
"composeType",
"createEnvFile",
"createdAt",
"enableSubmodules",
"environmentId",
"isolatedDeployment",
"isolatedDeploymentsVolume",
"name",
"randomize",
"sourceType",
"suffix",
"triggerType",
"watchPaths"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker stack name. Generated by Dokploy when omitted. Changing it forces a new stack.\n"
},
"autoDeploy": {
"type": "boolean",
"description": "Deploy automatically when the configured trigger fires.\n"
},
"bitbucketBranch": {
"type": "string",
"description": "Bitbucket branch to deploy.\n"
},
"bitbucketId": {
"type": "string",
"description": "ID of the configured Bitbucket provider connection.\n"
},
"bitbucketOwner": {
"type": "string",
"description": "Bitbucket repository owner.\n"
},
"bitbucketRepository": {
"type": "string",
"description": "Bitbucket repository name.\n"
},
"bitbucketRepositorySlug": {
"type": "string",
"description": "Bitbucket repository slug.\n"
},
"branch": {
"type": "string",
"description": "GitHub branch to deploy.\n"
},
"command": {
"type": "string",
"description": "Custom `docker compose` command to run.\n"
},
"composeFile": {
"type": "string",
"description": "Inline Compose file contents. Used when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`raw`\" pulumi-lang-dotnet=\"`Raw`\" pulumi-lang-go=\"`raw`\" pulumi-lang-python=\"`raw`\" pulumi-lang-yaml=\"`raw`\" pulumi-lang-java=\"`raw`\" pulumi-lang-hcl=\"`raw`\"\u003e`raw`\u003c/span\u003e.\n"
},
"composePath": {
"type": "string",
"description": "Path to the Compose file within the repository.\n"
},
"composeType": {
"type": "string",
"description": "Whether to run the stack with Docker Compose or Docker Swarm. Valid values: `docker-compose`, \u003cspan pulumi-lang-nodejs=\"`stack`\" pulumi-lang-dotnet=\"`Stack`\" pulumi-lang-go=\"`stack`\" pulumi-lang-python=\"`stack`\" pulumi-lang-yaml=\"`stack`\" pulumi-lang-java=\"`stack`\" pulumi-lang-hcl=\"`stack`\"\u003e`stack`\u003c/span\u003e.\n"
},
"createEnvFile": {
"type": "boolean",
"description": "Write the environment variables to a `.env` file next to the Compose file.\n"
},
"customGitBranch": {
"type": "string",
"description": "Branch to deploy for a custom Git remote.\n"
},
"customGitSshKeyId": {
"type": "string",
"description": "SSH key used to clone a private custom Git remote.\n"
},
"customGitUrl": {
"type": "string",
"description": "Git remote URL, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e.\n"
},
"deleteVolumes": {
"type": "boolean",
"description": "Whether to delete the stack's Docker volumes when this resource is destroyed. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which preserves the data.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"enableSubmodules": {
"type": "boolean",
"description": "Clone Git submodules when checking out the repository.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this stack belongs to.\n"
},
"giteaBranch": {
"type": "string",
"description": "Gitea branch to deploy.\n"
},
"giteaId": {
"type": "string",
"description": "ID of the configured Gitea provider connection.\n"
},
"giteaOwner": {
"type": "string",
"description": "Gitea repository owner.\n"
},
"giteaRepository": {
"type": "string",
"description": "Gitea repository name.\n"
},
"githubId": {
"type": "string",
"description": "ID of the configured GitHub provider connection.\n"
},
"gitlabBranch": {
"type": "string",
"description": "GitLab branch to deploy.\n"
},
"gitlabId": {
"type": "string",
"description": "ID of the configured GitLab provider connection.\n"
},
"gitlabOwner": {
"type": "string",
"description": "GitLab repository owner.\n"
},
"gitlabPathNamespace": {
"type": "string",
"description": "Full GitLab namespace path.\n"
},
"gitlabProjectId": {
"type": "integer",
"description": "Numeric GitLab project ID.\n"
},
"gitlabRepository": {
"type": "string",
"description": "GitLab repository name.\n"
},
"icon": {
"type": "string",
"description": "Icon shown next to the stack in the Dokploy UI.\n"
},
"isolatedDeployment": {
"type": "boolean",
"description": "Run the stack on its own isolated Docker network.\n"
},
"isolatedDeploymentsVolume": {
"type": "boolean",
"description": "Prefix volume names for isolated deployments. Retained for backwards compatibility.\n"
},
"name": {
"type": "string",
"description": "Display name of the stack.\n"
},
"owner": {
"type": "string",
"description": "GitHub repository owner.\n"
},
"randomize": {
"type": "boolean",
"description": "Append a random suffix to service and volume names.\n"
},
"repository": {
"type": "string",
"description": "GitHub repository name.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"serviceNetworks": {
"type": "string",
"description": "Per-service Docker network attachments, as a JSON object mapping each service name in the stack to an array of network IDs.\n"
},
"sourceType": {
"type": "string",
"description": "Where the Compose file comes from. Valid values: \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`github`\" pulumi-lang-dotnet=\"`Github`\" pulumi-lang-go=\"`github`\" pulumi-lang-python=\"`github`\" pulumi-lang-yaml=\"`github`\" pulumi-lang-java=\"`github`\" pulumi-lang-hcl=\"`github`\"\u003e`github`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitlab`\" pulumi-lang-dotnet=\"`Gitlab`\" pulumi-lang-go=\"`gitlab`\" pulumi-lang-python=\"`gitlab`\" pulumi-lang-yaml=\"`gitlab`\" pulumi-lang-java=\"`gitlab`\" pulumi-lang-hcl=\"`gitlab`\"\u003e`gitlab`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`bitbucket`\" pulumi-lang-dotnet=\"`Bitbucket`\" pulumi-lang-go=\"`bitbucket`\" pulumi-lang-python=\"`bitbucket`\" pulumi-lang-yaml=\"`bitbucket`\" pulumi-lang-java=\"`bitbucket`\" pulumi-lang-hcl=\"`bitbucket`\"\u003e`bitbucket`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitea`\" pulumi-lang-dotnet=\"`Gitea`\" pulumi-lang-go=\"`gitea`\" pulumi-lang-python=\"`gitea`\" pulumi-lang-yaml=\"`gitea`\" pulumi-lang-java=\"`gitea`\" pulumi-lang-hcl=\"`gitea`\"\u003e`gitea`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`raw`\" pulumi-lang-dotnet=\"`Raw`\" pulumi-lang-go=\"`raw`\" pulumi-lang-python=\"`raw`\" pulumi-lang-yaml=\"`raw`\" pulumi-lang-java=\"`raw`\" pulumi-lang-hcl=\"`raw`\"\u003e`raw`\u003c/span\u003e.\n"
},
"suffix": {
"type": "string",
"description": "Suffix appended to generated resource names.\n"
},
"triggerType": {
"type": "string",
"description": "What triggers an automatic deployment. Valid values: \u003cspan pulumi-lang-nodejs=\"`push`\" pulumi-lang-dotnet=\"`Push`\" pulumi-lang-go=\"`push`\" pulumi-lang-python=\"`push`\" pulumi-lang-yaml=\"`push`\" pulumi-lang-java=\"`push`\" pulumi-lang-hcl=\"`push`\"\u003e`push`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n"
},
"watchPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Glob patterns that limit which changed paths trigger an automatic deployment.\n"
}
},
"requiredInputs": [
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Compose resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker stack name. Generated by Dokploy when omitted. Changing it forces a new stack.\n"
},
"autoDeploy": {
"type": "boolean",
"description": "Deploy automatically when the configured trigger fires.\n"
},
"bitbucketBranch": {
"type": "string",
"description": "Bitbucket branch to deploy.\n"
},
"bitbucketId": {
"type": "string",
"description": "ID of the configured Bitbucket provider connection.\n"
},
"bitbucketOwner": {
"type": "string",
"description": "Bitbucket repository owner.\n"
},
"bitbucketRepository": {
"type": "string",
"description": "Bitbucket repository name.\n"
},
"bitbucketRepositorySlug": {
"type": "string",
"description": "Bitbucket repository slug.\n"
},
"branch": {
"type": "string",
"description": "GitHub branch to deploy.\n"
},
"command": {
"type": "string",
"description": "Custom `docker compose` command to run.\n"
},
"composeFile": {
"type": "string",
"description": "Inline Compose file contents. Used when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`raw`\" pulumi-lang-dotnet=\"`Raw`\" pulumi-lang-go=\"`raw`\" pulumi-lang-python=\"`raw`\" pulumi-lang-yaml=\"`raw`\" pulumi-lang-java=\"`raw`\" pulumi-lang-hcl=\"`raw`\"\u003e`raw`\u003c/span\u003e.\n"
},
"composePath": {
"type": "string",
"description": "Path to the Compose file within the repository.\n"
},
"composeStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"composeType": {
"type": "string",
"description": "Whether to run the stack with Docker Compose or Docker Swarm. Valid values: `docker-compose`, \u003cspan pulumi-lang-nodejs=\"`stack`\" pulumi-lang-dotnet=\"`Stack`\" pulumi-lang-go=\"`stack`\" pulumi-lang-python=\"`stack`\" pulumi-lang-yaml=\"`stack`\" pulumi-lang-java=\"`stack`\" pulumi-lang-hcl=\"`stack`\"\u003e`stack`\u003c/span\u003e.\n"
},
"createEnvFile": {
"type": "boolean",
"description": "Write the environment variables to a `.env` file next to the Compose file.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the stack was created.\n"
},
"customGitBranch": {
"type": "string",
"description": "Branch to deploy for a custom Git remote.\n"
},
"customGitSshKeyId": {
"type": "string",
"description": "SSH key used to clone a private custom Git remote.\n"
},
"customGitUrl": {
"type": "string",
"description": "Git remote URL, when \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e.\n"
},
"deleteVolumes": {
"type": "boolean",
"description": "Whether to delete the stack's Docker volumes when this resource is destroyed. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which preserves the data.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"enableSubmodules": {
"type": "boolean",
"description": "Clone Git submodules when checking out the repository.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this stack belongs to.\n"
},
"giteaBranch": {
"type": "string",
"description": "Gitea branch to deploy.\n"
},
"giteaId": {
"type": "string",
"description": "ID of the configured Gitea provider connection.\n"
},
"giteaOwner": {
"type": "string",
"description": "Gitea repository owner.\n"
},
"giteaRepository": {
"type": "string",
"description": "Gitea repository name.\n"
},
"githubId": {
"type": "string",
"description": "ID of the configured GitHub provider connection.\n"
},
"gitlabBranch": {
"type": "string",
"description": "GitLab branch to deploy.\n"
},
"gitlabId": {
"type": "string",
"description": "ID of the configured GitLab provider connection.\n"
},
"gitlabOwner": {
"type": "string",
"description": "GitLab repository owner.\n"
},
"gitlabPathNamespace": {
"type": "string",
"description": "Full GitLab namespace path.\n"
},
"gitlabProjectId": {
"type": "integer",
"description": "Numeric GitLab project ID.\n"
},
"gitlabRepository": {
"type": "string",
"description": "GitLab repository name.\n"
},
"icon": {
"type": "string",
"description": "Icon shown next to the stack in the Dokploy UI.\n"
},
"isolatedDeployment": {
"type": "boolean",
"description": "Run the stack on its own isolated Docker network.\n"
},
"isolatedDeploymentsVolume": {
"type": "boolean",
"description": "Prefix volume names for isolated deployments. Retained for backwards compatibility.\n"
},
"name": {
"type": "string",
"description": "Display name of the stack.\n"
},
"owner": {
"type": "string",
"description": "GitHub repository owner.\n"
},
"randomize": {
"type": "boolean",
"description": "Append a random suffix to service and volume names.\n"
},
"repository": {
"type": "string",
"description": "GitHub repository name.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"serviceNetworks": {
"type": "string",
"description": "Per-service Docker network attachments, as a JSON object mapping each service name in the stack to an array of network IDs.\n"
},
"sourceType": {
"type": "string",
"description": "Where the Compose file comes from. Valid values: \u003cspan pulumi-lang-nodejs=\"`git`\" pulumi-lang-dotnet=\"`Git`\" pulumi-lang-go=\"`git`\" pulumi-lang-python=\"`git`\" pulumi-lang-yaml=\"`git`\" pulumi-lang-java=\"`git`\" pulumi-lang-hcl=\"`git`\"\u003e`git`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`github`\" pulumi-lang-dotnet=\"`Github`\" pulumi-lang-go=\"`github`\" pulumi-lang-python=\"`github`\" pulumi-lang-yaml=\"`github`\" pulumi-lang-java=\"`github`\" pulumi-lang-hcl=\"`github`\"\u003e`github`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitlab`\" pulumi-lang-dotnet=\"`Gitlab`\" pulumi-lang-go=\"`gitlab`\" pulumi-lang-python=\"`gitlab`\" pulumi-lang-yaml=\"`gitlab`\" pulumi-lang-java=\"`gitlab`\" pulumi-lang-hcl=\"`gitlab`\"\u003e`gitlab`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`bitbucket`\" pulumi-lang-dotnet=\"`Bitbucket`\" pulumi-lang-go=\"`bitbucket`\" pulumi-lang-python=\"`bitbucket`\" pulumi-lang-yaml=\"`bitbucket`\" pulumi-lang-java=\"`bitbucket`\" pulumi-lang-hcl=\"`bitbucket`\"\u003e`bitbucket`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gitea`\" pulumi-lang-dotnet=\"`Gitea`\" pulumi-lang-go=\"`gitea`\" pulumi-lang-python=\"`gitea`\" pulumi-lang-yaml=\"`gitea`\" pulumi-lang-java=\"`gitea`\" pulumi-lang-hcl=\"`gitea`\"\u003e`gitea`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`raw`\" pulumi-lang-dotnet=\"`Raw`\" pulumi-lang-go=\"`raw`\" pulumi-lang-python=\"`raw`\" pulumi-lang-yaml=\"`raw`\" pulumi-lang-java=\"`raw`\" pulumi-lang-hcl=\"`raw`\"\u003e`raw`\u003c/span\u003e.\n"
},
"suffix": {
"type": "string",
"description": "Suffix appended to generated resource names.\n"
},
"triggerType": {
"type": "string",
"description": "What triggers an automatic deployment. Valid values: \u003cspan pulumi-lang-nodejs=\"`push`\" pulumi-lang-dotnet=\"`Push`\" pulumi-lang-go=\"`push`\" pulumi-lang-python=\"`push`\" pulumi-lang-yaml=\"`push`\" pulumi-lang-java=\"`push`\" pulumi-lang-hcl=\"`push`\"\u003e`push`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n"
},
"watchPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Glob patterns that limit which changed paths trigger an automatic deployment.\n"
}
},
"type": "object"
}
},
"dokploy:index/destination:Destination": {
"description": "An S3-compatible bucket that Dokploy writes database and volume backups to.\n\n\u003e The secret access key is stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"accessKey": {
"type": "string",
"description": "S3 access key ID.\n"
},
"additionalFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Extra flags passed to the underlying \u003cspan pulumi-lang-nodejs=\"`rclone`\" pulumi-lang-dotnet=\"`Rclone`\" pulumi-lang-go=\"`rclone`\" pulumi-lang-python=\"`rclone`\" pulumi-lang-yaml=\"`rclone`\" pulumi-lang-java=\"`rclone`\" pulumi-lang-hcl=\"`rclone`\"\u003e`rclone`\u003c/span\u003e invocation.\n"
},
"bucket": {
"type": "string",
"description": "Bucket name.\n"
},
"createdAt": {
"type": "string",
"description": "Timestamp of when the destination was created.\n"
},
"endpoint": {
"type": "string",
"description": "S3 endpoint URL.\n"
},
"name": {
"type": "string",
"description": "Display name of the destination.\n"
},
"providerName": {
"type": "string",
"description": "Provider label, for example \u003cspan pulumi-lang-nodejs=\"`s3`\" pulumi-lang-dotnet=\"`S3`\" pulumi-lang-go=\"`s3`\" pulumi-lang-python=\"`s3`\" pulumi-lang-yaml=\"`s3`\" pulumi-lang-java=\"`s3`\" pulumi-lang-hcl=\"`s3`\"\u003e`s3`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`cloudflare`\" pulumi-lang-dotnet=\"`Cloudflare`\" pulumi-lang-go=\"`cloudflare`\" pulumi-lang-python=\"`cloudflare`\" pulumi-lang-yaml=\"`cloudflare`\" pulumi-lang-java=\"`cloudflare`\" pulumi-lang-hcl=\"`cloudflare`\"\u003e`cloudflare`\u003c/span\u003e. Named \u003cspan pulumi-lang-nodejs=\"`providerName`\" pulumi-lang-dotnet=\"`ProviderName`\" pulumi-lang-go=\"`providerName`\" pulumi-lang-python=\"`provider_name`\" pulumi-lang-yaml=\"`providerName`\" pulumi-lang-java=\"`providerName`\" pulumi-lang-hcl=\"`provider_name`\"\u003e`providerName`\u003c/span\u003e because \u003cspan pulumi-lang-nodejs=\"`provider`\" pulumi-lang-dotnet=\"`Provider`\" pulumi-lang-go=\"`provider`\" pulumi-lang-python=\"`provider`\" pulumi-lang-yaml=\"`provider`\" pulumi-lang-java=\"`provider`\" pulumi-lang-hcl=\"`provider`\"\u003e`provider`\u003c/span\u003e is reserved by Terraform.\n"
},
"region": {
"type": "string",
"description": "Bucket region, for example `us-east-1`.\n"
},
"secretAccessKey": {
"type": "string",
"description": "S3 secret access key.\n",
"secret": true
},
"serverId": {
"type": "string",
"description": "Server this destination is scoped to.\n"
}
},
"required": [
"accessKey",
"additionalFlags",
"bucket",
"createdAt",
"endpoint",
"name",
"region",
"secretAccessKey"
],
"inputProperties": {
"accessKey": {
"type": "string",
"description": "S3 access key ID.\n"
},
"additionalFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Extra flags passed to the underlying \u003cspan pulumi-lang-nodejs=\"`rclone`\" pulumi-lang-dotnet=\"`Rclone`\" pulumi-lang-go=\"`rclone`\" pulumi-lang-python=\"`rclone`\" pulumi-lang-yaml=\"`rclone`\" pulumi-lang-java=\"`rclone`\" pulumi-lang-hcl=\"`rclone`\"\u003e`rclone`\u003c/span\u003e invocation.\n"
},
"bucket": {
"type": "string",
"description": "Bucket name.\n"
},
"endpoint": {
"type": "string",
"description": "S3 endpoint URL.\n"
},
"name": {
"type": "string",
"description": "Display name of the destination.\n"
},
"providerName": {
"type": "string",
"description": "Provider label, for example \u003cspan pulumi-lang-nodejs=\"`s3`\" pulumi-lang-dotnet=\"`S3`\" pulumi-lang-go=\"`s3`\" pulumi-lang-python=\"`s3`\" pulumi-lang-yaml=\"`s3`\" pulumi-lang-java=\"`s3`\" pulumi-lang-hcl=\"`s3`\"\u003e`s3`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`cloudflare`\" pulumi-lang-dotnet=\"`Cloudflare`\" pulumi-lang-go=\"`cloudflare`\" pulumi-lang-python=\"`cloudflare`\" pulumi-lang-yaml=\"`cloudflare`\" pulumi-lang-java=\"`cloudflare`\" pulumi-lang-hcl=\"`cloudflare`\"\u003e`cloudflare`\u003c/span\u003e. Named \u003cspan pulumi-lang-nodejs=\"`providerName`\" pulumi-lang-dotnet=\"`ProviderName`\" pulumi-lang-go=\"`providerName`\" pulumi-lang-python=\"`provider_name`\" pulumi-lang-yaml=\"`providerName`\" pulumi-lang-java=\"`providerName`\" pulumi-lang-hcl=\"`provider_name`\"\u003e`providerName`\u003c/span\u003e because \u003cspan pulumi-lang-nodejs=\"`provider`\" pulumi-lang-dotnet=\"`Provider`\" pulumi-lang-go=\"`provider`\" pulumi-lang-python=\"`provider`\" pulumi-lang-yaml=\"`provider`\" pulumi-lang-java=\"`provider`\" pulumi-lang-hcl=\"`provider`\"\u003e`provider`\u003c/span\u003e is reserved by Terraform.\n"
},
"region": {
"type": "string",
"description": "Bucket region, for example `us-east-1`.\n"
},
"secretAccessKey": {
"type": "string",
"description": "S3 secret access key.\n",
"secret": true
},
"serverId": {
"type": "string",
"description": "Server this destination is scoped to.\n"
}
},
"requiredInputs": [
"accessKey",
"bucket",
"endpoint",
"region",
"secretAccessKey"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Destination resources.\n",
"properties": {
"accessKey": {
"type": "string",
"description": "S3 access key ID.\n"
},
"additionalFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Extra flags passed to the underlying \u003cspan pulumi-lang-nodejs=\"`rclone`\" pulumi-lang-dotnet=\"`Rclone`\" pulumi-lang-go=\"`rclone`\" pulumi-lang-python=\"`rclone`\" pulumi-lang-yaml=\"`rclone`\" pulumi-lang-java=\"`rclone`\" pulumi-lang-hcl=\"`rclone`\"\u003e`rclone`\u003c/span\u003e invocation.\n"
},
"bucket": {
"type": "string",
"description": "Bucket name.\n"
},
"createdAt": {
"type": "string",
"description": "Timestamp of when the destination was created.\n"
},
"endpoint": {
"type": "string",
"description": "S3 endpoint URL.\n"
},
"name": {
"type": "string",
"description": "Display name of the destination.\n"
},
"providerName": {
"type": "string",
"description": "Provider label, for example \u003cspan pulumi-lang-nodejs=\"`s3`\" pulumi-lang-dotnet=\"`S3`\" pulumi-lang-go=\"`s3`\" pulumi-lang-python=\"`s3`\" pulumi-lang-yaml=\"`s3`\" pulumi-lang-java=\"`s3`\" pulumi-lang-hcl=\"`s3`\"\u003e`s3`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`cloudflare`\" pulumi-lang-dotnet=\"`Cloudflare`\" pulumi-lang-go=\"`cloudflare`\" pulumi-lang-python=\"`cloudflare`\" pulumi-lang-yaml=\"`cloudflare`\" pulumi-lang-java=\"`cloudflare`\" pulumi-lang-hcl=\"`cloudflare`\"\u003e`cloudflare`\u003c/span\u003e. Named \u003cspan pulumi-lang-nodejs=\"`providerName`\" pulumi-lang-dotnet=\"`ProviderName`\" pulumi-lang-go=\"`providerName`\" pulumi-lang-python=\"`provider_name`\" pulumi-lang-yaml=\"`providerName`\" pulumi-lang-java=\"`providerName`\" pulumi-lang-hcl=\"`provider_name`\"\u003e`providerName`\u003c/span\u003e because \u003cspan pulumi-lang-nodejs=\"`provider`\" pulumi-lang-dotnet=\"`Provider`\" pulumi-lang-go=\"`provider`\" pulumi-lang-python=\"`provider`\" pulumi-lang-yaml=\"`provider`\" pulumi-lang-java=\"`provider`\" pulumi-lang-hcl=\"`provider`\"\u003e`provider`\u003c/span\u003e is reserved by Terraform.\n"
},
"region": {
"type": "string",
"description": "Bucket region, for example `us-east-1`.\n"
},
"secretAccessKey": {
"type": "string",
"description": "S3 secret access key.\n",
"secret": true
},
"serverId": {
"type": "string",
"description": "Server this destination is scoped to.\n"
}
},
"type": "object"
}
},
"dokploy:index/dnsProvider:DnsProvider": {
"description": "A DNS provider connection Dokploy uses to create records for domains automatically.\n\n\u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e is a JSON object whose shape depends on `providerType`:\n\n",
"properties": {
"config": {
"type": "string",
"description": "Provider credentials as a JSON object, including the `providerType` discriminator.\n",
"secret": true
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the connection was created.\n"
},
"name": {
"type": "string",
"description": "Name of the connection. Must be unique within the organization and may contain only letters, digits, `-` and `_`.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the connection.\n"
},
"providerType": {
"type": "string",
"description": "Provider kind derived from \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e: \u003cspan pulumi-lang-nodejs=\"`cloudflare`\" pulumi-lang-dotnet=\"`Cloudflare`\" pulumi-lang-go=\"`cloudflare`\" pulumi-lang-python=\"`cloudflare`\" pulumi-lang-yaml=\"`cloudflare`\" pulumi-lang-java=\"`cloudflare`\" pulumi-lang-hcl=\"`cloudflare`\"\u003e`cloudflare`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`route53`\" pulumi-lang-dotnet=\"`Route53`\" pulumi-lang-go=\"`route53`\" pulumi-lang-python=\"`route53`\" pulumi-lang-yaml=\"`route53`\" pulumi-lang-java=\"`route53`\" pulumi-lang-hcl=\"`route53`\"\u003e`route53`\u003c/span\u003e.\n"
}
},
"required": [
"config",
"createdAt",
"name",
"organizationId",
"providerType"
],
"inputProperties": {
"config": {
"type": "string",
"description": "Provider credentials as a JSON object, including the `providerType` discriminator.\n",
"secret": true
},
"name": {
"type": "string",
"description": "Name of the connection. Must be unique within the organization and may contain only letters, digits, `-` and `_`.\n"
}
},
"requiredInputs": [
"config"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering DnsProvider resources.\n",
"properties": {
"config": {
"type": "string",
"description": "Provider credentials as a JSON object, including the `providerType` discriminator.\n",
"secret": true
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the connection was created.\n"
},
"name": {
"type": "string",
"description": "Name of the connection. Must be unique within the organization and may contain only letters, digits, `-` and `_`.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the connection.\n"
},
"providerType": {
"type": "string",
"description": "Provider kind derived from \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e: \u003cspan pulumi-lang-nodejs=\"`cloudflare`\" pulumi-lang-dotnet=\"`Cloudflare`\" pulumi-lang-go=\"`cloudflare`\" pulumi-lang-python=\"`cloudflare`\" pulumi-lang-yaml=\"`cloudflare`\" pulumi-lang-java=\"`cloudflare`\" pulumi-lang-hcl=\"`cloudflare`\"\u003e`cloudflare`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`route53`\" pulumi-lang-dotnet=\"`Route53`\" pulumi-lang-go=\"`route53`\" pulumi-lang-python=\"`route53`\" pulumi-lang-yaml=\"`route53`\" pulumi-lang-java=\"`route53`\" pulumi-lang-hcl=\"`route53`\"\u003e`route53`\u003c/span\u003e.\n"
}
},
"type": "object"
}
},
"dokploy:index/domain:Domain": {
"description": "A domain routed to an application or a Compose service through Dokploy's Traefik instance.\n\nSet exactly one of \u003cspan pulumi-lang-nodejs=\"`applicationId`\" pulumi-lang-dotnet=\"`ApplicationId`\" pulumi-lang-go=\"`applicationId`\" pulumi-lang-python=\"`application_id`\" pulumi-lang-yaml=\"`applicationId`\" pulumi-lang-java=\"`applicationId`\" pulumi-lang-hcl=\"`application_id`\"\u003e`applicationId`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`composeId`\" pulumi-lang-dotnet=\"`ComposeId`\" pulumi-lang-go=\"`composeId`\" pulumi-lang-python=\"`compose_id`\" pulumi-lang-yaml=\"`composeId`\" pulumi-lang-java=\"`composeId`\" pulumi-lang-hcl=\"`compose_id`\"\u003e`composeId`\u003c/span\u003e. When targeting a Compose stack, \u003cspan pulumi-lang-nodejs=\"`serviceName`\" pulumi-lang-dotnet=\"`ServiceName`\" pulumi-lang-go=\"`serviceName`\" pulumi-lang-python=\"`service_name`\" pulumi-lang-yaml=\"`serviceName`\" pulumi-lang-java=\"`serviceName`\" pulumi-lang-hcl=\"`service_name`\"\u003e`serviceName`\u003c/span\u003e selects which service in the stack receives the traffic.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application this domain routes to.\n"
},
"certificateType": {
"type": "string",
"description": "How TLS certificates are obtained. Use \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e for automatic certificates. Valid values: \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`none`\" pulumi-lang-dotnet=\"`None`\" pulumi-lang-go=\"`none`\" pulumi-lang-python=\"`none`\" pulumi-lang-yaml=\"`none`\" pulumi-lang-java=\"`none`\" pulumi-lang-hcl=\"`none`\"\u003e`none`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack this domain routes to.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the domain was created.\n"
},
"customCertResolver": {
"type": "string",
"description": "Traefik certificate resolver name, when \u003cspan pulumi-lang-nodejs=\"`certificateType`\" pulumi-lang-dotnet=\"`CertificateType`\" pulumi-lang-go=\"`certificateType`\" pulumi-lang-python=\"`certificate_type`\" pulumi-lang-yaml=\"`certificateType`\" pulumi-lang-java=\"`certificateType`\" pulumi-lang-hcl=\"`certificate_type`\"\u003e`certificateType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"customEntrypoint": {
"type": "string",
"description": "Traefik entrypoint to bind, when not using the defaults.\n"
},
"domainType": {
"type": "string",
"description": "What kind of target this domain points at. Valid values: \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`preview`\" pulumi-lang-dotnet=\"`Preview`\" pulumi-lang-go=\"`preview`\" pulumi-lang-python=\"`preview`\" pulumi-lang-yaml=\"`preview`\" pulumi-lang-java=\"`preview`\" pulumi-lang-hcl=\"`preview`\"\u003e`preview`\u003c/span\u003e.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the domain is served. Setting this to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e removes the route from Traefik but keeps the certificate, path and middleware configuration intact, so the domain can be brought back without reconfiguring it.\n"
},
"forwardAuthEnabled": {
"type": "boolean",
"description": "Protect this domain with Dokploy's forward auth.\n"
},
"host": {
"type": "string",
"description": "Fully-qualified hostname, for example `api.example.com`.\n"
},
"https": {
"type": "boolean",
"description": "Serve the domain over HTTPS and redirect HTTP traffic to it.\n"
},
"internalPath": {
"type": "string",
"description": "Path the request is rewritten to before it reaches the container, defaults to `/`.\n"
},
"middlewares": {
"type": "array",
"items": {
"type": "string"
},
"description": "Names of Traefik middlewares to apply.\n"
},
"path": {
"type": "string",
"description": "Path prefix this domain routes, defaults to `/`.\n"
},
"port": {
"type": "integer",
"description": "Container port that receives the traffic, defaults to \u003cspan pulumi-lang-nodejs=\"`3000`\" pulumi-lang-dotnet=\"`3000`\" pulumi-lang-go=\"`3000`\" pulumi-lang-python=\"`3000`\" pulumi-lang-yaml=\"`3000`\" pulumi-lang-java=\"`3000`\" pulumi-lang-hcl=\"`3000`\"\u003e`3000`\u003c/span\u003e.\n"
},
"previewDeploymentId": {
"type": "string",
"description": "Preview deployment this domain routes to.\n"
},
"serviceName": {
"type": "string",
"description": "Name of the service inside a Compose stack that receives the traffic. Required when \u003cspan pulumi-lang-nodejs=\"`composeId`\" pulumi-lang-dotnet=\"`ComposeId`\" pulumi-lang-go=\"`composeId`\" pulumi-lang-python=\"`compose_id`\" pulumi-lang-yaml=\"`composeId`\" pulumi-lang-java=\"`composeId`\" pulumi-lang-hcl=\"`compose_id`\"\u003e`composeId`\u003c/span\u003e is set.\n"
},
"stripPath": {
"type": "boolean",
"description": "Strip \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e from the request before forwarding it.\n"
}
},
"required": [
"certificateType",
"createdAt",
"domainType",
"enabled",
"forwardAuthEnabled",
"host",
"https",
"internalPath",
"middlewares",
"path",
"port",
"stripPath"
],
"inputProperties": {
"applicationId": {
"type": "string",
"description": "Application this domain routes to.\n"
},
"certificateType": {
"type": "string",
"description": "How TLS certificates are obtained. Use \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e for automatic certificates. Valid values: \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`none`\" pulumi-lang-dotnet=\"`None`\" pulumi-lang-go=\"`none`\" pulumi-lang-python=\"`none`\" pulumi-lang-yaml=\"`none`\" pulumi-lang-java=\"`none`\" pulumi-lang-hcl=\"`none`\"\u003e`none`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack this domain routes to.\n"
},
"customCertResolver": {
"type": "string",
"description": "Traefik certificate resolver name, when \u003cspan pulumi-lang-nodejs=\"`certificateType`\" pulumi-lang-dotnet=\"`CertificateType`\" pulumi-lang-go=\"`certificateType`\" pulumi-lang-python=\"`certificate_type`\" pulumi-lang-yaml=\"`certificateType`\" pulumi-lang-java=\"`certificateType`\" pulumi-lang-hcl=\"`certificate_type`\"\u003e`certificateType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"customEntrypoint": {
"type": "string",
"description": "Traefik entrypoint to bind, when not using the defaults.\n"
},
"domainType": {
"type": "string",
"description": "What kind of target this domain points at. Valid values: \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`preview`\" pulumi-lang-dotnet=\"`Preview`\" pulumi-lang-go=\"`preview`\" pulumi-lang-python=\"`preview`\" pulumi-lang-yaml=\"`preview`\" pulumi-lang-java=\"`preview`\" pulumi-lang-hcl=\"`preview`\"\u003e`preview`\u003c/span\u003e.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the domain is served. Setting this to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e removes the route from Traefik but keeps the certificate, path and middleware configuration intact, so the domain can be brought back without reconfiguring it.\n"
},
"forwardAuthEnabled": {
"type": "boolean",
"description": "Protect this domain with Dokploy's forward auth.\n"
},
"host": {
"type": "string",
"description": "Fully-qualified hostname, for example `api.example.com`.\n"
},
"https": {
"type": "boolean",
"description": "Serve the domain over HTTPS and redirect HTTP traffic to it.\n"
},
"internalPath": {
"type": "string",
"description": "Path the request is rewritten to before it reaches the container, defaults to `/`.\n"
},
"middlewares": {
"type": "array",
"items": {
"type": "string"
},
"description": "Names of Traefik middlewares to apply.\n"
},
"path": {
"type": "string",
"description": "Path prefix this domain routes, defaults to `/`.\n"
},
"port": {
"type": "integer",
"description": "Container port that receives the traffic, defaults to \u003cspan pulumi-lang-nodejs=\"`3000`\" pulumi-lang-dotnet=\"`3000`\" pulumi-lang-go=\"`3000`\" pulumi-lang-python=\"`3000`\" pulumi-lang-yaml=\"`3000`\" pulumi-lang-java=\"`3000`\" pulumi-lang-hcl=\"`3000`\"\u003e`3000`\u003c/span\u003e.\n"
},
"previewDeploymentId": {
"type": "string",
"description": "Preview deployment this domain routes to.\n"
},
"serviceName": {
"type": "string",
"description": "Name of the service inside a Compose stack that receives the traffic. Required when \u003cspan pulumi-lang-nodejs=\"`composeId`\" pulumi-lang-dotnet=\"`ComposeId`\" pulumi-lang-go=\"`composeId`\" pulumi-lang-python=\"`compose_id`\" pulumi-lang-yaml=\"`composeId`\" pulumi-lang-java=\"`composeId`\" pulumi-lang-hcl=\"`compose_id`\"\u003e`composeId`\u003c/span\u003e is set.\n"
},
"stripPath": {
"type": "boolean",
"description": "Strip \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e from the request before forwarding it.\n"
}
},
"requiredInputs": [
"host"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Domain resources.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application this domain routes to.\n"
},
"certificateType": {
"type": "string",
"description": "How TLS certificates are obtained. Use \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e for automatic certificates. Valid values: \u003cspan pulumi-lang-nodejs=\"`letsencrypt`\" pulumi-lang-dotnet=\"`Letsencrypt`\" pulumi-lang-go=\"`letsencrypt`\" pulumi-lang-python=\"`letsencrypt`\" pulumi-lang-yaml=\"`letsencrypt`\" pulumi-lang-java=\"`letsencrypt`\" pulumi-lang-hcl=\"`letsencrypt`\"\u003e`letsencrypt`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`none`\" pulumi-lang-dotnet=\"`None`\" pulumi-lang-go=\"`none`\" pulumi-lang-python=\"`none`\" pulumi-lang-yaml=\"`none`\" pulumi-lang-java=\"`none`\" pulumi-lang-hcl=\"`none`\"\u003e`none`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack this domain routes to.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the domain was created.\n"
},
"customCertResolver": {
"type": "string",
"description": "Traefik certificate resolver name, when \u003cspan pulumi-lang-nodejs=\"`certificateType`\" pulumi-lang-dotnet=\"`CertificateType`\" pulumi-lang-go=\"`certificateType`\" pulumi-lang-python=\"`certificate_type`\" pulumi-lang-yaml=\"`certificateType`\" pulumi-lang-java=\"`certificateType`\" pulumi-lang-hcl=\"`certificate_type`\"\u003e`certificateType`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`custom`\" pulumi-lang-dotnet=\"`Custom`\" pulumi-lang-go=\"`custom`\" pulumi-lang-python=\"`custom`\" pulumi-lang-yaml=\"`custom`\" pulumi-lang-java=\"`custom`\" pulumi-lang-hcl=\"`custom`\"\u003e`custom`\u003c/span\u003e.\n"
},
"customEntrypoint": {
"type": "string",
"description": "Traefik entrypoint to bind, when not using the defaults.\n"
},
"domainType": {
"type": "string",
"description": "What kind of target this domain points at. Valid values: \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`preview`\" pulumi-lang-dotnet=\"`Preview`\" pulumi-lang-go=\"`preview`\" pulumi-lang-python=\"`preview`\" pulumi-lang-yaml=\"`preview`\" pulumi-lang-java=\"`preview`\" pulumi-lang-hcl=\"`preview`\"\u003e`preview`\u003c/span\u003e.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the domain is served. Setting this to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e removes the route from Traefik but keeps the certificate, path and middleware configuration intact, so the domain can be brought back without reconfiguring it.\n"
},
"forwardAuthEnabled": {
"type": "boolean",
"description": "Protect this domain with Dokploy's forward auth.\n"
},
"host": {
"type": "string",
"description": "Fully-qualified hostname, for example `api.example.com`.\n"
},
"https": {
"type": "boolean",
"description": "Serve the domain over HTTPS and redirect HTTP traffic to it.\n"
},
"internalPath": {
"type": "string",
"description": "Path the request is rewritten to before it reaches the container, defaults to `/`.\n"
},
"middlewares": {
"type": "array",
"items": {
"type": "string"
},
"description": "Names of Traefik middlewares to apply.\n"
},
"path": {
"type": "string",
"description": "Path prefix this domain routes, defaults to `/`.\n"
},
"port": {
"type": "integer",
"description": "Container port that receives the traffic, defaults to \u003cspan pulumi-lang-nodejs=\"`3000`\" pulumi-lang-dotnet=\"`3000`\" pulumi-lang-go=\"`3000`\" pulumi-lang-python=\"`3000`\" pulumi-lang-yaml=\"`3000`\" pulumi-lang-java=\"`3000`\" pulumi-lang-hcl=\"`3000`\"\u003e`3000`\u003c/span\u003e.\n"
},
"previewDeploymentId": {
"type": "string",
"description": "Preview deployment this domain routes to.\n"
},
"serviceName": {
"type": "string",
"description": "Name of the service inside a Compose stack that receives the traffic. Required when \u003cspan pulumi-lang-nodejs=\"`composeId`\" pulumi-lang-dotnet=\"`ComposeId`\" pulumi-lang-go=\"`composeId`\" pulumi-lang-python=\"`compose_id`\" pulumi-lang-yaml=\"`composeId`\" pulumi-lang-java=\"`composeId`\" pulumi-lang-hcl=\"`compose_id`\"\u003e`composeId`\u003c/span\u003e is set.\n"
},
"stripPath": {
"type": "boolean",
"description": "Strip \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e from the request before forwarding it.\n"
}
},
"type": "object"
}
},
"dokploy:index/environment:Environment": {
"description": "An environment inside a Dokploy project, such as \u003cspan pulumi-lang-nodejs=\"`staging`\" pulumi-lang-dotnet=\"`Staging`\" pulumi-lang-go=\"`staging`\" pulumi-lang-python=\"`staging`\" pulumi-lang-yaml=\"`staging`\" pulumi-lang-java=\"`staging`\" pulumi-lang-hcl=\"`staging`\"\u003e`staging`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`production`\" pulumi-lang-dotnet=\"`Production`\" pulumi-lang-go=\"`production`\" pulumi-lang-python=\"`production`\" pulumi-lang-yaml=\"`production`\" pulumi-lang-java=\"`production`\" pulumi-lang-hcl=\"`production`\"\u003e`production`\u003c/span\u003e. Services belong to an environment rather than directly to a project.\n\nDokploy creates a default \u003cspan pulumi-lang-nodejs=\"`production`\" pulumi-lang-dotnet=\"`Production`\" pulumi-lang-go=\"`production`\" pulumi-lang-python=\"`production`\" pulumi-lang-yaml=\"`production`\" pulumi-lang-java=\"`production`\" pulumi-lang-hcl=\"`production`\"\u003e`production`\u003c/span\u003e environment with every project; reference it via `dokploy_project.\u003cname\u003e.default_environment_id` instead of declaring it here.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the environment was created.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"env": {
"type": "string",
"description": "Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.\n"
},
"isDefault": {
"type": "boolean",
"description": "Whether this is the project's default environment.\n"
},
"name": {
"type": "string",
"description": "Environment name, for example \u003cspan pulumi-lang-nodejs=\"`staging`\" pulumi-lang-dotnet=\"`Staging`\" pulumi-lang-go=\"`staging`\" pulumi-lang-python=\"`staging`\" pulumi-lang-yaml=\"`staging`\" pulumi-lang-java=\"`staging`\" pulumi-lang-hcl=\"`staging`\"\u003e`staging`\u003c/span\u003e.\n"
},
"projectId": {
"type": "string",
"description": "Project this environment belongs to.\n"
}
},
"required": [
"createdAt",
"env",
"isDefault",
"name",
"projectId"
],
"inputProperties": {
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"env": {
"type": "string",
"description": "Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.\n"
},
"name": {
"type": "string",
"description": "Environment name, for example \u003cspan pulumi-lang-nodejs=\"`staging`\" pulumi-lang-dotnet=\"`Staging`\" pulumi-lang-go=\"`staging`\" pulumi-lang-python=\"`staging`\" pulumi-lang-yaml=\"`staging`\" pulumi-lang-java=\"`staging`\" pulumi-lang-hcl=\"`staging`\"\u003e`staging`\u003c/span\u003e.\n"
},
"projectId": {
"type": "string",
"description": "Project this environment belongs to.\n"
}
},
"requiredInputs": [
"projectId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Environment resources.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the environment was created.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"env": {
"type": "string",
"description": "Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.\n"
},
"isDefault": {
"type": "boolean",
"description": "Whether this is the project's default environment.\n"
},
"name": {
"type": "string",
"description": "Environment name, for example \u003cspan pulumi-lang-nodejs=\"`staging`\" pulumi-lang-dotnet=\"`Staging`\" pulumi-lang-go=\"`staging`\" pulumi-lang-python=\"`staging`\" pulumi-lang-yaml=\"`staging`\" pulumi-lang-java=\"`staging`\" pulumi-lang-hcl=\"`staging`\"\u003e`staging`\u003c/span\u003e.\n"
},
"projectId": {
"type": "string",
"description": "Project this environment belongs to.\n"
}
},
"type": "object"
}
},
"dokploy:index/libsql:Libsql": {
"description": "A managed libSQL instance running on Dokploy.\n\n\u003e Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.\n\n\u003e Credentials are stored in Terraform state. Use a state backend with encryption at rest.\n\nlibSQL runs as a \u003cspan pulumi-lang-nodejs=\"`sqld`\" pulumi-lang-dotnet=\"`Sqld`\" pulumi-lang-go=\"`sqld`\" pulumi-lang-python=\"`sqld`\" pulumi-lang-yaml=\"`sqld`\" pulumi-lang-java=\"`sqld`\" pulumi-lang-hcl=\"`sqld`\"\u003e`sqld`\u003c/span\u003e server. A \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e node owns the data; a \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e node follows a primary named by \u003cspan pulumi-lang-nodejs=\"`sqldPrimaryUrl`\" pulumi-lang-dotnet=\"`SqldPrimaryUrl`\" pulumi-lang-go=\"`sqldPrimaryUrl`\" pulumi-lang-python=\"`sqld_primary_url`\" pulumi-lang-yaml=\"`sqldPrimaryUrl`\" pulumi-lang-java=\"`sqldPrimaryUrl`\" pulumi-lang-hcl=\"`sqld_primary_url`\"\u003e`sqldPrimaryUrl`\u003c/span\u003e.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated from \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e when omitted, because Dokploy's libSQL endpoint does not generate one. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "libSQL server image to run, for example `ghcr.io/tursodatabase/libsql-server:latest`.\n"
},
"enableNamespaces": {
"type": "boolean",
"description": "Serve multiple logical databases from one instance through libSQL namespaces.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalAdminPort": {
"type": "integer",
"description": "Host port exposing the admin API.\n"
},
"externalGrpcPort": {
"type": "integer",
"description": "Host port exposing the gRPC replication endpoint.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port exposing the HTTP API.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"sqldNode": {
"type": "string",
"description": "Role this node plays in a libSQL cluster. Valid values: \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e.\n"
},
"sqldPrimaryUrl": {
"type": "string",
"description": "URL of the primary node, when \u003cspan pulumi-lang-nodejs=\"`sqldNode`\" pulumi-lang-dotnet=\"`SqldNode`\" pulumi-lang-go=\"`sqldNode`\" pulumi-lang-python=\"`sqld_node`\" pulumi-lang-yaml=\"`sqldNode`\" pulumi-lang-java=\"`sqldNode`\" pulumi-lang-hcl=\"`sqld_node`\"\u003e`sqldNode`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"required": [
"appName",
"applicationStatus",
"createdAt",
"databasePassword",
"databaseUser",
"detachDokployNetwork",
"dockerImage",
"enableNamespaces",
"environmentId",
"name",
"networkIds",
"replicas",
"sqldNode"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated from \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e when omitted, because Dokploy's libSQL endpoint does not generate one. Changing it forces a new database.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "libSQL server image to run, for example `ghcr.io/tursodatabase/libsql-server:latest`.\n"
},
"enableNamespaces": {
"type": "boolean",
"description": "Serve multiple logical databases from one instance through libSQL namespaces.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalAdminPort": {
"type": "integer",
"description": "Host port exposing the admin API.\n"
},
"externalGrpcPort": {
"type": "integer",
"description": "Host port exposing the gRPC replication endpoint.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port exposing the HTTP API.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"sqldNode": {
"type": "string",
"description": "Role this node plays in a libSQL cluster. Valid values: \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e.\n"
},
"sqldPrimaryUrl": {
"type": "string",
"description": "URL of the primary node, when \u003cspan pulumi-lang-nodejs=\"`sqldNode`\" pulumi-lang-dotnet=\"`SqldNode`\" pulumi-lang-go=\"`sqldNode`\" pulumi-lang-python=\"`sqld_node`\" pulumi-lang-yaml=\"`sqldNode`\" pulumi-lang-java=\"`sqldNode`\" pulumi-lang-hcl=\"`sqld_node`\"\u003e`sqldNode`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"requiredInputs": [
"databasePassword",
"databaseUser",
"dockerImage",
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Libsql resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated from \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e when omitted, because Dokploy's libSQL endpoint does not generate one. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "libSQL server image to run, for example `ghcr.io/tursodatabase/libsql-server:latest`.\n"
},
"enableNamespaces": {
"type": "boolean",
"description": "Serve multiple logical databases from one instance through libSQL namespaces.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalAdminPort": {
"type": "integer",
"description": "Host port exposing the admin API.\n"
},
"externalGrpcPort": {
"type": "integer",
"description": "Host port exposing the gRPC replication endpoint.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port exposing the HTTP API.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"sqldNode": {
"type": "string",
"description": "Role this node plays in a libSQL cluster. Valid values: \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e.\n"
},
"sqldPrimaryUrl": {
"type": "string",
"description": "URL of the primary node, when \u003cspan pulumi-lang-nodejs=\"`sqldNode`\" pulumi-lang-dotnet=\"`SqldNode`\" pulumi-lang-go=\"`sqldNode`\" pulumi-lang-python=\"`sqld_node`\" pulumi-lang-yaml=\"`sqldNode`\" pulumi-lang-java=\"`sqldNode`\" pulumi-lang-hcl=\"`sqld_node`\"\u003e`sqldNode`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`replica`\" pulumi-lang-dotnet=\"`Replica`\" pulumi-lang-go=\"`replica`\" pulumi-lang-python=\"`replica`\" pulumi-lang-yaml=\"`replica`\" pulumi-lang-java=\"`replica`\" pulumi-lang-hcl=\"`replica`\"\u003e`replica`\u003c/span\u003e.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"type": "object"
}
},
"dokploy:index/mariaDb:MariaDb": {
"description": "A managed MariaDB instance running on Dokploy.\n\n\u003e Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.\n\n\u003e Credentials are stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseRootPassword": {
"type": "string",
"description": "Password for the MariaDB \u003cspan pulumi-lang-nodejs=\"`root`\" pulumi-lang-dotnet=\"`Root`\" pulumi-lang-go=\"`root`\" pulumi-lang-python=\"`root`\" pulumi-lang-yaml=\"`root`\" pulumi-lang-java=\"`root`\" pulumi-lang-hcl=\"`root`\"\u003e`root`\u003c/span\u003e user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MariaDB image to run, for example `mariadb:11`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"required": [
"appName",
"applicationStatus",
"args",
"createdAt",
"databaseName",
"databasePassword",
"databaseRootPassword",
"databaseUser",
"detachDokployNetwork",
"dockerImage",
"environmentId",
"name",
"networkIds",
"replicas"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseRootPassword": {
"type": "string",
"description": "Password for the MariaDB \u003cspan pulumi-lang-nodejs=\"`root`\" pulumi-lang-dotnet=\"`Root`\" pulumi-lang-go=\"`root`\" pulumi-lang-python=\"`root`\" pulumi-lang-yaml=\"`root`\" pulumi-lang-java=\"`root`\" pulumi-lang-hcl=\"`root`\"\u003e`root`\u003c/span\u003e user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MariaDB image to run, for example `mariadb:11`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"requiredInputs": [
"databaseName",
"databasePassword",
"databaseRootPassword",
"databaseUser",
"dockerImage",
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering MariaDb resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseRootPassword": {
"type": "string",
"description": "Password for the MariaDB \u003cspan pulumi-lang-nodejs=\"`root`\" pulumi-lang-dotnet=\"`Root`\" pulumi-lang-go=\"`root`\" pulumi-lang-python=\"`root`\" pulumi-lang-yaml=\"`root`\" pulumi-lang-java=\"`root`\" pulumi-lang-hcl=\"`root`\"\u003e`root`\u003c/span\u003e user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MariaDB image to run, for example `mariadb:11`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"type": "object"
}
},
"dokploy:index/mongo:Mongo": {
"description": "A managed MongoDB instance running on Dokploy.\n\n\u003e Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.\n\n\u003e Credentials are stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the root user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Root username to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MongoDB image to run. Defaults to `mongo:8`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicaSets": {
"type": "boolean",
"description": "Start the instance as a single-node replica set.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"required": [
"appName",
"applicationStatus",
"args",
"createdAt",
"databasePassword",
"databaseUser",
"detachDokployNetwork",
"dockerImage",
"environmentId",
"name",
"networkIds",
"replicaSets",
"replicas"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the root user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Root username to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MongoDB image to run. Defaults to `mongo:8`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicaSets": {
"type": "boolean",
"description": "Start the instance as a single-node replica set.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"requiredInputs": [
"databasePassword",
"databaseUser",
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Mongo resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the root user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Root username to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MongoDB image to run. Defaults to `mongo:8`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicaSets": {
"type": "boolean",
"description": "Start the instance as a single-node replica set.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"type": "object"
}
},
"dokploy:index/mount:Mount": {
"description": "A volume, bind mount, or config file attached to a Dokploy service.\n\n* `type = \"volume\"` — a named Docker volume; set \u003cspan pulumi-lang-nodejs=\"`volumeName`\" pulumi-lang-dotnet=\"`VolumeName`\" pulumi-lang-go=\"`volumeName`\" pulumi-lang-python=\"`volume_name`\" pulumi-lang-yaml=\"`volumeName`\" pulumi-lang-java=\"`volumeName`\" pulumi-lang-hcl=\"`volume_name`\"\u003e`volumeName`\u003c/span\u003e.\n* `type = \"bind\"` — a path on the host; set \u003cspan pulumi-lang-nodejs=\"`hostPath`\" pulumi-lang-dotnet=\"`HostPath`\" pulumi-lang-go=\"`hostPath`\" pulumi-lang-python=\"`host_path`\" pulumi-lang-yaml=\"`hostPath`\" pulumi-lang-java=\"`hostPath`\" pulumi-lang-hcl=\"`host_path`\"\u003e`hostPath`\u003c/span\u003e.\n* `type = \"file\"` — a file rendered from \u003cspan pulumi-lang-nodejs=\"`content`\" pulumi-lang-dotnet=\"`Content`\" pulumi-lang-go=\"`content`\" pulumi-lang-python=\"`content`\" pulumi-lang-yaml=\"`content`\" pulumi-lang-java=\"`content`\" pulumi-lang-hcl=\"`content`\"\u003e`content`\u003c/span\u003e; set \u003cspan pulumi-lang-nodejs=\"`filePath`\" pulumi-lang-dotnet=\"`FilePath`\" pulumi-lang-go=\"`filePath`\" pulumi-lang-python=\"`file_path`\" pulumi-lang-yaml=\"`filePath`\" pulumi-lang-java=\"`filePath`\" pulumi-lang-hcl=\"`file_path`\"\u003e`filePath`\u003c/span\u003e.\n\n\u003e **A \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e mount must set \u003cspan pulumi-lang-nodejs=\"`volumeName`\" pulumi-lang-dotnet=\"`VolumeName`\" pulumi-lang-go=\"`volumeName`\" pulumi-lang-python=\"`volume_name`\" pulumi-lang-yaml=\"`volumeName`\" pulumi-lang-java=\"`volumeName`\" pulumi-lang-hcl=\"`volume_name`\"\u003e`volumeName`\u003c/span\u003e.** Dokploy hands an unset name to Docker as an empty source, which creates a fresh anonymous volume on every deploy and orphans the previous one — the data never survives a redeploy. The provider rejects that combination at plan time.\n",
"properties": {
"content": {
"type": "string",
"description": "Contents of the generated file, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"filePath": {
"type": "string",
"description": "Path of the generated file, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"hostPath": {
"type": "string",
"description": "Path on the host, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`bind`\" pulumi-lang-dotnet=\"`Bind`\" pulumi-lang-go=\"`bind`\" pulumi-lang-python=\"`bind`\" pulumi-lang-yaml=\"`bind`\" pulumi-lang-java=\"`bind`\" pulumi-lang-hcl=\"`bind`\"\u003e`bind`\u003c/span\u003e.\n"
},
"mountPath": {
"type": "string",
"description": "Path inside the container where the mount appears.\n"
},
"serviceId": {
"type": "string",
"description": "ID of the service this mount attaches to. Must match \u003cspan pulumi-lang-nodejs=\"`serviceType`\" pulumi-lang-dotnet=\"`ServiceType`\" pulumi-lang-go=\"`serviceType`\" pulumi-lang-python=\"`service_type`\" pulumi-lang-yaml=\"`serviceType`\" pulumi-lang-java=\"`serviceType`\" pulumi-lang-hcl=\"`service_type`\"\u003e`serviceType`\u003c/span\u003e — an application ID, a compose ID, a postgres ID, and so on.\n"
},
"serviceType": {
"type": "string",
"description": "The kind of service this mount attaches to. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`postgres`\" pulumi-lang-dotnet=\"`Postgres`\" pulumi-lang-go=\"`postgres`\" pulumi-lang-python=\"`postgres`\" pulumi-lang-yaml=\"`postgres`\" pulumi-lang-java=\"`postgres`\" pulumi-lang-hcl=\"`postgres`\"\u003e`postgres`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mysql`\" pulumi-lang-dotnet=\"`Mysql`\" pulumi-lang-go=\"`mysql`\" pulumi-lang-python=\"`mysql`\" pulumi-lang-yaml=\"`mysql`\" pulumi-lang-java=\"`mysql`\" pulumi-lang-hcl=\"`mysql`\"\u003e`mysql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mariadb`\" pulumi-lang-dotnet=\"`Mariadb`\" pulumi-lang-go=\"`mariadb`\" pulumi-lang-python=\"`mariadb`\" pulumi-lang-yaml=\"`mariadb`\" pulumi-lang-java=\"`mariadb`\" pulumi-lang-hcl=\"`mariadb`\"\u003e`mariadb`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mongo`\" pulumi-lang-dotnet=\"`Mongo`\" pulumi-lang-go=\"`mongo`\" pulumi-lang-python=\"`mongo`\" pulumi-lang-yaml=\"`mongo`\" pulumi-lang-java=\"`mongo`\" pulumi-lang-hcl=\"`mongo`\"\u003e`mongo`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`redis`\" pulumi-lang-dotnet=\"`Redis`\" pulumi-lang-go=\"`redis`\" pulumi-lang-python=\"`redis`\" pulumi-lang-yaml=\"`redis`\" pulumi-lang-java=\"`redis`\" pulumi-lang-hcl=\"`redis`\"\u003e`redis`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`libsql`\" pulumi-lang-dotnet=\"`Libsql`\" pulumi-lang-go=\"`libsql`\" pulumi-lang-python=\"`libsql`\" pulumi-lang-yaml=\"`libsql`\" pulumi-lang-java=\"`libsql`\" pulumi-lang-hcl=\"`libsql`\"\u003e`libsql`\u003c/span\u003e.\n"
},
"type": {
"type": "string",
"description": "The kind of mount to create. Valid values: \u003cspan pulumi-lang-nodejs=\"`bind`\" pulumi-lang-dotnet=\"`Bind`\" pulumi-lang-go=\"`bind`\" pulumi-lang-python=\"`bind`\" pulumi-lang-yaml=\"`bind`\" pulumi-lang-java=\"`bind`\" pulumi-lang-hcl=\"`bind`\"\u003e`bind`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"volumeName": {
"type": "string",
"description": "Name of the Docker volume, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e.\n"
}
},
"required": [
"mountPath",
"serviceId",
"serviceType",
"type"
],
"inputProperties": {
"content": {
"type": "string",
"description": "Contents of the generated file, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"filePath": {
"type": "string",
"description": "Path of the generated file, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"hostPath": {
"type": "string",
"description": "Path on the host, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`bind`\" pulumi-lang-dotnet=\"`Bind`\" pulumi-lang-go=\"`bind`\" pulumi-lang-python=\"`bind`\" pulumi-lang-yaml=\"`bind`\" pulumi-lang-java=\"`bind`\" pulumi-lang-hcl=\"`bind`\"\u003e`bind`\u003c/span\u003e.\n"
},
"mountPath": {
"type": "string",
"description": "Path inside the container where the mount appears.\n"
},
"serviceId": {
"type": "string",
"description": "ID of the service this mount attaches to. Must match \u003cspan pulumi-lang-nodejs=\"`serviceType`\" pulumi-lang-dotnet=\"`ServiceType`\" pulumi-lang-go=\"`serviceType`\" pulumi-lang-python=\"`service_type`\" pulumi-lang-yaml=\"`serviceType`\" pulumi-lang-java=\"`serviceType`\" pulumi-lang-hcl=\"`service_type`\"\u003e`serviceType`\u003c/span\u003e — an application ID, a compose ID, a postgres ID, and so on.\n"
},
"serviceType": {
"type": "string",
"description": "The kind of service this mount attaches to. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`postgres`\" pulumi-lang-dotnet=\"`Postgres`\" pulumi-lang-go=\"`postgres`\" pulumi-lang-python=\"`postgres`\" pulumi-lang-yaml=\"`postgres`\" pulumi-lang-java=\"`postgres`\" pulumi-lang-hcl=\"`postgres`\"\u003e`postgres`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mysql`\" pulumi-lang-dotnet=\"`Mysql`\" pulumi-lang-go=\"`mysql`\" pulumi-lang-python=\"`mysql`\" pulumi-lang-yaml=\"`mysql`\" pulumi-lang-java=\"`mysql`\" pulumi-lang-hcl=\"`mysql`\"\u003e`mysql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mariadb`\" pulumi-lang-dotnet=\"`Mariadb`\" pulumi-lang-go=\"`mariadb`\" pulumi-lang-python=\"`mariadb`\" pulumi-lang-yaml=\"`mariadb`\" pulumi-lang-java=\"`mariadb`\" pulumi-lang-hcl=\"`mariadb`\"\u003e`mariadb`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mongo`\" pulumi-lang-dotnet=\"`Mongo`\" pulumi-lang-go=\"`mongo`\" pulumi-lang-python=\"`mongo`\" pulumi-lang-yaml=\"`mongo`\" pulumi-lang-java=\"`mongo`\" pulumi-lang-hcl=\"`mongo`\"\u003e`mongo`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`redis`\" pulumi-lang-dotnet=\"`Redis`\" pulumi-lang-go=\"`redis`\" pulumi-lang-python=\"`redis`\" pulumi-lang-yaml=\"`redis`\" pulumi-lang-java=\"`redis`\" pulumi-lang-hcl=\"`redis`\"\u003e`redis`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`libsql`\" pulumi-lang-dotnet=\"`Libsql`\" pulumi-lang-go=\"`libsql`\" pulumi-lang-python=\"`libsql`\" pulumi-lang-yaml=\"`libsql`\" pulumi-lang-java=\"`libsql`\" pulumi-lang-hcl=\"`libsql`\"\u003e`libsql`\u003c/span\u003e.\n"
},
"type": {
"type": "string",
"description": "The kind of mount to create. Valid values: \u003cspan pulumi-lang-nodejs=\"`bind`\" pulumi-lang-dotnet=\"`Bind`\" pulumi-lang-go=\"`bind`\" pulumi-lang-python=\"`bind`\" pulumi-lang-yaml=\"`bind`\" pulumi-lang-java=\"`bind`\" pulumi-lang-hcl=\"`bind`\"\u003e`bind`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"volumeName": {
"type": "string",
"description": "Name of the Docker volume, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e.\n"
}
},
"requiredInputs": [
"mountPath",
"serviceId",
"serviceType",
"type"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Mount resources.\n",
"properties": {
"content": {
"type": "string",
"description": "Contents of the generated file, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"filePath": {
"type": "string",
"description": "Path of the generated file, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"hostPath": {
"type": "string",
"description": "Path on the host, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`bind`\" pulumi-lang-dotnet=\"`Bind`\" pulumi-lang-go=\"`bind`\" pulumi-lang-python=\"`bind`\" pulumi-lang-yaml=\"`bind`\" pulumi-lang-java=\"`bind`\" pulumi-lang-hcl=\"`bind`\"\u003e`bind`\u003c/span\u003e.\n"
},
"mountPath": {
"type": "string",
"description": "Path inside the container where the mount appears.\n"
},
"serviceId": {
"type": "string",
"description": "ID of the service this mount attaches to. Must match \u003cspan pulumi-lang-nodejs=\"`serviceType`\" pulumi-lang-dotnet=\"`ServiceType`\" pulumi-lang-go=\"`serviceType`\" pulumi-lang-python=\"`service_type`\" pulumi-lang-yaml=\"`serviceType`\" pulumi-lang-java=\"`serviceType`\" pulumi-lang-hcl=\"`service_type`\"\u003e`serviceType`\u003c/span\u003e — an application ID, a compose ID, a postgres ID, and so on.\n"
},
"serviceType": {
"type": "string",
"description": "The kind of service this mount attaches to. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`postgres`\" pulumi-lang-dotnet=\"`Postgres`\" pulumi-lang-go=\"`postgres`\" pulumi-lang-python=\"`postgres`\" pulumi-lang-yaml=\"`postgres`\" pulumi-lang-java=\"`postgres`\" pulumi-lang-hcl=\"`postgres`\"\u003e`postgres`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mysql`\" pulumi-lang-dotnet=\"`Mysql`\" pulumi-lang-go=\"`mysql`\" pulumi-lang-python=\"`mysql`\" pulumi-lang-yaml=\"`mysql`\" pulumi-lang-java=\"`mysql`\" pulumi-lang-hcl=\"`mysql`\"\u003e`mysql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mariadb`\" pulumi-lang-dotnet=\"`Mariadb`\" pulumi-lang-go=\"`mariadb`\" pulumi-lang-python=\"`mariadb`\" pulumi-lang-yaml=\"`mariadb`\" pulumi-lang-java=\"`mariadb`\" pulumi-lang-hcl=\"`mariadb`\"\u003e`mariadb`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mongo`\" pulumi-lang-dotnet=\"`Mongo`\" pulumi-lang-go=\"`mongo`\" pulumi-lang-python=\"`mongo`\" pulumi-lang-yaml=\"`mongo`\" pulumi-lang-java=\"`mongo`\" pulumi-lang-hcl=\"`mongo`\"\u003e`mongo`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`redis`\" pulumi-lang-dotnet=\"`Redis`\" pulumi-lang-go=\"`redis`\" pulumi-lang-python=\"`redis`\" pulumi-lang-yaml=\"`redis`\" pulumi-lang-java=\"`redis`\" pulumi-lang-hcl=\"`redis`\"\u003e`redis`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`libsql`\" pulumi-lang-dotnet=\"`Libsql`\" pulumi-lang-go=\"`libsql`\" pulumi-lang-python=\"`libsql`\" pulumi-lang-yaml=\"`libsql`\" pulumi-lang-java=\"`libsql`\" pulumi-lang-hcl=\"`libsql`\"\u003e`libsql`\u003c/span\u003e.\n"
},
"type": {
"type": "string",
"description": "The kind of mount to create. Valid values: \u003cspan pulumi-lang-nodejs=\"`bind`\" pulumi-lang-dotnet=\"`Bind`\" pulumi-lang-go=\"`bind`\" pulumi-lang-python=\"`bind`\" pulumi-lang-yaml=\"`bind`\" pulumi-lang-java=\"`bind`\" pulumi-lang-hcl=\"`bind`\"\u003e`bind`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n"
},
"volumeName": {
"type": "string",
"description": "Name of the Docker volume, when \u003cspan pulumi-lang-nodejs=\"`type`\" pulumi-lang-dotnet=\"`Type`\" pulumi-lang-go=\"`type`\" pulumi-lang-python=\"`type`\" pulumi-lang-yaml=\"`type`\" pulumi-lang-java=\"`type`\" pulumi-lang-hcl=\"`type`\"\u003e`type`\u003c/span\u003e is \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e.\n"
}
},
"type": "object"
}
},
"dokploy:index/mySql:MySql": {
"description": "A managed MySQL instance running on Dokploy.\n\n\u003e Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.\n\n\u003e Credentials are stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseRootPassword": {
"type": "string",
"description": "Password for the MySQL \u003cspan pulumi-lang-nodejs=\"`root`\" pulumi-lang-dotnet=\"`Root`\" pulumi-lang-go=\"`root`\" pulumi-lang-python=\"`root`\" pulumi-lang-yaml=\"`root`\" pulumi-lang-java=\"`root`\" pulumi-lang-hcl=\"`root`\"\u003e`root`\u003c/span\u003e user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MySQL image to run, for example `mysql:8`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"required": [
"appName",
"applicationStatus",
"args",
"createdAt",
"databaseName",
"databasePassword",
"databaseRootPassword",
"databaseUser",
"detachDokployNetwork",
"dockerImage",
"environmentId",
"name",
"networkIds",
"replicas"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseRootPassword": {
"type": "string",
"description": "Password for the MySQL \u003cspan pulumi-lang-nodejs=\"`root`\" pulumi-lang-dotnet=\"`Root`\" pulumi-lang-go=\"`root`\" pulumi-lang-python=\"`root`\" pulumi-lang-yaml=\"`root`\" pulumi-lang-java=\"`root`\" pulumi-lang-hcl=\"`root`\"\u003e`root`\u003c/span\u003e user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MySQL image to run, for example `mysql:8`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"requiredInputs": [
"databaseName",
"databasePassword",
"databaseRootPassword",
"databaseUser",
"dockerImage",
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering MySql resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseRootPassword": {
"type": "string",
"description": "Password for the MySQL \u003cspan pulumi-lang-nodejs=\"`root`\" pulumi-lang-dotnet=\"`Root`\" pulumi-lang-go=\"`root`\" pulumi-lang-python=\"`root`\" pulumi-lang-yaml=\"`root`\" pulumi-lang-java=\"`root`\" pulumi-lang-hcl=\"`root`\"\u003e`root`\u003c/span\u003e user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "MySQL image to run, for example `mysql:8`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"type": "object"
}
},
"dokploy:index/network:Network": {
"description": "A Docker network managed by Dokploy.\n\nAttach services to it with \u003cspan pulumi-lang-nodejs=\"`networkIds`\" pulumi-lang-dotnet=\"`NetworkIds`\" pulumi-lang-go=\"`networkIds`\" pulumi-lang-python=\"`network_ids`\" pulumi-lang-yaml=\"`networkIds`\" pulumi-lang-java=\"`networkIds`\" pulumi-lang-hcl=\"`network_ids`\"\u003e`networkIds`\u003c/span\u003e on \u003cspan pulumi-lang-nodejs=\"`dokploy.Application`\" pulumi-lang-dotnet=\"`dokploy.Application`\" pulumi-lang-go=\"`Application`\" pulumi-lang-python=\"`Application`\" pulumi-lang-yaml=\"`dokploy.Application`\" pulumi-lang-java=\"`dokploy.Application`\" pulumi-lang-hcl=\"`dokploy_application`\"\u003e`dokploy.Application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`dokploy.Compose`\" pulumi-lang-dotnet=\"`dokploy.Compose`\" pulumi-lang-go=\"`Compose`\" pulumi-lang-python=\"`Compose`\" pulumi-lang-yaml=\"`dokploy.Compose`\" pulumi-lang-java=\"`dokploy.Compose`\" pulumi-lang-hcl=\"`dokploy_compose`\"\u003e`dokploy.Compose`\u003c/span\u003e and the database resources. Every service also joins the shared `dokploy-network` unless \u003cspan pulumi-lang-nodejs=\"`detachDokployNetwork`\" pulumi-lang-dotnet=\"`DetachDokployNetwork`\" pulumi-lang-go=\"`detachDokployNetwork`\" pulumi-lang-python=\"`detach_dokploy_network`\" pulumi-lang-yaml=\"`detachDokployNetwork`\" pulumi-lang-java=\"`detachDokployNetwork`\" pulumi-lang-hcl=\"`detach_dokploy_network`\"\u003e`detachDokployNetwork`\u003c/span\u003e is set.\n\n\u003e Docker networks are immutable. Dokploy has no update endpoint, so changing any attribute replaces the network — which detaches the services currently using it until they redeploy.\n",
"properties": {
"attachable": {
"type": "boolean",
"description": "Allow standalone containers to attach to an overlay network.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the network was created.\n"
},
"driver": {
"type": "string",
"description": "Network driver. Use \u003cspan pulumi-lang-nodejs=\"`overlay`\" pulumi-lang-dotnet=\"`Overlay`\" pulumi-lang-go=\"`overlay`\" pulumi-lang-python=\"`overlay`\" pulumi-lang-yaml=\"`overlay`\" pulumi-lang-java=\"`overlay`\" pulumi-lang-hcl=\"`overlay`\"\u003e`overlay`\u003c/span\u003e for multi-node Swarm clusters and \u003cspan pulumi-lang-nodejs=\"`bridge`\" pulumi-lang-dotnet=\"`Bridge`\" pulumi-lang-go=\"`bridge`\" pulumi-lang-python=\"`bridge`\" pulumi-lang-yaml=\"`bridge`\" pulumi-lang-java=\"`bridge`\" pulumi-lang-hcl=\"`bridge`\"\u003e`bridge`\u003c/span\u003e for a single host. Valid values: \u003cspan pulumi-lang-nodejs=\"`bridge`\" pulumi-lang-dotnet=\"`Bridge`\" pulumi-lang-go=\"`bridge`\" pulumi-lang-python=\"`bridge`\" pulumi-lang-yaml=\"`bridge`\" pulumi-lang-java=\"`bridge`\" pulumi-lang-hcl=\"`bridge`\"\u003e`bridge`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`overlay`\" pulumi-lang-dotnet=\"`Overlay`\" pulumi-lang-go=\"`overlay`\" pulumi-lang-python=\"`overlay`\" pulumi-lang-yaml=\"`overlay`\" pulumi-lang-java=\"`overlay`\" pulumi-lang-hcl=\"`overlay`\"\u003e`overlay`\u003c/span\u003e.\n"
},
"enableIpv4": {
"type": "boolean",
"description": "Enable IPv4 address allocation.\n"
},
"enableIpv6": {
"type": "boolean",
"description": "Enable IPv6 address allocation.\n"
},
"internal": {
"type": "boolean",
"description": "Isolate the network from external access.\n"
},
"ipam": {
"type": "string",
"description": "Custom IP address management, as a JSON object with \u003cspan pulumi-lang-nodejs=\"`subnet`\" pulumi-lang-dotnet=\"`Subnet`\" pulumi-lang-go=\"`subnet`\" pulumi-lang-python=\"`subnet`\" pulumi-lang-yaml=\"`subnet`\" pulumi-lang-java=\"`subnet`\" pulumi-lang-hcl=\"`subnet`\"\u003e`subnet`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gateway`\" pulumi-lang-dotnet=\"`Gateway`\" pulumi-lang-go=\"`gateway`\" pulumi-lang-python=\"`gateway`\" pulumi-lang-yaml=\"`gateway`\" pulumi-lang-java=\"`gateway`\" pulumi-lang-hcl=\"`gateway`\"\u003e`gateway`\u003c/span\u003e and `ipRange` keys. Leave unset to let Docker choose a subnet.\n"
},
"mtu": {
"type": "integer",
"description": "Maximum transmission unit for the network. Leave unset to use Docker's default.\n"
},
"name": {
"type": "string",
"description": "Name of the Docker network.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the network.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to create the network on. Omit to use the Dokploy host itself.\n"
}
},
"required": [
"attachable",
"createdAt",
"driver",
"enableIpv4",
"enableIpv6",
"internal",
"name",
"organizationId"
],
"inputProperties": {
"attachable": {
"type": "boolean",
"description": "Allow standalone containers to attach to an overlay network.\n"
},
"driver": {
"type": "string",
"description": "Network driver. Use \u003cspan pulumi-lang-nodejs=\"`overlay`\" pulumi-lang-dotnet=\"`Overlay`\" pulumi-lang-go=\"`overlay`\" pulumi-lang-python=\"`overlay`\" pulumi-lang-yaml=\"`overlay`\" pulumi-lang-java=\"`overlay`\" pulumi-lang-hcl=\"`overlay`\"\u003e`overlay`\u003c/span\u003e for multi-node Swarm clusters and \u003cspan pulumi-lang-nodejs=\"`bridge`\" pulumi-lang-dotnet=\"`Bridge`\" pulumi-lang-go=\"`bridge`\" pulumi-lang-python=\"`bridge`\" pulumi-lang-yaml=\"`bridge`\" pulumi-lang-java=\"`bridge`\" pulumi-lang-hcl=\"`bridge`\"\u003e`bridge`\u003c/span\u003e for a single host. Valid values: \u003cspan pulumi-lang-nodejs=\"`bridge`\" pulumi-lang-dotnet=\"`Bridge`\" pulumi-lang-go=\"`bridge`\" pulumi-lang-python=\"`bridge`\" pulumi-lang-yaml=\"`bridge`\" pulumi-lang-java=\"`bridge`\" pulumi-lang-hcl=\"`bridge`\"\u003e`bridge`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`overlay`\" pulumi-lang-dotnet=\"`Overlay`\" pulumi-lang-go=\"`overlay`\" pulumi-lang-python=\"`overlay`\" pulumi-lang-yaml=\"`overlay`\" pulumi-lang-java=\"`overlay`\" pulumi-lang-hcl=\"`overlay`\"\u003e`overlay`\u003c/span\u003e.\n"
},
"enableIpv4": {
"type": "boolean",
"description": "Enable IPv4 address allocation.\n"
},
"enableIpv6": {
"type": "boolean",
"description": "Enable IPv6 address allocation.\n"
},
"internal": {
"type": "boolean",
"description": "Isolate the network from external access.\n"
},
"ipam": {
"type": "string",
"description": "Custom IP address management, as a JSON object with \u003cspan pulumi-lang-nodejs=\"`subnet`\" pulumi-lang-dotnet=\"`Subnet`\" pulumi-lang-go=\"`subnet`\" pulumi-lang-python=\"`subnet`\" pulumi-lang-yaml=\"`subnet`\" pulumi-lang-java=\"`subnet`\" pulumi-lang-hcl=\"`subnet`\"\u003e`subnet`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gateway`\" pulumi-lang-dotnet=\"`Gateway`\" pulumi-lang-go=\"`gateway`\" pulumi-lang-python=\"`gateway`\" pulumi-lang-yaml=\"`gateway`\" pulumi-lang-java=\"`gateway`\" pulumi-lang-hcl=\"`gateway`\"\u003e`gateway`\u003c/span\u003e and `ipRange` keys. Leave unset to let Docker choose a subnet.\n"
},
"mtu": {
"type": "integer",
"description": "Maximum transmission unit for the network. Leave unset to use Docker's default.\n"
},
"name": {
"type": "string",
"description": "Name of the Docker network.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to create the network on. Omit to use the Dokploy host itself.\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering Network resources.\n",
"properties": {
"attachable": {
"type": "boolean",
"description": "Allow standalone containers to attach to an overlay network.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the network was created.\n"
},
"driver": {
"type": "string",
"description": "Network driver. Use \u003cspan pulumi-lang-nodejs=\"`overlay`\" pulumi-lang-dotnet=\"`Overlay`\" pulumi-lang-go=\"`overlay`\" pulumi-lang-python=\"`overlay`\" pulumi-lang-yaml=\"`overlay`\" pulumi-lang-java=\"`overlay`\" pulumi-lang-hcl=\"`overlay`\"\u003e`overlay`\u003c/span\u003e for multi-node Swarm clusters and \u003cspan pulumi-lang-nodejs=\"`bridge`\" pulumi-lang-dotnet=\"`Bridge`\" pulumi-lang-go=\"`bridge`\" pulumi-lang-python=\"`bridge`\" pulumi-lang-yaml=\"`bridge`\" pulumi-lang-java=\"`bridge`\" pulumi-lang-hcl=\"`bridge`\"\u003e`bridge`\u003c/span\u003e for a single host. Valid values: \u003cspan pulumi-lang-nodejs=\"`bridge`\" pulumi-lang-dotnet=\"`Bridge`\" pulumi-lang-go=\"`bridge`\" pulumi-lang-python=\"`bridge`\" pulumi-lang-yaml=\"`bridge`\" pulumi-lang-java=\"`bridge`\" pulumi-lang-hcl=\"`bridge`\"\u003e`bridge`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`overlay`\" pulumi-lang-dotnet=\"`Overlay`\" pulumi-lang-go=\"`overlay`\" pulumi-lang-python=\"`overlay`\" pulumi-lang-yaml=\"`overlay`\" pulumi-lang-java=\"`overlay`\" pulumi-lang-hcl=\"`overlay`\"\u003e`overlay`\u003c/span\u003e.\n"
},
"enableIpv4": {
"type": "boolean",
"description": "Enable IPv4 address allocation.\n"
},
"enableIpv6": {
"type": "boolean",
"description": "Enable IPv6 address allocation.\n"
},
"internal": {
"type": "boolean",
"description": "Isolate the network from external access.\n"
},
"ipam": {
"type": "string",
"description": "Custom IP address management, as a JSON object with \u003cspan pulumi-lang-nodejs=\"`subnet`\" pulumi-lang-dotnet=\"`Subnet`\" pulumi-lang-go=\"`subnet`\" pulumi-lang-python=\"`subnet`\" pulumi-lang-yaml=\"`subnet`\" pulumi-lang-java=\"`subnet`\" pulumi-lang-hcl=\"`subnet`\"\u003e`subnet`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gateway`\" pulumi-lang-dotnet=\"`Gateway`\" pulumi-lang-go=\"`gateway`\" pulumi-lang-python=\"`gateway`\" pulumi-lang-yaml=\"`gateway`\" pulumi-lang-java=\"`gateway`\" pulumi-lang-hcl=\"`gateway`\"\u003e`gateway`\u003c/span\u003e and `ipRange` keys. Leave unset to let Docker choose a subnet.\n"
},
"mtu": {
"type": "integer",
"description": "Maximum transmission unit for the network. Leave unset to use Docker's default.\n"
},
"name": {
"type": "string",
"description": "Name of the Docker network.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the network.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to create the network on. Omit to use the Dokploy host itself.\n"
}
},
"type": "object"
}
},
"dokploy:index/port:Port": {
"description": "A published port that exposes an application directly on the host, bypassing Traefik.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application this port belongs to.\n"
},
"protocol": {
"type": "string",
"description": "Transport protocol. Valid values: \u003cspan pulumi-lang-nodejs=\"`tcp`\" pulumi-lang-dotnet=\"`Tcp`\" pulumi-lang-go=\"`tcp`\" pulumi-lang-python=\"`tcp`\" pulumi-lang-yaml=\"`tcp`\" pulumi-lang-java=\"`tcp`\" pulumi-lang-hcl=\"`tcp`\"\u003e`tcp`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`udp`\" pulumi-lang-dotnet=\"`Udp`\" pulumi-lang-go=\"`udp`\" pulumi-lang-python=\"`udp`\" pulumi-lang-yaml=\"`udp`\" pulumi-lang-java=\"`udp`\" pulumi-lang-hcl=\"`udp`\"\u003e`udp`\u003c/span\u003e.\n"
},
"publishMode": {
"type": "string",
"description": "Docker Swarm publish mode. \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e binds directly to the node; \u003cspan pulumi-lang-nodejs=\"`ingress`\" pulumi-lang-dotnet=\"`Ingress`\" pulumi-lang-go=\"`ingress`\" pulumi-lang-python=\"`ingress`\" pulumi-lang-yaml=\"`ingress`\" pulumi-lang-java=\"`ingress`\" pulumi-lang-hcl=\"`ingress`\"\u003e`ingress`\u003c/span\u003e uses the swarm routing mesh. Valid values: \u003cspan pulumi-lang-nodejs=\"`ingress`\" pulumi-lang-dotnet=\"`Ingress`\" pulumi-lang-go=\"`ingress`\" pulumi-lang-python=\"`ingress`\" pulumi-lang-yaml=\"`ingress`\" pulumi-lang-java=\"`ingress`\" pulumi-lang-hcl=\"`ingress`\"\u003e`ingress`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e.\n"
},
"publishedPort": {
"type": "integer",
"description": "Port exposed on the host.\n"
},
"targetPort": {
"type": "integer",
"description": "Port the container listens on.\n"
}
},
"required": [
"applicationId",
"protocol",
"publishMode",
"publishedPort",
"targetPort"
],
"inputProperties": {
"applicationId": {
"type": "string",
"description": "Application this port belongs to.\n"
},
"protocol": {
"type": "string",
"description": "Transport protocol. Valid values: \u003cspan pulumi-lang-nodejs=\"`tcp`\" pulumi-lang-dotnet=\"`Tcp`\" pulumi-lang-go=\"`tcp`\" pulumi-lang-python=\"`tcp`\" pulumi-lang-yaml=\"`tcp`\" pulumi-lang-java=\"`tcp`\" pulumi-lang-hcl=\"`tcp`\"\u003e`tcp`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`udp`\" pulumi-lang-dotnet=\"`Udp`\" pulumi-lang-go=\"`udp`\" pulumi-lang-python=\"`udp`\" pulumi-lang-yaml=\"`udp`\" pulumi-lang-java=\"`udp`\" pulumi-lang-hcl=\"`udp`\"\u003e`udp`\u003c/span\u003e.\n"
},
"publishMode": {
"type": "string",
"description": "Docker Swarm publish mode. \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e binds directly to the node; \u003cspan pulumi-lang-nodejs=\"`ingress`\" pulumi-lang-dotnet=\"`Ingress`\" pulumi-lang-go=\"`ingress`\" pulumi-lang-python=\"`ingress`\" pulumi-lang-yaml=\"`ingress`\" pulumi-lang-java=\"`ingress`\" pulumi-lang-hcl=\"`ingress`\"\u003e`ingress`\u003c/span\u003e uses the swarm routing mesh. Valid values: \u003cspan pulumi-lang-nodejs=\"`ingress`\" pulumi-lang-dotnet=\"`Ingress`\" pulumi-lang-go=\"`ingress`\" pulumi-lang-python=\"`ingress`\" pulumi-lang-yaml=\"`ingress`\" pulumi-lang-java=\"`ingress`\" pulumi-lang-hcl=\"`ingress`\"\u003e`ingress`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e.\n"
},
"publishedPort": {
"type": "integer",
"description": "Port exposed on the host.\n"
},
"targetPort": {
"type": "integer",
"description": "Port the container listens on.\n"
}
},
"requiredInputs": [
"applicationId",
"protocol",
"publishedPort",
"targetPort"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Port resources.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application this port belongs to.\n"
},
"protocol": {
"type": "string",
"description": "Transport protocol. Valid values: \u003cspan pulumi-lang-nodejs=\"`tcp`\" pulumi-lang-dotnet=\"`Tcp`\" pulumi-lang-go=\"`tcp`\" pulumi-lang-python=\"`tcp`\" pulumi-lang-yaml=\"`tcp`\" pulumi-lang-java=\"`tcp`\" pulumi-lang-hcl=\"`tcp`\"\u003e`tcp`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`udp`\" pulumi-lang-dotnet=\"`Udp`\" pulumi-lang-go=\"`udp`\" pulumi-lang-python=\"`udp`\" pulumi-lang-yaml=\"`udp`\" pulumi-lang-java=\"`udp`\" pulumi-lang-hcl=\"`udp`\"\u003e`udp`\u003c/span\u003e.\n"
},
"publishMode": {
"type": "string",
"description": "Docker Swarm publish mode. \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e binds directly to the node; \u003cspan pulumi-lang-nodejs=\"`ingress`\" pulumi-lang-dotnet=\"`Ingress`\" pulumi-lang-go=\"`ingress`\" pulumi-lang-python=\"`ingress`\" pulumi-lang-yaml=\"`ingress`\" pulumi-lang-java=\"`ingress`\" pulumi-lang-hcl=\"`ingress`\"\u003e`ingress`\u003c/span\u003e uses the swarm routing mesh. Valid values: \u003cspan pulumi-lang-nodejs=\"`ingress`\" pulumi-lang-dotnet=\"`Ingress`\" pulumi-lang-go=\"`ingress`\" pulumi-lang-python=\"`ingress`\" pulumi-lang-yaml=\"`ingress`\" pulumi-lang-java=\"`ingress`\" pulumi-lang-hcl=\"`ingress`\"\u003e`ingress`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e.\n"
},
"publishedPort": {
"type": "integer",
"description": "Port exposed on the host.\n"
},
"targetPort": {
"type": "integer",
"description": "Port the container listens on.\n"
}
},
"type": "object"
}
},
"dokploy:index/postgres:Postgres": {
"description": "A managed PostgreSQL instance running on Dokploy.\n\n\u003e Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.\n\n\u003e Credentials are stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "PostgreSQL image to run, for example `postgres:16`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"required": [
"appName",
"applicationStatus",
"args",
"createdAt",
"databaseName",
"databasePassword",
"databaseUser",
"detachDokployNetwork",
"dockerImage",
"environmentId",
"name",
"networkIds",
"replicas"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "PostgreSQL image to run, for example `postgres:16`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"requiredInputs": [
"databaseName",
"databasePassword",
"databaseUser",
"dockerImage",
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Postgres resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databaseName": {
"type": "string",
"description": "Name of the database to create.\n"
},
"databasePassword": {
"type": "string",
"description": "Password for the database user.\n",
"secret": true
},
"databaseUser": {
"type": "string",
"description": "Database user to create.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "PostgreSQL image to run, for example `postgres:16`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"type": "object"
}
},
"dokploy:index/project:Project": {
"description": "A Dokploy project: the top-level container for environments and services.\n\nCreating a project automatically creates a default \u003cspan pulumi-lang-nodejs=\"`production`\" pulumi-lang-dotnet=\"`Production`\" pulumi-lang-go=\"`production`\" pulumi-lang-python=\"`production`\" pulumi-lang-yaml=\"`production`\" pulumi-lang-java=\"`production`\" pulumi-lang-hcl=\"`production`\"\u003e`production`\u003c/span\u003e environment. Its ID is exposed as \u003cspan pulumi-lang-nodejs=\"`defaultEnvironmentId`\" pulumi-lang-dotnet=\"`DefaultEnvironmentId`\" pulumi-lang-go=\"`defaultEnvironmentId`\" pulumi-lang-python=\"`default_environment_id`\" pulumi-lang-yaml=\"`defaultEnvironmentId`\" pulumi-lang-java=\"`defaultEnvironmentId`\" pulumi-lang-hcl=\"`default_environment_id`\"\u003e`defaultEnvironmentId`\u003c/span\u003e, so services can be attached without declaring a separate \u003cspan pulumi-lang-nodejs=\"`dokploy.Environment`\" pulumi-lang-dotnet=\"`dokploy.Environment`\" pulumi-lang-go=\"`Environment`\" pulumi-lang-python=\"`Environment`\" pulumi-lang-yaml=\"`dokploy.Environment`\" pulumi-lang-java=\"`dokploy.Environment`\" pulumi-lang-hcl=\"`dokploy_environment`\"\u003e`dokploy.Environment`\u003c/span\u003e resource.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the project was created.\n"
},
"defaultEnvironmentId": {
"type": "string",
"description": "ID of the \u003cspan pulumi-lang-nodejs=\"`production`\" pulumi-lang-dotnet=\"`Production`\" pulumi-lang-go=\"`production`\" pulumi-lang-python=\"`production`\" pulumi-lang-yaml=\"`production`\" pulumi-lang-java=\"`production`\" pulumi-lang-hcl=\"`production`\"\u003e`production`\u003c/span\u003e environment that Dokploy creates automatically with the project.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"env": {
"type": "string",
"description": "Project-wide environment variables in `KEY=value` format, one per line. These are shared with every service in the project.\n"
},
"name": {
"type": "string",
"description": "Display name of the project.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the project.\n"
}
},
"required": [
"createdAt",
"defaultEnvironmentId",
"env",
"name",
"organizationId"
],
"inputProperties": {
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"env": {
"type": "string",
"description": "Project-wide environment variables in `KEY=value` format, one per line. These are shared with every service in the project.\n"
},
"name": {
"type": "string",
"description": "Display name of the project.\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering Project resources.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the project was created.\n"
},
"defaultEnvironmentId": {
"type": "string",
"description": "ID of the \u003cspan pulumi-lang-nodejs=\"`production`\" pulumi-lang-dotnet=\"`Production`\" pulumi-lang-go=\"`production`\" pulumi-lang-python=\"`production`\" pulumi-lang-yaml=\"`production`\" pulumi-lang-java=\"`production`\" pulumi-lang-hcl=\"`production`\"\u003e`production`\u003c/span\u003e environment that Dokploy creates automatically with the project.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"env": {
"type": "string",
"description": "Project-wide environment variables in `KEY=value` format, one per line. These are shared with every service in the project.\n"
},
"name": {
"type": "string",
"description": "Display name of the project.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the project.\n"
}
},
"type": "object"
}
},
"dokploy:index/redirect:Redirect": {
"description": "A Traefik redirect rule attached to an application.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application this redirect belongs to.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the redirect was created.\n"
},
"permanent": {
"type": "boolean",
"description": "Issue a permanent (301) redirect instead of a temporary (302) one.\n"
},
"regex": {
"type": "string",
"description": "Regular expression matched against the incoming URL.\n"
},
"replacement": {
"type": "string",
"description": "Replacement URL, which may reference capture groups such as `${1}`.\n"
}
},
"required": [
"applicationId",
"createdAt",
"permanent",
"regex",
"replacement"
],
"inputProperties": {
"applicationId": {
"type": "string",
"description": "Application this redirect belongs to.\n"
},
"permanent": {
"type": "boolean",
"description": "Issue a permanent (301) redirect instead of a temporary (302) one.\n"
},
"regex": {
"type": "string",
"description": "Regular expression matched against the incoming URL.\n"
},
"replacement": {
"type": "string",
"description": "Replacement URL, which may reference capture groups such as `${1}`.\n"
}
},
"requiredInputs": [
"applicationId",
"regex",
"replacement"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Redirect resources.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application this redirect belongs to.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the redirect was created.\n"
},
"permanent": {
"type": "boolean",
"description": "Issue a permanent (301) redirect instead of a temporary (302) one.\n"
},
"regex": {
"type": "string",
"description": "Regular expression matched against the incoming URL.\n"
},
"replacement": {
"type": "string",
"description": "Replacement URL, which may reference capture groups such as `${1}`.\n"
}
},
"type": "object"
}
},
"dokploy:index/redis:Redis": {
"description": "A managed Redis instance running on Dokploy.\n\n\u003e Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.\n\n\u003e Credentials are stored in Terraform state. Use a state backend with encryption at rest.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databasePassword": {
"type": "string",
"description": "Password used to authenticate to Redis.\n",
"secret": true
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "Redis image to run, for example `redis:7`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"required": [
"appName",
"applicationStatus",
"args",
"createdAt",
"databasePassword",
"detachDokployNetwork",
"dockerImage",
"environmentId",
"name",
"networkIds",
"replicas"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"databasePassword": {
"type": "string",
"description": "Password used to authenticate to Redis.\n",
"secret": true
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "Redis image to run, for example `redis:7`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"requiredInputs": [
"databasePassword",
"dockerImage",
"environmentId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Redis resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.\n"
},
"applicationStatus": {
"type": "string",
"description": "Current status reported by Dokploy: \u003cspan pulumi-lang-nodejs=\"`idle`\" pulumi-lang-dotnet=\"`Idle`\" pulumi-lang-go=\"`idle`\" pulumi-lang-python=\"`idle`\" pulumi-lang-yaml=\"`idle`\" pulumi-lang-java=\"`idle`\" pulumi-lang-hcl=\"`idle`\"\u003e`idle`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`running`\" pulumi-lang-dotnet=\"`Running`\" pulumi-lang-go=\"`running`\" pulumi-lang-python=\"`running`\" pulumi-lang-yaml=\"`running`\" pulumi-lang-java=\"`running`\" pulumi-lang-hcl=\"`running`\"\u003e`running`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`done`\" pulumi-lang-dotnet=\"`Done`\" pulumi-lang-go=\"`done`\" pulumi-lang-python=\"`done`\" pulumi-lang-yaml=\"`done`\" pulumi-lang-java=\"`done`\" pulumi-lang-hcl=\"`done`\"\u003e`done`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`error`\" pulumi-lang-dotnet=\"`Error`\" pulumi-lang-go=\"`error`\" pulumi-lang-python=\"`error`\" pulumi-lang-yaml=\"`error`\" pulumi-lang-java=\"`error`\" pulumi-lang-hcl=\"`error`\"\u003e`error`\u003c/span\u003e.\n"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments appended to the container command.\n"
},
"command": {
"type": "string",
"description": "Override the container entrypoint command.\n"
},
"cpuLimit": {
"type": "string",
"description": "Hard CPU limit, for example \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e.\n"
},
"cpuReservation": {
"type": "string",
"description": "Soft CPU reservation, for example `0.5`.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the database was created.\n"
},
"databasePassword": {
"type": "string",
"description": "Password used to authenticate to Redis.\n",
"secret": true
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"detachDokployNetwork": {
"type": "boolean",
"description": "Detach the service from the shared `dokploy-network`.\n"
},
"dockerImage": {
"type": "string",
"description": "Redis image to run, for example `redis:7`.\n"
},
"endpointSpecSwarm": {
"type": "string",
"description": "Docker Swarm endpoint specification, as a JSON object.\n"
},
"env": {
"type": "string",
"description": "Environment variables in `KEY=value` format, one per line.\n"
},
"environmentId": {
"type": "string",
"description": "Environment this database belongs to.\n"
},
"externalPort": {
"type": "integer",
"description": "Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.\n"
},
"healthCheckSwarm": {
"type": "string",
"description": "Docker Swarm health check configuration, as a JSON object.\n"
},
"labelsSwarm": {
"type": "string",
"description": "Docker Swarm service labels, as a JSON object.\n"
},
"memoryLimit": {
"type": "string",
"description": "Hard memory limit, for example \u003cspan pulumi-lang-nodejs=\"`512m`\" pulumi-lang-dotnet=\"`512m`\" pulumi-lang-go=\"`512m`\" pulumi-lang-python=\"`512m`\" pulumi-lang-yaml=\"`512m`\" pulumi-lang-java=\"`512m`\" pulumi-lang-hcl=\"`512m`\"\u003e`512m`\u003c/span\u003e.\n"
},
"memoryReservation": {
"type": "string",
"description": "Soft memory reservation, for example \u003cspan pulumi-lang-nodejs=\"`256m`\" pulumi-lang-dotnet=\"`256m`\" pulumi-lang-go=\"`256m`\" pulumi-lang-python=\"`256m`\" pulumi-lang-yaml=\"`256m`\" pulumi-lang-java=\"`256m`\" pulumi-lang-hcl=\"`256m`\"\u003e`256m`\u003c/span\u003e.\n"
},
"modeSwarm": {
"type": "string",
"description": "Docker Swarm service mode, as a JSON object.\n"
},
"name": {
"type": "string",
"description": "Display name of the database.\n"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of additional Docker networks to attach.\n"
},
"networkSwarm": {
"type": "string",
"description": "Docker Swarm network attachments, as a JSON array.\n"
},
"placementSwarm": {
"type": "string",
"description": "Docker Swarm placement constraints, as a JSON object.\n"
},
"replicas": {
"type": "integer",
"description": "Number of replicas to run.\n"
},
"restartPolicySwarm": {
"type": "string",
"description": "Docker Swarm restart policy, as a JSON object.\n"
},
"rollbackConfigSwarm": {
"type": "string",
"description": "Docker Swarm rollback configuration, as a JSON object.\n"
},
"serverId": {
"type": "string",
"description": "Remote server to deploy on. Omit to use the Dokploy host itself.\n"
},
"stopGracePeriodSwarm": {
"type": "integer",
"description": "Grace period in nanoseconds before a container is killed.\n"
},
"ulimitsSwarm": {
"type": "string",
"description": "Docker Swarm ulimits, as a JSON object.\n"
},
"updateConfigSwarm": {
"type": "string",
"description": "Docker Swarm rolling update configuration, as a JSON object.\n"
}
},
"type": "object"
}
},
"dokploy:index/registry:Registry": {
"description": "A container registry that Dokploy pushes built images to and pulls them from.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the registry was created.\n"
},
"imagePrefix": {
"type": "string",
"description": "Prefix prepended to pushed image names, for example an organization or namespace.\n"
},
"password": {
"type": "string",
"description": "Password or access token used to authenticate.\n",
"secret": true
},
"registryName": {
"type": "string",
"description": "Display name of the registry.\n"
},
"registryType": {
"type": "string",
"description": "Registry kind. Dokploy currently accepts only \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e. Valid values: \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e.\n"
},
"registryUrl": {
"type": "string",
"description": "Registry hostname, for example `ghcr.io`.\n"
},
"serverId": {
"type": "string",
"description": "Server this registry is scoped to.\n"
},
"username": {
"type": "string",
"description": "Username used to authenticate to the registry.\n"
}
},
"required": [
"createdAt",
"password",
"registryName",
"registryType",
"registryUrl",
"username"
],
"inputProperties": {
"imagePrefix": {
"type": "string",
"description": "Prefix prepended to pushed image names, for example an organization or namespace.\n"
},
"password": {
"type": "string",
"description": "Password or access token used to authenticate.\n",
"secret": true
},
"registryName": {
"type": "string",
"description": "Display name of the registry.\n"
},
"registryType": {
"type": "string",
"description": "Registry kind. Dokploy currently accepts only \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e. Valid values: \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e.\n"
},
"registryUrl": {
"type": "string",
"description": "Registry hostname, for example `ghcr.io`.\n"
},
"serverId": {
"type": "string",
"description": "Server this registry is scoped to.\n"
},
"username": {
"type": "string",
"description": "Username used to authenticate to the registry.\n"
}
},
"requiredInputs": [
"password",
"registryName",
"registryUrl",
"username"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Registry resources.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the registry was created.\n"
},
"imagePrefix": {
"type": "string",
"description": "Prefix prepended to pushed image names, for example an organization or namespace.\n"
},
"password": {
"type": "string",
"description": "Password or access token used to authenticate.\n",
"secret": true
},
"registryName": {
"type": "string",
"description": "Display name of the registry.\n"
},
"registryType": {
"type": "string",
"description": "Registry kind. Dokploy currently accepts only \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e. Valid values: \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`cloud`\" pulumi-lang-dotnet=\"`Cloud`\" pulumi-lang-go=\"`cloud`\" pulumi-lang-python=\"`cloud`\" pulumi-lang-yaml=\"`cloud`\" pulumi-lang-java=\"`cloud`\" pulumi-lang-hcl=\"`cloud`\"\u003e`cloud`\u003c/span\u003e.\n"
},
"registryUrl": {
"type": "string",
"description": "Registry hostname, for example `ghcr.io`.\n"
},
"serverId": {
"type": "string",
"description": "Server this registry is scoped to.\n"
},
"username": {
"type": "string",
"description": "Username used to authenticate to the registry.\n"
}
},
"type": "object"
}
},
"dokploy:index/schedule:Schedule": {
"description": "A cron job Dokploy runs on a schedule.\n\n\u003cspan pulumi-lang-nodejs=\"`scheduleType`\" pulumi-lang-dotnet=\"`ScheduleType`\" pulumi-lang-go=\"`scheduleType`\" pulumi-lang-python=\"`schedule_type`\" pulumi-lang-yaml=\"`scheduleType`\" pulumi-lang-java=\"`scheduleType`\" pulumi-lang-hcl=\"`schedule_type`\"\u003e`scheduleType`\u003c/span\u003e selects where the command runs:\n\n* \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e — inside a running application container; set \u003cspan pulumi-lang-nodejs=\"`applicationId`\" pulumi-lang-dotnet=\"`ApplicationId`\" pulumi-lang-go=\"`applicationId`\" pulumi-lang-python=\"`application_id`\" pulumi-lang-yaml=\"`applicationId`\" pulumi-lang-java=\"`applicationId`\" pulumi-lang-hcl=\"`application_id`\"\u003e`applicationId`\u003c/span\u003e.\n* \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e — inside one service of a Compose stack; set \u003cspan pulumi-lang-nodejs=\"`composeId`\" pulumi-lang-dotnet=\"`ComposeId`\" pulumi-lang-go=\"`composeId`\" pulumi-lang-python=\"`compose_id`\" pulumi-lang-yaml=\"`composeId`\" pulumi-lang-java=\"`composeId`\" pulumi-lang-hcl=\"`compose_id`\"\u003e`composeId`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`serviceName`\" pulumi-lang-dotnet=\"`ServiceName`\" pulumi-lang-go=\"`serviceName`\" pulumi-lang-python=\"`service_name`\" pulumi-lang-yaml=\"`serviceName`\" pulumi-lang-java=\"`serviceName`\" pulumi-lang-hcl=\"`service_name`\"\u003e`serviceName`\u003c/span\u003e.\n* \u003cspan pulumi-lang-nodejs=\"`server`\" pulumi-lang-dotnet=\"`Server`\" pulumi-lang-go=\"`server`\" pulumi-lang-python=\"`server`\" pulumi-lang-yaml=\"`server`\" pulumi-lang-java=\"`server`\" pulumi-lang-hcl=\"`server`\"\u003e`server`\u003c/span\u003e — on a remote server; set \u003cspan pulumi-lang-nodejs=\"`serverId`\" pulumi-lang-dotnet=\"`ServerId`\" pulumi-lang-go=\"`serverId`\" pulumi-lang-python=\"`server_id`\" pulumi-lang-yaml=\"`serverId`\" pulumi-lang-java=\"`serverId`\" pulumi-lang-hcl=\"`server_id`\"\u003e`serverId`\u003c/span\u003e.\n* `dokploy-server` — on the Dokploy host itself.\n\n\u003e A schedule targeting an application runs inside its container, so the container has to be running when the cron fires.\n",
"properties": {
"appName": {
"type": "string",
"description": "Docker service name the schedule targets. Derived by Dokploy when omitted.\n"
},
"applicationId": {
"type": "string",
"description": "Application this schedule belongs to.\n"
},
"command": {
"type": "string",
"description": "Command to run.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack this schedule belongs to.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the schedule was created.\n"
},
"cronExpression": {
"type": "string",
"description": "Standard five-field cron expression, for example `0 3 * * *`.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the schedule is active.\n"
},
"name": {
"type": "string",
"description": "Display name of the schedule.\n"
},
"scheduleType": {
"type": "string",
"description": "Where the command runs. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`server`\" pulumi-lang-dotnet=\"`Server`\" pulumi-lang-go=\"`server`\" pulumi-lang-python=\"`server`\" pulumi-lang-yaml=\"`server`\" pulumi-lang-java=\"`server`\" pulumi-lang-hcl=\"`server`\"\u003e`server`\u003c/span\u003e, `dokploy-server`. Defaults to \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e.\n"
},
"script": {
"type": "string",
"description": "Multi-line script to run instead of a single command.\n"
},
"serverId": {
"type": "string",
"description": "Server this schedule runs on.\n"
},
"serviceName": {
"type": "string",
"description": "Service inside a Compose stack to run the command in.\n"
},
"shellType": {
"type": "string",
"description": "Shell used to interpret the command. Valid values: \u003cspan pulumi-lang-nodejs=\"`bash`\" pulumi-lang-dotnet=\"`Bash`\" pulumi-lang-go=\"`bash`\" pulumi-lang-python=\"`bash`\" pulumi-lang-yaml=\"`bash`\" pulumi-lang-java=\"`bash`\" pulumi-lang-hcl=\"`bash`\"\u003e`bash`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`sh`\" pulumi-lang-dotnet=\"`Sh`\" pulumi-lang-go=\"`sh`\" pulumi-lang-python=\"`sh`\" pulumi-lang-yaml=\"`sh`\" pulumi-lang-java=\"`sh`\" pulumi-lang-hcl=\"`sh`\"\u003e`sh`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`bash`\" pulumi-lang-dotnet=\"`Bash`\" pulumi-lang-go=\"`bash`\" pulumi-lang-python=\"`bash`\" pulumi-lang-yaml=\"`bash`\" pulumi-lang-java=\"`bash`\" pulumi-lang-hcl=\"`bash`\"\u003e`bash`\u003c/span\u003e.\n"
},
"timezone": {
"type": "string",
"description": "IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.\n"
}
},
"required": [
"appName",
"command",
"createdAt",
"cronExpression",
"enabled",
"name",
"scheduleType",
"shellType"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Docker service name the schedule targets. Derived by Dokploy when omitted.\n"
},
"applicationId": {
"type": "string",
"description": "Application this schedule belongs to.\n"
},
"command": {
"type": "string",
"description": "Command to run.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack this schedule belongs to.\n"
},
"cronExpression": {
"type": "string",
"description": "Standard five-field cron expression, for example `0 3 * * *`.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the schedule is active.\n"
},
"name": {
"type": "string",
"description": "Display name of the schedule.\n"
},
"scheduleType": {
"type": "string",
"description": "Where the command runs. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`server`\" pulumi-lang-dotnet=\"`Server`\" pulumi-lang-go=\"`server`\" pulumi-lang-python=\"`server`\" pulumi-lang-yaml=\"`server`\" pulumi-lang-java=\"`server`\" pulumi-lang-hcl=\"`server`\"\u003e`server`\u003c/span\u003e, `dokploy-server`. Defaults to \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e.\n"
},
"script": {
"type": "string",
"description": "Multi-line script to run instead of a single command.\n"
},
"serverId": {
"type": "string",
"description": "Server this schedule runs on.\n"
},
"serviceName": {
"type": "string",
"description": "Service inside a Compose stack to run the command in.\n"
},
"shellType": {
"type": "string",
"description": "Shell used to interpret the command. Valid values: \u003cspan pulumi-lang-nodejs=\"`bash`\" pulumi-lang-dotnet=\"`Bash`\" pulumi-lang-go=\"`bash`\" pulumi-lang-python=\"`bash`\" pulumi-lang-yaml=\"`bash`\" pulumi-lang-java=\"`bash`\" pulumi-lang-hcl=\"`bash`\"\u003e`bash`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`sh`\" pulumi-lang-dotnet=\"`Sh`\" pulumi-lang-go=\"`sh`\" pulumi-lang-python=\"`sh`\" pulumi-lang-yaml=\"`sh`\" pulumi-lang-java=\"`sh`\" pulumi-lang-hcl=\"`sh`\"\u003e`sh`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`bash`\" pulumi-lang-dotnet=\"`Bash`\" pulumi-lang-go=\"`bash`\" pulumi-lang-python=\"`bash`\" pulumi-lang-yaml=\"`bash`\" pulumi-lang-java=\"`bash`\" pulumi-lang-hcl=\"`bash`\"\u003e`bash`\u003c/span\u003e.\n"
},
"timezone": {
"type": "string",
"description": "IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.\n"
}
},
"requiredInputs": [
"command",
"cronExpression"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Schedule resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Docker service name the schedule targets. Derived by Dokploy when omitted.\n"
},
"applicationId": {
"type": "string",
"description": "Application this schedule belongs to.\n"
},
"command": {
"type": "string",
"description": "Command to run.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack this schedule belongs to.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the schedule was created.\n"
},
"cronExpression": {
"type": "string",
"description": "Standard five-field cron expression, for example `0 3 * * *`.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the schedule is active.\n"
},
"name": {
"type": "string",
"description": "Display name of the schedule.\n"
},
"scheduleType": {
"type": "string",
"description": "Where the command runs. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`server`\" pulumi-lang-dotnet=\"`Server`\" pulumi-lang-go=\"`server`\" pulumi-lang-python=\"`server`\" pulumi-lang-yaml=\"`server`\" pulumi-lang-java=\"`server`\" pulumi-lang-hcl=\"`server`\"\u003e`server`\u003c/span\u003e, `dokploy-server`. Defaults to \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e.\n"
},
"script": {
"type": "string",
"description": "Multi-line script to run instead of a single command.\n"
},
"serverId": {
"type": "string",
"description": "Server this schedule runs on.\n"
},
"serviceName": {
"type": "string",
"description": "Service inside a Compose stack to run the command in.\n"
},
"shellType": {
"type": "string",
"description": "Shell used to interpret the command. Valid values: \u003cspan pulumi-lang-nodejs=\"`bash`\" pulumi-lang-dotnet=\"`Bash`\" pulumi-lang-go=\"`bash`\" pulumi-lang-python=\"`bash`\" pulumi-lang-yaml=\"`bash`\" pulumi-lang-java=\"`bash`\" pulumi-lang-hcl=\"`bash`\"\u003e`bash`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`sh`\" pulumi-lang-dotnet=\"`Sh`\" pulumi-lang-go=\"`sh`\" pulumi-lang-python=\"`sh`\" pulumi-lang-yaml=\"`sh`\" pulumi-lang-java=\"`sh`\" pulumi-lang-hcl=\"`sh`\"\u003e`sh`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`bash`\" pulumi-lang-dotnet=\"`Bash`\" pulumi-lang-go=\"`bash`\" pulumi-lang-python=\"`bash`\" pulumi-lang-yaml=\"`bash`\" pulumi-lang-java=\"`bash`\" pulumi-lang-hcl=\"`bash`\"\u003e`bash`\u003c/span\u003e.\n"
},
"timezone": {
"type": "string",
"description": "IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.\n"
}
},
"type": "object"
}
},
"dokploy:index/security:Security": {
"description": "HTTP basic authentication credentials protecting an application's domains.\n\n\u003e Dokploy stores the password hashed and does not return it. The value in Terraform state is the one you configured.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application these credentials protect.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the credentials were created.\n"
},
"password": {
"type": "string",
"description": "Basic auth password.\n",
"secret": true
},
"username": {
"type": "string",
"description": "Basic auth username.\n"
}
},
"required": [
"applicationId",
"createdAt",
"password",
"username"
],
"inputProperties": {
"applicationId": {
"type": "string",
"description": "Application these credentials protect.\n"
},
"password": {
"type": "string",
"description": "Basic auth password.\n",
"secret": true
},
"username": {
"type": "string",
"description": "Basic auth username.\n"
}
},
"requiredInputs": [
"applicationId",
"password",
"username"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering Security resources.\n",
"properties": {
"applicationId": {
"type": "string",
"description": "Application these credentials protect.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the credentials were created.\n"
},
"password": {
"type": "string",
"description": "Basic auth password.\n",
"secret": true
},
"username": {
"type": "string",
"description": "Basic auth username.\n"
}
},
"type": "object"
}
},
"dokploy:index/sshKey:SshKey": {
"description": "An SSH key pair Dokploy uses to clone private Git repositories and to reach remote servers.\n\n\u003e The private key is stored in Terraform state. Use a state backend with encryption at rest.\n\n\u003e Dokploy's update endpoint only accepts \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`description`\" pulumi-lang-dotnet=\"`Description`\" pulumi-lang-go=\"`description`\" pulumi-lang-python=\"`description`\" pulumi-lang-yaml=\"`description`\" pulumi-lang-java=\"`description`\" pulumi-lang-hcl=\"`description`\"\u003e`description`\u003c/span\u003e. Changing either key forces a new resource.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the key was created.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"lastUsedAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the key was last used, if ever.\n"
},
"name": {
"type": "string",
"description": "Display name of the key pair.\n"
},
"privateKey": {
"type": "string",
"description": "PEM-encoded private key.\n",
"secret": true
},
"publicKey": {
"type": "string",
"description": "OpenSSH-formatted public key.\n"
}
},
"required": [
"createdAt",
"lastUsedAt",
"name",
"privateKey",
"publicKey"
],
"inputProperties": {
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"name": {
"type": "string",
"description": "Display name of the key pair.\n"
},
"privateKey": {
"type": "string",
"description": "PEM-encoded private key.\n",
"secret": true
},
"publicKey": {
"type": "string",
"description": "OpenSSH-formatted public key.\n"
}
},
"requiredInputs": [
"privateKey",
"publicKey"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering SshKey resources.\n",
"properties": {
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the key was created.\n"
},
"description": {
"type": "string",
"description": "Free-form description.\n"
},
"lastUsedAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the key was last used, if ever.\n"
},
"name": {
"type": "string",
"description": "Display name of the key pair.\n"
},
"privateKey": {
"type": "string",
"description": "PEM-encoded private key.\n",
"secret": true
},
"publicKey": {
"type": "string",
"description": "OpenSSH-formatted public key.\n"
}
},
"type": "object"
}
},
"dokploy:index/vaultProvider:VaultProvider": {
"description": "An external secret manager Dokploy resolves environment variables from at deploy time.\n\nReference a secret from any \u003cspan pulumi-lang-nodejs=\"`env`\" pulumi-lang-dotnet=\"`Env`\" pulumi-lang-go=\"`env`\" pulumi-lang-python=\"`env`\" pulumi-lang-yaml=\"`env`\" pulumi-lang-java=\"`env`\" pulumi-lang-hcl=\"`env`\"\u003e`env`\u003c/span\u003e value with `${{vault.\u003cscope\u003e.\u003ckey\u003e}}`. The value is fetched when the deployment runs and is never stored in Dokploy — so rotating it in the vault takes effect on the next deploy with no Terraform change.\n\nSupported `providerType` values: \u003cspan pulumi-lang-nodejs=\"`hashicorp`\" pulumi-lang-dotnet=\"`Hashicorp`\" pulumi-lang-go=\"`hashicorp`\" pulumi-lang-python=\"`hashicorp`\" pulumi-lang-yaml=\"`hashicorp`\" pulumi-lang-java=\"`hashicorp`\" pulumi-lang-hcl=\"`hashicorp`\"\u003e`hashicorp`\u003c/span\u003e (Vault/OpenBao), \u003cspan pulumi-lang-nodejs=\"`infisical`\" pulumi-lang-dotnet=\"`Infisical`\" pulumi-lang-go=\"`infisical`\" pulumi-lang-python=\"`infisical`\" pulumi-lang-yaml=\"`infisical`\" pulumi-lang-java=\"`infisical`\" pulumi-lang-hcl=\"`infisical`\"\u003e`infisical`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`aws`\" pulumi-lang-dotnet=\"`Aws`\" pulumi-lang-go=\"`aws`\" pulumi-lang-python=\"`aws`\" pulumi-lang-yaml=\"`aws`\" pulumi-lang-java=\"`aws`\" pulumi-lang-hcl=\"`aws`\"\u003e`aws`\u003c/span\u003e (Secrets Manager), \u003cspan pulumi-lang-nodejs=\"`doppler`\" pulumi-lang-dotnet=\"`Doppler`\" pulumi-lang-go=\"`doppler`\" pulumi-lang-python=\"`doppler`\" pulumi-lang-yaml=\"`doppler`\" pulumi-lang-java=\"`doppler`\" pulumi-lang-hcl=\"`doppler`\"\u003e`doppler`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`azure`\" pulumi-lang-dotnet=\"`Azure`\" pulumi-lang-go=\"`azure`\" pulumi-lang-python=\"`azure`\" pulumi-lang-yaml=\"`azure`\" pulumi-lang-java=\"`azure`\" pulumi-lang-hcl=\"`azure`\"\u003e`azure`\u003c/span\u003e (Key Vault) and \u003cspan pulumi-lang-nodejs=\"`scaleway`\" pulumi-lang-dotnet=\"`Scaleway`\" pulumi-lang-go=\"`scaleway`\" pulumi-lang-python=\"`scaleway`\" pulumi-lang-yaml=\"`scaleway`\" pulumi-lang-java=\"`scaleway`\" pulumi-lang-hcl=\"`scaleway`\"\u003e`scaleway`\u003c/span\u003e.\n\n",
"properties": {
"assignments": {
"type": "string",
"description": "JSON array scoping which projects or environments may resolve secrets from this provider. Pass `jsonencode([])` to leave it unscoped.\n"
},
"config": {
"type": "string",
"description": "Provider credentials as a JSON object, including the `providerType` discriminator.\n",
"secret": true
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the connection was created.\n"
},
"name": {
"type": "string",
"description": "Name of the connection, unique within the organization.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the connection.\n"
},
"providerType": {
"type": "string",
"description": "Provider kind derived from \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e.\n"
}
},
"required": [
"assignments",
"config",
"createdAt",
"name",
"organizationId",
"providerType"
],
"inputProperties": {
"assignments": {
"type": "string",
"description": "JSON array scoping which projects or environments may resolve secrets from this provider. Pass `jsonencode([])` to leave it unscoped.\n"
},
"config": {
"type": "string",
"description": "Provider credentials as a JSON object, including the `providerType` discriminator.\n",
"secret": true
},
"name": {
"type": "string",
"description": "Name of the connection, unique within the organization.\n"
}
},
"requiredInputs": [
"assignments",
"config"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering VaultProvider resources.\n",
"properties": {
"assignments": {
"type": "string",
"description": "JSON array scoping which projects or environments may resolve secrets from this provider. Pass `jsonencode([])` to leave it unscoped.\n"
},
"config": {
"type": "string",
"description": "Provider credentials as a JSON object, including the `providerType` discriminator.\n",
"secret": true
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the connection was created.\n"
},
"name": {
"type": "string",
"description": "Name of the connection, unique within the organization.\n"
},
"organizationId": {
"type": "string",
"description": "Organization that owns the connection.\n"
},
"providerType": {
"type": "string",
"description": "Provider kind derived from \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e.\n"
}
},
"type": "object"
}
},
"dokploy:index/volumeBackup:VolumeBackup": {
"description": "A scheduled backup of a Docker volume to a configured \u003cspan pulumi-lang-nodejs=\"`dokploy.Destination`\" pulumi-lang-dotnet=\"`dokploy.Destination`\" pulumi-lang-go=\"`Destination`\" pulumi-lang-python=\"`Destination`\" pulumi-lang-yaml=\"`dokploy.Destination`\" pulumi-lang-java=\"`dokploy.Destination`\" pulumi-lang-hcl=\"`dokploy_destination`\"\u003e`dokploy.Destination`\u003c/span\u003e.\n\nThis is the counterpart to a \u003cspan pulumi-lang-nodejs=\"`dokploy.Mount`\" pulumi-lang-dotnet=\"`dokploy.Mount`\" pulumi-lang-go=\"`Mount`\" pulumi-lang-python=\"`Mount`\" pulumi-lang-yaml=\"`dokploy.Mount`\" pulumi-lang-java=\"`dokploy.Mount`\" pulumi-lang-hcl=\"`dokploy_mount`\"\u003e`dokploy.Mount`\u003c/span\u003e with `type = \"volume\"`: the mount gives the volume a stable name, and this resource copies its contents off the host on a schedule.\n\nSet exactly one of the `*_id` attributes to say which service owns the volume.\n",
"properties": {
"appName": {
"type": "string",
"description": "Docker service name that owns the volume. Derived by Dokploy when omitted.\n"
},
"applicationId": {
"type": "string",
"description": "Application that owns the volume.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack that owns the volume.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the backup job was created.\n"
},
"cronExpression": {
"type": "string",
"description": "Standard five-field cron expression, for example `0 4 * * *`.\n"
},
"destinationId": {
"type": "string",
"description": "Backup destination (S3-compatible bucket) to upload to.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the backup schedule is active.\n"
},
"keepLatestCount": {
"type": "integer",
"description": "Number of backups to retain. Older ones are pruned.\n"
},
"libsqlId": {
"type": "string",
"description": "libSQL instance that owns the volume.\n"
},
"mariadbId": {
"type": "string",
"description": "MariaDB instance that owns the volume.\n"
},
"mongoId": {
"type": "string",
"description": "MongoDB instance that owns the volume.\n"
},
"mysqlId": {
"type": "string",
"description": "MySQL instance that owns the volume.\n"
},
"name": {
"type": "string",
"description": "Display name of the backup job.\n"
},
"postgresId": {
"type": "string",
"description": "PostgreSQL instance that owns the volume.\n"
},
"prefix": {
"type": "string",
"description": "Path prefix inside the destination bucket, for example `backups/shop/`.\n"
},
"redisId": {
"type": "string",
"description": "Redis instance that owns the volume.\n"
},
"serviceName": {
"type": "string",
"description": "Service inside a Compose stack that owns the volume.\n"
},
"serviceType": {
"type": "string",
"description": "The kind of service that owns the volume. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`postgres`\" pulumi-lang-dotnet=\"`Postgres`\" pulumi-lang-go=\"`postgres`\" pulumi-lang-python=\"`postgres`\" pulumi-lang-yaml=\"`postgres`\" pulumi-lang-java=\"`postgres`\" pulumi-lang-hcl=\"`postgres`\"\u003e`postgres`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mysql`\" pulumi-lang-dotnet=\"`Mysql`\" pulumi-lang-go=\"`mysql`\" pulumi-lang-python=\"`mysql`\" pulumi-lang-yaml=\"`mysql`\" pulumi-lang-java=\"`mysql`\" pulumi-lang-hcl=\"`mysql`\"\u003e`mysql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mariadb`\" pulumi-lang-dotnet=\"`Mariadb`\" pulumi-lang-go=\"`mariadb`\" pulumi-lang-python=\"`mariadb`\" pulumi-lang-yaml=\"`mariadb`\" pulumi-lang-java=\"`mariadb`\" pulumi-lang-hcl=\"`mariadb`\"\u003e`mariadb`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mongo`\" pulumi-lang-dotnet=\"`Mongo`\" pulumi-lang-go=\"`mongo`\" pulumi-lang-python=\"`mongo`\" pulumi-lang-yaml=\"`mongo`\" pulumi-lang-java=\"`mongo`\" pulumi-lang-hcl=\"`mongo`\"\u003e`mongo`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`redis`\" pulumi-lang-dotnet=\"`Redis`\" pulumi-lang-go=\"`redis`\" pulumi-lang-python=\"`redis`\" pulumi-lang-yaml=\"`redis`\" pulumi-lang-java=\"`redis`\" pulumi-lang-hcl=\"`redis`\"\u003e`redis`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`libsql`\" pulumi-lang-dotnet=\"`Libsql`\" pulumi-lang-go=\"`libsql`\" pulumi-lang-python=\"`libsql`\" pulumi-lang-yaml=\"`libsql`\" pulumi-lang-java=\"`libsql`\" pulumi-lang-hcl=\"`libsql`\"\u003e`libsql`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e.\n"
},
"turnOff": {
"type": "boolean",
"description": "Stop the service while the backup runs. Slower, but guarantees a consistent copy of data that is being written to.\n"
},
"volumeName": {
"type": "string",
"description": "Name of the Docker volume to back up.\n"
}
},
"required": [
"appName",
"createdAt",
"cronExpression",
"destinationId",
"enabled",
"keepLatestCount",
"name",
"prefix",
"serviceType",
"turnOff",
"volumeName"
],
"inputProperties": {
"appName": {
"type": "string",
"description": "Docker service name that owns the volume. Derived by Dokploy when omitted.\n"
},
"applicationId": {
"type": "string",
"description": "Application that owns the volume.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack that owns the volume.\n"
},
"cronExpression": {
"type": "string",
"description": "Standard five-field cron expression, for example `0 4 * * *`.\n"
},
"destinationId": {
"type": "string",
"description": "Backup destination (S3-compatible bucket) to upload to.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the backup schedule is active.\n"
},
"keepLatestCount": {
"type": "integer",
"description": "Number of backups to retain. Older ones are pruned.\n"
},
"libsqlId": {
"type": "string",
"description": "libSQL instance that owns the volume.\n"
},
"mariadbId": {
"type": "string",
"description": "MariaDB instance that owns the volume.\n"
},
"mongoId": {
"type": "string",
"description": "MongoDB instance that owns the volume.\n"
},
"mysqlId": {
"type": "string",
"description": "MySQL instance that owns the volume.\n"
},
"name": {
"type": "string",
"description": "Display name of the backup job.\n"
},
"postgresId": {
"type": "string",
"description": "PostgreSQL instance that owns the volume.\n"
},
"prefix": {
"type": "string",
"description": "Path prefix inside the destination bucket, for example `backups/shop/`.\n"
},
"redisId": {
"type": "string",
"description": "Redis instance that owns the volume.\n"
},
"serviceName": {
"type": "string",
"description": "Service inside a Compose stack that owns the volume.\n"
},
"serviceType": {
"type": "string",
"description": "The kind of service that owns the volume. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`postgres`\" pulumi-lang-dotnet=\"`Postgres`\" pulumi-lang-go=\"`postgres`\" pulumi-lang-python=\"`postgres`\" pulumi-lang-yaml=\"`postgres`\" pulumi-lang-java=\"`postgres`\" pulumi-lang-hcl=\"`postgres`\"\u003e`postgres`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mysql`\" pulumi-lang-dotnet=\"`Mysql`\" pulumi-lang-go=\"`mysql`\" pulumi-lang-python=\"`mysql`\" pulumi-lang-yaml=\"`mysql`\" pulumi-lang-java=\"`mysql`\" pulumi-lang-hcl=\"`mysql`\"\u003e`mysql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mariadb`\" pulumi-lang-dotnet=\"`Mariadb`\" pulumi-lang-go=\"`mariadb`\" pulumi-lang-python=\"`mariadb`\" pulumi-lang-yaml=\"`mariadb`\" pulumi-lang-java=\"`mariadb`\" pulumi-lang-hcl=\"`mariadb`\"\u003e`mariadb`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mongo`\" pulumi-lang-dotnet=\"`Mongo`\" pulumi-lang-go=\"`mongo`\" pulumi-lang-python=\"`mongo`\" pulumi-lang-yaml=\"`mongo`\" pulumi-lang-java=\"`mongo`\" pulumi-lang-hcl=\"`mongo`\"\u003e`mongo`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`redis`\" pulumi-lang-dotnet=\"`Redis`\" pulumi-lang-go=\"`redis`\" pulumi-lang-python=\"`redis`\" pulumi-lang-yaml=\"`redis`\" pulumi-lang-java=\"`redis`\" pulumi-lang-hcl=\"`redis`\"\u003e`redis`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`libsql`\" pulumi-lang-dotnet=\"`Libsql`\" pulumi-lang-go=\"`libsql`\" pulumi-lang-python=\"`libsql`\" pulumi-lang-yaml=\"`libsql`\" pulumi-lang-java=\"`libsql`\" pulumi-lang-hcl=\"`libsql`\"\u003e`libsql`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e.\n"
},
"turnOff": {
"type": "boolean",
"description": "Stop the service while the backup runs. Slower, but guarantees a consistent copy of data that is being written to.\n"
},
"volumeName": {
"type": "string",
"description": "Name of the Docker volume to back up.\n"
}
},
"requiredInputs": [
"cronExpression",
"destinationId",
"prefix",
"volumeName"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering VolumeBackup resources.\n",
"properties": {
"appName": {
"type": "string",
"description": "Docker service name that owns the volume. Derived by Dokploy when omitted.\n"
},
"applicationId": {
"type": "string",
"description": "Application that owns the volume.\n"
},
"composeId": {
"type": "string",
"description": "Compose stack that owns the volume.\n"
},
"createdAt": {
"type": "string",
"description": "RFC 3339 timestamp of when the backup job was created.\n"
},
"cronExpression": {
"type": "string",
"description": "Standard five-field cron expression, for example `0 4 * * *`.\n"
},
"destinationId": {
"type": "string",
"description": "Backup destination (S3-compatible bucket) to upload to.\n"
},
"enabled": {
"type": "boolean",
"description": "Whether the backup schedule is active.\n"
},
"keepLatestCount": {
"type": "integer",
"description": "Number of backups to retain. Older ones are pruned.\n"
},
"libsqlId": {
"type": "string",
"description": "libSQL instance that owns the volume.\n"
},
"mariadbId": {
"type": "string",
"description": "MariaDB instance that owns the volume.\n"
},
"mongoId": {
"type": "string",
"description": "MongoDB instance that owns the volume.\n"
},
"mysqlId": {
"type": "string",
"description": "MySQL instance that owns the volume.\n"
},
"name": {
"type": "string",
"description": "Display name of the backup job.\n"
},
"postgresId": {
"type": "string",
"description": "PostgreSQL instance that owns the volume.\n"
},
"prefix": {
"type": "string",
"description": "Path prefix inside the destination bucket, for example `backups/shop/`.\n"
},
"redisId": {
"type": "string",
"description": "Redis instance that owns the volume.\n"
},
"serviceName": {
"type": "string",
"description": "Service inside a Compose stack that owns the volume.\n"
},
"serviceType": {
"type": "string",
"description": "The kind of service that owns the volume. Valid values: \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`postgres`\" pulumi-lang-dotnet=\"`Postgres`\" pulumi-lang-go=\"`postgres`\" pulumi-lang-python=\"`postgres`\" pulumi-lang-yaml=\"`postgres`\" pulumi-lang-java=\"`postgres`\" pulumi-lang-hcl=\"`postgres`\"\u003e`postgres`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mysql`\" pulumi-lang-dotnet=\"`Mysql`\" pulumi-lang-go=\"`mysql`\" pulumi-lang-python=\"`mysql`\" pulumi-lang-yaml=\"`mysql`\" pulumi-lang-java=\"`mysql`\" pulumi-lang-hcl=\"`mysql`\"\u003e`mysql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mariadb`\" pulumi-lang-dotnet=\"`Mariadb`\" pulumi-lang-go=\"`mariadb`\" pulumi-lang-python=\"`mariadb`\" pulumi-lang-yaml=\"`mariadb`\" pulumi-lang-java=\"`mariadb`\" pulumi-lang-hcl=\"`mariadb`\"\u003e`mariadb`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`mongo`\" pulumi-lang-dotnet=\"`Mongo`\" pulumi-lang-go=\"`mongo`\" pulumi-lang-python=\"`mongo`\" pulumi-lang-yaml=\"`mongo`\" pulumi-lang-java=\"`mongo`\" pulumi-lang-hcl=\"`mongo`\"\u003e`mongo`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`redis`\" pulumi-lang-dotnet=\"`Redis`\" pulumi-lang-go=\"`redis`\" pulumi-lang-python=\"`redis`\" pulumi-lang-yaml=\"`redis`\" pulumi-lang-java=\"`redis`\" pulumi-lang-hcl=\"`redis`\"\u003e`redis`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`compose`\" pulumi-lang-dotnet=\"`Compose`\" pulumi-lang-go=\"`compose`\" pulumi-lang-python=\"`compose`\" pulumi-lang-yaml=\"`compose`\" pulumi-lang-java=\"`compose`\" pulumi-lang-hcl=\"`compose`\"\u003e`compose`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`libsql`\" pulumi-lang-dotnet=\"`Libsql`\" pulumi-lang-go=\"`libsql`\" pulumi-lang-python=\"`libsql`\" pulumi-lang-yaml=\"`libsql`\" pulumi-lang-java=\"`libsql`\" pulumi-lang-hcl=\"`libsql`\"\u003e`libsql`\u003c/span\u003e. Defaults to \u003cspan pulumi-lang-nodejs=\"`application`\" pulumi-lang-dotnet=\"`Application`\" pulumi-lang-go=\"`application`\" pulumi-lang-python=\"`application`\" pulumi-lang-yaml=\"`application`\" pulumi-lang-java=\"`application`\" pulumi-lang-hcl=\"`application`\"\u003e`application`\u003c/span\u003e.\n"
},
"turnOff": {
"type": "boolean",
"description": "Stop the service while the backup runs. Slower, but guarantees a consistent copy of data that is being written to.\n"
},
"volumeName": {
"type": "string",
"description": "Name of the Docker volume to back up.\n"
}
},
"type": "object"
}
}
},
"functions": {
"dokploy:index/getApplication:getApplication": {
"description": "Look up an existing application by ID.\n",
"inputs": {
"description": "A collection of arguments for invoking getApplication.\n",
"properties": {
"id": {
"type": "string",
"description": "Application identifier.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"outputs": {
"description": "A collection of values returned by getApplication.\n",
"properties": {
"appName": {
"description": "Docker service name.\n",
"type": "string"
},
"applicationStatus": {
"description": "Current status.\n",
"type": "string"
},
"buildType": {
"description": "Build strategy.\n",
"type": "string"
},
"createdAt": {
"description": "Creation timestamp.\n",
"type": "string"
},
"description": {
"description": "Application description.\n",
"type": "string"
},
"environmentId": {
"description": "Owning environment.\n",
"type": "string"
},
"id": {
"description": "Application identifier.\n",
"type": "string"
},
"name": {
"description": "Application name.\n",
"type": "string"
},
"sourceType": {
"description": "Source of the code or image.\n",
"type": "string"
}
},
"required": [
"appName",
"applicationStatus",
"buildType",
"createdAt",
"description",
"environmentId",
"id",
"name",
"sourceType"
],
"type": "object"
}
},
"dokploy:index/getEnvironment:getEnvironment": {
"description": "Look up an existing environment by ID.\n",
"inputs": {
"description": "A collection of arguments for invoking getEnvironment.\n",
"properties": {
"id": {
"type": "string",
"description": "Environment identifier.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"outputs": {
"description": "A collection of values returned by getEnvironment.\n",
"properties": {
"createdAt": {
"description": "Creation timestamp.\n",
"type": "string"
},
"description": {
"description": "Environment description.\n",
"type": "string"
},
"env": {
"description": "Environment-wide variables.\n",
"type": "string"
},
"id": {
"description": "Environment identifier.\n",
"type": "string"
},
"isDefault": {
"description": "Whether this is the project's default environment.\n",
"type": "boolean"
},
"name": {
"description": "Environment name.\n",
"type": "string"
},
"projectId": {
"description": "Owning project.\n",
"type": "string"
}
},
"required": [
"createdAt",
"description",
"env",
"id",
"isDefault",
"name",
"projectId"
],
"type": "object"
}
},
"dokploy:index/getProject:getProject": {
"description": "Look up an existing Dokploy project by ID, including its environments.\n",
"inputs": {
"description": "A collection of arguments for invoking getProject.\n",
"properties": {
"id": {
"type": "string",
"description": "Project identifier.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"outputs": {
"description": "A collection of values returned by getProject.\n",
"properties": {
"createdAt": {
"description": "Creation timestamp.\n",
"type": "string"
},
"defaultEnvironmentId": {
"description": "ID of the project's default environment.\n",
"type": "string"
},
"description": {
"description": "Project description.\n",
"type": "string"
},
"env": {
"description": "Project-wide environment variables.\n",
"type": "string"
},
"environments": {
"description": "Every environment in the project.\n",
"items": {
"$ref": "#/types/dokploy:index/getProjectEnvironment:getProjectEnvironment"
},
"type": "array"
},
"id": {
"description": "Project identifier.\n",
"type": "string"
},
"name": {
"description": "Project name.\n",
"type": "string"
},
"organizationId": {
"description": "Owning organization.\n",
"type": "string"
}
},
"required": [
"createdAt",
"defaultEnvironmentId",
"description",
"env",
"environments",
"id",
"name",
"organizationId"
],
"type": "object"
}
},
"dokploy:index/getProjects:getProjects": {
"description": "List every Dokploy project the API token can see.\n",
"outputs": {
"description": "A collection of values returned by getProjects.\n",
"properties": {
"projects": {
"description": "All visible projects.\n",
"items": {
"$ref": "#/types/dokploy:index/getProjectsProject:getProjectsProject"
},
"type": "array"
}
},
"required": [
"projects"
],
"type": "object"
}
},
"dokploy:index/getServers:getServers": {
"description": "List the remote servers registered with Dokploy. Use a server's \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e as the \u003cspan pulumi-lang-nodejs=\"`serverId`\" pulumi-lang-dotnet=\"`ServerId`\" pulumi-lang-go=\"`serverId`\" pulumi-lang-python=\"`server_id`\" pulumi-lang-yaml=\"`serverId`\" pulumi-lang-java=\"`serverId`\" pulumi-lang-hcl=\"`server_id`\"\u003e`serverId`\u003c/span\u003e of an application, stack, or database to deploy it away from the Dokploy host.\n",
"outputs": {
"description": "A collection of values returned by getServers.\n",
"properties": {
"servers": {
"description": "All registered servers.\n",
"items": {
"$ref": "#/types/dokploy:index/getServersServer:getServersServer"
},
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
}
},
"pulumi:providers:dokploy/terraformConfig": {
"description": "This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.",
"inputs": {
"properties": {
"__self__": {
"type": "ref",
"$ref": "#/provider"
}
},
"type": "pulumi:providers:dokploy/terraformConfig",
"required": [
"__self__"
]
},
"outputs": {
"properties": {
"result": {
"additionalProperties": {
"$ref": "pulumi.json#/Any"
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink