README.md

Terraform Provider for Community SONiC

Built and maintained by Ben Goldstone and Contributors

---

Welcome to the Terraform Provider for Community SONiC!

• Requirements
• Building the Provider
• How to Contribute
• Adding Dependencies
• Using the Provider
• Developing the Provider

You can find the provider on the Hashicorp Terraform Registry

📋 Requirements

• Terraform >= 1.0
• Go >= 1.19

🚀 Building The Provider

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

go install .

Make sure you have overridden the community-sonic provider with a dev-override block in your ~/.terraformrc file:

  dev_overrides {
      "registry.terraform.io/dell/community-sonic" = "/home/[user]/go/bin"
  }

Ensure the above referenced directory matches your GOBIN go environment setup (recent go versions will default to $GOPATH/bin). You can view your go environment with go env

You can check the terraform provider by entering the examples/provider-install-verification directly and running terraform plan.

📋 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

This section is under construction..

👏 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.

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

make testacc