{"id":35573031,"url":"https://github.com/hellscrimson/terraform-provider-arcane","last_synced_at":"2026-02-05T02:03:05.568Z","repository":{"id":332409330,"uuid":"1127721509","full_name":"HellsCrimson/terraform-provider-arcane","owner":"HellsCrimson","description":"Terraform provider for Arcane","archived":false,"fork":false,"pushed_at":"2026-02-03T23:35:39.000Z","size":126,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-04T10:44:55.093Z","etag":null,"topics":["arcane","docker","opentofu","terraform"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HellsCrimson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-04T13:20:06.000Z","updated_at":"2026-02-03T23:35:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/HellsCrimson/terraform-provider-arcane","commit_stats":null,"previous_names":["hellscrimson/terraform-provider-arcane"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/HellsCrimson/terraform-provider-arcane","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HellsCrimson%2Fterraform-provider-arcane","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HellsCrimson%2Fterraform-provider-arcane/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HellsCrimson%2Fterraform-provider-arcane/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HellsCrimson%2Fterraform-provider-arcane/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HellsCrimson","download_url":"https://codeload.github.com/HellsCrimson/terraform-provider-arcane/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HellsCrimson%2Fterraform-provider-arcane/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29107301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T00:52:08.035Z","status":"online","status_checked_at":"2026-02-05T02:00:07.839Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arcane","docker","opentofu","terraform"],"created_at":"2026-01-04T18:23:17.242Z","updated_at":"2026-02-05T02:03:05.562Z","avatar_url":"https://github.com/HellsCrimson.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Arcane Terraform Provider\n\nManage Arcane using Terraform or OpenTofu. This provider talks to the Arcane HTTP API using an API key and implements common workflows: users, environment settings, compose projects (inline or from files), project state (up/down), notifications, and single containers.\n\nOverview\n\n- Auth via `X-API-Key` header.\n- Provider address used in this repository: `registry.terraform.io/hellscrimson/arcane`.\n\nRequirements\n\n- Terraform or OpenTofu 1.4+.\n- Go 1.21+ (to build from source).\n\nInstallation\n\n- From Registry (recommended):\n```\nterraform {\n  required_providers {\n    arcane = {\n      source  = \"hellscrimson/arcane\"\n      version = \"~\u003e 0.0.1\"\n    }\n  }\n}\n```\n\n- Local development override:\n  1) Build the binary:\n\n```\ngo build ./cmd/terraform-provider-arcane\n```\n\n  2) Add a dev override in your CLI config (e.g. `~/.terraformrc`):\n\n```\ndependency_lock_file_path = \"./.terraform.lock.hcl\"\nprovider_installation {\n  dev_overrides {\n    \"hellscrimson/arcane\" = \"/abs/path/to/your/build/folder\"\n  }\n  direct {}\n}\n```\n\n  3) In your configuration, set:\n\n```\nterraform {\n  required_providers {\n    arcane = { source = \"hellscrimson/arcane\" }\n  }\n}\n```\n\nAuthentication\n\n- API key: provider attribute `api_key` or environment `ARCANE_API_KEY`.\n- Endpoint: provider attribute `endpoint` (defaults to `http://localhost:3552/api`).\n\nQuick Start\n\nSee `examples/basic/main.tf` for a working setup that demonstrates projects, file-based projects (with content hashing), notifications and containers. Example provider block:\n\n```\nprovider \"arcane\" {\n  api_key  = var.arcane_api_key\n  endpoint = \"http://localhost:3552/api\"\n}\n\nvariable \"environment_id\" {\n  type = string\n}\n```\n\nResources\n\n- arcane_user\n  - Create/read/update/delete Arcane users.\n  - Attributes: username (required, replace), password (required, sensitive), display_name, email, locale, roles.\n  - Note: Older runtimes do not support write-only attributes; password is stored sensitive in state for apply consistency.\n\n- arcane_settings\n  - Update environment settings using explicit attributes mapped from SettingsUpdate.\n  - Typical fields: base_server_url, polling_enabled, polling_interval, and many others defined in `api-1.json`.\n  - Computed `applied` map exposes the server’s current settings after apply.\n\n- arcane_project\n  - Manage a compose project with inline content.\n  - Attributes: environment_id, name, compose_content (required), env_content (optional).\n  - Computed: id, path, status, service_count, running_count, created_at, updated_at.\n\n- arcane_project_path\n  - Manage a compose project from local files.\n  - Attributes: environment_id, name, compose_path (required), env_path (optional).\n  - content_hash_mode (bool): when true, state stores only SHA256 hashes (compose_content_hash/env_content_hash) instead of full content; still detects file changes and updates.\n  - When false (default), state stores the last read file contents (sensitive) to detect changes.\n\n  - Lifecycle: set `running = true` to ensure the project is deployed (compose up), or `false` to bring it down. If unset, lifecycle is not managed.\n\n- arcane_notification\n  - Manage notification settings for a provider.\n  - Attributes: environment_id, provider_name, enabled, config (map(string)).\n\n- arcane_container\n  - Create/delete a single container.\n  - Attributes: environment_id, name, image (required), and advanced options (command, ports, volumes, etc.). Most changes force replacement.\n  - Ports map format: container port -\u003e host port, numeric strings only (e.g., `{ \"8081\" = \"8081\" }`). The provider normalizes values if a protocol suffix is present.\n\nImports\n\n- arcane_user: `id`\n- arcane_settings: `environment_id`\n- arcane_project: `environment_id:project_id`\n- arcane_project_path: `environment_id:project_id`\n- arcane_notification: `environment_id:provider_name`\n- arcane_container: `environment_id:container_id`\n\nExamples\n\n- Full example: `examples/basic/main.tf`\n\nBuilding from source\n\n- Ensure Go 1.21+ then build:\n\n```\ngo build ./cmd/terraform-provider-arcane\n```\n\nReleases \u0026 Publishing\n\n- This repo includes a minimal GoReleaser configuration (`.goreleaser.yaml`) to build multi-platform archives, generate checksums and GPG-sign the checksum file.\n\nAPI Coverage \u0026 Notes\n\n- This provider adheres to the OpenAPI available in an arcane instance.\n- Implemented endpoints:\n  - Users: `POST /users`, `GET/PUT/DELETE /users/{userId}`\n  - Settings: `GET/PUT /environments/{id}/settings`\n  - Projects: `POST /environments/{id}/projects`, `GET/PUT /environments/{id}/projects/{projectId}`, `DELETE /environments/{id}/projects/{projectId}/destroy`, `POST /environments/{id}/projects/{projectId}/up|down`\n  - Notifications: `POST /environments/{id}/notifications/settings`, `GET/DELETE /environments/{id}/notifications/settings/{provider}`\n  - Containers: `POST /environments/{id}/containers`, `GET/DELETE /environments/{id}/containers/{containerId}` (supports `force` and `volumes` on delete)\n\nLimitations / Roadmap\n\n- No data sources yet.\n- Additional endpoints (images, registries, templates, etc.) not covered.\n- When using Terraform/OpenTofu \u003c 1.11, write-only attributes are not available; sensitive-only storage is used for passwords.\n\nContributing\n\n- PRs welcome. Please keep changes minimal and aligned with the OpenAPI.\n- Before opening a PR, run:\n\n```\ngo mod tidy\ngo build ./cmd/terraform-provider-arcane\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhellscrimson%2Fterraform-provider-arcane","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhellscrimson%2Fterraform-provider-arcane","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhellscrimson%2Fterraform-provider-arcane/lists"}