1
0
mirror of https://github.com/ko-build/ko.git synced 2025-11-23 22:35:11 +02:00
Files
ko-build/docs/advanced/terraform.md
Chao Dai 3fe83e4a35 Fix a typo in terraform.md
The field name of `image` does not exist per https://registry.terraform.io/providers/ko-build/ko/latest/docs/resources/build#read-only.

Found this problem while trying to use it, and confirmed it working with this fix.
2024-05-28 16:36:31 -07:00

1.1 KiB

Terraform Provider

In addition to the CLI, ko's functionality is also available as a Terraform provider.

This allows ko to be integrated with your Infrastructure-as-Code (IaC) workflows, and makes building your code a seamless part of your deployment process.

Using the Terraform provider is as simple as adding a ko_build resource to your Terraform configuration:

// Require the `ko-build/ko` provider.
terraform {
  required_providers {
    ko = { source = "ko-build/ko" }
  }
}

// Configure the provider to push to your repo.
provider "ko" {
  repo = "example.registry/my-repo" // equivalent to KO_DOCKER_REPO
}

// Build your code.
resource "ko_build" "app" {
  importpath = "github.com/example/repo/cmd/app"
}

// TODO: use the `ko_build.app` resource elsewhere in your Terraform configuration.

// Report the build image's digest.
output "image" {
  value = ko_build.app.image_ref
}

See the ko-build/ko provider on the Terraform Registry for more information, and the GitHub repo for more examples.