Go to file
Nicolas Leiva ee34a15b82
Bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.17.0 to 2.18.0
Bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.17.0 to 2.18.0
2022-07-11 09:05:19 -04:00
.github Fix generate test error 2022-06-02 01:36:08 -04:00
.vscode first working version 2022-04-28 03:01:16 -04:00
client Add client library test example 2022-05-07 16:40:31 -04:00
docs Manual update to terraform-plugin-docs@v0.9.0 2022-06-02 01:47:27 -04:00
examples Add manufacturer update 2022-04-28 11:53:42 -04:00
internal/provider re-arranged code 2022-05-05 11:18:56 +01:00
tools first working version 2022-04-28 03:01:16 -04:00
.gitignore first working version 2022-04-28 03:01:16 -04:00
.goreleaser.yml first working version 2022-04-28 03:01:16 -04:00
CHANGELOG.md first working version 2022-04-28 03:01:16 -04:00
GNUmakefile Gracefully handle manually deleted resources 2022-05-01 00:07:35 -04:00
LICENSE first working version 2022-04-28 03:01:16 -04:00
README.md Update readme 2022-05-01 00:10:35 -04:00
go.mod Bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.17.0 to 2.18.0 2022-07-06 00:52:34 +00:00
go.sum Bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.17.0 to 2.18.0 2022-07-06 00:52:34 +00:00
main.go first working version 2022-04-28 03:01:16 -04:00
terraform-registry-manifest.json first working version 2022-04-28 03:01:16 -04:00

README.md

Terraform Provider Nautobot

Nautobot provider created for educational purposes. You can fork it for long term development :-)

Requirements

Building The Provider

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

Adding Dependencies

This provider uses Go 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:

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

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

Using the provider

The provide takes two arguments, url and token. For the data sources and resources supported, take a look at the internal/provider folder. In the next example, we capture the data of all manufacturers and create a new manufacturer "Vendor I".

terraform {
  required_providers {
    nautobot = {
      version = "0.2.4"
      source  = "nleiva/nautobot"
    }
  }
}

provider "nautobot" {
  url = "https://demo.nautobot.com/api/"
  token = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

data "nautobot_manufacturers" "all" {}

resource "nautobot_manufacturer" "new" {
  description = "Created with Terraform"
  name    = "Vendor I"
}

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 make install.

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

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.

$ make testacc