diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..3aeca19 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,38 @@ +build: + image: golang:1.5 + environment: + - CGO_ENABLED=0 + commands: + - make deps + - make vet + - make build + - make test + +publish: + coverage: + when: + branch: master + docker: + username: $$DOCKER_USER + password: $$DOCKER_PASS + email: $$DOCKER_EMAIL + repo: plugins/drone-terraform + tag: latest + when: + branch: master + docker: + username: $$DOCKER_USER + password: $$DOCKER_PASS + email: $$DOCKER_EMAIL + repo: plugins/drone-terraform + tag: develop + when: + branch: develop + +plugin: + name: Terraform + desc: Execute Terraform plan and apply + type: deploy + image: plugins/drone-terraform + labels: + - terraform diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/DOCS.md b/DOCS.md new file mode 100644 index 0000000..7748118 --- /dev/null +++ b/DOCS.md @@ -0,0 +1,24 @@ +Use the Terraform plugin to apply the infrastructure configuration contained within the repository. The following parameters are used to configure this plugin: + +* `dry_run` - if true, calculates a plan but does __NOT__ apply it. +* `remote` - contains the configuration for the Terraform remote state tracking. + * `backend` - the Terraform remote state backend to use. + * `config` - a map of configuration parameters for the remote state backend. Each value is passed as a `-backend-config==` option. +* `vars` - a map of variables to pass to the Terraform `plan` and `apply` commands. Each value is passed as a `-var =` option. + +The following is a sample Terraform configuration in your .drone.yml file: + +```yaml +deploy: + terraform: + dry_run: false + remote: + backend: S3 + config: + bucket: my-terraform-config-bucket + key: tf-states/my-project + region: us-east-1 + vars: + app_name: my-project + app_version: 1.0.0 +``` diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..e8f6edd --- /dev/null +++ b/Dockerfile @@ -0,0 +1,19 @@ +# Docker image for Drone's terraform deployment plugin +# +# CGO_ENABLED=0 go build -a -tags netgo +# docker build --rm=true -t plugins/drone-terraform . + +FROM gliderlabs/alpine:3.2 +RUN apk-install ca-certificates + +ENV TERRAFORM_VERSION 0.6.9 + +RUN apk update && \ + wget -q "https://circle-artifacts.com/gh/andyshinn/alpine-pkg-glibc/6/artifacts/0/home/ubuntu/alpine-pkg-glibc/packages/x86_64/glibc-2.21-r2.apk" && \ + apk add --allow-untrusted glibc-2.21-r2.apk && \ + wget -q -O terraform.zip "https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_linux_amd64.zip" && \ + unzip terraform.zip -d /bin && \ + rm -rf /var/cache/apk/* glibc-2.21-r2.apk terraform.zip + +ADD drone-terraform /bin/ +ENTRYPOINT ["/bin/drone-terraform"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c304d1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d1cd996 --- /dev/null +++ b/Makefile @@ -0,0 +1,32 @@ +.PHONY: clean deps fmt vet test docker + +EXECUTABLE ?= drone-terraform +IMAGE ?= plugins/$(EXECUTABLE) +CI_BUILD_NUMBER ?= 0 + +LDFLAGS = -X "main.buildDate=$(shell date -u '+%Y-%m-%d %H:%M:%S %Z')" +PACKAGES = $(shell go list ./... | grep -v /vendor/) + +clean: + go clean -i ./... + +deps: + go get -t ./... + +fmt: + go fmt $(PACKAGES) + +vet: + go vet $(PACKAGES) + +test: + @for PKG in $(PACKAGES); do go test -cover -coverprofile $$GOPATH/src/$$PKG/coverage.out $$PKG || exit 1; done; + +docker: + GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -ldflags '-s -w $(LDFLAGS)' + docker build --rm -t $(IMAGE) . + +$(EXECUTABLE): $(wildcard *.go) + go build -ldflags '-s -w $(LDFLAGS)' + +build: $(EXECUTABLE) diff --git a/README.md b/README.md index df9a59d..84b4519 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,7 @@ -# drone-terraform -Drone plugin for triggering Terraform deployments +# Drone Terraform Deploy Plugin + +This project provides a [Drone](drone.io) plugin docker image that contains the [Terraform](terraform.io) binaries and a small Go app that receives the Drone meta-data and executes Terraform commands. + +Documentation for Drone Plugin development can be found here: http://readme.drone.io/plugin/ + +See [DOCS](docs.md) for details on this plugin's configuration and usage. diff --git a/logo.svg b/logo.svg new file mode 100644 index 0000000..f658556 --- /dev/null +++ b/logo.svg @@ -0,0 +1,33 @@ + + + + +Created by potrace 1.13, written by Peter Selinger 2001-2015 + + + + + diff --git a/main.go b/main.go new file mode 100644 index 0000000..54498dc --- /dev/null +++ b/main.go @@ -0,0 +1,100 @@ +package main + +import ( + "fmt" + "os" + "os/exec" + "strings" + + "github.com/drone/drone-plugin-go/plugin" +) + +type terraform struct { + Remote remote `json:"remote"` + DryRun bool `json:"dry_run"` + Vars map[string]string `json:"vars"` +} + +type remote struct { + Backend string `json:"backend"` + Config map[string]string `json:"config"` +} + +func main() { + + workspace := plugin.Workspace{} + vargs := terraform{} + + plugin.Param("workspace", &workspace) + plugin.Param("vargs", &vargs) + plugin.MustParse() + + var commands []*exec.Cmd + remote := vargs.Remote + if remote.Backend != "" { + commands = append(commands, remoteConfigCommand(remote)) + } + commands = append(commands, planCommand(vargs.Vars)) + if !vargs.DryRun { + commands = append(commands, applyCommand()) + } + + for _, c := range commands { + c.Env = os.Environ() + c.Dir = workspace.Path + c.Stdout = os.Stdout + c.Stderr = os.Stderr + trace(c) + + err := c.Run() + if err != nil { + fmt.Println("Error!") + fmt.Println(err) + os.Exit(1) + } + fmt.Println("Command completed successfully") + } + +} + +func remoteConfigCommand(config remote) *exec.Cmd { + args := []string{ + "remote", + "config", + fmt.Sprintf("-backend=%s", config.Backend), + } + for k, v := range config.Config { + args = append(args, fmt.Sprintf("-backend-config=%s=%s", k, v)) + } + return exec.Command( + "terraform", + args..., + ) +} + +func planCommand(variables map[string]string) *exec.Cmd { + args := []string{ + "plan", + "-out=plan.tfout", + } + for k, v := range variables { + args = append(args, "-var") + args = append(args, fmt.Sprintf("%s=%s", k, v)) + } + return exec.Command( + "terraform", + args..., + ) +} + +func applyCommand() *exec.Cmd { + return exec.Command( + "terraform", + "apply", + "plan.tfout", + ) +} + +func trace(cmd *exec.Cmd) { + fmt.Println("$", strings.Join(cmd.Args, " ")) +}