An open API service indexing awesome lists of open source software.

https://github.com/epilot-dev/terraform-provider-epilot-erp-integration


https://github.com/epilot-dev/terraform-provider-epilot-erp-integration

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# epilot-erp-integration

Terraform Provider for the *epilot-erp-integration* API.






## Summary

ERP Integration API: API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates.

## Summary

ERP Integration API: API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates.

## Table of Contents

* [epilot-erp-integration](#epilot-erp-integration)
* [Installation](#installation)
* [Authentication](#authentication)
* [Available Resources and Data Sources](#available-resources-and-data-sources)
* [Testing the provider locally](#testing-the-provider-locally)

## Installation

To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.

```hcl
terraform {
required_providers {
epilot-erp-integration = {
source = "epilot-dev/epilot-erp-integration"
version = "0.19.1"
}
}
}

provider "epilot-erp-integration" {
epilot_auth = "" # Required
server_url = "..." # Optional
}
```

## Authentication

This provider supports authentication configuration via provider configuration.

Available configuration:

| Provider Attribute | Description |
|---|---|
| `epilot_auth` | Authorization header with epilot OAuth2 bearer token. |

## Available Resources and Data Sources

### Managed Resources

* [epilot-erp-integration_integration](docs/resources/integration.md)

### Data Sources

* [epilot-erp-integration_integration](docs/data-sources/integration.md)

## Testing the provider locally

#### Local Provider

Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.

This also allows for debuggers (e.g. delve) to be attached to the provider.

```sh
go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply
```

#### Compiled Provider

Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.

1. Execute `go build` to construct a binary called `terraform-provider-epilot-erp-integration`
2. Ensure that the `.terraformrc` file is configured with a `dev_overrides` section such that your local copy of terraform can see the provider binary

Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.

```
provider_installation {

dev_overrides {
"registry.terraform.io/epilot-dev/epilot-erp-integration" = ""
}

# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```