Skip to content

Commit a84d227

Browse files
author
Sean Sain
committed
update readme with testing and dev info
1 parent 4a0c1f4 commit a84d227

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,49 @@ This provider is used to manage multiple configuration entities within the Sumo
88
The code in this repository has been developed in collaboration with the Sumo Logic community and is not supported via standard Sumo Logic Support channels. For any issues or questions please submit an issue within the GitHub repository. The maintainers of this project will work directly with the community to answer any questions, address bugs, or review any requests for new features.
99

1010
## License
11-
Released under Apache 2.0 License.
11+
Released under Mozilla Public License 2.0.
1212

1313
# Getting started / usage
1414

1515
See [docs][10]
1616

17-
# Building the provider
18-
19-
In this section you will learn how to build and run terraform-provider-sumologic locally. Please follow the steps below:
20-
2117
Requirements
2218
------------
2319

2420
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x or 0.12.x
2521
- [Go](https://golang.org/doc/install) >= 1.9 (to build the provider plugin)
2622
- [Sumo Logic](https://www.sumologic.com/pricing/)
2723

28-
Build and install
29-
------------
30-
`make install`
24+
# Using the provider
25+
26+
To use the provider run `make install` in the root direcory to install it as a plugin. You can then run `terraform init` to initialize it.
27+
28+
# Developing the provider
29+
30+
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`.
31+
32+
Clone repository to: `$GOPATH/src/SumoLogic/sumologic-terraform-provider`
33+
34+
```sh
35+
$ mkdir -p $GOPATH/src/SumoLogic;
36+
$ cd $GOPATH/src/SumoLogic
37+
$ git clone [email protected]:SumoLogic/sumologic-terraform-provider.git
38+
```
39+
40+
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.
41+
42+
```sh
43+
$ cd $GOPATH/src/SumoLogic/sumologic-terraform-provider
44+
$ make build
45+
```
46+
47+
# Testing the provider
48+
49+
In order to test the provider, you can run `make test`.
50+
51+
In order to run the full suite of Acceptance tests, run `make testacc`.
52+
53+
*Note:* Acceptance tests *create real resources*, and often cost money to run. The environment variables `SUMOLOGIC_ACCESSID`, `SUMOLOGIC_ACCESSKEY`, and `SUMOLOGIC_ENVIRONMENT` must also be set for acceptance tests to work properly.
3154

3255
[0]: https://help.sumologic.com/Manage/Security/Access-Keys
3356
[1]: https://help.sumologic.com/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security

0 commit comments

Comments
 (0)