docs(instance): add support for resource description

internal/services/instance/data_source_instance_private_nic.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 	"errors"
 	"fmt"
 
@@ -16,6 +17,9 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/private_nic_datasource.md
+var privateNicDataSourceDescription string
+
 func DataSourcePrivateNIC() *schema.Resource {
 	// Generate datasource schema from resource
 	dsSchema := datasource.SchemaFromResourceSchema(ResourcePrivateNIC().SchemaFunc())
@@ -36,6 +40,7 @@ func DataSourcePrivateNIC() *schema.Resource {
 	return &schema.Resource{
 		ReadContext: DataSourceInstancePrivateNICRead,
 		Schema:      dsSchema,
+		Description: privateNicDataSourceDescription,
 	}
 }
 

internal/services/instance/descriptions/image.md

@@ -0,0 +1,2 @@
+Creates and manages Scaleway Instance Images.
+For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-images-list-instance-images).

internal/services/instance/descriptions/image_datasource.md

@@ -0,0 +1 @@
+Gets information about an instance image.

internal/services/instance/descriptions/ip.md

@@ -0,0 +1 @@
+Creates and manages Scaleway compute Instance IPs. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-ips-list-all-flexible-ips).

internal/services/instance/descriptions/ip_datasource.md

@@ -0,0 +1 @@
+Gets information about an instance IP.

internal/services/instance/descriptions/ip_reverse_dns.md

@@ -0,0 +1,3 @@
+Manages Scaleway compute Instance IPs Reverse DNS.
+
+Please check our [guide](https://www.scaleway.com/en/docs/compute/instances/how-to/configure-reverse-dns/) for more details

internal/services/instance/descriptions/placement_group.md

@@ -0,0 +1 @@
+Creates and manages Compute Instance Placement Groups. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-list-placement-groups).

internal/services/instance/descriptions/placement_group_datasource.md

@@ -0,0 +1 @@
+Gets information about a Security Group.

internal/services/instance/descriptions/private_nic.md

@@ -0,0 +1,2 @@
+Creates and manages Scaleway Instance Private NICs. For more information, see
+the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-private-nics-list-all-private-nics).

internal/services/instance/descriptions/private_nic_datasource.md

@@ -0,0 +1 @@
+Gets information about an instance private NIC.

internal/services/instance/descriptions/security_group.md

@@ -0,0 +1 @@
+Creates and manages Scaleway compute Instance security groups. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-security-groups-list-security-groups).

internal/services/instance/descriptions/security_group_datasource.md

@@ -0,0 +1 @@
+Gets information about a Security Group.

internal/services/instance/descriptions/security_group_rules.md

@@ -0,0 +1,5 @@
+Creates and manages Scaleway compute Instance security group rules. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-security-groups-list-security-groups).
+
+This resource can be used to externalize rules from a `scaleway_instance_security_group` to solve circular dependency problems. When using this resource do not forget to set `external_rules = true` on the security group.
+
+~> **Warning:** In order to guaranty rules order in a given security group only one scaleway_instance_security_group_rules is allowed per security group.

internal/services/instance/descriptions/server.md

@@ -0,0 +1,3 @@
+Creates and manages Scaleway compute Instances. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-instances-list-all-instances).
+
+Please check our [FAQ - Instances](https://www.scaleway.com/en/docs/faq/instances).

internal/services/instance/descriptions/server_datasource.md

@@ -0,0 +1 @@
+Gets information about an instance server.

internal/services/instance/descriptions/server_type_datasource.md

@@ -0,0 +1 @@
+Gets information about a server type.

internal/services/instance/descriptions/servers_datasource.md

@@ -0,0 +1 @@
+Gets information about multiple instance servers.

internal/services/instance/descriptions/snapshot.md

@@ -0,0 +1,3 @@
+Creates and manages Scaleway Compute Snapshots.
+For more information,
+see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-snapshots-list-snapshots).

internal/services/instance/descriptions/snapshot_datasource.md

@@ -0,0 +1 @@
+Gets information about an instance snapshot.

internal/services/instance/descriptions/user_data.md

