Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 2.71 KB

README.md

File metadata and controls

96 lines (68 loc) · 2.71 KB
Raw

This repository is an unofficial fork

The fork is mostly based of the official (now archived) repo. The provider has also some extra changes and solves almost all the reported issues.

I incorporated changes by winebarrel/terraform-provider-mysql. Because I found out about that repo only after some work, PR cannot be created easily now. Feel free to create a PR with my code to their repo or the other way around.

Build Status

Terraform Provider

Requirements

  • Terraform 0.12.x
  • Go 1.17 (to build the provider plugin)

Usage

For Terraform 0.12+ compatibility, the configuration should specify version 1.6 or higher:

provider "mysql" {
  version = "~> 1.6"
}

Building The Provider

If you want to reproduce a build (to verify my build confirms to sources), download the provider of any version first and find the correct go version:

egrep -a -o 'go1[0-9\.]+' path_to_the_provider_binary

Clone the repository anywhere. Use goreleaser to build the packages for all architectures:

goreleaser build --clean

Files in dist should match whatever is provided. If they don't, consider reading https://words.filippo.io/reproducing-go-binaries-byte-by-byte/ or open an issue here.

Using the provider

Fill in for each provider

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.17+ 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 bin
...
$ $GOPATH/bin/terraform-provider-mysql
...

Ensure local requirements are present:

  1. Docker environment
  2. mysql-client binary which can be installed on Mac with brew install mysql-client@8.0
    1. Then add it to your path OR brew link mysql-client@8.0

Running tests

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, and often cost money to run.

$ make testacc

If you want to run the Acceptance tests on your own machine with a MySQL in Docker:

make acceptance
# or to test only one mysql version:
make testversion8.0