https://github.com/poseidon/terraform-provider-matchbox

Terraform provider for Matchbox on-premise / bare-metal provisioning
https://github.com/poseidon/terraform-provider-matchbox

butane fedora-coreos flatcar-linux matchbox terraform terraform-provider

Last synced: about 1 month ago
JSON representation

Terraform provider for Matchbox on-premise / bare-metal provisioning

• Host: GitHub
• URL: https://github.com/poseidon/terraform-provider-matchbox
• Owner: poseidon
• License: apache-2.0
• Created: 2017-04-04T21:58:42.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T19:02:03.000Z (7 months ago)
• Last Synced: 2024-05-17T20:22:56.954Z (7 months ago)
• Topics: butane, fedora-coreos, flatcar-linux, matchbox, terraform, terraform-provider
• Language: Go
• Homepage: https://registry.terraform.io/providers/poseidon/matchbox/latest/docs
• Size: 9.06 MB
• Stars: 123
• Watchers: 14
• Forks: 35
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# terraform-provider-matchbox

[![GoDoc](https://pkg.go.dev/badge/github.com/poseidon/terraform-provider-matchbox.svg)](https://pkg.go.dev/github.com/poseidon/terraform-provider-matchbox)

[![Workflow](https://github.com/poseidon/terraform-provider-matchbox/actions/workflows/test.yaml/badge.svg)](https://github.com/poseidon/terraform-provider-matchbox/actions/workflows/test.yaml?query=branch%3Amain)

![Downloads](https://img.shields.io/github/downloads/poseidon/terraform-provider-matchbox/total)

[![Sponsors](https://img.shields.io/github/sponsors/poseidon?logo=github)](https://github.com/sponsors/poseidon)

[![Mastodon](https://img.shields.io/badge/follow-news-6364ff?logo=mastodon)](https://fosstodon.org/@poseidon)

`terraform-provider-matchbox` allows defining [Matchbox](https://github.com/poseidon/matchbox) Profiles and Groups in Terraform. Matchbox matches machines, by label (e.g. MAC address), to Profiles with iPXE configs, Ignition configs, or generic free-form configs to provision clusters. Resources are created via the client certificate authenticated Matchbox API.

## Usage

[Setup](https://matchbox.psdn.io/network-setup/) a PXE network boot environment and [deploy](https://matchbox.psdn.io/deployment/) a Matchbox instance. Be sure to enable the gRPC API and follow the instructions to generate TLS credentials.

Configure the Matchbox provider with the Matchbox API endpoint and client certificate (e.g. `providers.tf`).

```tf

provider "matchbox" {

  endpoint    = "matchbox.example.com:8081"

  client_cert = "${file("~/.matchbox/client.crt")}"

  client_key  = "${file("~/.matchbox/client.key")}"

  ca          = "${file("~/.matchbox/ca.crt")}"

}

terraform {

  required_providers {

    matchbox = {

      source = "poseidon/matchbox"

      version = "0.5.4"

    }

  }

}

```

Define a Matchbox Profile or Group resource in Terraform.

```tf

// Fedora CoreOS profile

resource "matchbox_profile" "fedora-coreos-install" {

  name  = "worker"

  kernel = "https://builds.coreos.fedoraproject.org/prod/streams/${var.os_stream}/builds/${var.os_version}/x86_64/fedora-coreos-${var.os_version}-live-kernel-x86_64"

  initrd = [

    "--name main https://builds.coreos.fedoraproject.org/prod/streams/${var.os_stream}/builds/${var.os_version}/x86_64/fedora-coreos-${var.os_version}-live-initramfs.x86_64.img"

  ]

  args = [

    "initrd=main",

    "coreos.live.rootfs_url=https://builds.coreos.fedoraproject.org/prod/streams/${var.os_stream}/builds/${var.os_version}/x86_64/fedora-coreos-${var.os_version}-live-rootfs.x86_64.img",

    "coreos.inst.install_dev=/dev/sda",

    "coreos.inst.ignition_url=${var.matchbox_http_endpoint}/ignition?uuid=$${uuid}&mac=$${mac:hexhyp}"

  ]

  raw_ignition = data.ct_config.worker.rendered

}

data "ct_config" "worker" {

  content = templatefile("fcc/fedora-coreos.yaml", {

    ssh_authorized_key = var.ssh_authorized_key

  })

  strict = true

}

// Default matcher group for machines

resource "matchbox_group" "default" {

  name    = "default"

  profile = matchbox_profile.fedora-coreos-install.name

  selector = {}

  metadata = {}

}

```

Run `terraform init` to ensure plugin version requirements are met.

```

$ terraform init

```

See [examples](https://github.com/poseidon/matchbox/tree/master/examples/terraform) for Terraform configs which PXE boot, install CoreOS, and provision entire clusters.

## Requirements

* Terraform v0.13+ [installed](https://www.terraform.io/downloads.html)

* Matchbox v0.8+ [installed](https://matchbox.psdn.io/deployment/)

* Matchbox credentials `client.crt`, `client.key`, `ca.crt`

## Development

### Binary

To develop the provider plugin locally, build an executable with Go 1.18+.

```

make

```