terraform-provider-meraki

README

terraform-provider-meraki

terraform-provider-meraki is a Terraform Provider for Cisco Meraki

Requirements

• Terraform 0.13.x
• Go 1.21 (to build the provider plugin)

Introduction

The terraform-provider-meraki provides a Terraform provider for managing and automating your Cisco Meraki environment. It consists of a set of resources and data-sources for performing tasks related to Meraki.

This collection has been tested and supports Cisco Meraki 1.33.0.

Using the provider

There are two ways to get and use the provider.

1. Downloading & installing it from registry.terraform.io
2. Building it from source

From registry

To install this provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    meraki = {
      source = "cisco-open/meraki"
      version = "0.2.13-alpha"
    }
  }
}

provider "meraki" {
  # Configuration options
  # More info at https://registry.terraform.io/providers/cisco-open/meraki/latest/docs#example-usage
}

From build

Clone this repository to: $GOPATH/src/github.com/cisco-open/terraform-provider-meraki

mkdir -p $GOPATH/src/github.com/meraki/
cd $GOPATH/src/github.com/meraki/
git clone https://github.com/cisco-open/terraform-provider-meraki.git

Enter the provider directory and build the provider

cd $GOPATH/src/github.com/cisco-open/terraform-provider-meraki
make build

If the Makefile values (HOSTNAME, NAMESPACE, NAME, VERSION) were not changed, then the following code could used without changes. Otherwise change the values accordingly.

To use this provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    meraki = {
      source = "hashicorp.com/edu/meraki"
      version = "0.2.13-alpha"
    }
  }
}

provider "meraki" {
  # Configuration options
  # More info at https://registry.terraform.io/providers/cisco-open/meraki/latest/docs#example-usage
}

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.15+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

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

$ make build
...
$ $GOPATH/bin/terraform-provider-meraki
...

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources.

$ make testacc

Documentation

In the docs directory, you can find the documentation.

Compatibility matrix

The following table shows the supported versions.

Dashboard Api version	Terraform "meraki" provider version	Go "dashboard-api-go" version
1.33.0	0.1.0-alpha	2.0.9
1.44.1	0.2.0-alpha	3.0.0

If your SDK, Terraform provider is older please consider updating it first.

Contributing

Ongoing development efforts and contributions to this provider are tracked as issues in this repository.

We welcome community contributions to this project. If you find problems, need an enhancement or need a new data-source or resource, please open an issue or create a PR against the Terraform Provider for Cisco Meraki repository.

Change log

All notable changes to this project will be documented in the CHANGELOG file.

The development team may make additional changes as the library evolves with the Cisco Meraki.

License

This library is distributed under the license found in the LICENSE file.