Git Product home page Git Product logo

hashicorp / terraform-provider-cloudflare Goto Github PK

View Code? Open in Web Editor NEW

This project forked from cloudflare/terraform-provider-cloudflare

1.0 2.0 5.0 23.05 MB

This has moved to https://github.com/cloudflare/terraform-provider-cloudflare

Home Page: https://github.com/cloudflare/terraform-provider-cloudflare

License: Mozilla Public License 2.0

Makefile 0.35% Go 97.70% Shell 0.38% HTML 1.57%

terraform-provider-cloudflare's Introduction

Terraform Provider

Requirements

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

Building The Provider

Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-cloudflare

$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone https://github.com/terraform-providers/terraform-provider-cloudflare.git

When it comes to building you have two options:

make build and install it globally

If you don't mind installing the development version of the provider globally, you can use make build in the provider directory which will build and link the binary into your $GOPATH/bin directory.

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-cloudflare
$ make build

go build and install it local to your changes

If you would rather install the provider locally and not impact the stable version you already have installed, you can use the ~/.terraformrc file to tell Terraform where your provider is. You do this by building the provider using Go.

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-cloudflare
$ go build -o terraform-provider-cloudflare

And then update your ~/.terraformrc file to point at the location you've built it.

providers {
  cloudflare = "${GOPATH}/src/github.com/terraform-providers/terraform-provider-cloudflare/terraform-provider-cloudflare"
}

A caveat with this approach is that you will need to run terraform init whenever the provider is rebuilt. You'll also need to remember to comment it/remove it when it's not in use to avoid tripping yourself up.

Developing the Provider

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

See above for which option suits your workflow for building the provider.

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

Managing dependencies

Terraform providers use Go modules to manage the dependencies. To add or update a dependency, you would run the following (v1.2.3 of foo is a new package we want to add):

# Depending on your environment, you may need to `export GO111MODULE=on`
# before using these commands.

$ go get [email protected]
$ go mod tidy
$ go mod vendor

Stepping through the above commands:

  • go get [email protected] fetches version v1.2.3 from the source (if needed) and adds it to the go.mod file for use.
  • go mod tidy cleans up any dangling dependencies or references that aren't defined in your module file.
  • go mod vendor manages the vendor directory of the project. This is done to maintain backwards compatibility with older versions of Go that don't support Go modules.

(The example above will also work if you'd like to upgrade to v1.2.3)

If you wish to remove a dependency, you can remove the reference from go.mod and use the same commands above but omit the initial go get.

terraform-provider-cloudflare's People

Contributors

benjvi avatar blakeembrey avatar bobrik avatar catsby avatar dhoeric avatar evesy avatar grubernaut avatar gstotts avatar jacobbednarz avatar matthieudolci avatar mbrowne avatar mitchellh avatar nlamirault avatar ojford avatar patryk avatar pdecat avatar pearkes avatar radeksimko avatar renovate-bot avatar renovate[bot] avatar sean- avatar sethvargo avatar stack72 avatar stevegoldthorpe-work avatar stevehodgkiss avatar tootedom avatar tristan-weil avatar xaf avatar xens avatar zackproser avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.