Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opsgenie/terraform-provider-opsgenie
Terraform OpsGenie provider
https://github.com/opsgenie/terraform-provider-opsgenie
opsgenie terraform terraform-provider
Last synced: 5 days ago
JSON representation
Terraform OpsGenie provider
- Host: GitHub
- URL: https://github.com/opsgenie/terraform-provider-opsgenie
- Owner: opsgenie
- License: mpl-2.0
- Created: 2017-06-05T20:53:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T06:21:59.000Z (5 months ago)
- Last Synced: 2024-07-31T19:33:54.371Z (5 months ago)
- Topics: opsgenie, terraform, terraform-provider
- Language: Go
- Homepage: https://registry.terraform.io/providers/opsgenie/opsgenie/latest/docs
- Size: 10.3 MB
- Stars: 101
- Watchers: 24
- Forks: 134
- Open Issues: 120
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# Terraform Provider
- Website: https://www.terraform.io
- [](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
## Development
Everything needed to start local development and testing of the Provider plugin
### 1. Requirements
- [Go](https://golang.org/doc/install) 1.18 (or higher, to build the provider plugin)
- [Terraform](https://www.terraform.io/downloads.html) 0.12.x (To test the plugin)
### 2. Development Setup
#### Cloning the project
```bash
export GOPATH="${GOPATH:=$HOME/go}"
mkdir -p "$GOPATH/src/github.com/opsgenie"
cd "$GOPATH/src/github.com/opsgenie"
git clone [email protected]:opsgenie/terraform-provider-opsgenie
```
### 3. Compiling The Provider
```sh
export GOPATH="${GOPATH:=$HOME/go}"
cd "$GOPATH/src/github.com/opsgenie"
# Compile all versions of the provider and install it in GOPATH.
make build
# Only compile the local executable version (Faster)
make dev
```
#### Running tests on the Provider
Run all local unit tests.
```sh
make test
```
### 4. Using the Compiled Provider
#### Configure Terraform to use the compiled provider.
This configuration makes use of the [`dev_overrides`](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers).
See the [Manual Setup][Manual Setup] for more details.
```bash
# Creates $HOME/.terraformrc
make setup
```
#### Manual setup
Click to expand
1. Create the `.terraformrc` file on your in your home folder using `touch ~/.terraformrc`
2. Configure [`dev_overrides`](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers) in your `~/.terraformrc` as show below:
```hcl
provider_installation {
dev_overrides {
# Remember to replace with your username
"opsgenie/opsgenie" = "/home//go/bin"
}
direct {}
}
```
3. Run `make build`
#### New OpsGenie Terraform project
1. Create a basic terraform project locally with a `main.tf` file:
```hcl
terraform {
required_providers {
opsgenie = {
source = "opsgenie/opsgenie"
version = ">=0.6.0" # version can be omitted
}
}
}
# Configure the Opsgenie Provider
provider "opsgenie" {
api_key = "" # https://support.atlassian.com/opsgenie/docs/api-key-management/
api_url = "api.opsgenie.com" # can be a stage instance url for devs
}
resource "opsgenie_team" {
name = "Dev-Provider test team"
description = "New team made using in-development OpsGenie provider"
}
```
2. And, Add respective terraform change files which you want to apply on your OG instance
3. Run respective terraform commands to test the provider as per your convenience
Install the currently available provider with `tf init`
`terraform plan` and `terraform init` will use providers from the configured paths in `$HOME/.terraformrc`
`terraform` will output an error if no provider is found in the `dev_overrides` path. (`make build`)
#### Removing the 'dev_override' again
This allows you to use the normal release versions of the `opsgenie/opsgenie` provider.
*Note* Removes `$HOME/.terraformrc`
```bash
make clean
```