{"id":21897426,"url":"https://github.com/form3tech-oss/terraform-provider-chronicle","last_synced_at":"2025-04-15T17:58:32.724Z","repository":{"id":221711961,"uuid":"755176215","full_name":"form3tech-oss/terraform-provider-chronicle","owner":"form3tech-oss","description":"A terraform provider for chronicle","archived":false,"fork":false,"pushed_at":"2025-03-13T01:07:26.000Z","size":7885,"stargazers_count":16,"open_issues_count":2,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-12T07:03:37.007Z","etag":null,"topics":["chronicle","go","google","provider","siem","terraform"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/form3tech-oss.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-09T15:29:22.000Z","updated_at":"2025-04-09T10:29:14.000Z","dependencies_parsed_at":"2024-04-19T14:28:20.978Z","dependency_job_id":"ca545b89-a02c-45fa-9ee1-184a4b0d139b","html_url":"https://github.com/form3tech-oss/terraform-provider-chronicle","commit_stats":null,"previous_names":["form3tech-oss/terraform-provider-chronicle"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form3tech-oss%2Fterraform-provider-chronicle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form3tech-oss%2Fterraform-provider-chronicle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form3tech-oss%2Fterraform-provider-chronicle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form3tech-oss%2Fterraform-provider-chronicle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/form3tech-oss","download_url":"https://codeload.github.com/form3tech-oss/terraform-provider-chronicle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249125959,"owners_count":21216705,"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":["chronicle","go","google","provider","siem","terraform"],"created_at":"2024-11-28T14:17:14.536Z","updated_at":"2025-04-15T17:58:32.684Z","avatar_url":"https://github.com/form3tech-oss.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable first-line-h1 no-inline-html --\u003e\n\u003ca href=\"https://terraform.io\"\u003e\n    \u003cimg src=\"https://github.com/hashicorp/terraform-provider-aws/raw/main/.github/terraform_logo_light.svg\" alt=\"Terraform logo\" title=\"Terraform\" align=\"right\" height=\"50\" /\u003e\n\u003c/a\u003e\n\n# Terraform Chronicle\n\n[![CI](https://github.com/form3tech-oss/terraform-provider-chronicle/actions/workflows/ci.yaml/badge.svg)](https://github.com/form3tech-oss/terraform-provider-chronicle/actions/workflows/ci.yaml)\n[![release](https://github.com/form3tech-oss/terraform-provider-chronicle/actions/workflows/release.yaml/badge.svg)](https://github.com/form3tech-oss/terraform-provider-chronicle/actions/workflows/release.yaml)\n\nTerraform provider for Chronicle\n\n# Documentation\n\nFind available docs [here](docs/).\n\n## Building The Provider\n\n```bash\nmake build\n```\n\n## Debugging\n\nTF examples can be found under `examples/` directory, and can be used for debugging purposes.\n\n- run `./debug.sh` script in this repo root and init target workspace (`terraform init`)\n- attach with your debugger to port `2345`, this will also print required gRPC debug info to stdout\n- note the env variable from the above output (you'll need it in the next step)\n- set breakpoints in code and run a plan (`TF_REATTACH_PROVIDERS='{...}' terraform plan`)\n- re-run the above command as many times as needed (provider process keeps running after the plan has finished)\n\n## Release\n\nAfter merging to master, GitHub Action will push new tag, which in turn will trigger `goreleaser`.\n\n`goreleaser` action will build and upload to GitHub release.\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 (version 1.21+ is *required*).\n\nTo compile the provider, run `make build`.\n\n```sh\nmake build\n```\n\nIn order to test the provider, you can simply run `make test`.\n\n```sh\nmake test\n```\n\nIn order to run the full suite of Acceptance tests, set the environment variables listed below and run `make testacc`.\n\nThe order of precedence for chronicle's API configuration is the following: `Credential file through TF \u003e Access Token through TF \u003e Environment Variable`.\nEnvironment variables always take the lowest precedence\n\n*Note:* Acceptance tests create real resources\n| Environment variables            | Description                                |\n|:---------------------------------|:-------------------------------------------|\n| CHRONICLE_BACKSTORY_CREDENTIALS  | backstory base64 credentials               |\n| CHRONICLE_BIGQUERY_CREDENTIALS   | bigquery base64 credentials                |\n| CHRONICLE_INGESTION_CREDENTIALS  | ingestion base64 credentials               |\n| CHRONICLE_FORWARDER_CREDENTIALS  | forwarder base64 credentials               |\n| CHRONICLE_REGION                 | API region                                 |\n\n## Using a local version of the provider\nFirstly install the provider by running:\n\n```sh\nmake install\n```\nModify your `.terraformrc` file as the following:\n\n```tf\nprovider_installation {\n  filesystem_mirror {\n    path = \"\u003cHOME_PATH\u003e/.terraform.d/plugins\"\n    include = [\"github.com/form3tech-oss/chronicle\"]\n  }\n  direct {\n    exclude = [\"github.com/form3tech-oss/chronicle\"]\n  }\n}\n```\n\nNow leverage the provider by using:\n```tf\nterraform {\n  required_providers {\n    chronicle = {\n      source  = \"github.com/form3tech-oss/chronicle\"\n    }\n  }\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fform3tech-oss%2Fterraform-provider-chronicle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fform3tech-oss%2Fterraform-provider-chronicle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fform3tech-oss%2Fterraform-provider-chronicle/lists"}