Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightstep/terraform-provider-lightstep
Terraform Lightstep provider
https://github.com/lightstep/terraform-provider-lightstep
Last synced: 8 days ago
JSON representation
Terraform Lightstep provider
- Host: GitHub
- URL: https://github.com/lightstep/terraform-provider-lightstep
- Owner: lightstep
- License: apache-2.0
- Created: 2019-02-13T19:48:45.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T21:01:52.000Z (7 months ago)
- Last Synced: 2024-04-13T21:54:02.193Z (7 months ago)
- Language: Go
- Homepage:
- Size: 12.9 MB
- Stars: 12
- Watchers: 49
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lightstep Terraform Provider
In August 2023, [Lightstep became ServiceNow
Cloud Observability](https://docs.lightstep.com/docs/banner-faq). To ease the
transition, all code artifacts will continue to use the Lightstep name. You
don't need to do anything to keep using this provider.
- [Hashicorp Terraform Registry](https://registry.terraform.io/providers/lightstep/lightstep/latest)
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) v1.x+
## Using the provider
- [Install Terraform](https://www.terraform.io/downloads)
- Write some code to initialize the provider with your Lightstep organization and [API Key](https://docs.lightstep.com/docs/create-and-manage-api-keys) with `member` permissions:
```
terraform {
required_providers {
lightstep = {
source = "lightstep/lightstep"
version = "1.77.2"
}
}
}
provider "lightstep" {
api_key = "your-lightstep-org-api-key"
organization = "your-lightstep-organization"
}
# Example: Create AWS EC2 Dashboard
module "aws-dashboards" {
source = "lightstep/aws-dashboards/lightstep//modules/ec2-dashboard"
lightstep_project = "your-lightstep-project"
}
```
- Run `terraform init`
- Add some code to define dashboards, streams, alerts, and more. [See documentation](https://registry.terraform.io/providers/lightstep/lightstep/latest/docs) for examples or use [pre-built Lightstep Terraform modules](https://registry.terraform.io/namespaces/lightstep).
- After setting an environment variable with your API Key that matches the name in the provider configuration above, run `terraform plan` to preview changes.
:warning: If you're creating many Lightstep resources at once, we recommend running the `apply` with the `parallelism` flag set to a low value to avoid API 500 errors:
```
# Avoids 500 errors when creating many resources.
terraform apply -parallelism=1
```
## Development
See [`DEVELOPMENT.md`](DEVELOPMENT.md).
## Exporter
It's possible to export an existing Lightstep dashboard to HCL code using the provider. This allows you to generate terrform code for a dashboard you created in the Lightstep UI ("reverse terraform").
The `exporter` utility is built-in to the provider binary and requires certain environment variables to be set:
```
$ export LIGHTSTEP_API_KEY=....
$ export LIGHTSTEP_ORG=your-org
$ export LIGHTSTEP_API_BASE_URL='https://api.lightstep.com'
# exports to console dashboard id = rZbPJ33q from project terraform-shop
$ go run github.com/lightstep/terraform-provider-lightstep exporter lightstep_dashboard terraform-shop rZbPJ33q
```