Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sumologic/terraform-provider-sumologic
Terraform provider for Sumo Logic
https://github.com/sumologic/terraform-provider-sumologic
sumologic terraform terraform-provider
Last synced: about 1 month ago
JSON representation
Terraform provider for Sumo Logic
- Host: GitHub
- URL: https://github.com/sumologic/terraform-provider-sumologic
- Owner: SumoLogic
- License: mpl-2.0
- Created: 2020-04-08T22:17:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T18:06:17.000Z (7 months ago)
- Last Synced: 2024-05-22T19:29:31.924Z (7 months ago)
- Topics: sumologic, terraform, terraform-provider
- Language: Go
- Homepage: https://www.terraform.io/docs/providers/sumologic/
- Size: 16.6 MB
- Stars: 35
- Watchers: 34
- Forks: 51
- Open Issues: 109
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Terraform Provider for Sumo Logic
- Website: [terraform.io](https://terraform.io)
- Chat: [gitter](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing List: [Google Groups](http://groups.google.com/group/terraform-tool)
The Terraform Sumo Logic provider is a plugin for Terraform that allows for the full lifecycle management of Sumo Logic resources.
This provider is maintained by Sumo Logic.
## Getting started
[Using the provider](https://www.terraform.io/docs/providers/sumologic/)
Run `terraform init` to automatically install the latest version of the provider.
Requirements
------------
- [Terraform](https://www.terraform.io/downloads.html) 0.12.x, 0.13x, or 0.14x
- [Go](https://golang.org/doc/install) >= 1.13 (to build the provider plugin)
- [Sumo Logic](https://www.sumologic.com/)
## Developing the provider
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine. You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
Clone repository to: `$GOPATH/src/SumoLogic/sumologic-terraform-provider`
```sh
$ mkdir -p $GOPATH/src/SumoLogic;
$ cd $GOPATH/src/SumoLogic
$ git clone https://github.com/SumoLogic/terraform-provider-sumologic.git
```
Enter the provider directory and build the provider. To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
```sh
$ cd $GOPATH/src/SumoLogic/terraform-provider-sumologic
$ make build
```
## Testing the provider
In order to test the provider, you can run `make test`.
For manual testing, run `make install` in the root directory to install it as a plugin.
Then run `terraform init` to initialize it.
In order to run the full suite of Acceptance tests, run `make testacc`.
To run a specific acceptance test, run `go test -v ./sumologic -run YourSpecificTestName`
*Note:*
- Acceptance tests *create real resources*, and often cost money to run. The environment variables `SUMOLOGIC_ACCESSID`, `SUMOLOGIC_ACCESSKEY`, `SUMOLOGIC_ENVIRONMENT` / `SUMOLOGIC_BASE_URL`, and `TF_ACC` must also be set for acceptance tests to work properly. You can generate a personal access key from your environment. Once your test runs, you are then capable of viewing the real resources created by Terraform in the UI.
```sh
$ export SUMOLOGIC_ACCESSID="yourAccessID"
$ export SUMOLOGIC_ACCESSKEY="yourAccessKey"
$ export SUMOLOGIC_ENVIRONMENT="yourEnvironment"
$ export SUMOLOGIC_BASE_URL="yourEnvironmentAPIUrl"
$ export TF_ACC=1
```
- More information on configuration can be found [here](https://github.com/SumoLogic/terraform-provider-sumologic/blob/master/website/docs/index.html.markdown#environment-variables).
- Environment variable `SUMOLOGIC_TEST_GOOGLE_APPLICATION_CREDENTIALS` must be set for gcp metrics acceptance tests to work properly (ex. below).
- export SUMOLOGIC_TEST_GOOGLE_APPLICATION_CREDENTIALS=`cat /path/to/service_acccount.json`
- Set Environment variable `SUMOLOGIC_ENABLE_GCP_METRICS_ACC_TESTS` to false, to disable acceptance test for Gcp Metrics.
[0]: https://help.sumologic.com/Manage/Security/Access-Keys
[1]: https://help.sumologic.com/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security
[10]: https://www.terraform.io/docs/providers/sumologic/