Version compatibility matrix between Portainer server and terraform-provider-portainer?

[skokado]

Ask a Question!

Hi team,

Using terraform-provider-portainer and it appeared to be compatible with the Portainer Server version.

I'm using Portainer Server 2.33.x.
At least the following code only worked up to terraform-provider-portainer 1.23.0, and I encountered the following error with 1.24+.

terraform {
  required_providers {
    portainer = {
      source = "portainer/portainer"
      version = ">= 1.24.0"
    }
  }
}

provider "portainer" {
  api_key         = "..."
  endpoint        = "https://my-portainer.server:9443"
  skip_ssl_verify = true
}

resource "portainer_environment" "this" {
  name = "my-server"

  environment_address = "tcp://my-server.local:9001"
  type                = 2 # Agent

  tag_ids = [1]
}

terraform apply
│ Error: failed to create environment: [POST /endpoints][400] endpointCreateBadRequest
│ 
│   with portainer_environment.this,
│   on main.tf line 28, in resource "portainer_environment" "this":
│   28: resource "portainer_environment" "this" {
...

Pinning version to 1.23.x then apply succeeded.
It took a lot of effort to find this workaround.

By the way, deleting the portainer_environment was successful even with v1.24+. The error occurred during creation.

If there is version compatibility between the Terraform provider and Server, it would be helpful if that matrix were shown in the documentation.

[grulicht]

Hi @skokado - thanks for the report. The 400 you see is misleading: in v1.24.0 we migrated portainer_environment to the Portainer Go SDK, whose auto-generated error readers discard the response body and only print placeholders like endpointCreateBadRequest. The actual Portainer error (likely a real validation against 2.33.x) was hidden from you.

Fixed in v1.31.0: the provider now appends Portainer's raw response body to the error. Re-running your config will produce something like:

Error: failed to create environment: [POST /endpoints][400] endpointCreateBadRequest: {"message":"...","details":"..."}
Please retry against your 2.33.x and share the full output - that will tell us whether there's also a request-shape issue to fix.

A compat matrix in CI (LTS / 2.33.x / latest) is on the follow-up list. 🙌🏽

[skokado]

Thank you.

I tried the Terraform code today and it successfully created the portainer_environment in both 1.30.0 and 1.31.0.
Perhaps there was something wrong with my code 🤔, My apologize

Also, the fact that error details for 1.31.0 are now output with dummy settings is very helpful. Thank you!

resource "portainer_environment" "test" {
  name = "skokado-test"

  environment_address = "tcp://dummy-host:9001"
  type                = 2
}

│ Error: failed to create environment: [POST /endpoints][500] endpointCreateInternalServerError: {"message":"Unable to get environment type","details":"Get \"https://dummy-host:9001/ping\": dial tcp: lookup dummy-host on x.x.x.x:53: no such host"}
│ 
│   with portainer_environment.test,
│   on foo.tf line 1, in resource "portainer_environment" "test":
│    1: resource "portainer_environment" "test" {

[skokado]

Sorry after closed,
but I encountered a creation error with the latest provider version.

│ Error: failed to create environment: [POST /endpoints][400] endpointCreateBadRequest: {"message":"Invalid request payload","details":"Invalid TagIds parameter"}

Regarding to the error response using v1.31.0, I understand that the format for TagIds is different in 2.33.x.
Therefore, I will continue to use provider version 1.23.0. Thank you.

[grulicht]

Thanks @skokado - fixed in v1.31.1: the provider now sends tag_ids in the single bracketed-string multipart format Portainer expects, so your original HCL works on 2.33.x without changes.

[skokado]

The portainer_environment was successfully created in v1.31.1!
Thank you for the quick fix!