Lumi Terraform provider overview
The Imply Lumi Terraform provider lets you manage Lumi resources as code. Instead of creating IAM keys and pipelines in the Lumi UI, you define them in Terraform configuration files that you can version, review, and apply consistently across environments.
You can use the provider to manage resources in both Lumi Cloud and Lumi Enterprise. This documentation assumes you have basic working knowledge of Terraform. If you're new to Terraform, see the Terraform tutorials.
Your Terraform configuration is the source of truth for the resources it manages.
The next time you run terraform apply, Terraform overwrites any changes made in the Lumi UI.
Terraform management doesn't alter any settings that are only available in the UI and not the provider. See each resource's documentation for details.
The provider manages resources in an existing Lumi deployment. To install Lumi Enterprise itself, use the Lumi Terraform module. See Install Lumi Enterprise with Terraform.
Workflow
Follow these steps to get started with the Terraform provider:
- Obtain the Terraform provider. Contact your Imply support representative for details.
- Complete the installation guide to install the provider, authenticate, and verify the setup.
- Define Lumi Terraform resources in your Terraform configuration.
- Use the standard Terraform workflow to plan and apply changes.
For a workflow on using the Lumi Terraform provider to build pipelines from Splunk® technology add-ons, see Automate pipeline creation for Splunk add-ons with Terraform.
Resource types
The Lumi Terraform provider lets you manage the following resources:
lumi_iam_key: IAM keys to send and search events.lumi_pipeline: Pipelines to process incoming events using custom transformations.lumi_predefined_pipeline: Predefined pipelines to process incoming events using templates for standardized log formats.
To learn how to use these resources, see the following:
Provider configuration
The lumi provider block configures how to reach Lumi. It takes the following settings:
iam_key_token: IAM key token. Overrides the environment variableLUMI_IAM_KEY_TOKEN.
Not recommended in your.tffile since this can leak your credentials.app_endpoint: Endpoint to manage IAM keys. Overrides the environment variableLUMI_APP_ENDPOINT.endpoint: Endpoint to manage pipelines. Overrides the environment variableLUMI_ENDPOINT.
The following example sets both endpoints in the provider block and reads the IAM key token from the LUMI_IAM_KEY_TOKEN environment variable:
terraform {
required_providers {
lumi = {
source = "implydata/lumi"
}
}
}
provider "lumi" {
app_endpoint = "https://lumi.imply.io"
endpoint = "https://us1.api.lumi.imply.io"
}
If you define all settings as environment variables, you can define the provider as an empty block:
provider "lumi" {}
Installation
Install the Imply Lumi Terraform provider, configure authentication, and verify your setup.
IAM keys
Manage IAM keys, their integrations, and integration attributes using the Imply Lumi Terraform provider.
Pipelines
Manage custom and predefined pipelines using the Imply Lumi Terraform provider.