Service: OpenTofu Deployer - EyevinnOSC/community GitHub Wiki

OpenTofu Deployer

OpenTofu Deployer (serviceId eyevinn-tf-deployer) is a web-based deployment tool for running OpenTofu (the open-source Terraform fork) plans from GitHub repositories, without a local OpenTofu environment. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: MIT.

What it can do

  • Connect a GitHub repository containing an OpenTofu or Terraform configuration.
  • Trigger plan and apply runs from a web UI.
  • Show real-time output and deployment status, and keep a history of runs.

Creating an instance

Call create-service-instance with serviceId: "eyevinn-tf-deployer". The instance name must be alphanumeric and at most 20 characters. No other OSC service is required. You need an OpenTofu or Terraform repository on GitHub, and a GitHub personal access token if it is private.

{ "name": "mydeployer" }

Verify with wait-for-service-ready or get-instance-status; describe-service-instance returns the URL of the web UI.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.

The service has no other options.

Using the instance

  1. Open the instance URL to reach the deployer UI.
  2. Point the deployer at a GitHub repository with a valid OpenTofu (or Terraform) configuration. It runs tofu init and tofu apply on your behalf.
  3. Trigger plan and apply runs and follow the output.

Do not commit sensitive values such as cloud provider credentials to the repository. Store them as OSC service secrets (create-service-secret, serviceId eyevinn-tf-deployer) and reference them as environment variables in your configuration.

CLI:

osc create eyevinn-tf-deployer mydeployer

Limitations

  • Storage is limited to 10 GiB per instance.

Resources