Merge branch 'lxc:main' into main

Author: serturx

.github/workflows/test.yml

@@ -39,7 +39,7 @@ jobs:
       INCUS_SCHEME: https
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Setup Go ${{ matrix.go-version }}
         uses: actions/setup-go@v5
         with:
@@ -102,7 +102,7 @@ jobs:
           - stable
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Setup Go ${{ matrix.go-version }}
         uses: actions/setup-go@v5
         with:
@@ -124,7 +124,7 @@ jobs:
           - stable
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Setup Go ${{ matrix.go-version }}
         uses: actions/setup-go@v5
         with:

docs/index.md

@@ -61,7 +61,8 @@ The following arguments are supported:
   to. See the `remote` reference below for details.
 
 * `config_dir` - *Optional* - The directory to look for existing Incus
-  configuration. Defaults to `$HOME/.config/incus`
+  configuration. This can also be set with the `INCUS_CONF`
+  Environment variable. Defaults to `$HOME/.config/incus`
 
 * `generate_client_certificates` - *Optional* - Automatically generate the Incus
   client certificate if it does not exist. Valid values are `true` and `false`.
@@ -89,7 +90,8 @@ The `remote` block supports:
   for more information.
   The default can also be set with the `INCUS_REMOTE` Environment variable.
 
-* `name` - *Optional* - The name of the Incus remote.
+* `name` - **Required** - Name of the Incus remote. Name is used to locate
+  server certificate if incus_scheme is set to `https`.
 
 * `token` - *Optional* - The one-time trust [token](https://linuxcontainers.org/incus/docs/main/authentication/#adding-client-certificates-using-tokens) used for initial authentication with the Incus remote.
 

docs/resources/storage_pool.md

@@ -55,7 +55,7 @@ for more details on how to create a storage pool in clustered mode.
 
 * `driver` - **Required** - Storage Pool driver. Must be one of `dir`, `zfs`, `lvm`, `lvmcluster`, `btrfs`, `ceph`, `cephfs`, `cephobject` or `linstor`.
 
-* `description` - *Optional* - Description of the storage pool.
+* `description` - *Optional* - Description of the storage pool. `description` is mutual exclusive with `target`. The `description` can only be set on cluster level (with `target` not set) or on non-clustered setups.
 
 * `config` - *Optional* - Map of key/value pairs of
   [storage pool config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/hashicorp/terraform-plugin-framework-validators v0.18.0
 	github.com/hashicorp/terraform-plugin-go v0.28.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0
-	github.com/hashicorp/terraform-plugin-testing v1.13.2
+	github.com/hashicorp/terraform-plugin-testing v1.13.3
 	github.com/lxc/incus/v6 v6.15.0
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/stretchr/testify v1.10.0

go.sum

@@ -132,8 +132,8 @@ github.com/hashicorp/terraform-plugin-log v0.9.0 h1:i7hOA+vdAItN1/7UrfBqBwvYPQ9T
 github.com/hashicorp/terraform-plugin-log v0.9.0/go.mod h1:rKL8egZQ/eXSyDqzLUuwUYLVdlYeamldAHSxjUFADow=
 github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0 h1:NFPMacTrY/IdcIcnUB+7hsore1ZaRWU9cnB6jFoBnIM=
 github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0/go.mod h1:QYmYnLfsosrxjCnGY1p9c7Zj6n9thnEE+7RObeYs3fA=
-github.com/hashicorp/terraform-plugin-testing v1.13.2 h1:mSotG4Odl020vRjIenA3rggwo6Kg6XCKIwtRhYgp+/M=
-github.com/hashicorp/terraform-plugin-testing v1.13.2/go.mod h1:WHQ9FDdiLoneey2/QHpGM/6SAYf4A7AZazVg7230pLE=
+github.com/hashicorp/terraform-plugin-testing v1.13.3 h1:QLi/khB8Z0a5L54AfPrHukFpnwsGL8cwwswj4RZduCo=
+github.com/hashicorp/terraform-plugin-testing v1.13.3/go.mod h1:WHQ9FDdiLoneey2/QHpGM/6SAYf4A7AZazVg7230pLE=
 github.com/hashicorp/terraform-registry-address v0.2.5 h1:2GTftHqmUhVOeuu9CW3kwDkRe4pcBDq0uuK5VJngU1M=
 github.com/hashicorp/terraform-registry-address v0.2.5/go.mod h1:PpzXWINwB5kuVS5CA7m1+eO2f1jKb5ZDIxrOPfpnGkg=
 github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ=

internal/network/resource_network.go

@@ -396,6 +396,7 @@ func (_ NetworkModel) ComputedKeys() []string {
 		"ipv6.address",
 		"ipv6.nat",
 		"network",
+		"tunnel.",
 		"volatile.",
 	}
 }

internal/profile/resource_profile.go

@@ -69,6 +69,8 @@ func (r ProfileResource) Schema(_ context.Context, _ resource.SchemaRequest, res
 
 			"project": schema.StringAttribute{
 				Optional: true,
+				Computed: true,
+				Default:  stringdefault.StaticString(api.ProjectDefaultName),
 				PlanModifiers: []planmodifier.String{
 					stringplanmodifier.RequiresReplace(),
 				},
@@ -356,6 +358,12 @@ func (r ProfileResource) ImportState(ctx context.Context, req resource.ImportSta
 		return
 	}
 
+	// If the imported profile does not specify the project, set the correct default value.
+	_, ok := fields["project"]
+	if !ok {
+		fields["project"] = api.ProjectDefaultName
+	}
+
 	for k, v := range fields {
 		resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root(k), v)...)
 	}

internal/provider/provider.go

@@ -97,7 +97,7 @@ func (p *IncusProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp
 					Attributes: map[string]schema.Attribute{
 						"name": schema.StringAttribute{
 							Required:    true,
-							Description: "Name of the Incus remote. Required when incus_scheme set to https, to enable locating server certificate.",
+							Description: "Name of the Incus remote. Name is used to locate server certificate if incus_scheme is set to \"https\".",
 						},
 
 						"address": schema.StringAttribute{
@@ -146,6 +146,11 @@ func (p *IncusProvider) Configure(ctx context.Context, req provider.ConfigureReq
 	configDir := data.ConfigDir.ValueString()
 	if configDir == "" {
 		configDir = "$HOME/.config/incus"
+
+		v, ok := os.LookupEnv("INCUS_CONF")
+		if ok {
+			configDir = v
+		}
 	}
 	configDir = os.ExpandEnv(configDir)
 

internal/storage/resource_storage_pool.go

@@ -63,6 +63,9 @@ func (r StoragePoolResource) Schema(_ context.Context, _ resource.SchemaRequest,
 				Optional: true,
 				Computed: true,
 				Default:  stringdefault.StaticString(""),
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.MatchRoot("target")),
+				},
 			},
 
 			"driver": schema.StringAttribute{
@@ -320,10 +323,16 @@ func (r StoragePoolResource) SyncState(ctx context.Context, tfState *tfsdk.State
 	respDiags.Append(diags...)
 
 	m.Name = types.StringValue(pool.Name)
-	m.Description = types.StringValue(pool.Description)
 	m.Driver = types.StringValue(pool.Driver)
 	m.Config = config
 
+	// target and description are mutual exclusive, but description might be
+	// set by the cluster level resource (without target) and is then returned
+	// by the API also for requests using target.
+	if m.Target.IsUnknown() || m.Target.IsNull() {
+		m.Description = types.StringValue(pool.Description)
+	}
+
 	if respDiags.HasError() {
 		return respDiags
 	}

internal/storage/resource_storage_pool_test.go

@@ -22,6 +22,7 @@ func TestAccStoragePool_dir(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 					// Ensure computed keys are not tracked.
@@ -33,6 +34,7 @@ func TestAccStoragePool_dir(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 				),
@@ -53,6 +55,7 @@ func TestAccStoragePool_zfs(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 					// Ensure computed keys are not tracked.
@@ -66,6 +69,7 @@ func TestAccStoragePool_zfs(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 				),
@@ -86,6 +90,7 @@ func TestAccStoragePool_lvm(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 					// Ensure computed keys are not tracked.
@@ -100,6 +105,7 @@ func TestAccStoragePool_lvm(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 				),
@@ -120,6 +126,7 @@ func TestAccStoragePool_btrfs(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 					// Ensure computed keys are not tracked.
@@ -132,6 +139,7 @@ func TestAccStoragePool_btrfs(t *testing.T) {
 				Config: testAccStoragePool(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "config.%", "0"),
 				),
@@ -216,14 +224,18 @@ func TestAccStoragePool_target(t *testing.T) {
 			{
 				Config: testAccStoragePool_target(poolName, driverName),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node2", "name", poolName),
-					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node2", "driver", driverName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node1", "name", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", poolName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node1", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node1", "target", "node-1"),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node1", "description", ""), // Since target and description are mutual exclusive, we expect the default value in the state.
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node2", "name", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node2", "driver", driverName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node2", "target", "node-2"),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1_node2", "description", ""), // Since target and description are mutual exclusive, we expect the default value in the state.
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "name", poolName),
 					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "driver", driverName),
+					resource.TestCheckResourceAttr("incus_storage_pool.storage_pool1", "description", "clustered storage pool description"),
 				),
 			},
 		},
@@ -303,8 +315,9 @@ func TestAccStoragePool_importProject(t *testing.T) {
 func testAccStoragePool(name string, driver string) string {
 	return fmt.Sprintf(`
 resource "incus_storage_pool" "storage_pool1" {
-  name   = "%s"
-  driver = "%s"
+  name        = "%s"
+  driver      = "%s"
+  description = "%[1]s"
 }
 	`, name, driver)
 }
@@ -359,8 +372,9 @@ resource "incus_storage_pool" "storage_pool1" {
     incus_storage_pool.storage_pool1_node2,
   ]
 
-  name   = "%[1]s"
-  driver = "%[2]s"
+  name        = "%[1]s"
+  driver      = "%[2]s"
+  description = "clustered storage pool description"
 }
 	`, name, driver)
 }