@@ -0,0 +1,9 @@
+Creates and manages Scaleway compute Instance User Data values.
+
+User data is a key value store API you can use to provide data from and to your server without authentication. It is the mechanism by which a user can pass information contained in a local file to an Instance at launch time.
+
+The typical use case is to pass something like a shell script or a configuration file as user data.
+
+For more information about [user_data](https://www.scaleway.com/en/developers/api/instance/#path-user-data-list-user-data) check [our documentation guide](https://www.scaleway.com/en/docs/compute/instances/how-to/use-boot-modes/#how-to-use-cloud-init).
+
+About cloud-init documentation please check [the official documentation](https://cloudinit.readthedocs.io/en/latest/).

internal/services/instance/descriptions/volume.md

@@ -0,0 +1,2 @@
+Creates and manages Scaleway compute Instance Volumes.
+For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-volumes-list-volumes).

internal/services/instance/descriptions/volume_data_source.md

@@ -0,0 +1 @@
+Gets information about an instance volume.

internal/services/instance/image.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -19,8 +20,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/image.md
+var imageDescription string
+
 func ResourceImage() *schema.Resource {
 	return &schema.Resource{
+		Description:   imageDescription,
 		CreateContext: ResourceInstanceImageCreate,
 		ReadContext:   ResourceInstanceImageRead,
 		UpdateContext: ResourceInstanceImageUpdate,

internal/services/instance/image_data_source.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 	"sort"
 
@@ -15,10 +16,14 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/types"
 )
 
+//go:embed descriptions/image_datasource.md
+var imageDataSourceDescription string
+
 func DataSourceImage() *schema.Resource {
 	return &schema.Resource{
 		ReadContext: DataSourceInstanceImageRead,
 		SchemaFunc:  dataSourceImageSchema,
+		Description: imageDataSourceDescription,
 	}
 }
 

internal/services/instance/ip.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -14,8 +15,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/ip.md
+var ipDescription string
+
 func ResourceIP() *schema.Resource {
 	return &schema.Resource{
+		Description:   ipDescription,
 		CreateContext: ResourceInstanceIPCreate,
 		ReadContext:   ResourceInstanceIPRead,
 		UpdateContext: ResourceInstanceIPUpdate,

internal/services/instance/ip_data_source.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -15,6 +16,9 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/ip_datasource.md
+var ipDataSourceDescription string
+
 func DataSourceIP() *schema.Resource {
 	// Generate datasource schema from resource
 	dsSchema := datasource.SchemaFromResourceSchema(ResourceIP().SchemaFunc())
@@ -38,8 +42,8 @@ func DataSourceIP() *schema.Resource {
 
 	return &schema.Resource{
 		ReadContext: DataSourceInstanceIPRead,
-
-		Schema: dsSchema,
+		Description: ipDataSourceDescription,
+		Schema:      dsSchema,
 	}
 }
 

internal/services/instance/ip_reverse_dns.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-log/tflog"
@@ -15,8 +16,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/locality/zonal"
 )
 
+//go:embed descriptions/ip_reverse_dns.md
+var ipReverseDnsDescription string
+
 func ResourceIPReverseDNS() *schema.Resource {
 	return &schema.Resource{
+		Description:   ipReverseDnsDescription,
 		CreateContext: ResourceInstanceIPReverseDNSCreate,
 		ReadContext:   ResourceInstanceIPReverseDNSRead,
 		UpdateContext: ResourceInstanceIPReverseDNSUpdate,

internal/services/instance/placement_group.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -14,8 +15,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/placement_group.md
+var placementDescription string
+
 func ResourcePlacementGroup() *schema.Resource {
 	return &schema.Resource{
+		Description:   placementDescription,
 		CreateContext: ResourceInstancePlacementGroupCreate,
 		ReadContext:   ResourceInstancePlacementGroupRead,
 		UpdateContext: ResourceInstancePlacementGroupUpdate,

internal/services/instance/placement_group_data_source.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -11,6 +12,9 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/placement_group_datasource.md
+var placementGroupDataSourceDescription string
+
 func DataSourcePlacementGroup() *schema.Resource {
 	// Generate datasource schema from resource
 	dsSchema := datasource.SchemaFromResourceSchema(ResourcePlacementGroup().SchemaFunc())
@@ -29,6 +33,7 @@ func DataSourcePlacementGroup() *schema.Resource {
 	return &schema.Resource{
 		ReadContext: DataSourcePlacementGroupRead,
 		Schema:      dsSchema,
+		Description: placementGroupDataSourceDescription,
 	}
 }
 

internal/services/instance/private_nic.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 
 	"github.com/hashicorp/go-cty/cty"
@@ -20,8 +21,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/types"
 )
 
+//go:embed descriptions/private_nic.md
+var privateNicDescription string
+
 func ResourcePrivateNIC() *schema.Resource {
 	return &schema.Resource{
+		Description:   privateNicDescription,
 		CreateContext: ResourceInstancePrivateNICCreate,
 		ReadContext:   ResourceInstancePrivateNICRead,
 		UpdateContext: ResourceInstancePrivateNICUpdate,

internal/services/instance/security_group.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 	"sort"
 
@@ -18,8 +19,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/security_group.md
+var securityGroupDescription string
+
 func ResourceSecurityGroup() *schema.Resource {
 	return &schema.Resource{
+		Description:   securityGroupDescription,
 		CreateContext: ResourceInstanceSecurityGroupCreate,
 		ReadContext:   ResourceInstanceSecurityGroupRead,
 		UpdateContext: ResourceInstanceSecurityGroupUpdate,

internal/services/instance/security_group_data_source.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -12,6 +13,9 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/security_group_datasource.md
+var securityGroupDataSourceDescription string
+
 func DataSourceSecurityGroup() *schema.Resource {
 	// Generate datasource schema from resource
 	dsSchema := datasource.SchemaFromResourceSchema(ResourceSecurityGroup().SchemaFunc())
@@ -30,8 +34,8 @@ func DataSourceSecurityGroup() *schema.Resource {
 
 	return &schema.Resource{
 		ReadContext: DataSourceInstanceSecurityGroupRead,
-
-		Schema: dsSchema,
+		Description: securityGroupDataSourceDescription,
+		Schema:      dsSchema,
 	}
 }
 

internal/services/instance/security_group_rules.go

@@ -2,14 +2,19 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/httperrors"
 )
 
+//go:embed descriptions/security_group_rules.md
+var securityGroupRulesDescription string
+
 func ResourceSecurityGroupRules() *schema.Resource {
 	return &schema.Resource{
+		Description:   securityGroupRulesDescription,
 		CreateContext: ResourceInstanceSecurityGroupRulesCreate,
 		ReadContext:   ResourceInstanceSecurityGroupRulesRead,
 		UpdateContext: ResourceInstanceSecurityGroupRulesUpdate,

internal/services/instance/server.go

@@ -3,6 +3,7 @@ package instance
 import (
 	"bytes"
 	"context"
+	_ "embed"
 	"errors"
 	"fmt"
 	"io"
@@ -40,8 +41,12 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/server.md
+var serverDescription string
+
 func ResourceServer() *schema.Resource {
 	return &schema.Resource{
+		Description:   serverDescription,
 		CreateContext: ResourceInstanceServerCreate,
 		ReadContext:   ResourceInstanceServerRead,
 		UpdateContext: ResourceInstanceServerUpdate,

internal/services/instance/server_data_source.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	_ "embed"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -12,6 +13,9 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
 
+//go:embed descriptions/server_datasource.md
+var serverDataSourceDescription string
+
 func DataSourceServer() *schema.Resource {
 	// Generate datasource schema from resource
 	dsSchema := datasource.SchemaFromResourceSchema(ResourceServer().SchemaFunc())
@@ -30,8 +34,8 @@ func DataSourceServer() *schema.Resource {
 
 	return &schema.Resource{
 		ReadContext: DataSourceInstanceServerRead,
-
-		Schema: dsSchema,
+		Description: serverDataSourceDescription,
+		Schema:      dsSchema,
 	}
 }