Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utilitywarehouse/terraform-provider-megaport
Terraform provider for https://megaport.com
https://github.com/utilitywarehouse/terraform-provider-megaport
megaport terraform terraform-provider uw-dep-go uw-owner-system
Last synced: about 19 hours ago
JSON representation
Terraform provider for https://megaport.com
- Host: GitHub
- URL: https://github.com/utilitywarehouse/terraform-provider-megaport
- Owner: utilitywarehouse
- License: mpl-2.0
- Created: 2019-09-26T16:12:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T23:00:51.000Z (7 months ago)
- Last Synced: 2024-11-16T02:12:53.400Z (about 1 month ago)
- Topics: megaport, terraform, terraform-provider, uw-dep-go, uw-owner-system
- Language: Go
- Homepage:
- Size: 466 KB
- Stars: 9
- Watchers: 12
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform Provider for Megaport
- [](https://travis-ci.org/utilitywarehouse/terraform-provider-megaport)
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) 0.12+
- [Go](https://golang.org/doc/install) 1.13 (to build the provider plugin)
## Credentials
To use the Megaport API, this Provider requires that a Megaport API access token
is provided. To simplify the process of obtaining a new access token, there is a
utility tool you can use. It is recommended that the token is provided via the
`MEGAPORT_TOKEN` environment variable.
To retrieve a new token for the megaport api and export it as a variable:
```sh
$ export $(make reset-token)
```
Alternatively, you can use the helper tool directly:
```sh
$ cd util/megaport_token
$ go run .
```
To revoke the current token (and get a new one) you can pass the `--reset` flag.
By default, the above script will obtain a token to use with megaport staging
api environment. You can set `MEGAPORT_ENDPOINT` environment variable to specify
an alternative endpoint. For example, to get a token for megaport production
api, you can use the above target as:
```sh
MEGAPORT_ENDPOINT=https://api.megaport.com make reset-token
```
## Developing the Provider
If you wish to work on the provider, you'll first need
[Go](http://www.golang.org) installed on your machine (please check the
[requirements](#requirements) before proceeding).
```sh
$ git clone https://github.com/utilitywarehouse/terraform-provider-megaport.git
...
$ cd terraform-provider-megaport
```
To compile the provider, run `make build`. This will build the provider and put
the provider binary in the `$GOPATH/bin` directory.
```sh
$ make build
...
$ $GOPATH/bin/terraform-provider-megaport
...
```
## Using the Provider
You can simply use the provider published in the Terraform Registry [here](https://registry.terraform.io/providers/utilitywarehouse/megaport/latest)
to manage your terraform resources.
To use a custom-built provider in your Terraform environment (e.g. the provider
binary from the build instructions above), follow the instructions to
[install it as a plugin](https://www.terraform.io/docs/plugins/basics.html#installing-plugins).
After placing the custom-built provider into your plugins directory,
run `terraform init` to initialize it.
### Provider Documentation
To browse the documentation, you can simply `make website` to serve it locally.
```sh
$ make website
...
```
Additionally, there are a number of templated examples (used in acceptance
testing) inside the `examples/` directory.
## Testing the Provider
In order to test the provider, you can run `make test`.
```sh
$ make test
```
In order to run the full suite of Acceptance tests, run `make testacc`.
*Note:* Acceptance tests create real resources, and often cost money to run. By
default, acceptance tests for this provider are run in the staging Megaport
environment which does not incur any costs.
```sh
$ make testacc
```
## Contributing
Terraform is the work of thousands of contributors. We appreciate your help!
To contribute, please read the contribution guidelines:
[Contributing to Terraform - Megaport Provider](.github/CONTRIBUTING.md)
GitHub issues are intended for bugs or feature requests related to the Megaport
provider codebase. See https://www.terraform.io/docs/extend/community/index.html
for a list of community resources to ask questions about Terraform.