terraform-provider-keychain

README

Terraform Provider Keychain

This provider is used to manage the local macOS Keychain. Ideal for syncing a set of application or wifi passwords.

Note that this is macOS only!

Requirements

• Terraform 0.10.x
• Go 1.8 (to build the provider plugin)

Usage

See test.tf for more examples. There is no Provider required.

data "keychain_item" "test_key_name" {
  service = "MY_SERVICE"
  account = "An key name"
}

resource "keychain_item" "test_key" {
  service = "MY_SERVICE"
  account = "A key name"
  data    = "My key password"
}

data "keychain_wifi" "test_ssid_name" {
  account = "An ssid name"
}

resource "keychain_wifi" "test_ssid" {
  account = "A ssid name"
  data    = "My wifi password"
}

Building The Provider

Clone repository to: $GOPATH/src/github.com/thrashr888/terraform-provider-keychain

$ mkdir -p $GOPATH/src/github.com/thrashr888; cd $GOPATH/src/github.com/thrashr888
$ git clone git@github.com:thrashr888/terraform-provider-keychain

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/thrashr888/terraform-provider-keychain
$ make build

Developing the Provider

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

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

TODO

• Make the data source usable
• Allow the data source to return multiple items (??? might not want to)
• Add a separate provider for specifically wifi passwords
• Update the build & README according to the Terraform Provider Template
• Add API docs
• Add instructions on using with Terraform
• Add travis config