Merge branch 'master' into instance_doc_root_volume_type_compatibility

Author: Mia-Cross

.github/workflows/golangci-lint.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v7.0.0
+        uses: golangci/golangci-lint-action@v8.0.0
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
           version: latest

TESTING.md

@@ -62,3 +62,16 @@ Running a single test:
 ```sh
 TF_UPDATE_CASSETTES=true TF_LOG=DEBUG SCW_DEBUG=1 TF_ACC=1 go test ./scaleway -v -run=TestAccScalewayDataSourceRDBInstance_Basic -timeout=120m -parallel=10
 ```
+
+## Compressing the cassettes
+
+We record interactions with the Scaleway API in cassettes, which are stored in the `testdata` directory of each service.
+Each wait function used in the resources will perform several requests to the API for pulling a resource state, which can lead to large cassettes.
+We use a compressor to reduce the size of these cassettes once they are recorded.
+By doing so, tests can run faster and the cassettes are easier to read.
+
+To use the compressor on a given cassette, run the following command:
+
+```sh
+go run -v ./cmd/vcr-compressor internal/services/rdb/testdata/acl-basic.cassette
+```

cmd/vcr-compressor/main.go

@@ -0,0 +1,104 @@
+package main
+
+import (
+	"encoding/json"
+	"log"
+	"os"
+
+	"github.com/scaleway/scaleway-sdk-go/api/k8s/v1"
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+)
+
+var transientStates = map[string]bool{
+	k8s.ClusterStatusCreating.String(): true,
+	k8s.ClusterStatusDeleting.String(): true,
+	k8s.ClusterStatusUpdating.String(): true,
+	k8s.PoolStatusDeleting.String():    true,
+	k8s.PoolStatusScaling.String():     true,
+	k8s.PoolStatusUpgrading.String():   true,
+}
+
+func main() {
+	if len(os.Args) < 2 {
+		log.Fatalf("Usage: %s <cassette_file_name_without_yaml>\n", os.Args[0])
+	}
+
+	path := os.Args[1]
+
+	inputCassette, err := cassette.Load(path)
+	if err != nil {
+		log.Fatalf("Error while reading file : %v\n", err)
+	}
+
+	outputCassette := cassette.New(path)
+	transitioning := false
+
+	for i := range len(inputCassette.Interactions) {
+		interaction := inputCassette.Interactions[i]
+		responseBody := interaction.Response.Body
+		requestMethod := interaction.Request.Method
+
+		if requestMethod != "GET" {
+			transitioning = false
+
+			log.Printf("Interaction %d is not a GET request. Recording it\n", i)
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		if responseBody == "" {
+			log.Printf("Interaction %d got an empty response body. Recording it\n", i)
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		var m map[string]interface{}
+
+		err := json.Unmarshal([]byte(responseBody), &m)
+		if err != nil {
+			log.Printf("Interaction %d have an error with unmarshalling response body: %v. Recording it\n", i, err)
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		if m["status"] == nil {
+			log.Printf("Interaction %d does not contain a status field. Recording it\n", i)
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		status := m["status"].(string)
+		// We test if the state is transient
+		if _, ok := transientStates[status]; ok {
+			if transitioning {
+				log.Printf("Interaction %d is in a transient state while we are already in transitient state. No need to record it: %s\n", i, status)
+			} else {
+				log.Printf("Interaction %d is in a transient state: %s, Recording it\n", i, status)
+
+				transitioning = true
+
+				outputCassette.AddInteraction(interaction)
+			}
+		} else {
+			if transitioning {
+				log.Printf("Interaction %d is not in a transient state anymore: %s, Recording it\n", i, status)
+
+				outputCassette.AddInteraction(interaction)
+
+				transitioning = false
+			} else {
+				log.Printf("Interaction %d is not in a transient state: %s, Recording it\n", i, status)
+				outputCassette.AddInteraction(interaction)
+			}
+		}
+	}
+
+	err = outputCassette.Save()
+	if err != nil {
+		log.Fatalf("error while saving file: %v", err)
+	}
+}

cmd/vcr-viewer/main.go

@@ -0,0 +1,55 @@
+package main
+
+import (
+	"encoding/json"
+	"log"
+	"os"
+
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		log.Fatalf("Usage: %s <cassette_file_name_without_yaml>\n", os.Args[0])
+	}
+
+	path := os.Args[1]
+
+	data, err := cassette.Load(path)
+	if err != nil {
+		log.Fatalf("Error while reading file: %v\n", err)
+	}
+
+	for i := range len(data.Interactions) {
+		interaction := data.Interactions[i]
+
+		log.Println("--------------")
+		log.Printf("Interaction %d:\n", i+1)
+		log.Printf("  Request:\n")
+		log.Printf("    Method: %s\n", interaction.Request.Method)
+		log.Printf("    URL: %s\n", interaction.Request.URL)
+
+		if interaction.Request.Body != "" {
+			log.Printf("    Body: %s\n", interaction.Request.Body)
+		}
+
+		log.Printf("  Response:\n")
+		log.Printf("    Status: %s\n", interaction.Response.Status)
+		log.Printf("    Body: %s\n", interaction.Response.Body)
+
+		var m map[string]interface{}
+
+		err := json.Unmarshal([]byte(interaction.Response.Body), &m)
+		if err != nil {
+			continue
+		}
+
+		if m["status"] != nil {
+			log.Println("++++++++++++++++")
+			log.Printf("status: %s\n", m["status"])
+			log.Println("++++++++++++++++")
+		}
+
+		log.Println("--------------")
+	}
+}

docs/data-sources/flexible_ip.md

@@ -11,33 +11,26 @@ Gets information about a Flexible IP.
 
 ```hcl
 # Get info by IP address
-data "scaleway_flexible_ip" "my_ip" {
+data "scaleway_flexible_ip" "with_ip" {
   ip_address = "1.2.3.4"
 }
 
 # Get info by IP ID
-data "scaleway_flexible_ip" "my_ip" {
-  ip_id = "11111111-1111-1111-1111-111111111111"
+data "scaleway_flexible_ip" "with_id" {
+  flexible_ip_id = "11111111-1111-1111-1111-111111111111"
 }
 ```
 
 ## Argument Reference
 
 - `ip_address` - (Optional) The IP address.
-  Only one of `ip_address` and `ip_id` should be specified.
+  Only one of `ip_address` and `flexible_ip_id` should be specified.
 
 - `flexible_ip_id` - (Optional) The IP ID.
   Only one of `ip_address` and `flexible_ip_id` should be specified.
 
-## Attributes Reference
-
-In addition to all above arguments, the following attributes are exported:
+- `project_id` - (Optional. Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Flexible IP is associated with.
 
-- `id` - The ID of the flexible IP.
-
-~> **Important:** Flexible IPs' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
+## Attributes Reference
 
-- `reverse` - The reverse domain associated with this IP.
-- `server_id` - The associated server ID if any
-- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the IP is in.
-- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the IP is in.
+Exported attributes are the ones from `flexible_ip` [resource](../resources/flexible_ip.md)

docs/resources/container.md

@@ -22,6 +22,7 @@ resource "scaleway_container_namespace" "main" {
 resource "scaleway_container" "main" {
   name            = "my-container-02"
   description     = "environment variables test"
+  tags            = ["tag1", "tag2"]
   namespace_id    = scaleway_container_namespace.main.id
   registry_image  = "${scaleway_container_namespace.main.registry_endpoint}/alpine:test"
   port            = 9997
@@ -56,6 +57,8 @@ The following arguments are supported:
 
 - `description` (Optional) The description of the container.
 
+- `tags` - (Optional) The list of tags associated with the container.
+
 - `environment_variables` - (Optional) The [environment variables](https://www.scaleway.com/en/docs/serverless-containers/concepts/#environment-variables) of the container.
 
 - `secret_environment_variables` - (Optional) The [secret environment variables](https://www.scaleway.com/en/docs/serverless-containers/concepts/#secrets) of the container.
@@ -99,7 +102,7 @@ The following arguments are supported:
 
 - `deploy` - (Optional) Boolean indicating whether the container is in a production environment.
 
-- `local_storage_limit` - Local storage limit of the container (in MB)
+- `local_storage_limit` - (Optional) Local storage limit of the container (in MB)
 
 Note that if you want to use your own configuration, you must consult our configuration [restrictions](https://www.scaleway.com/en/docs/serverless-containers/reference-content/containers-limitations/#configuration-restrictions) section.
 

docs/resources/container_namespace.md

@@ -16,6 +16,7 @@ Refer to the Containers namespace [documentation](https://www.scaleway.com/en/do
 resource "scaleway_container_namespace" "main" {
   name        = "main-container-namespace"
   description = "Main container namespace"
+  tags        = ["tag1", "tag2"]
 }
 ```
 
@@ -27,15 +28,17 @@ The following arguments are supported:
 
 ~> **Important** Updates to the `name` argument will recreate the namespace.
 
-- `description` (Optional) The description of the namespace.
+- `description` - (Optional) The description of the namespace.
+
+- `tags` - (Optional) The list of tags associated with the namespace.
 
 - `region` - (Defaults to [provider](../index.md#region) `region`). The [region](../guides/regions_and_zones.md#regions) in which the namespace is created.
 
 - `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The unique identifier of the project that contains the namespace.
 
-- `environment_variables` - The environment variables of the namespace.
+- `environment_variables` - (Optional) The environment variables of the namespace.
 
-- `secret_environment_variables` - The secret environment variables of the namespace.
+- `secret_environment_variables` - (Optional) The secret environment variables of the namespace.
 
 ## Attributes Reference
 

docs/resources/flexible_ip.md

@@ -78,7 +78,7 @@ The following arguments are supported:
 - `reverse` - (Optional) The reverse domain associated with this flexible IP.
 - `is_ipv6` - (Optional) Defines whether the flexible IP has an IPv6 address.
 - `zone` -(Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the Flexible IP.
-
+- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Flexible IP is associated with.
 
 ## Attributes Reference
 
@@ -94,7 +94,6 @@ In addition to all arguments above, the following attributes are exported:
 - `created_at` - The date and time of the creation of the Flexible IP (Format ISO 8601).
 - `updated_at` - The date and time of the last update of the Flexible IP (Format ISO 8601).
 - `organization_id` - The organization of the Flexible IP.
-- `project_id` - The project of the Flexible IP.
 
 ## Import
 

docs/resources/function.md

@@ -41,6 +41,8 @@ resource "scaleway_function_namespace" "main" {
 
 resource "scaleway_function" "main" {
   namespace_id = scaleway_function_namespace.main.id
+  description  = "function with zip file"
+  tags         = ["tag1", "tag2"]
   runtime      = "go118"
   handler      = "Handle"
   privacy      = "private"
@@ -63,29 +65,31 @@ The following arguments are supported:
 
 - `description` (Optional) The description of the function.
 
+- `tags` - (Optional) The list of tags associated with the function.
+
 - `environment_variables` - (Optional) The [environment variables](https://www.scaleway.com/en/docs/compute/functions/concepts/#environment-variables) of the function.
 
 - `secret_environment_variables` - (Optional) The [secret environment variables](https://www.scaleway.com/en/docs/compute/functions/concepts/#secrets) of the function.
 
 - `privacy` - (Optional) The privacy type defines the way to authenticate to your function. Please check our dedicated [section](https://www.scaleway.com/en/developers/api/serverless-functions/#protocol-9dd4c8).
 
-- `runtime` - Runtime of the function. Runtimes can be fetched using [specific route](https://www.scaleway.com/en/developers/api/serverless-functions/#path-functions-get-a-function)
+- `runtime` - (Required) Runtime of the function. Runtimes can be fetched using [specific route](https://www.scaleway.com/en/developers/api/serverless-functions/#path-functions-get-a-function)
 
 - `min_scale` - (Optional) The minimum number of function instances running continuously. Defaults to 0. Functions are billed when executed, and using a `min_scale` greater than 0 will cause your function to run constantly.
 
 - `max_scale` - (Optional) The maximum number of instances this function can scale to. Default to 20. Your function will scale automatically based on the incoming workload, but will never exceed the configured `max_scale` value.
 
 - `memory_limit` - (Optional) The memory resources in MB to allocate to each function. Defaults to 256 MB.
 
-- `handler` - Handler of the function, depends on the runtime. Refer to the [dedicated documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-functions-create-a-new-function) for the list of supported runtimes.
+- `handler` - (Required) Handler of the function, depends on the runtime. Refer to the [dedicated documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-functions-create-a-new-function) for the list of supported runtimes.
 
 - `timeout` - (Optional) The maximum amount of time your function can spend processing a request before being stopped. Defaults to 300s.
 
-- `zip_file` - Path to the zip file containing your function sources to upload.
+- `zip_file` - (Optional) Path to the zip file containing your function sources to upload.
 
-- `zip_hash` - The hash of your source zip file, changing it will redeploy the function. Can be any string, changing it will simply trigger a state change. You can use any Terraform hash function to trigger a change on your zip change (see examples).
+- `zip_hash` - (Optional) The hash of your source zip file, changing it will redeploy the function. Can be any string, changing it will simply trigger a state change. You can use any Terraform hash function to trigger a change on your zip change (see examples).
 
-- `deploy` - Define whether the function should be deployed. Terraform will wait for the function to be deployed. Your function will be redeployed if you update the source zip file.
+- `deploy` - (Optional, defaults to `false`) Define whether the function should be deployed. Terraform will wait for the function to be deployed. Your function will be redeployed if you update the source zip file.
 
 - `http_option` - (Optional) Allows both HTTP and HTTPS (`enabled`) or redirect HTTP to HTTPS (`redirected`). Defaults to `enabled`.
 

docs/resources/function_namespace.md

@@ -16,6 +16,7 @@ Refer to the Functions namespace [documentation](https://www.scaleway.com/en/doc
 resource "scaleway_function_namespace" "main" {
   name        = "main-function-namespace"
   description = "Main function namespace"
+  tags        = ["tag1", "tag2"]
 }
 ```
 
@@ -29,13 +30,15 @@ The following arguments are supported:
 
 - `description` (Optional) The description of the namespace.
 
+- `tags` - (Optional) The list of tags associated with the namespace.
+
 - `region` - (Defaults to [provider](../index.md#region) `region`). The [region](../guides/regions_and_zones.md#regions) in which the namespace is created.
 
 - `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The unique identifier of the project that contains the namespace.
 
-- `environment_variables` - The environment variables of the namespace.
+- `environment_variables` - (Optional) The environment variables of the namespace.
 
-- `secret_environment_variables` - The secret environment variables of the namespace.
+- `secret_environment_variables` - (Optional) The secret environment variables of the namespace.
 
 ## Attributes Reference