From patchwork Tue Apr 1 00:59:31 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chuck Lever X-Patchwork-Id: 14034250 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CBDCD2E3371 for ; Tue, 1 Apr 2025 01:00:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743469208; cv=none; b=cq65sToOHgRjRwtELE945n1SlqDfxs0qUO+zo73r2+Uq+0WHr7oOLzzSqGKLNqTzUOj0ww/GeaJJnQUnxqD3Yiu3q/5/vgsNpKBCnFlD6o9McIMT6PK+zC921bk90oSmLYG4Jy7+DDIuLpUcBBf7SOspGmikRtSgOKMgAw/UboE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743469208; c=relaxed/simple; bh=gCu7bJgsAyzUmGr6ttwRlfVoVNg+QCXrqXbPZv23tAE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=eTrwJ2EghdZHVR/cQ9cdhr6hU5+dWp6pcQAoL3az2cQaIE/CvOfukPYhMs1i/m7xseHv2oxHd5cDSvez2Odcgpj628MBVgzt62nPEhqWyAHu67EHCFA7Tf9GIlFvObEyhpFzEYAuCCPimpvyyW8vcmovzsk60IQetCRw0G3eTC0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DJ9l6aqs; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="DJ9l6aqs" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 5214CC4CEE3; Tue, 1 Apr 2025 01:00:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1743469208; bh=gCu7bJgsAyzUmGr6ttwRlfVoVNg+QCXrqXbPZv23tAE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DJ9l6aqsIcjHtz1R/zwpeJMhO2iHJZqlUyXJ2sm/8PrYUtRvTgZEJ0GJhVQSwYtcq EAhHid2JHeNWRTQumuhjFFcF3wgPEjdU8nRJadl3gSbSHnJTG5BnGwTB/kTwSD0gIx qHJWJ3yILr/6EZtSeLOJaDeownjrO0NvrarVGd1O7trdcEWDiKAv3ZrG+EHFD2YHLx QeSsWWQPQx8aGiVc6KHJIa83CY6NqD1JEM8wED/uwjHQo0RthyXjjldXJbDRlKbDsT hG5PFCO0FtOfea6CUTokRnzdqUYiuX51GiXVxTnCVQ/kNihAHMnfSBerrIL7Dilc9n RwgUud+Nvnl2Q== From: cel@kernel.org To: Cc: Chandan Babu R , Chuck Lever Subject: [RFC PATCH 02/31] terraform/OCI: One default value to rule them Date: Mon, 31 Mar 2025 20:59:31 -0400 Message-ID: <20250401010000.764234-3-cel@kernel.org> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250401010000.764234-1-cel@kernel.org> References: <20250401010000.764234-1-cel@kernel.org> Precedence: bulk X-Mailing-List: kdevops@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 From: Chuck Lever There are 3 sets of default values for each terraform setting. 1. The default value set in terraform/oci/Kconfig 2. The default value in playbooks/roles/gen_tfvars/defaults/main.yml 3. The default value specified in terraform/oci/vars.tf Often these defaults are different values. It's confusing for developers, but worse is that it can result in hard-to-diagnose terraform provider error messages (eg, "Where did that 'invalid' come from?"). IMO a better plan is to let Kconfig provide the only default value, and remove the other two. We then have a single authoritative default value for each setting. If a required variable is missing a value during "terraform plan", that will always be a local bug, not something exposed to the provider to report via an obscure error message. There are two exceptions: - For Kconfig booleans, often the variable is defined with a "y" value in the "true" case, but not defined at all in the "false" case. So for booleans, the gen_tfvars template needs a default value in gen_tfvars/defaults/main.yml of "false". - Where a terraform resource expects an argument to be not present in some configurations, then vars.tf needs to explicitly define a default value of "null". Only in those cases it is OK for no value to be provided by Kconfig. This is a refactoring change; no behavior change is intended. Signed-off-by: Chuck Lever --- playbooks/roles/gen_tfvars/defaults/main.yml | 18 +-------- terraform/oci/vars.tf | 42 ++++++++++---------- 2 files changed, 21 insertions(+), 39 deletions(-) diff --git a/playbooks/roles/gen_tfvars/defaults/main.yml b/playbooks/roles/gen_tfvars/defaults/main.yml index e892d85572a8..f64102b2fbf5 100644 --- a/playbooks/roles/gen_tfvars/defaults/main.yml +++ b/playbooks/roles/gen_tfvars/defaults/main.yml @@ -48,23 +48,7 @@ terraform_gce_scatch_disk_type: "invalid" terraform_gce_image_name: "invalid" terraform_gce_credentials: "invalid" -terraform_oci_region: "invalid" -terraform_oci_tenancy_ocid: "invalid" -terraform_oci_user_ocid: "invalid" -terraform_oci_user_private_key_path: "invalid" -terraform_oci_user_fingerprint: "invalid" -terraform_oci_availablity_domain_ocid: "invalid" -terraform_oci_compartment_ocid: "invalid" -terraform_oci_shape: "invalid" -terraform_oci_instance_flex_ocpus: "invalid" -terraform_oci_instance_flex_memory_in_gbs: "invalid" -terraform_oci_os_image_ocid: "invalid" -terraform_oci_assign_public_ip: "invalid" -terraform_oci_subnet_ocid: "invalid" -terraform_oci_data_volume_display_name: "invalid" -terraform_oci_data_volume_device_file_name: "invalid" -terraform_oci_sparse_volume_display_name: "invalid" -terraform_oci_sparse_volume_device_file_name: "invalid" +terraform_oci_assign_public_ip: "false" terraform_openstack_cloud_name: "invalid" terraform_openstack_instance_prefix: "invalid" diff --git a/terraform/oci/vars.tf b/terraform/oci/vars.tf index f43e1ee281fc..4c6383d9b231 100644 --- a/terraform/oci/vars.tf +++ b/terraform/oci/vars.tf @@ -1,103 +1,101 @@ variable "oci_region" { description = "An OCI region" - default = "" + type = string } variable "oci_tenancy_ocid" { description = "OCID of your tenancy" - default = "" + type = string } variable "oci_user_ocid" { description = "OCID of the user calling the API" - default = "" + type = string } variable "oci_user_private_key_path" { description = "The path of the private key stored on your computer" - default = "" + type = string } variable "oci_user_fingerprint" { description = "Fingerprint for the key pair being used" - default = "" + type = string } variable "oci_availablity_domain" { description = "Name of availability domain" - default = "" + type = string } variable "oci_compartment_ocid" { description = "OCID of compartment" - default = "" + type = string } variable "oci_shape" { description = "Shape name" - default = "" + type = string } variable "oci_instance_flex_ocpus" { + default = null description = "The total number of OCPUs available to the instance." - type = number - default = null + type = number } variable "oci_instance_flex_memory_in_gbs" { + default = null description = "The total amount of memory available to the instance, in gigabytes." - type = number - default = null + type = number } variable "oci_os_image_ocid" { description = "OCID of OS image" - default = "" + type = string } variable "oci_assign_public_ip" { description = "Assign public IP to the instance" - default = false + type = bool } variable "oci_subnet_ocid" { description = "Subnet OCID" - default = "" + type = string } variable "oci_volumes_enable_extra" { description = "Create additional block volumes per instance" - default = false + type = bool } variable "oci_volumes_per_instance" { description = "The count of additional block volumes per instance" type = number - default = 0 } variable "oci_volumes_size" { description = "The size of additional block volumes, in gibibytes" type = number - default = 0 } variable "oci_data_volume_display_name" { description = "Display name to use for the data volume" - default = "data" + type = string } variable oci_data_volume_device_file_name { description = "Data volume's device file name" - default = "/dev/oracleoci/oraclevdb" + type = string } variable "oci_sparse_volume_display_name" { description = "Display name to use for the sparse volume" - default = "sparse" + type = string } variable oci_sparse_volume_device_file_name { description = "Sparse volume's device file name" - default = "/dev/oracleoci/oraclevdc" + type = string }