{"id":15065573,"url":"https://github.com/qovery/terraform-provider-qovery","last_synced_at":"2026-02-26T11:12:03.637Z","repository":{"id":36953336,"uuid":"426566427","full_name":"Qovery/terraform-provider-qovery","owner":"Qovery","description":"Qovery Terraform Provider","archived":false,"fork":false,"pushed_at":"2025-03-31T07:14:07.000Z","size":2207,"stargazers_count":16,"open_issues_count":11,"forks_count":8,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-03T03:31:26.312Z","etag":null,"topics":["aws","cloud","gcp","scaleway","terraform","terraform-module","terraform-provider"],"latest_commit_sha":null,"homepage":"https://registry.terraform.io/providers/Qovery/qovery/latest/docs","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/Qovery.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}},"created_at":"2021-11-10T09:48:51.000Z","updated_at":"2025-03-29T19:29:51.000Z","dependencies_parsed_at":"2023-12-21T11:59:18.403Z","dependency_job_id":"4660f6f4-4fe7-4ac9-a266-48a6b4f40c2b","html_url":"https://github.com/Qovery/terraform-provider-qovery","commit_stats":null,"previous_names":[],"tags_count":120,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qovery%2Fterraform-provider-qovery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qovery%2Fterraform-provider-qovery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qovery%2Fterraform-provider-qovery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qovery%2Fterraform-provider-qovery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Qovery","download_url":"https://codeload.github.com/Qovery/terraform-provider-qovery/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248252723,"owners_count":21072703,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["aws","cloud","gcp","scaleway","terraform","terraform-module","terraform-provider"],"created_at":"2024-09-25T00:41:55.939Z","updated_at":"2026-01-17T16:28:38.064Z","avatar_url":"https://github.com/Qovery.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Qovery Terraform Provider\n\n[![Tests](https://github.com/qovery/terraform-provider-qovery/actions/workflows/tests.yml/badge.svg)](https://github.com/qovery/terraform-provider-qovery/actions/workflows/tests.yml)\n\n- Documentation: https://registry.terraform.io/providers/qovery/qovery/latest\n\n## Requirements\n\n- [Terraform](https://www.terraform.io/downloads.html) \u003e= 1.0\n- [Go](https://golang.org/doc/install) \u003e= 1.25 (to build the provider)\n- [Task](https://taskfile.dev) v3 (to run Taskfile commands)\n- [jq](https://stedolan.github.io/jq/download/) (to parse json from curl api calls)\n\n## Building The Provider\n\n1. Clone the repository\n1. Enter the repository directory\n1. Build the provider using the task `build` command:\n\n```shell\ntask build\n```\n\n## Available Commands\n\n| Command | Description |\n|---------|-------------|\n| `task build` | Build the provider binary |\n| `task install` | Build and install dev override |\n| `task test` | Run unit tests |\n| `task testacc` | Run acceptance tests |\n| `task lint` | Run linters |\n| `task docs` | Generate documentation |\n| `task mocks` | Generate test mocks |\n| `task clean-tests` | Clean up test resources |\n\n## Developing The Provider\n\nIf you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).\n\nTo compile the provider, run the task `build` command:\n\n```shell\ntask build\n```\n\nThis will build the provider and put the provider binary in the repository `/bin` folder.\n\nTo be able to use the compiled provider binary, you will need to create a [development override](https://www.terraform.io/docs/cli/config/config-file.html#development-overrides-for-provider-developers) for this provider in your `~/.terraformrc` pointing to the repository `/bin` folder. \nTo create a development override, run the task `install-dev-override` command:\n\n```shell\ntask install-dev-override\n```\n\nWhen you are finished using the compiled version of the provider, you can safely remove the `~/.terraformrc` file.\nTo remove a development override, run the task `uninstall-dev-override` command:\n\n```shell\ntask uninstall-dev-override\n```\n\n## Testing The Provider\n\nIn order to run the full suite of Acceptance tests, run task `testacc` command:\n\n```shell\ntask testacc\n```\n\n*Note:* Acceptance tests create real resources, and often cost money to run.\n\nThe acceptance tests require a `QOVERY_API_TOKEN` environment variable to be set. \nIt corresponds to your JWT token on the Qovery's console and can be acquired using the [qovery-cli](https://github.com/Qovery/qovery-cli) with the following command (needs [jq](https://stedolan.github.io/jq/download/)): \n\n```shell\nqovery auth ; cat ~/.qovery/context.json | jq -r .access_token | sed 's/.*Authorization: Bearer \\(*\\)/\\1/' | tr -d '\\n'\n```\n\nThis JWT needs to be put inside a `.env` file at the root of the repository. \nYou can use the `.env.example` file as a base for you file.  \n\n```dotenv\nQOVERY_API_TOKEN=\u003cqovery-api-token\u003e\n```\n\n*Note:* API tokens can be generated via the [qovery-cli](https://github.com/Qovery/qovery-cli) command `qovery token`.\n\nIn order to run the tests with extra debugging context, prefix with `TF_LOG` (see the [terraform documentation](https://www.terraform.io/docs/internals/debugging.html) for details).\n\n```sh\nTF_LOG=trace task testacc\n```\n\nTo run a specific set of tests, use the `-run` flag and specify a regex pattern matching the test names.\n\n```sh\ntask testacc -- -run 'TestAcc_Organization*'\n```\n\n### Using Intellij IDEA Debugger\n\nTo be able to add breakpoints in you code and use the debugger provided by Intellij IDEA, you'll need to add `--debug` in `Program arguments` field in Idea configuration.\n\nOnce you run the project in debug mod, you'll find a line in terminal looking like `TF_REATTACH_PROVIDERS='{\"registry.terraform.io/Qovery/qovery\":{\"Protocol\":\"grpc\",\"ProtocolVersion\":6,\"Pid\":591078,\"Test\":true,\"Addr\":{\"Network\":\"unix\",\"String\":\"/tmp/plugin1516819738\"}}}'`\n\nCopy and export this environment variable in the terminal you use to run Terraform Commands. Use any Terraform command in this terminal and Idea will listen to it and stop on breakpoints you set.\n\n## Generating The Provider Documentation\n\nThe documentation is autogenerated from Description fields within the provider, and the `examples` directory.\nGenerating the documentation creates markdown in the `docs` folder, ready for deployment to Hashicorp.\nTo generate the documentation, run the task `docs` command:\n\n*NOTE:* To generate the documentation you need to have provided the environment variable `QOVERY_API_TOKEN` as it uses the api to fetch some data present in the doc.\n\n```sh\ntask docs\n```\n\nYou can preview the generated documentation by copying `/docs` Markdown file content into this [preview tool](https://registry.terraform.io/tools/doc-preview).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqovery%2Fterraform-provider-qovery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqovery%2Fterraform-provider-qovery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqovery%2Fterraform-provider-qovery/lists"}