{"id":44092679,"url":"https://github.com/barodeur/terraform-provider-truenas","last_synced_at":"2026-02-27T13:14:57.240Z","repository":{"id":337121179,"uuid":"1152420967","full_name":"barodeur/terraform-provider-truenas","owner":"barodeur","description":"Terraform provider for TrueNAS Scale via WebSocket JSON-RPC API","archived":false,"fork":false,"pushed_at":"2026-02-24T23:14:44.000Z","size":225,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-25T03:40:47.601Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/barodeur.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-02-07T21:11:43.000Z","updated_at":"2026-02-24T23:14:49.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/barodeur/terraform-provider-truenas","commit_stats":null,"previous_names":["barodeur/terraform-provider-truenas"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/barodeur/terraform-provider-truenas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barodeur%2Fterraform-provider-truenas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barodeur%2Fterraform-provider-truenas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barodeur%2Fterraform-provider-truenas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barodeur%2Fterraform-provider-truenas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barodeur","download_url":"https://codeload.github.com/barodeur/terraform-provider-truenas/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barodeur%2Fterraform-provider-truenas/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29896315,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T12:09:13.686Z","status":"ssl_error","status_checked_at":"2026-02-27T12:09:13.282Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-02-08T11:16:48.966Z","updated_at":"2026-02-27T13:14:57.231Z","avatar_url":"https://github.com/barodeur.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Terraform Provider for TrueNAS Scale\n\nA Terraform provider for managing [TrueNAS Scale](https://www.truenas.com/truenas-scale/) resources via its WebSocket JSON-RPC API.\n\n## Requirements\n\n- [Terraform](https://developer.hashicorp.com/terraform/downloads) \u003e= 1.0\n- [Go](https://go.dev/dl/) \u003e= 1.24 (to build the provider)\n- A TrueNAS Scale instance with an API key\n\n## Usage\n\n```hcl\nterraform {\n  required_providers {\n    truenas = {\n      source = \"barodeur/truenas\"\n    }\n  }\n}\n\nprovider \"truenas\" {\n  host     = \"wss://truenas.local\"\n  api_key  = var.truenas_api_key\n  insecure = true  # skip TLS verification for self-signed certs\n}\n\nvariable \"truenas_api_key\" {\n  type      = string\n  sensitive = true\n}\n```\n\n### Provider arguments\n\n| Argument   | Description | Required | Default |\n|------------|-------------|----------|---------|\n| `host`     | WebSocket URL of the TrueNAS server (e.g. `wss://truenas.local`). If no scheme is provided, `wss://` is assumed. Also settable via `TRUENAS_HOST`. | Yes | — |\n| `api_key`  | API key for authentication. Also settable via `TRUENAS_API_KEY`. | Yes | — |\n| `insecure` | Skip TLS certificate verification. | No | `false` |\n\n## Resources\n\n- `truenas_api_key` — API keys\n- `truenas_cronjob` — Cron jobs\n- `truenas_group` — Groups\n- `truenas_nfs_share` — NFS shares\n- `truenas_pool_dataset` — ZFS datasets\n- `truenas_smb_share` — SMB shares\n- `truenas_user` — Users\n\n## Data Sources\n\n- `truenas_api_key` — Look up an API key\n- `truenas_cronjob` — Look up a cron job\n- `truenas_pool` — Look up a storage pool\n\n## Development\n\n```sh\nmake build     # build the provider binary\nmake install   # install to ~/.terraform.d/plugins\nmake test      # run unit tests\nmake testacc   # run acceptance tests (requires TRUENAS_HOST, TRUENAS_API_KEY, TF_ACC=1)\nmake fmt       # format Go code\nmake lint      # run golangci-lint\n```\n\n### Running acceptance tests\n\nAcceptance tests run against a QEMU-based TrueNAS VM. Use `scripts/testacc.sh` as the single entry point:\n\n```sh\nscripts/testacc.sh                          # Restore cached snapshot, run tests\nscripts/testacc.sh --vm=running             # Reuse a running VM as-is\nscripts/testacc.sh --vm=reinstall           # Boot from cached ISO, re-run setup\nscripts/testacc.sh --vm=full                # Download ISO, full rebuild from scratch\nscripts/testacc.sh --vm=running -run TestAccGroup  # Pass extra go test flags\n```\n\nThe first run requires `--vm=full` (or `--vm=reinstall` with `TRUENAS_ISO` set) to build the VM. Subsequent runs use `snapshot` mode (the default), which restores a cached VM image in seconds.\n\nRequires QEMU, zstd, and socat (`apt install qemu-system-x86 qemu-utils zstd socat`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarodeur%2Fterraform-provider-truenas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarodeur%2Fterraform-provider-truenas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarodeur%2Fterraform-provider-truenas/lists"}