terraform-provider-openstack

Terraform OpenStack Provider
============================

Documentation:

• registry.terraform.io

• search.opentofu.org

Requirements
------------

• Terraform 1.x

• OpenTofu 1.x

• Go 1.24 (to build the provider plugin)

Building The Provider
---------------------

Clone the repository

$ git clone git@github.com:terraform-provider-openstack/terraform-provider-openstack.git

Enter the provider directory and build the provider

$ cd terraform-provider-openstack
$ make build

Using the provider
----------------------
Please see the documentation at registry.terraform.io or search.opentofu.org.

Or you can browse the documentation within this repo here.

Developing the Provider
---------------------------

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.24+ is required).

To compile the provider, run make build. This will build the provider and put the provider binary in the current directory.

$ make build

For further details on how to work on this provider, please see the Testing and Development documentation.

Releasing the Provider
----------------------

This repository contains a GitHub Action configured to automatically build and
publish assets for release when a tag is pushed that matches the pattern v*
(ie. v0.1.0).

A Gorelaser configuration is provided that produce
build artifacts matching the layout required
to publish the provider in the Terraform Registry.

Releases will as drafts. Once marked as published on the GitHub Releases page,
they will become available via the Terraform Registry.

Before releasing, a PR updating the changelog should be made to trigger the CI
for all services and ensure that everything is OK. Moreover, update the example
on website/docs/index.html.markdown to point to the new version.