From mboxrd@z Thu Jan 1 00:00:00 1970 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 B79732E3371 for ; Tue, 1 Apr 2025 01:00:26 +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=1743469226; cv=none; b=ikGacyYi2cFAIEr/8NheKYo85vvTDyzk6ibmatIxJWBaunhWMI2efCx3AC7eG6R5rpktCza/IVQHayXdmA+8engjf0YZPlEz16/z1MAzHBoTUqEm1BO+0V6Ih1A0MgYdDTG2TTM3RsEyfM95BhFzAiP7F8zV7LFLU8xoiwq+Gaw= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743469226; c=relaxed/simple; bh=1HOw3d3X0jCKd5XoBdG/pEzLTbYlGcW1LJGzPPCuYwg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ikvloelleZ3w3BsU+4enNmkIMKgNTQc8245Yj2dInjAC6cKx1CZ+68oY2oBX7HT4kcD38OEGlnBqVe6MmZPSkTkJrlquTzTUyc5nvgzEIp3PcRpXeZJ1iVqBbtzokCFC/+5BV1FlmA9fG+9c6ilpQwrZT/JfdRCd5LmZ+bEKZZI= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=omvvQvbg; 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="omvvQvbg" Received: by smtp.kernel.org (Postfix) with ESMTPSA id BFC0CC4CEE3; Tue, 1 Apr 2025 01:00:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1743469226; bh=1HOw3d3X0jCKd5XoBdG/pEzLTbYlGcW1LJGzPPCuYwg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=omvvQvbgYdzrKFfAY3pCZJSjaCYfCsKSriVuVkZi+3t8sFFtbOOJ7EVTaOVmqtiwN 3FKUPnJcsh+l18hGrhEp2v+YtISkR2/BYVKKDuf4dNx+x18w72cDMKKmKt/IfiQ5H/ yszZvVsXRNYwgWSdoX4dU0N0yjYkypmRoKyLAviN5UojjwS8lfv9n6C5ytVcYENWnd WeUFfEKtkUL2KxqyJ0d7Y2d9PLhw+Ia+sBkxTTwc2FZOS6ihN6xfCd6mcQbL/Jmb4D vz6wzRwu0Hzfyv7i0x+eSSGLrFrM7ljeI/0PSwhMku7OZQChS9NwiNAmqEm1V7Cj9B 4QGtsa31++D7g== From: cel@kernel.org To: Cc: Chandan Babu R , Chuck Lever Subject: [RFC PATCH 31/31] terraform/OCI: Update the OCI section of docs/kdevops-terraform.md Date: Mon, 31 Mar 2025 21:00:00 -0400 Message-ID: <20250401010000.764234-32-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 Content-Transfer-Encoding: 8bit From: Chuck Lever Update documentation URLs, focus on the basics. Signed-off-by: Chuck Lever --- docs/kdevops-terraform.md | 117 ++++++++++++-------------------------- 1 file changed, 35 insertions(+), 82 deletions(-) diff --git a/docs/kdevops-terraform.md b/docs/kdevops-terraform.md index 5e5107fef73e..34ac1a19eff1 100644 --- a/docs/kdevops-terraform.md +++ b/docs/kdevops-terraform.md @@ -298,86 +298,39 @@ https://www.terraform.io/docs/providers/google/index.html https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource ### OCI - Oracle Cloud Infrastructure -OCI documentation is located at -1. https://docs.oracle.com/en-us/iaas/Content/home.htm -2. https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/terraform.htm -The following is a list of OCI specific configuration variables that the user -needs to provide values (through `make menuconfig` interface). - 1. `CONFIG_TERRAFORM_SSH_CONFIG_USER` - - User name used for the logging into the cloud instance. - - Please use, - - `opc` for Oracle Linux. - - `ubuntu` for Ubuntu Linux - 2. `CONFIG_TERRAFORM_SSH_CONFIG_PUBKEY_FILE` - - Path to user's ssh public key (e.g. `~/.ssh/id_rsa.pub`). - - This key will be copied over to the cloud instance during its - creation. - 3. `CONFIG_TERRAFORM_OCI_REGION` - - String representing the name of the region (e.g. `us-ashburn-1`). - - https://docs.oracle.com/en-us/iaas/Content/anomaly/using/regions.htm - - List of the regions can be found at - https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm - 4. `CONFIG_TERRAFORM_OCI_TENANCY_OCID` - - OCID of the tenancy being used. - - In order to obtain the OCID, Please refer to - https://docs.oracle.com/en-us/iaas/Content/GSG/Tasks/contactingsupport_topic-Finding_Your_Tenancy_OCID_Oracle_Cloud_Identifier.htm - 5. `CONFIG_TERRAFORM_OCI_USER_OCID` - - OCID of the user. - - In order to obtain the OCID, Please refer to - https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#five - 6. `CONFIG_TERRAFORM_OCI_USER_PRIVATE_KEY_PATH` - - Path to API private key. - - Documentation - - Generating API keys. - Refer to section `Generating an API Signing Key (Linux and Mac OS X)` - at - https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm - - Uploading Public API key. - Refer to section `How to Upload the Public Key` at - https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm - - Video: https://www.youtube.com/watch?v=LMvYOSkXF1k - 7. `CONFIG_TERRAFORM_OCI_USER_FINGERPRINT` - - Finger print of the API key. - 8. `CONFIG_TERRAFORM_OCI_AVAILABLITY_DOMAIN` ="VkEH:US-ASHBURN-AD-3" - - String specifying the availability domain to use in the region - - Availability domain names can be obtained from the web page used to - launch an cloud instance. - 9. `CONFIG_TERRAFORM_OCI_COMPARTMENT_OCID` - - OCID of the compartment can be obtained by following the instructions - at - https://docs.oracle.com/en-us/iaas/Content/GSG/Tasks/contactingsupport_topic-Finding_the_OCID_of_a_Compartment.htm - 10. `CONFIG_TERRAFORM_OCI_SHAPE`="VM.Standard.E2.8" - - String representing the name of the compute shape to create. - - https://docs.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm - 11. `CONFIG_TERRAFORM_OCI_OS_IMAGE_OCID` - - OCID of the OS image to be installed. - - Image's OCID can be obtained by following instructions at - https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/terraformbestpractices_topic-Referencing_Images.htm - 12. `CONFIG_TERRAFORM_OCI_SUBNET_OCID` - - OCID of the subnet to be assigned to the cloud instance. - - Overview: - https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/Overview_of_VCNs_and_Subnets.htm - - Instructions on how to get a list of available subnets can be found at - https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/get-subnet.htm - - Click on the hamburger menu provided the right side of a subnet entry - and select `Copy OCID`. - 13. `CONFIG_TERRAFORM_OCI_DATA_VOLUME_DISPLAY_NAME` - - String representing the name for the `data` disk. - - This is used for storing sources and binaries corresponding to Linux - kernel, Fstests & Kdevops. - 14. `CONFIG_TERRAFORM_OCI_DATA_VOLUME_DEVICE_FILE_NAME` - - Device node to be used for `data` disk. - - Please specify `/dev/oracleoci/oraclevdb` as the device file. - 15. `CONFIG_TERRAFORM_OCI_SPARSE_VOLUME_DISPLAY_NAME` - - String representing the name for the `sparse` disk. - - This is used for creating regular files to back loop devices. - 16. `CONFIG_TERRAFORM_OCI_SPARSE_VOLUME_DEVICE_FILE_NAME` - - Device node to be used for `sparse` disk. - - Please specify `/dev/oracleoci/oraclevdc` as the device file. - 17. `CONFIG_TERRAFORM_OCI_INSTANCE_FLEX_OCPUS` - - Number of OCPUs for a flexiable compute shape. - - https://docs.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm#flexible - 18. `CONFIG_TERRAFORM_OCI_INSTANCE_FLEX_MEMORY_IN_GBS` - - Amount of RAM in GB for a flexiable compute shape. - - https://docs.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm#flexible +kdevops supports using the OCI Public Cloud (OCI). + +#### New To OCI? + +You can find a generic tutorial guide at the following link. You'll +need many (but not all) of these steps to bring up kdevops with OCI. + +https://docs.oracle.com/en-us/iaas/Content/dev/terraform/tutorials/tf-provider.htm + +This explains what an "OCID" is: + +https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm + +#### Quick Start + +To authenticate to the Oracle cloud, kdevops uses the API Key +authentication method, described here: + + https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm + +Copy these items into the Kconfig settings under the "Identity & +Access" submenu. Additional guidance is available in the Kconfig +help text in this menu. + +OCI pre-configures an admin ssh user on each instance. Under the +CONFIG_TERRAFORM_SSH_CONFIG_USER option, you need to explicitly set +kconfig's ssh login name depending on which OS image you have +selected: + + - `opc` for Oracle Linux. + - `ubuntu` for Ubuntu Linux + +If your Ansible controller (where you run "make bringup") and your +test instances operate inside the same subnet, you can disable the +TERRAFORM_OCI_ASSIGN_PUBLIC_IP option for better network security. -- 2.48.1