From 08603a03fde1b94596051a470572791cb4181300 Mon Sep 17 00:00:00 2001
From: "simeon.zhekov" <simeon.zhekov@ontotext.com>
Date: Thu, 11 Apr 2024 11:11:38 +0300
Subject: [PATCH] GDB-9926-Fixed-Comments

---
 README.md | 46 +++++++++++++++++++++++-----------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index a2280e0..a0ace60 100644
--- a/README.md
+++ b/README.md
@@ -143,17 +143,14 @@ Before you begin using this Terraform module, ensure you meet the following prer
 The following are the important variables you should configure when using this module:
 
 - `aws_region`: The region in which GraphDB will be deployed.
-- `vpc_id`: The ID of the Virtual Private Cloud (VPC) where you want to create the AWS GraphDB cluster. This is a
-  required variable.
 - `ec2_instance_type`: The instance type for the GDB cluster nodes. This should match your performance and cost
   requirements.
-- `node_count`: The number of instances in the cluster. Recommended is 3, 5 or 7 in order to have consensus according to
+- `graphdb_node_count`: The number of instances in the cluster. Recommended is 3, 5 or 7 in order to have consensus according to
   the [Raft algorithm](https://raft.github.io/).
 - `graphdb_license_path` : The path where the license for the GraphDB resides.
 - `graphdb_admin_password`: This variable allows you to set password of your choice. If nothing is specified it will be
   autogenerated, you can find the autogenerated password in the SSM Parameter Store. You should know that is
   base64 Encoded.
-- `graphdb_version`: This variable allows you to specify the GraphDB version.
 
 To use this module, follow these steps:
 
@@ -169,7 +166,6 @@ module "graphdb" {
   ec2_instance_type        = "c5a.2xlarge"
   graphdb_license_path     = "path-to-graphdb-license"
   allowed_inbound_cidrs_lb = ["0.0.0.0/0"]
-  graphdb_version          = "10.6.2"
 }
 ```
 Initialize the module and it's required providers with:
@@ -193,38 +189,46 @@ There are several ways to customize the GraphDB properties.
 
 1. Using a Custom GraphDB Properties File:
 
-You can specify a custom GraphDB properties file using the graphdb_properties_path variable. For example:
+You can specify a custom GraphDB properties file using the `graphdb_properties_path` variable. For example:
+
 ```hcl
 graphdb_properties_path = "<path_to_custom_graphdb_properties_file>"
 ```
-2. Setting Java Options with graphdb_java_options:
-Another option is to set Java options using the graphdb_java_options variable.
+
+2. Setting Java Options with `graphdb_java_options`:
+Another option is to set Java options using the `graphdb_java_options` variable.
 For instance, if you want to print the command line flags, use:
-`graphdb_java_options = "-XX:+PrintCommandLineFlags"`
+
+```hcl
+graphdb_java_options = "-XX:+PrintCommandLineFlags"
+```
 
 Note: The options mention above will be appended to the ones set in the user data script.
 
 **Customize GraphDB Version**
-
-`graphdb_version = "10.6.2"`
+```hcl
+graphdb_version = "10.6.2"
+```
 
 **Purge Protection**
 Resources that support purge protection have them enabled by default. You can override the default configurations with
 the following variables:
-`prevent_resource_deletion = false`
-
+```hcl
+prevent_resource_deletion = false
+```
 **Backup**
 
 To enable deployment of the backup module, you need to enable the following flag:
-
-`deploy_backup = true`
+```hcl
+deploy_backup = true
+```
 
 **Monitoring**
 
 To enable deployment of the monitoring module, you need to enable the following flag:
-
-`deploy_monitoring = true`
-
+```hcl
+deploy_monitoring = true
+```
 **Providing a TLS certificate**
 
 ```hcl
@@ -234,7 +238,7 @@ lb_tls_certificate_arn = "arn:aws:acm:us-east-1:123456789012:certificate/1234567
 
 ## Local Development
 
-Instead of using the module dependency, you can create a local variables file named terraform.tfvars and provide
+Instead of using the module dependency, you can create a local variables file named `terraform.tfvars` and provide
 configuration overrides there.
 Here's an example of a terraform.tfvars file:
 
@@ -248,10 +252,6 @@ resource_name_prefix = "my-prefix"
 
 graphdb_license_path = "/path/to/your/license.license"
 
-ami_id = "GraphDB-AMI"
-
-graphdb_version  = "10.6.2"
-
 ec2_instance_type = "c5a.2xlarge"
 
 allowed_inbound_cidrs_lb = ["0.0.0.0/0"]