Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elasticpath/terraform-provider-epcc
https://github.com/elasticpath/terraform-provider-epcc
elastic-path elastic-path-commerce-cloud terraform terraform-provider
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elasticpath/terraform-provider-epcc
- Owner: elasticpath
- License: agpl-3.0
- Created: 2021-05-11T13:45:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-11T19:36:41.000Z (over 1 year ago)
- Last Synced: 2024-06-21T09:49:50.900Z (7 months ago)
- Topics: elastic-path, elastic-path-commerce-cloud, terraform, terraform-provider
- Language: Go
- Homepage:
- Size: 5.29 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Elastic Path Commerce Cloud Terraform Provider
This repository contains a [Terraform](https://www.terraform.io) provider for the [Elastic Path Commerce Cloud API](https://documentation.elasticpath.com/commerce-cloud/docs/api/).
This project was based upon the [Terraform Provider Scaffolding Project](https://github.com/hashicorp/terraform-provider-scaffolding)
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) >= 0.15.x
- [Go](https://golang.org/doc/install) >= 1.15
## Building The Provider
1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
```sh
$ go install
```
## Environment Variables
The following environment variables are defined in the EPCC Terraform Provider.
| Name | Default | Description |
|--------------------------|------------------| ------------ |
| `EPCC_API_BASE_URL` | - | The Base URL of the EPCC API |
| `EPCC_BETA_API_FEATURES` | - | The value of the `EP-Beta-Features` header being sent to the EPCC API |
| `EPCC_CLIENT_ID` | - | Client ID used for authenticating to the EPCC API |
| `EPCC_CLIENT_SECRET` | - | Client Secret used for authenticating to the EPCC API |
| `EPCC_RATE_LIMIT` | 25 | A limit on the number of requests that can be made per second to EPCC |
| `EPCC_LOG_DIR` | (work directory) | The directory of the http log files |
## Adding Dependencies
This provider uses [Go modules](https://github.com/golang/go/wiki/Modules). Please see the Go documentation for the most up to date information about using Go
modules.
To add a new dependency `github.com/author/dependency` to your Terraform provider:
```
go get github.com/author/dependency
go mod tidy
```
Then commit the changes to `go.mod` and `go.sum`.
## Project Layout
This project follows the terraform provider template: [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
| Directory | Description |
|-------------------|------------------------------------------------------------------------------------------------|
| `docs/` | Folder that contains documentation |
| `examples/` | Directory for sample resources and data sources |
| `component-tests/` | Component tests for the service are located in here. |
| `external/` | Any Go package that can be shared with other projects |
| `internal/` | Application specific Go packages, e.g., they cannot be shared and are specific to this service|
## Using the provider
You would use the epcc-terraform-provider just as any other terraform provider. See the `./examples` directory for sample resources and data sources.
See the [Core Terraform Workflow] (https://www.terraform.io/guides/core-workflow.html) page for more info on using Terraform.
## Useful commands
| Command | Description |
| ----------------| ----------------------------------------------------------------------------------------------|
| go install | Compile the provider. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.|
| go generate | Generate or update documentation |
| make testacc | Runs the full suite of Acceptance tests |
## Debugging the Provider
1. Run `make build`
2. Run the following command (assuming you've installed delve)
```bash
dlv exec --accept-multiclient --continue --headless ./bin/terraform-provider-epcc --listen=:41837 -- -debug
```
3. Connect with your Debugger
4. Find the line `TF_REATTACH_PROVIDERS` in the output
5. When running terraform prefix the above to the command, for example:
```
TF_REATTACH_PROVIDERS='...' terraform apply
```
## Code Style
Please run `gofmt` prior to committing, the following [pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) (create and mark executable
in `.git/hooks/pre-commit`) can do this automatically for you
```bash
#!/bin/bash
echo "Running commit hook"
echo "Fixing changed files"
git diff --cached --name-only --diff-filter=ACM | grep -E "\.go$" | xargs -n 1 -d "\n" gofmt -s -w
git diff --cached --name-only --diff-filter=ACM | grep -E "\.go$" | xargs git add
echo "Inspecting all other files"
if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then
echo "Code style differences detected:"
gofmt -s -l .
exit 1
fi
```
[Debugging Providers](https://www.terraform.io/docs/extend/debugging.html#starting-a-provider-in-debug-mode)
### Useful Links
1. [AWS SDK for Go](https://github.com/aws/aws-sdk-go-v2)
2. [Extending Terraform](https://www.terraform.io/docs/extend/index.html)
3. [AWS Terraform Provider](https://github.com/hashicorp/terraform-provider-aws)