terraform-provider-zip2b64

README

terraform-provider-zip2b64

https://github.com/Ackers-BUD/terraform-provider-zip2b64 and Provider https://github.com/Ackers-BUD/terraform-provider-http2b64 were written to work together. The provider http2b64 requests an URL and will take whatever the URL serves saving it as a base64 encoded string. zip2b64 then takes this encoded value as a zip file and extracts a specifc file from the archive.

This was written as a specific suppiler, provides the provisioning information to a service as a zip file on every invocation of that service. The zip file contains a range of details needed to use the service. Each needs to be used in terraform.

Example Usage

resource "http-b64" "provisioningzipfile" {
    provider = http-b64
    url      = "http://<url-to-a-zipfile>.zip"
}

resource "zip2b64" "extractedfile" {
    provider = zip2b64
    base64file = http-b64.provisioningzipfile.response_body_base64
    filename = "/ca.crt"
}

http-b64 values

"url"

The URL of the request

"id" (computed)

Set as the URL of the Request.

"status_code" (computed)

The Status code of the http request. Useful if determining if file isn't found. ALL request bodies regardless of http code are converted to base64.

"response_body_base64" (computed)

A base64 representation of the the responce.

zip2b64 values

"base64file" (required)

A base64 string respresenting a zip file

"filename" (required)

The filename in the zip file looking to extract

"id" (computed)

Typically the filename

"filecontents_base64" (computed)

A base64 representation of the extracted file

Requirements

• Terraform (>= 0.12)
• Go (1.18)
• golangci-lint (optional)

Development

Building

1. git clone this repository and cd into its directory
2. make will trigger the Golang build

The provided Makefile defines additional commands generally useful during development, like for running tests, generating documentation, code formatting and linting. Taking a look at it's content is recommended.

Testing

In order to test the provider, you can run

• make test to run provider tests
• make testacc to run provider acceptance tests

It's important to note that acceptance tests (testacc) will actually spawn terraform and the provider. Read more about they work on the official page.

Generating documentation

This provider uses terraform-plugin-docs to generate documentation and store it in the docs/ directory. Once a release is cut, the Terraform Registry will download the documentation from docs/ and associate it with the release version. Read more about how this works on the official page.

Use make generate to ensure the documentation is regenerated with any changes.

Using a development build

If running tests and acceptance tests isn't enough, it's possible to set up a local terraform configuration to use a development builds of the provider. This can be achieved by leveraging the Terraform CLI configuration file development overrides .

First, use make install to place a fresh development build of the provider in your ${GOBIN} (defaults to ${GOPATH}/bin or ${HOME}/go/bin if ${GOPATH} is not set). Repeat this every time you make changes to the provider locally.

Then, setup your environment following these instructions to make your local terraform use your local build.