You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-8Lines changed: 31 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,26 +8,49 @@ This provider is used to manage multiple configuration entities within the Sumo
8
8
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.
9
9
10
10
## License
11
-
Released under Apache 2.0 License.
11
+
Released under Mozilla Public License 2.0.
12
12
13
13
# Getting started / usage
14
14
15
15
See [docs][10]
16
16
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
-
21
17
Requirements
22
18
------------
23
19
24
20
-[Terraform](https://www.terraform.io/downloads.html) 0.11.x or 0.12.x
25
21
-[Go](https://golang.org/doc/install) >= 1.9 (to build the provider plugin)
26
22
-[Sumo Logic](https://www.sumologic.com/pricing/)
27
23
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`
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.
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.
0 commit comments