A Terraform provider for Dokploy
Plugin-framework provider covering projects, environments, applications, Compose stacks, managed databases, domains, mounts, ports, redirects, basic auth, registries, SSH keys, certificates and backup destinations, over Dokploy's tRPC-over-REST API. The shim package exposes the provider to other Go modules, which is how pulumi-dokploy bridges it.
This commit is contained in:
128
docs/resources/application.md
Normal file
128
docs/resources/application.md
Normal file
@@ -0,0 +1,128 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_application Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A Dokploy application: a single service built from a Git repository, a Docker image, or an uploaded artifact.
|
||||
Dokploy'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.
|
||||
~> Creating this resource does not deploy the application. Trigger a deployment from the Dokploy UI, the CLI, or a terraform_data provisioner calling application.deploy.
|
||||
---
|
||||
|
||||
# dokploy_application (Resource)
|
||||
|
||||
A Dokploy application: a single service built from a Git repository, a Docker image, or an uploaded artifact.
|
||||
|
||||
Dokploy'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`.
|
||||
|
||||
~> Creating this resource does **not** deploy the application. Trigger a deployment from the Dokploy UI, the CLI, or a `terraform_data` provisioner calling `application.deploy`.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `environment_id` (String) Environment this application belongs to.
|
||||
- `name` (String) Display name of the application.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new application.
|
||||
- `args` (List of String) Arguments appended to the container command.
|
||||
- `auto_deploy` (Boolean) Deploy automatically when the configured trigger fires.
|
||||
- `bitbucket_branch` (String) Bitbucket branch to build.
|
||||
- `bitbucket_build_path` (String) Path within the Bitbucket repository to build from.
|
||||
- `bitbucket_id` (String) ID of the configured Bitbucket provider connection.
|
||||
- `bitbucket_owner` (String) Bitbucket repository owner.
|
||||
- `bitbucket_repository` (String) Bitbucket repository name.
|
||||
- `bitbucket_repository_slug` (String) Bitbucket repository slug.
|
||||
- `branch` (String) GitHub branch to build.
|
||||
- `build_args` (String) Docker build arguments in `KEY=value` format, one per line.
|
||||
- `build_path` (String) Path within the GitHub repository to build from.
|
||||
- `build_registry_id` (String) Registry used by a dedicated build server.
|
||||
- `build_secrets` (String, Sensitive) Docker build secrets in `KEY=value` format, one per line.
|
||||
- `build_server_id` (String) Server that performs builds, when separate from the deploy server.
|
||||
- `build_type` (String) How the application is built. Valid values: `dockerfile`, `heroku_buildpacks`, `paketo_buildpacks`, `nixpacks`, `static`, `railpack`.
|
||||
- `clean_cache` (Boolean) Discard the build cache on the next deployment.
|
||||
- `command` (String) Override the container entrypoint command.
|
||||
- `cpu_limit` (String) Hard CPU limit, for example `1`.
|
||||
- `cpu_reservation` (String) Soft CPU reservation, for example `0.5`.
|
||||
- `create_env_file` (Boolean) Write the environment variables to a `.env` file in the container.
|
||||
- `custom_git_branch` (String) Branch to build for a custom Git remote.
|
||||
- `custom_git_build_path` (String) Path within a custom Git repository to build from.
|
||||
- `custom_git_ssh_key_id` (String) SSH key used to clone a private custom Git remote.
|
||||
- `custom_git_url` (String) Git remote URL, when `source_type` is `git`.
|
||||
- `description` (String) Free-form description.
|
||||
- `detach_dokploy_network` (Boolean) Detach the service from the shared `dokploy-network`.
|
||||
- `docker_build_stage` (String) Target stage for a multi-stage Docker build.
|
||||
- `docker_context_path` (String) Docker build context path.
|
||||
- `docker_image` (String) Docker image reference, when `source_type` is `docker`.
|
||||
- `dockerfile` (String) Path to the Dockerfile, when `build_type` is `dockerfile`.
|
||||
- `enable_submodules` (Boolean) Clone Git submodules when checking out the repository.
|
||||
- `enabled` (Boolean) Whether the application is enabled.
|
||||
- `endpoint_spec_swarm` (String) Docker Swarm endpoint specification, as a JSON object.
|
||||
- `env` (String) Runtime environment variables in `KEY=value` format, one per line.
|
||||
- `gitea_branch` (String) Gitea branch to build.
|
||||
- `gitea_build_path` (String) Path within the Gitea repository to build from.
|
||||
- `gitea_id` (String) ID of the configured Gitea provider connection.
|
||||
- `gitea_owner` (String) Gitea repository owner.
|
||||
- `gitea_repository` (String) Gitea repository name.
|
||||
- `github_id` (String) ID of the configured GitHub provider connection.
|
||||
- `gitlab_branch` (String) GitLab branch to build.
|
||||
- `gitlab_build_path` (String) Path within the GitLab repository to build from.
|
||||
- `gitlab_id` (String) ID of the configured GitLab provider connection.
|
||||
- `gitlab_owner` (String) GitLab repository owner.
|
||||
- `gitlab_path_namespace` (String) Full GitLab namespace path.
|
||||
- `gitlab_project_id` (Number) Numeric GitLab project ID.
|
||||
- `gitlab_repository` (String) GitLab repository name.
|
||||
- `health_check_swarm` (String) Docker Swarm health check configuration, as a JSON object.
|
||||
- `heroku_version` (String) Heroku buildpack stack version.
|
||||
- `is_preview_deployments_active` (Boolean) Build a preview deployment for each pull request.
|
||||
- `is_static_spa` (Boolean) Serve a static build as a single-page application.
|
||||
- `labels_swarm` (String) Docker Swarm service labels, as a JSON object.
|
||||
- `memory_limit` (String) Hard memory limit, for example `512m`.
|
||||
- `memory_reservation` (String) Soft memory reservation, for example `256m`.
|
||||
- `mode_swarm` (String) Docker Swarm service mode, as a JSON object.
|
||||
- `network_ids` (List of String) IDs of additional Docker networks to attach.
|
||||
- `network_swarm` (String) Docker Swarm network attachments, as a JSON array.
|
||||
- `owner` (String) GitHub repository owner.
|
||||
- `password` (String, Sensitive) Registry password, when pulling a private image.
|
||||
- `placement_swarm` (String) Docker Swarm placement constraints, as a JSON object.
|
||||
- `preview_build_args` (String) Build arguments applied to preview deployments.
|
||||
- `preview_build_secrets` (String, Sensitive) Build secrets applied to preview deployments.
|
||||
- `preview_certificate_type` (String) Certificate strategy for preview deployments. Valid values: `letsencrypt`, `none`, `custom`.
|
||||
- `preview_custom_cert_resolver` (String) Traefik certificate resolver for preview deployments.
|
||||
- `preview_env` (String) Environment variables applied to preview deployments.
|
||||
- `preview_https` (Boolean) Serve preview deployments over HTTPS.
|
||||
- `preview_labels` (List of String) Pull request labels that opt into preview deployments.
|
||||
- `preview_limit` (Number) Maximum number of concurrent preview deployments.
|
||||
- `preview_path` (String) Base path for preview deployments.
|
||||
- `preview_port` (Number) Container port exposed by preview deployments.
|
||||
- `preview_wildcard` (String) Wildcard domain used to expose preview deployments.
|
||||
- `publish_directory` (String) Directory served when `build_type` is `static`.
|
||||
- `railpack_version` (String) Railpack version.
|
||||
- `registry_id` (String) Registry used to push the built image.
|
||||
- `registry_url` (String) Registry URL, when pulling a private image.
|
||||
- `replicas` (Number) Number of replicas to run.
|
||||
- `repository` (String) GitHub repository name.
|
||||
- `restart_policy_swarm` (String) Docker Swarm restart policy, as a JSON object.
|
||||
- `rollback_active` (Boolean) Keep previous images so deployments can be rolled back.
|
||||
- `rollback_config_swarm` (String) Docker Swarm rollback configuration, as a JSON object.
|
||||
- `rollback_registry_id` (String) Registry used to store rollback images.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `source_type` (String) Where the application's code or image comes from. Valid values: `docker`, `git`, `github`, `gitlab`, `bitbucket`, `gitea`, `drop`.
|
||||
- `stop_grace_period_swarm` (Number) Grace period in nanoseconds before a container is killed.
|
||||
- `subtitle` (String) Display subtitle shown in the Dokploy UI.
|
||||
- `title` (String) Display title shown in the Dokploy UI.
|
||||
- `trigger_type` (String) What triggers an automatic GitHub deployment. Valid values: `push`, `tag`.
|
||||
- `ulimits_swarm` (String) Docker Swarm ulimits, as a JSON object.
|
||||
- `update_config_swarm` (String) Docker Swarm rolling update configuration, as a JSON object.
|
||||
- `username` (String) Registry username, when pulling a private image.
|
||||
- `watch_paths` (List of String) Glob patterns that limit which changed paths trigger an automatic deployment.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `application_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the application was created.
|
||||
- `id` (String) Unique application identifier.
|
||||
35
docs/resources/certificate.md
Normal file
35
docs/resources/certificate.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_certificate Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A TLS certificate uploaded to Dokploy, for domains that use certificate_type = "custom".
|
||||
~> The private key is stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_certificate (Resource)
|
||||
|
||||
A TLS certificate uploaded to Dokploy, for domains that use `certificate_type = "custom"`.
|
||||
|
||||
~> The private key is stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `certificate_data` (String) PEM-encoded certificate chain.
|
||||
- `name` (String) Display name of the certificate.
|
||||
- `private_key` (String, Sensitive) PEM-encoded private key.
|
||||
|
||||
### Optional
|
||||
|
||||
- `auto_renew` (Boolean) Whether Dokploy should renew this certificate automatically.
|
||||
- `server_id` (String) Server this certificate is installed on.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `certificate_path` (String) Path where Dokploy writes the certificate on disk.
|
||||
- `id` (String) Unique certificate identifier.
|
||||
76
docs/resources/compose.md
Normal file
76
docs/resources/compose.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_compose Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A Docker Compose or Docker Swarm stack managed by Dokploy.
|
||||
Set compose_file to manage the stack definition inline (with source_type = "raw"), or point the stack at a Git repository and set compose_path.
|
||||
~> Creating this resource does not deploy the stack.
|
||||
---
|
||||
|
||||
# dokploy_compose (Resource)
|
||||
|
||||
A Docker Compose or Docker Swarm stack managed by Dokploy.
|
||||
|
||||
Set `compose_file` to manage the stack definition inline (with `source_type = "raw"`), or point the stack at a Git repository and set `compose_path`.
|
||||
|
||||
~> Creating this resource does **not** deploy the stack.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `environment_id` (String) Environment this stack belongs to.
|
||||
- `name` (String) Display name of the stack.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker stack name. Generated by Dokploy when omitted. Changing it forces a new stack.
|
||||
- `auto_deploy` (Boolean) Deploy automatically when the configured trigger fires.
|
||||
- `bitbucket_branch` (String) Bitbucket branch to deploy.
|
||||
- `bitbucket_id` (String) ID of the configured Bitbucket provider connection.
|
||||
- `bitbucket_owner` (String) Bitbucket repository owner.
|
||||
- `bitbucket_repository` (String) Bitbucket repository name.
|
||||
- `bitbucket_repository_slug` (String) Bitbucket repository slug.
|
||||
- `branch` (String) GitHub branch to deploy.
|
||||
- `command` (String) Custom `docker compose` command to run.
|
||||
- `compose_file` (String) Inline Compose file contents. Used when `source_type` is `raw`.
|
||||
- `compose_path` (String) Path to the Compose file within the repository.
|
||||
- `compose_type` (String) Whether to run the stack with Docker Compose or Docker Swarm. Valid values: `docker-compose`, `stack`.
|
||||
- `custom_git_branch` (String) Branch to deploy for a custom Git remote.
|
||||
- `custom_git_ssh_key_id` (String) SSH key used to clone a private custom Git remote.
|
||||
- `custom_git_url` (String) Git remote URL, when `source_type` is `git`.
|
||||
- `delete_volumes` (Boolean) Whether to delete the stack's Docker volumes when this resource is destroyed. Defaults to `false`, which preserves the data.
|
||||
- `description` (String) Free-form description.
|
||||
- `enable_submodules` (Boolean) Clone Git submodules when checking out the repository.
|
||||
- `env` (String) Environment variables in `KEY=value` format, one per line.
|
||||
- `gitea_branch` (String) Gitea branch to deploy.
|
||||
- `gitea_id` (String) ID of the configured Gitea provider connection.
|
||||
- `gitea_owner` (String) Gitea repository owner.
|
||||
- `gitea_repository` (String) Gitea repository name.
|
||||
- `github_id` (String) ID of the configured GitHub provider connection.
|
||||
- `gitlab_branch` (String) GitLab branch to deploy.
|
||||
- `gitlab_id` (String) ID of the configured GitLab provider connection.
|
||||
- `gitlab_owner` (String) GitLab repository owner.
|
||||
- `gitlab_path_namespace` (String) Full GitLab namespace path.
|
||||
- `gitlab_project_id` (Number) Numeric GitLab project ID.
|
||||
- `gitlab_repository` (String) GitLab repository name.
|
||||
- `isolated_deployment` (Boolean) Run the stack on its own isolated Docker network.
|
||||
- `isolated_deployments_volume` (Boolean) Prefix volume names for isolated deployments. Retained for backwards compatibility.
|
||||
- `owner` (String) GitHub repository owner.
|
||||
- `randomize` (Boolean) Append a random suffix to service and volume names.
|
||||
- `repository` (String) GitHub repository name.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `source_type` (String) Where the Compose file comes from. Valid values: `git`, `github`, `gitlab`, `bitbucket`, `gitea`, `raw`.
|
||||
- `suffix` (String) Suffix appended to generated resource names.
|
||||
- `trigger_type` (String) What triggers an automatic deployment. Valid values: `push`, `tag`.
|
||||
- `watch_paths` (List of String) Glob patterns that limit which changed paths trigger an automatic deployment.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `compose_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the stack was created.
|
||||
- `id` (String) Unique compose identifier.
|
||||
39
docs/resources/destination.md
Normal file
39
docs/resources/destination.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_destination Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
An S3-compatible bucket that Dokploy writes database and volume backups to.
|
||||
~> The secret access key is stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_destination (Resource)
|
||||
|
||||
An S3-compatible bucket that Dokploy writes database and volume backups to.
|
||||
|
||||
~> The secret access key is stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `access_key` (String) S3 access key ID.
|
||||
- `bucket` (String) Bucket name.
|
||||
- `endpoint` (String) S3 endpoint URL.
|
||||
- `name` (String) Display name of the destination.
|
||||
- `region` (String) Bucket region, for example `us-east-1`.
|
||||
- `secret_access_key` (String, Sensitive) S3 secret access key.
|
||||
|
||||
### Optional
|
||||
|
||||
- `additional_flags` (List of String) Extra flags passed to the underlying `rclone` invocation.
|
||||
- `provider_name` (String) Provider label, for example `s3` or `cloudflare`. Named `provider_name` because `provider` is reserved by Terraform.
|
||||
- `server_id` (String) Server this destination is scoped to.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) Timestamp of when the destination was created.
|
||||
- `id` (String) Unique destination identifier.
|
||||
46
docs/resources/domain.md
Normal file
46
docs/resources/domain.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_domain Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A domain routed to an application or a Compose service through Dokploy's Traefik instance.
|
||||
Set exactly one of application_id or compose_id. When targeting a Compose stack, service_name selects which service in the stack receives the traffic.
|
||||
---
|
||||
|
||||
# dokploy_domain (Resource)
|
||||
|
||||
A domain routed to an application or a Compose service through Dokploy's Traefik instance.
|
||||
|
||||
Set exactly one of `application_id` or `compose_id`. When targeting a Compose stack, `service_name` selects which service in the stack receives the traffic.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `host` (String) Fully-qualified hostname, for example `api.example.com`.
|
||||
|
||||
### Optional
|
||||
|
||||
- `application_id` (String) Application this domain routes to.
|
||||
- `certificate_type` (String) How TLS certificates are obtained. Use `letsencrypt` for automatic certificates. Valid values: `letsencrypt`, `none`, `custom`.
|
||||
- `compose_id` (String) Compose stack this domain routes to.
|
||||
- `custom_cert_resolver` (String) Traefik certificate resolver name, when `certificate_type` is `custom`.
|
||||
- `custom_entrypoint` (String) Traefik entrypoint to bind, when not using the defaults.
|
||||
- `domain_type` (String) What kind of target this domain points at. Valid values: `compose`, `application`, `preview`.
|
||||
- `forward_auth_enabled` (Boolean) Protect this domain with Dokploy's forward auth.
|
||||
- `https` (Boolean) Serve the domain over HTTPS and redirect HTTP traffic to it.
|
||||
- `internal_path` (String) Path the request is rewritten to before it reaches the container, defaults to `/`.
|
||||
- `middlewares` (List of String) Names of Traefik middlewares to apply.
|
||||
- `path` (String) Path prefix this domain routes, defaults to `/`.
|
||||
- `port` (Number) Container port that receives the traffic, defaults to `3000`.
|
||||
- `preview_deployment_id` (String) Preview deployment this domain routes to.
|
||||
- `service_name` (String) Name of the service inside a Compose stack that receives the traffic. Required when `compose_id` is set.
|
||||
- `strip_path` (Boolean) Strip `path` from the request before forwarding it.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the domain was created.
|
||||
- `id` (String) Unique domain identifier.
|
||||
35
docs/resources/environment.md
Normal file
35
docs/resources/environment.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_environment Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
An environment inside a Dokploy project, such as staging or production. Services belong to an environment rather than directly to a project.
|
||||
Dokploy creates a default production environment with every project; reference it via dokploy_project.<name>.default_environment_id instead of declaring it here.
|
||||
---
|
||||
|
||||
# dokploy_environment (Resource)
|
||||
|
||||
An environment inside a Dokploy project, such as `staging` or `production`. Services belong to an environment rather than directly to a project.
|
||||
|
||||
Dokploy creates a default `production` environment with every project; reference it via `dokploy_project.<name>.default_environment_id` instead of declaring it here.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `name` (String) Environment name, for example `staging`.
|
||||
- `project_id` (String) Project this environment belongs to.
|
||||
|
||||
### Optional
|
||||
|
||||
- `description` (String) Free-form description.
|
||||
- `env` (String) Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the environment was created.
|
||||
- `id` (String) Unique environment identifier.
|
||||
- `is_default` (Boolean) Whether this is the project's default environment.
|
||||
66
docs/resources/mariadb.md
Normal file
66
docs/resources/mariadb.md
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_mariadb Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A managed MariaDB instance running on Dokploy.
|
||||
~> Creating this resource provisions the service definition but does not start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_mariadb (Resource)
|
||||
|
||||
A managed MariaDB instance running on Dokploy.
|
||||
|
||||
~> Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `database_name` (String) Name of the database to create.
|
||||
- `database_password` (String, Sensitive) Password for the database user.
|
||||
- `database_root_password` (String, Sensitive) Password for the MariaDB `root` user.
|
||||
- `database_user` (String) Database user to create.
|
||||
- `docker_image` (String) MariaDB image to run, for example `mariadb:11`.
|
||||
- `environment_id` (String) Environment this database belongs to.
|
||||
- `name` (String) Display name of the database.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.
|
||||
- `args` (List of String) Arguments appended to the container command.
|
||||
- `command` (String) Override the container entrypoint command.
|
||||
- `cpu_limit` (String) Hard CPU limit, for example `1`.
|
||||
- `cpu_reservation` (String) Soft CPU reservation, for example `0.5`.
|
||||
- `description` (String) Free-form description.
|
||||
- `detach_dokploy_network` (Boolean) Detach the service from the shared `dokploy-network`.
|
||||
- `endpoint_spec_swarm` (String) Docker Swarm endpoint specification, as a JSON object.
|
||||
- `env` (String) Environment variables in `KEY=value` format, one per line.
|
||||
- `external_port` (Number) Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.
|
||||
- `health_check_swarm` (String) Docker Swarm health check configuration, as a JSON object.
|
||||
- `labels_swarm` (String) Docker Swarm service labels, as a JSON object.
|
||||
- `memory_limit` (String) Hard memory limit, for example `512m`.
|
||||
- `memory_reservation` (String) Soft memory reservation, for example `256m`.
|
||||
- `mode_swarm` (String) Docker Swarm service mode, as a JSON object.
|
||||
- `network_ids` (List of String) IDs of additional Docker networks to attach.
|
||||
- `network_swarm` (String) Docker Swarm network attachments, as a JSON array.
|
||||
- `placement_swarm` (String) Docker Swarm placement constraints, as a JSON object.
|
||||
- `replicas` (Number) Number of replicas to run.
|
||||
- `restart_policy_swarm` (String) Docker Swarm restart policy, as a JSON object.
|
||||
- `rollback_config_swarm` (String) Docker Swarm rollback configuration, as a JSON object.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `stop_grace_period_swarm` (Number) Grace period in nanoseconds before a container is killed.
|
||||
- `ulimits_swarm` (String) Docker Swarm ulimits, as a JSON object.
|
||||
- `update_config_swarm` (String) Docker Swarm rolling update configuration, as a JSON object.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `application_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the database was created.
|
||||
- `id` (String) Unique mariadb identifier.
|
||||
65
docs/resources/mongo.md
Normal file
65
docs/resources/mongo.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_mongo Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A managed MongoDB instance running on Dokploy.
|
||||
~> Creating this resource provisions the service definition but does not start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_mongo (Resource)
|
||||
|
||||
A managed MongoDB instance running on Dokploy.
|
||||
|
||||
~> Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `database_password` (String, Sensitive) Password for the root user.
|
||||
- `database_user` (String) Root username to create.
|
||||
- `environment_id` (String) Environment this database belongs to.
|
||||
- `name` (String) Display name of the database.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.
|
||||
- `args` (List of String) Arguments appended to the container command.
|
||||
- `command` (String) Override the container entrypoint command.
|
||||
- `cpu_limit` (String) Hard CPU limit, for example `1`.
|
||||
- `cpu_reservation` (String) Soft CPU reservation, for example `0.5`.
|
||||
- `description` (String) Free-form description.
|
||||
- `detach_dokploy_network` (Boolean) Detach the service from the shared `dokploy-network`.
|
||||
- `docker_image` (String) MongoDB image to run. Defaults to `mongo:8`.
|
||||
- `endpoint_spec_swarm` (String) Docker Swarm endpoint specification, as a JSON object.
|
||||
- `env` (String) Environment variables in `KEY=value` format, one per line.
|
||||
- `external_port` (Number) Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.
|
||||
- `health_check_swarm` (String) Docker Swarm health check configuration, as a JSON object.
|
||||
- `labels_swarm` (String) Docker Swarm service labels, as a JSON object.
|
||||
- `memory_limit` (String) Hard memory limit, for example `512m`.
|
||||
- `memory_reservation` (String) Soft memory reservation, for example `256m`.
|
||||
- `mode_swarm` (String) Docker Swarm service mode, as a JSON object.
|
||||
- `network_ids` (List of String) IDs of additional Docker networks to attach.
|
||||
- `network_swarm` (String) Docker Swarm network attachments, as a JSON array.
|
||||
- `placement_swarm` (String) Docker Swarm placement constraints, as a JSON object.
|
||||
- `replica_sets` (Boolean) Start the instance as a single-node replica set.
|
||||
- `replicas` (Number) Number of replicas to run.
|
||||
- `restart_policy_swarm` (String) Docker Swarm restart policy, as a JSON object.
|
||||
- `rollback_config_swarm` (String) Docker Swarm rollback configuration, as a JSON object.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `stop_grace_period_swarm` (Number) Grace period in nanoseconds before a container is killed.
|
||||
- `ulimits_swarm` (String) Docker Swarm ulimits, as a JSON object.
|
||||
- `update_config_swarm` (String) Docker Swarm rolling update configuration, as a JSON object.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `application_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the database was created.
|
||||
- `id` (String) Unique mongo identifier.
|
||||
39
docs/resources/mount.md
Normal file
39
docs/resources/mount.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_mount Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A volume, bind mount, or config file attached to a Dokploy service.
|
||||
type = "volume" — a named Docker volume; set volume_name.type = "bind" — a path on the host; set host_path.type = "file" — a file rendered from content; set file_path.
|
||||
---
|
||||
|
||||
# dokploy_mount (Resource)
|
||||
|
||||
A volume, bind mount, or config file attached to a Dokploy service.
|
||||
|
||||
* `type = "volume"` — a named Docker volume; set `volume_name`.
|
||||
* `type = "bind"` — a path on the host; set `host_path`.
|
||||
* `type = "file"` — a file rendered from `content`; set `file_path`.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `mount_path` (String) Path inside the container where the mount appears.
|
||||
- `service_id` (String) ID of the service this mount attaches to. Must match `service_type` — an application ID, a compose ID, a postgres ID, and so on.
|
||||
- `service_type` (String) The kind of service this mount attaches to. Valid values: `application`, `postgres`, `mysql`, `mariadb`, `mongo`, `redis`, `compose`.
|
||||
- `type` (String) The kind of mount to create. Valid values: `bind`, `volume`, `file`.
|
||||
|
||||
### Optional
|
||||
|
||||
- `content` (String) Contents of the generated file, when `type` is `file`.
|
||||
- `file_path` (String) Path of the generated file, when `type` is `file`.
|
||||
- `host_path` (String) Path on the host, when `type` is `bind`.
|
||||
- `volume_name` (String) Name of the Docker volume, when `type` is `volume`.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `id` (String) Unique mount identifier.
|
||||
66
docs/resources/mysql.md
Normal file
66
docs/resources/mysql.md
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_mysql Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A managed MySQL instance running on Dokploy.
|
||||
~> Creating this resource provisions the service definition but does not start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_mysql (Resource)
|
||||
|
||||
A managed MySQL instance running on Dokploy.
|
||||
|
||||
~> Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `database_name` (String) Name of the database to create.
|
||||
- `database_password` (String, Sensitive) Password for the database user.
|
||||
- `database_root_password` (String, Sensitive) Password for the MySQL `root` user.
|
||||
- `database_user` (String) Database user to create.
|
||||
- `docker_image` (String) MySQL image to run, for example `mysql:8`.
|
||||
- `environment_id` (String) Environment this database belongs to.
|
||||
- `name` (String) Display name of the database.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.
|
||||
- `args` (List of String) Arguments appended to the container command.
|
||||
- `command` (String) Override the container entrypoint command.
|
||||
- `cpu_limit` (String) Hard CPU limit, for example `1`.
|
||||
- `cpu_reservation` (String) Soft CPU reservation, for example `0.5`.
|
||||
- `description` (String) Free-form description.
|
||||
- `detach_dokploy_network` (Boolean) Detach the service from the shared `dokploy-network`.
|
||||
- `endpoint_spec_swarm` (String) Docker Swarm endpoint specification, as a JSON object.
|
||||
- `env` (String) Environment variables in `KEY=value` format, one per line.
|
||||
- `external_port` (Number) Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.
|
||||
- `health_check_swarm` (String) Docker Swarm health check configuration, as a JSON object.
|
||||
- `labels_swarm` (String) Docker Swarm service labels, as a JSON object.
|
||||
- `memory_limit` (String) Hard memory limit, for example `512m`.
|
||||
- `memory_reservation` (String) Soft memory reservation, for example `256m`.
|
||||
- `mode_swarm` (String) Docker Swarm service mode, as a JSON object.
|
||||
- `network_ids` (List of String) IDs of additional Docker networks to attach.
|
||||
- `network_swarm` (String) Docker Swarm network attachments, as a JSON array.
|
||||
- `placement_swarm` (String) Docker Swarm placement constraints, as a JSON object.
|
||||
- `replicas` (Number) Number of replicas to run.
|
||||
- `restart_policy_swarm` (String) Docker Swarm restart policy, as a JSON object.
|
||||
- `rollback_config_swarm` (String) Docker Swarm rollback configuration, as a JSON object.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `stop_grace_period_swarm` (Number) Grace period in nanoseconds before a container is killed.
|
||||
- `ulimits_swarm` (String) Docker Swarm ulimits, as a JSON object.
|
||||
- `update_config_swarm` (String) Docker Swarm rolling update configuration, as a JSON object.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `application_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the database was created.
|
||||
- `id` (String) Unique mysql identifier.
|
||||
31
docs/resources/port.md
Normal file
31
docs/resources/port.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_port Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A published port that exposes an application directly on the host, bypassing Traefik.
|
||||
---
|
||||
|
||||
# dokploy_port (Resource)
|
||||
|
||||
A published port that exposes an application directly on the host, bypassing Traefik.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `application_id` (String) Application this port belongs to.
|
||||
- `protocol` (String) Transport protocol. Valid values: `tcp`, `udp`.
|
||||
- `published_port` (Number) Port exposed on the host.
|
||||
- `target_port` (Number) Port the container listens on.
|
||||
|
||||
### Optional
|
||||
|
||||
- `publish_mode` (String) Docker Swarm publish mode. `host` binds directly to the node; `ingress` uses the swarm routing mesh. Valid values: `ingress`, `host`.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `id` (String) Unique port identifier.
|
||||
65
docs/resources/postgres.md
Normal file
65
docs/resources/postgres.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_postgres Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A managed PostgreSQL instance running on Dokploy.
|
||||
~> Creating this resource provisions the service definition but does not start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_postgres (Resource)
|
||||
|
||||
A managed PostgreSQL instance running on Dokploy.
|
||||
|
||||
~> Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `database_name` (String) Name of the database to create.
|
||||
- `database_password` (String, Sensitive) Password for the database user.
|
||||
- `database_user` (String) Database user to create.
|
||||
- `docker_image` (String) PostgreSQL image to run, for example `postgres:16`.
|
||||
- `environment_id` (String) Environment this database belongs to.
|
||||
- `name` (String) Display name of the database.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.
|
||||
- `args` (List of String) Arguments appended to the container command.
|
||||
- `command` (String) Override the container entrypoint command.
|
||||
- `cpu_limit` (String) Hard CPU limit, for example `1`.
|
||||
- `cpu_reservation` (String) Soft CPU reservation, for example `0.5`.
|
||||
- `description` (String) Free-form description.
|
||||
- `detach_dokploy_network` (Boolean) Detach the service from the shared `dokploy-network`.
|
||||
- `endpoint_spec_swarm` (String) Docker Swarm endpoint specification, as a JSON object.
|
||||
- `env` (String) Environment variables in `KEY=value` format, one per line.
|
||||
- `external_port` (Number) Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.
|
||||
- `health_check_swarm` (String) Docker Swarm health check configuration, as a JSON object.
|
||||
- `labels_swarm` (String) Docker Swarm service labels, as a JSON object.
|
||||
- `memory_limit` (String) Hard memory limit, for example `512m`.
|
||||
- `memory_reservation` (String) Soft memory reservation, for example `256m`.
|
||||
- `mode_swarm` (String) Docker Swarm service mode, as a JSON object.
|
||||
- `network_ids` (List of String) IDs of additional Docker networks to attach.
|
||||
- `network_swarm` (String) Docker Swarm network attachments, as a JSON array.
|
||||
- `placement_swarm` (String) Docker Swarm placement constraints, as a JSON object.
|
||||
- `replicas` (Number) Number of replicas to run.
|
||||
- `restart_policy_swarm` (String) Docker Swarm restart policy, as a JSON object.
|
||||
- `rollback_config_swarm` (String) Docker Swarm rollback configuration, as a JSON object.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `stop_grace_period_swarm` (Number) Grace period in nanoseconds before a container is killed.
|
||||
- `ulimits_swarm` (String) Docker Swarm ulimits, as a JSON object.
|
||||
- `update_config_swarm` (String) Docker Swarm rolling update configuration, as a JSON object.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `application_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the database was created.
|
||||
- `id` (String) Unique postgres identifier.
|
||||
35
docs/resources/project.md
Normal file
35
docs/resources/project.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_project Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A Dokploy project: the top-level container for environments and services.
|
||||
Creating a project automatically creates a default production environment. Its ID is exposed as default_environment_id, so services can be attached without declaring a separate dokploy_environment resource.
|
||||
---
|
||||
|
||||
# dokploy_project (Resource)
|
||||
|
||||
A Dokploy project: the top-level container for environments and services.
|
||||
|
||||
Creating a project automatically creates a default `production` environment. Its ID is exposed as `default_environment_id`, so services can be attached without declaring a separate `dokploy_environment` resource.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `name` (String) Display name of the project.
|
||||
|
||||
### Optional
|
||||
|
||||
- `description` (String) Free-form description.
|
||||
- `env` (String) Project-wide environment variables in `KEY=value` format, one per line. These are shared with every service in the project.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the project was created.
|
||||
- `default_environment_id` (String) ID of the `production` environment that Dokploy creates automatically with the project.
|
||||
- `id` (String) Unique project identifier.
|
||||
- `organization_id` (String) Organization that owns the project.
|
||||
31
docs/resources/redirect.md
Normal file
31
docs/resources/redirect.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_redirect Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A Traefik redirect rule attached to an application.
|
||||
---
|
||||
|
||||
# dokploy_redirect (Resource)
|
||||
|
||||
A Traefik redirect rule attached to an application.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `application_id` (String) Application this redirect belongs to.
|
||||
- `regex` (String) Regular expression matched against the incoming URL.
|
||||
- `replacement` (String) Replacement URL, which may reference capture groups such as `${1}`.
|
||||
|
||||
### Optional
|
||||
|
||||
- `permanent` (Boolean) Issue a permanent (301) redirect instead of a temporary (302) one.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the redirect was created.
|
||||
- `id` (String) Unique redirect identifier.
|
||||
63
docs/resources/redis.md
Normal file
63
docs/resources/redis.md
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_redis Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A managed Redis instance running on Dokploy.
|
||||
~> Creating this resource provisions the service definition but does not start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
---
|
||||
|
||||
# dokploy_redis (Resource)
|
||||
|
||||
A managed Redis instance running on Dokploy.
|
||||
|
||||
~> Creating this resource provisions the service definition but does **not** start a deployment. Deploy it from the Dokploy UI or CLI.
|
||||
|
||||
~> Credentials are stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `database_password` (String, Sensitive) Password used to authenticate to Redis.
|
||||
- `docker_image` (String) Redis image to run, for example `redis:7`.
|
||||
- `environment_id` (String) Environment this database belongs to.
|
||||
- `name` (String) Display name of the database.
|
||||
|
||||
### Optional
|
||||
|
||||
- `app_name` (String) Unique Docker service name. Generated by Dokploy when omitted. Changing it forces a new database.
|
||||
- `args` (List of String) Arguments appended to the container command.
|
||||
- `command` (String) Override the container entrypoint command.
|
||||
- `cpu_limit` (String) Hard CPU limit, for example `1`.
|
||||
- `cpu_reservation` (String) Soft CPU reservation, for example `0.5`.
|
||||
- `description` (String) Free-form description.
|
||||
- `detach_dokploy_network` (Boolean) Detach the service from the shared `dokploy-network`.
|
||||
- `endpoint_spec_swarm` (String) Docker Swarm endpoint specification, as a JSON object.
|
||||
- `env` (String) Environment variables in `KEY=value` format, one per line.
|
||||
- `external_port` (Number) Host port to expose the database on. Leave unset to keep the database reachable only from inside the Docker network.
|
||||
- `health_check_swarm` (String) Docker Swarm health check configuration, as a JSON object.
|
||||
- `labels_swarm` (String) Docker Swarm service labels, as a JSON object.
|
||||
- `memory_limit` (String) Hard memory limit, for example `512m`.
|
||||
- `memory_reservation` (String) Soft memory reservation, for example `256m`.
|
||||
- `mode_swarm` (String) Docker Swarm service mode, as a JSON object.
|
||||
- `network_ids` (List of String) IDs of additional Docker networks to attach.
|
||||
- `network_swarm` (String) Docker Swarm network attachments, as a JSON array.
|
||||
- `placement_swarm` (String) Docker Swarm placement constraints, as a JSON object.
|
||||
- `replicas` (Number) Number of replicas to run.
|
||||
- `restart_policy_swarm` (String) Docker Swarm restart policy, as a JSON object.
|
||||
- `rollback_config_swarm` (String) Docker Swarm rollback configuration, as a JSON object.
|
||||
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
|
||||
- `stop_grace_period_swarm` (Number) Grace period in nanoseconds before a container is killed.
|
||||
- `ulimits_swarm` (String) Docker Swarm ulimits, as a JSON object.
|
||||
- `update_config_swarm` (String) Docker Swarm rolling update configuration, as a JSON object.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `application_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
|
||||
- `created_at` (String) RFC 3339 timestamp of when the database was created.
|
||||
- `id` (String) Unique redis identifier.
|
||||
34
docs/resources/registry.md
Normal file
34
docs/resources/registry.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_registry Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
A container registry that Dokploy pushes built images to and pulls them from.
|
||||
---
|
||||
|
||||
# dokploy_registry (Resource)
|
||||
|
||||
A container registry that Dokploy pushes built images to and pulls them from.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `password` (String, Sensitive) Password or access token used to authenticate.
|
||||
- `registry_name` (String) Display name of the registry.
|
||||
- `registry_url` (String) Registry hostname, for example `ghcr.io`.
|
||||
- `username` (String) Username used to authenticate to the registry.
|
||||
|
||||
### Optional
|
||||
|
||||
- `image_prefix` (String) Prefix prepended to pushed image names, for example an organization or namespace.
|
||||
- `registry_type` (String) Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
|
||||
- `server_id` (String) Server this registry is scoped to.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the registry was created.
|
||||
- `id` (String) Unique registry identifier.
|
||||
30
docs/resources/security.md
Normal file
30
docs/resources/security.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_security Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
HTTP basic authentication credentials protecting an application's domains.
|
||||
~> Dokploy stores the password hashed and does not return it. The value in Terraform state is the one you configured.
|
||||
---
|
||||
|
||||
# dokploy_security (Resource)
|
||||
|
||||
HTTP basic authentication credentials protecting an application's domains.
|
||||
|
||||
~> Dokploy stores the password hashed and does not return it. The value in Terraform state is the one you configured.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `application_id` (String) Application these credentials protect.
|
||||
- `password` (String, Sensitive) Basic auth password.
|
||||
- `username` (String) Basic auth username.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the credentials were created.
|
||||
- `id` (String) Unique credential identifier.
|
||||
38
docs/resources/ssh_key.md
Normal file
38
docs/resources/ssh_key.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "dokploy_ssh_key Resource - dokploy"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
An SSH key pair Dokploy uses to clone private Git repositories and to reach remote servers.
|
||||
~> The private key is stored in Terraform state. Use a state backend with encryption at rest.
|
||||
~> Dokploy's update endpoint only accepts name and description. Changing either key forces a new resource.
|
||||
---
|
||||
|
||||
# dokploy_ssh_key (Resource)
|
||||
|
||||
An SSH key pair Dokploy uses to clone private Git repositories and to reach remote servers.
|
||||
|
||||
~> The private key is stored in Terraform state. Use a state backend with encryption at rest.
|
||||
|
||||
~> Dokploy's update endpoint only accepts `name` and `description`. Changing either key forces a new resource.
|
||||
|
||||
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `name` (String) Display name of the key pair.
|
||||
- `private_key` (String, Sensitive) PEM-encoded private key.
|
||||
- `public_key` (String) OpenSSH-formatted public key.
|
||||
|
||||
### Optional
|
||||
|
||||
- `description` (String) Free-form description.
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `created_at` (String) RFC 3339 timestamp of when the key was created.
|
||||
- `id` (String) Unique SSH key identifier.
|
||||
- `last_used_at` (String) RFC 3339 timestamp of when the key was last used, if ever.
|
||||
Reference in New Issue
Block a user