Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.43 KB

index.md

File metadata and controls

43 lines (31 loc) · 2.43 KB
page_title description
Provider: Coralogix
The Coralogix provider for configuring Coralogix.

Coralogix Provider

Coralogix is a cloud-based, SaaS analytics and monitoring platform that combines logs, metrics, and traces to gain full observability into your system using one tool. The platform ingests data from any digital source and transforms it using our core features, allowing you to fully understand your system, analyze that data efficiently, and respond to incidents before they become problems.

Manage your Coralogix account from Terraform, including alerts, dashboards, and more. First, sign up for an account at Coralogix.com and create an API key. With that key and your region you can then configure the provider as follows:

terraform {
  required_providers {
    coralogix = {
      version = "~> 2.0"
      source  = "coralogix/coralogix"
    }
  }
}

provider "coralogix" {
  #api_key = "<add your api key here or add env variable CORALOGIX_API_KEY>"
  #env = "<add the environment you want to work at or add env variable CORALOGIX_ENV>"
}
```<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `api_key` (String, Sensitive) A key for using coralogix APIs (Auto Generated), appropriate for the defined environment. environment variable 'CORALOGIX_API_KEY' can be defined instead.
- `domain` (String) The Coralogix domain. Conflict With 'env'. environment variable 'CORALOGIX_DOMAIN' can be defined instead.
- `env` (String) The Coralogix API environment. can be one of ["USA1" "APAC1" "US2" "AP1" "APAC2" "AP3" "EUROPE1" "EU1" "EU2" "US1" "AP2" "APAC3" "EUROPE2" "USA2"]. environment variable 'CORALOGIX_ENV' can be defined instead.# Getting Started

Check out our examples for how to configure the various resources offered by the provider. If you already have Coralogix set up and want to import any existing resources, check out our migration script: [https://github.com/coralogix/coralogix-management-sdk/tree/master/tools/terraform-importer]().

# Additional Notes

## Upgrading from V1.x.x to V2.x.x 

In this version upgrade we changed the schema of our alerts, which are now incompatible to previous versions. You can ease the transition process by using the importer tool mentioned above so your state is safely upgraded. Note that for existing Coralogix users an additional process is required for upgrading your account. Please reach out to customer support to receive more guidance.