Go to file
Nicolas Leiva 05d55f809f
OAPI NB Client Generation Fix (#56)
OAPI NB Client Generation Fix
2023-03-29 15:25:26 -04:00
.github Bump actions/setup-go from 3 to 4 2023-03-28 01:00:59 +00:00
.vscode first working version 2022-04-28 03:01:16 -04:00
client Attempting to fix nb go client generation. OpenAPI spec is wrong and will need to be fixed upstream but still partly broken. 2023-03-28 14:10:13 -06:00
docs Merge latest updates in and get the same updates as pipeline. This should solve the pipeline issue. 2023-03-27 08:59:56 -06:00
examples Add manufacturer update 2022-04-28 11:53:42 -04:00
internal/provider Due to update in oapi-codegen it appears it generates different methods/funcs, but tested the provider for manufacturers and it works, not sure if something broke. 2023-03-28 18:59:09 -06:00
test Bump to version 0.3.2 2023-03-27 13:33:14 -04:00
tools first working version 2022-04-28 03:01:16 -04:00
.gitignore Bump to version 0.3.0 2023-03-27 11:45:02 -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 Due to update in oapi-codegen it appears it generates different methods/funcs, but tested the provider for manufacturers and it works, not sure if something broke. 2023-03-28 18:59:09 -06:00
LICENSE first working version 2022-04-28 03:01:16 -04:00
README.md Bump to version 0.3.2 2023-03-27 13:33:14 -04:00
go.mod Merge latest updates in and get the same updates as pipeline. This should solve the pipeline issue. 2023-03-27 08:59:56 -06:00
go.sum Upgrade all dependencies and make changes that broke in oapi and UUID conversions. 2023-03-26 20:08:32 -06: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.3.2"
      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).

There are a few make tagets you can leverage you can leverage:

  • make install: To compile the provider.
  • go generate ./...: To generate or update documentation.
  • make local: Test local version of the provider.
  • make testacc: To run the full suite of Acceptance tests.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc