Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/form3tech-oss/terraform-provider-chronicle
A terraform provider for chronicle
https://github.com/form3tech-oss/terraform-provider-chronicle
chronicle go google provider siem terraform
Last synced: 2 months ago
JSON representation
A terraform provider for chronicle
- Host: GitHub
- URL: https://github.com/form3tech-oss/terraform-provider-chronicle
- Owner: form3tech-oss
- License: apache-2.0
- Created: 2024-02-09T15:29:22.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-09-04T13:19:16.000Z (5 months ago)
- Last Synced: 2024-09-06T13:13:37.852Z (5 months ago)
- Topics: chronicle, go, google, provider, siem, terraform
- Language: Go
- Homepage:
- Size: 6.7 MB
- Stars: 12
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Terraform Chronicle
[](https://github.com/form3tech-oss/terraform-provider-chronicle/actions/workflows/ci.yaml)
[](https://github.com/form3tech-oss/terraform-provider-chronicle/actions/workflows/release.yaml)
Terraform provider for Chronicle
# Documentation
Find available docs [here](docs/).
## Building The Provider
```bash
make build
```
## Debugging
TF examples can be found under `examples/` directory, and can be used for debugging purposes.
- run `./debug.sh` script in this repo root and init target workspace (`terraform init`)
- attach with your debugger to port `2345`, this will also print required gRPC debug info to stdout
- note the env variable from the above output (you'll need it in the next step)
- set breakpoints in code and run a plan (`TF_REATTACH_PROVIDERS='{...}' terraform plan`)
- re-run the above command as many times as needed (provider process keeps running after the plan has finished)
## Release
After merging to master, GitHub Action will push new tag, which in turn will trigger `goreleaser`.
`goreleaser` action will build and upload to GitHub release.
## Developing the Provider
If 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*).
To compile the provider, run `make build`.
```sh
make build
```
In order to test the provider, you can simply run `make test`.
```sh
make test
```
In order to run the full suite of Acceptance tests, set the environment variables listed below and run `make testacc`.
The order of precedence for chronicle's API configuration is the following: `Credential file through TF > Access Token through TF > Environment Variable`.
Environment variables always take the lowest precedence
*Note:* Acceptance tests create real resources
| Environment variables | Description |
|:---------------------------------|:-------------------------------------------|
| CHRONICLE_BACKSTORY_CREDENTIALS | backstory base64 credentials |
| CHRONICLE_BIGQUERY_CREDENTIALS | bigquery base64 credentials |
| CHRONICLE_INGESTION_CREDENTIALS | ingestion base64 credentials |
| CHRONICLE_FORWARDER_CREDENTIALS | forwarder base64 credentials |
| CHRONICLE_REGION | API region |
## Using a local version of the provider
Firstly install the provider by running:
```sh
make install
```
Modify your `.terraformrc` file as the following:
```tf
provider_installation {
filesystem_mirror {
path = "/.terraform.d/plugins"
include = ["github.com/form3tech-oss/chronicle"]
}
direct {
exclude = ["github.com/form3tech-oss/chronicle"]
}
}
```
Now leverage the provider by using:
```tf
terraform {
required_providers {
chronicle = {
source = "github.com/form3tech-oss/chronicle"
}
}
}
```