Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ciscodevnet/terraform-provider-sdwan

Terraform Cisco SD-WAN Provider
https://github.com/ciscodevnet/terraform-provider-sdwan

cisco sd-wan sdwan terraform terraform-provider

Last synced: 4 days ago
JSON representation

Terraform Cisco SD-WAN Provider

Awesome Lists containing this project

README

        

[![Tests](https://github.com/CiscoDevNet/terraform-provider-sdwan/actions/workflows/test.yml/badge.svg)](https://github.com/CiscoDevNet/terraform-provider-sdwan/actions/workflows/test.yml)

# Terraform Provider SDWAN

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.22

## Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go `install` command:

```shell
go install
```

## Adding Dependencies

This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency `github.com/author/dependency` to your Terraform provider:

```shell
go get github.com/author/dependency
go mod tidy
```

Then commit the changes to `go.mod` and `go.sum`.

## Using the provider

This Terraform Provider is available to install automatically via `terraform init`. If you're building the provider, follow the instructions to
[install it as a plugin.](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin)
After placing it into your plugins directory, run `terraform init` to initialize it.

Additional documentation, including available resources and their arguments/attributes can be found on the [Terraform documentation website](https://registry.terraform.io/providers/CiscoDevNet/sdwan/latest/docs).

## Developing the Provider

If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).

To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.

To generate or update documentation, run `go generate`.

In order to run the full suite of Acceptance tests, run `make testacc`. Make sure the respective environment variables are set (e.g., `SDWAN_USERNAME`, `SDWAN_PASSWORD`, `SDWAN_URL`).

Note: Acceptance tests create real resources.

```shell
make testacc
```