refactor(image): move image data sources to Plugin Framework (#1448)

Related to #752

Author: jooola

docs/data-sources/image.md

@@ -1,22 +1,26 @@
 ---
-page_title: "Hetzner Cloud: hcloud_image"
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "hcloud_image Data Source - hcloud"
+subcategory: ""
 description: |-
-  Provides details about a specific Hetzner Cloud Image.
+  Provides details about a Hetzner Cloud Image.
+  It is recommended to always provide the image architecture (using ''with_architecture'').
+  See the Image API documentation https://docs.hetzner.cloud/reference/cloud#images for more details.
 ---
 
-# Data Source: hcloud_image
+# hcloud_image (Data Source)
 
 Provides details about a Hetzner Cloud Image.
-This resource is useful if you want to use a non-terraform managed image.
 
-When relevant, it is recommended to always provide the image architecture
-(`with_architecture`) when fetching images.
+It is recommended to always provide the image architecture (using ''with_architecture'').
+
+See the [Image API documentation](https://docs.hetzner.cloud/reference/cloud#images) for more details.
 
 ## Example Usage
 
 ```terraform
 data "hcloud_image" "by_id" {
-  id = "114690387"
+  id = 114690387
 }
 
 data "hcloud_image" "by_name_x86" {
@@ -31,33 +35,36 @@ data "hcloud_image" "by_name_arm" {
 
 data "hcloud_image" "by_label" {
   with_selector = "key=value"
+  most_recent   = true
 }
 
 resource "hcloud_server" "main" {
   image = data.hcloud_image.by_name.id
 }
 ```
 
-## Argument Reference
-
-- `id` - (Optional, string) ID of the Image.
-- `name` - (Optional, string) Name of the Image.
-- `with_selector` - (Optional, string) [Label selector](https://docs.hetzner.cloud/reference/cloud#label-selector)
-- `most_recent` - (Optional, bool) If more than one result is returned, use the most recent Image.
-- `with_status` - (Optional, list) Select only images with the specified status, could contain `creating` or `available`.
-- `with_architecture` - (Optional, string) Select only images with this architecture, could be `x86` (default) or `arm`.
-- `include_deprecated` - (Optional, bool) Also return the image if it is marked as deprecated.
-
-## Attributes Reference
-
-- `id` - (int) Unique ID of the Image.
-- `name` - (string) Name of the Image, only present when the Image is of type `system`.
-- `type` - (string) Type of the Image, could be `system`, `backup` or `snapshot`.
-- `status` - (string) Status of the Image.
-- `description` - (string) Description of the Image.
-- `created` - (string) Date when the Image was created (in ISO-8601 format).
-- `os_flavor` - (string) Flavor of operating system contained in the image, could be `ubuntu`, `centos`, `debian`, `fedora` or `unknown`.
-- `os_version` - (string) Operating system version.
-- `rapid_deploy` - (bool) Indicates that rapid deploy of the image is available.
-- `deprecated` - (string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
-- `architecture` - (string) Architecture of the Image.
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `id` (Number) ID of the Image.
+- `include_deprecated` (Boolean) Include deprecated images.
+- `most_recent` (Boolean) Sort results by created date, and return the most recent result.
+- `name` (String) Name of the Image, only present when the type is `system`.
+- `selector` (String, Deprecated) Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/cloud#label-selector).
+- `with_architecture` (String) Filter results by architecture, for example `x86` (default) or `arm`.
+- `with_selector` (String) Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
+- `with_status` (Set of String) Filter results by statuses, for example `creating` or `available`.
+
+### Read-Only
+
+- `architecture` (String) CPU architecture compatible with the Image.
+- `created` (String) Point in time when the Image was created (in RFC3339 format).
+- `deprecated` (String) Point in time when the Image was marked as deprecated (in RFC3339 format).
+- `description` (String) Description of the Image.
+- `labels` (Map of String) User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
+- `os_flavor` (String) Flavor of the operating system contained in the Image.
+- `os_version` (String) Version of the operating system contained in the Image.
+- `rapid_deploy` (Boolean) Whether the Image is optimized for a rapid deployment.
+- `type` (String) Type of the Image, for example `system`, `backup` or `snapshot`.

docs/data-sources/images.md

@@ -1,15 +1,20 @@
 ---
-page_title: "Hetzner Cloud: hcloud_images"
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "hcloud_images Data Source - hcloud"
+subcategory: ""
 description: |-
-  Provides details about multiple Hetzner Cloud Images.
+  Provides a list of Hetzner Storage Images.
+  It is recommended to always provide the image architecture (using ''with_architecture'').
+  See the Image API documentation https://docs.hetzner.cloud/reference/cloud#images for more details.
 ---
 
-# Data Source: hcloud_images
+# hcloud_images (Data Source)
 
-Provides details about multiple Hetzner Cloud Images.
+Provides a list of Hetzner Storage Images.
 
-When relevant, it is recommended to always provide the image architecture
-(`with_architecture`) when fetching images.
+It is recommended to always provide the image architecture (using ''with_architecture'').
+
+See the [Image API documentation](https://docs.hetzner.cloud/reference/cloud#images) for more details.
 
 ## Example Usage
 
@@ -23,14 +28,35 @@ data "hcloud_images" "by_label" {
 }
 ```
 
-## Argument Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `include_deprecated` (Boolean) Include deprecated images.
+- `most_recent` (Boolean) Sort results by created date.
+- `with_architecture` (Set of String) Filter results by architecture, for example `x86` or `arm`.
+- `with_selector` (String) Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
+- `with_status` (Set of String) Filter results by statuses, for example `creating` or `available`.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `images` (Attributes List) (see [below for nested schema](#nestedatt--images))
 
-- `with_selector` - (Optional, string) [Label selector](https://docs.hetzner.cloud/reference/cloud#label-selector)
-- `most_recent` - (Optional, bool) Sorts list by date.
-- `with_status` - (Optional, list) List only images with the specified status, could contain `creating` or `available`.
-- `with_architecture` - (Optional, list) List only images with this architecture, could contain `x86` or `arm`.
-- `include_deprecated` - (Optional, bool) Also list images that are marked as deprecated.
+<a id="nestedatt--images"></a>
+### Nested Schema for `images`
 
-## Attributes Reference
+Read-Only:
 
-- `images` - (list) List of all matching images. See `data.hcloud_image` for schema.
+- `architecture` (String) CPU architecture compatible with the Image.
+- `created` (String) Point in time when the Image was created (in RFC3339 format).
+- `deprecated` (String) Point in time when the Image was marked as deprecated (in RFC3339 format).
+- `description` (String) Description of the Image.
+- `id` (Number) ID of the Image.
+- `labels` (Map of String) User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
+- `name` (String) Name of the Image, only present when the type is `system`.
+- `os_flavor` (String) Flavor of the operating system contained in the Image.
+- `os_version` (String) Version of the operating system contained in the Image.
+- `rapid_deploy` (Boolean) Whether the Image is optimized for a rapid deployment.
+- `type` (String) Type of the Image, for example `system`, `backup` or `snapshot`.

examples/data-sources/hcloud_image/data-source.tf

@@ -1,5 +1,5 @@
 data "hcloud_image" "by_id" {
-  id = "114690387"
+  id = 114690387
 }
 
 data "hcloud_image" "by_name_x86" {
@@ -14,6 +14,7 @@ data "hcloud_image" "by_name_arm" {
 
 data "hcloud_image" "by_label" {
   with_selector = "key=value"
+  most_recent   = true
 }
 
 resource "hcloud_server" "main" {

hcloud/plugin_provider.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/datacenter"
+	"github.com/hetznercloud/terraform-provider-hcloud/internal/image"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/loadbalancer"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/loadbalancertype"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/location"
@@ -209,6 +210,8 @@ func (p *PluginProvider) DataSources(_ context.Context) []func() datasource.Data
 	return []func() datasource.DataSource{
 		datacenter.NewDataSource,
 		datacenter.NewDataSourceList,
+		image.NewDataSource,
+		image.NewDataSourceList,
 		loadbalancertype.NewDataSource,
 		loadbalancertype.NewDataSourceList,
 		location.NewDataSource,

hcloud/provider.go

@@ -15,7 +15,6 @@ import (
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/certificate"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/firewall"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/floatingip"
-	"github.com/hetznercloud/terraform-provider-hcloud/internal/image"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/loadbalancer"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/network"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/placementgroup"
@@ -102,8 +101,6 @@ func Provider() *schema.Provider {
 			firewall.DataSourceListType:       firewall.DataSourceList(),
 			floatingip.DataSourceType:         floatingip.DataSource(),
 			floatingip.DataSourceListType:     floatingip.DataSourceList(),
-			image.DataSourceType:              image.DataSource(),
-			image.DataSourceListType:          image.DataSourceList(),
 			loadbalancer.DataSourceType:       loadbalancer.DataSource(),
 			loadbalancer.DataSourceListType:   loadbalancer.DataSourceList(),
 			network.DataSourceType:            network.DataSource(),

hcloud/provider_test.go

@@ -8,7 +8,6 @@ import (
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/certificate"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/firewall"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/floatingip"
-	"github.com/hetznercloud/terraform-provider-hcloud/internal/image"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/loadbalancer"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/network"
 	"github.com/hetznercloud/terraform-provider-hcloud/internal/placementgroup"
@@ -63,8 +62,6 @@ func TestProvider_DataSources(t *testing.T) {
 		firewall.DataSourceListType,
 		floatingip.DataSourceType,
 		floatingip.DataSourceListType,
-		image.DataSourceType,
-		image.DataSourceListType,
 		loadbalancer.DataSourceType,
 		loadbalancer.DataSourceListType,
 		network.DataSourceType,