Terraform: Implement suggestions by CodeRabbit

Author: amotl

docs/integrate/terraform/tutorial.md

@@ -10,7 +10,7 @@ To make cloud setups more manageable and predictable, this guide presents
 another option using [Terraform], an infrastructure-as-code tool.
 Terraform eliminates manual console steps to create resources.
 Instead, Terraform uses a configuration language that describes resources
-based on a given parametrization.
+with parameters.
 
 ## Example
 
@@ -26,8 +26,11 @@ Specify several variables regarding the target environment.
 
 
 ```hcl
-module "cratedb-cluster" {
-  source = "[email protected]:crate/cratedb-terraform.git//aws"
+terraform {
+  required_version = ">= 1.5.0"
+}
+module "cratedb_cluster" {
+  source = "https://github.com/crate/cratedb-terraform.git//aws"
 
   # Global configuration items for naming/tagging resources
   config = {
@@ -64,15 +67,15 @@ module "cratedb-cluster" {
   availability_zones = ["eu-central-1b", "eu-central-1a"]
 
   # SSH key pair name for EC2 instances
-  ssh_keypair = "cratedb-cluster"
+  ssh_keypair = "cratedb_cluster"
 
   # Enable SSH access to EC2 instances
   ssh_access = true
 }
 
 # Connection information for the newly created cluster
 output "cratedb" {
-  value     = module.cratedb-cluster
+  value     = module.cratedb_cluster
   sensitive = true
 }
 ```
@@ -83,8 +86,8 @@ Once you adjust all variables, initialize Terraform by installing the needed plu
 ```bash
 $ terraform init   
 Initializing modules...
-Downloading [email protected]:crate/cratedb-terraform.git for cratedb-cluster...
-- cratedb-cluster in .terraform/modules/cratedb-cluster/aws
+Downloading [email protected]:crate/cratedb-terraform.git for cratedb_cluster...
+- cratedb_cluster in .terraform/modules/cratedb_cluster/aws
 
 Initializing the backend...
 
@@ -123,7 +126,7 @@ Terraform used the selected providers to generate the following execution plan.
 
 Terraform will perform the following actions:
 
-  # module.cratedb-cluster.aws_instance.cratedb_node[0] will be created
+  # module.cratedb_cluster.aws_instance.cratedb_node[0] will be created
   + resource "aws_instance" "cratedb_node" {
       + ami                                  = "ami-0afc0414aefc9eaa7"
       + arn                                  = (known after apply)
@@ -141,7 +144,7 @@ Terraform will perform the following actions:
       + instance_type                        = "t3.xlarge"
       + ipv6_address_count                   = (known after apply)
       + ipv6_addresses                       = (known after apply)
-      + key_name                             = "cratedb-cluster"
+      + key_name                             = "cratedb_cluster"
       + monitoring                           = (known after apply)
       + outpost_arn                          = (known after apply)
       + password_data                        = (known after apply)
@@ -227,7 +230,7 @@ Terraform will perform the following actions:
         }
     }
 
-  # module.cratedb-cluster.aws_instance.cratedb_node[1] will be created
+  # module.cratedb_cluster.aws_instance.cratedb_node[1] will be created
   + resource "aws_instance" "cratedb_node" {
         [...]
     }
@@ -259,7 +262,7 @@ cratedb = <sensitive>
 The `cratedb` output element contains information on the newly created cluster, such as URL and credentials.
 Since it contains the admin password, Terraform marks the output as sensitive and does not immediately display it. Use the `terraform output` command to display it:
 ```bash
-$ terraform output cratedb
+$ terraform output -json cratedb | jq
 {
   "cratedb_application_url" = "https://example-project-test-lb-572e07fbd6b72b88.elb.eu-central-1.amazonaws.com:4200"
   "cratedb_password" = "IgqVcBV28wNX8Js1"
@@ -284,7 +287,7 @@ Terraform used the selected providers to generate the following execution plan.
 
 Terraform will perform the following actions:
 
-  # module.cratedb-cluster.aws_instance.cratedb_node[0] will be destroyed
+  # module.cratedb_cluster.aws_instance.cratedb_node[0] will be destroyed
   - resource "aws_instance" "cratedb_node" {
        [...]
         } -> null