README.md

Netbox BGP Plugin Terraform Provider

This provider allows managing BGP resources in Netbox, when the Netbox BGP plugin is installed.

The provider is intentionally using a similar structure to the e-breuninger/netbox provider. If you're already using that provider, this provider should work smoothly alongside it.

Configure

Example configuration:

provider "netboxbgp" {
  server_url = "https://netbox.my-company.net"
  api_token  = var.netbox_api_token
}

You can also set the provider config from environment variables:

• NETBOX_SERVER_URL in place of server_url
• NETBOX_API_TOKEN in place of api_token

For more details and additional properties, see the docs.

Development

Requirements

• Terraform >= 1.0
• Go >= 1.22
• Docker

Building The Provider

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

go install

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see 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 testacc