chore: Fix a batch of typos and a couple dead links across the repo

FAQ.md

@@ -19,7 +19,7 @@
 #### Does the user running this terraform need specialized knowledge of AWS services?
 
 > Typically, to run terraform the user must know to configure awscli with the right credentials and run `terraform apply`. It is recommended
-> to have a certain level of knowledge on [these list of resources](https://github.com/wandb/terraform-aws-wandb/tree/venky/add-faq-section#aws-services-used) to be able to deploy and maintain W&B successfully.
+> to have a certain level of knowledge on [this list of resources](https://github.com/wandb/terraform-aws-wandb/tree/main#aws-services-used) to be able to deploy and maintain W&B successfully.
 
 #### How does the W&B private cloud architecture look like?
 
@@ -28,7 +28,7 @@
 
 #### What are the different subnets created as part of the W&B deployment?
 
-> The W&B AWS terraform spins up atleast two subnets, one per availability zone in a region to account for fail over. If the deployment is private, then W&B creates two public subnets and two private subnets.
+> The W&B AWS terraform spins up at least two subnets, one per availability zone in a region to account for failover. If the deployment is private, then W&B creates two public subnets and two private subnets.
 
 #### What permissions should be granted to the W&B deployment?
 
@@ -84,7 +84,7 @@ You can supply your own KMS key to our terraform module via the **kms_key_alias*
 
 > Customer sensitive data is stored in an S3 bucket. Once authenticated a user can access S3 bucket resource through pre-signed urls. The user must have access to the project to view these resources.
 
-#### What are the different data encrytion configurations in place?
+#### What are the different data encryption configurations in place?
 
 ```
 - S3 bucket is encrypted by a customer defined KMS key

README.md

@@ -18,7 +18,7 @@ audit logging and SAML single sign-on.
 This module is intended to run in an AWS account with minimal preparation,
 however it does have the following pre-requisites:
 
-### Terrafom version >= 1.9
+### Terraform version >= 1.9
 
 ### Credentials / Permissions
 
@@ -55,8 +55,8 @@ resource](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/reso
 
 ### ACM Certificate
 
-While this is not required, it is recommend to already have an existing ACM
-certification. Certificate validation can take up two hours, causing timeouts
+While this is not required, it is recommended to already have an existing ACM
+certificate. Certificate validation can take up to two hours, causing timeouts
 during module apply if the cert is generated as one of the resources contained
 in the module.
 
@@ -103,14 +103,14 @@ All the values set via `deployment-size.tf` can be overridden by setting the app
 - `database_instance_class` - The instance type for the database
 
 ## Bring Your Own Bucket (BYOB)
-We have added additional variable that make enabling BYOB easier to enable.
+We have added additional variables that make enabling BYOB easier.
 `bucket_permissions_mode` accepts 1 of 3 values; 
-- `strict` the default requires an explict list of the buckets for proper access, the same as byob before `7.3.0`.
-- `restricted` makes use of the new variable `bucket_restricted_accounts` which is a list of AWS account Id's where the BYOBs can be hosted from. ex: `["1234567890", "1234876590"]`
-- `public` enables access to any BYOB properly configured not present in the the calling account. Effectively this enables cross account s3 access to ANY aws s3 account.
+- `strict` the default requires an explicit list of the buckets for proper access, the same as byob before `7.3.0`.
+- `restricted` makes use of the new variable `bucket_restricted_accounts` which is a list of AWS account IDs where the BYOBs can be hosted from. ex: `["1234567890", "1234876590"]`
+- `public` enables access to any BYOB properly configured not present in the calling account. Effectively this enables cross account s3 access to ANY aws s3 account.
 
 > [!IMPORTANT]
-> Enabling BYOB or cross-account reguardless of `bucket_permissions_mode` still requires a policy attached to that bucket to allowing the eks node role to perform s3 actions.
+> Enabling BYOB or cross-account regardless of `bucket_permissions_mode` still requires a policy attached to that bucket allowing the eks node role to perform s3 actions.
 >
 > To find out the role which needs to be allowed access to your BYOB go to bucket section of `https://YOUR_WANDB_DEPLOYMENT/console/settings/system` or see the output of the module `cluster_node_role`
 >
@@ -123,7 +123,7 @@ installation scenarios for Weights & Biases, as well as examples for supporting
 resources that lack official modules.
 
 - [Private Access Only](https://github.com/wandb/terraform-aws-wandb/tree/main/examples/private-access-only)
-- [Private Existing Network](https://github.com/wandb/terraform-aws-wandb/tree/main/examples/private-existing-network)
+- [Private Existing Network](https://github.com/wandb/terraform-aws-wandb/tree/main/examples/byo-vpc)
 - [Public External DNS](https://github.com/wandb/terraform-aws-wandb/tree/main/examples/public-dns-external)
 - [Public Route 53 DNS](https://github.com/wandb/terraform-aws-wandb/tree/main/examples/public-dns-with-route53)
 
@@ -352,7 +352,7 @@ module "wandb" {
 }
 ```
 
-### Alow customer specific customer-managed keys for S3 and RDS
+### Allow customer-specific customer-managed keys for S3 and RDS
 
 - we can provide external kms key to encrypt database, redis and S3 buckets.
 - To provide kms keys we need to provide kms arn values in
@@ -364,7 +364,7 @@ bucket_kms_key_arn
 
 ### In order to allow cross account KMS keys. we need to allow kms keys to be accessed by WandB account.
 
-This can be donw by adding the following policy document.
+This can be done by adding the following policy document.
 
 ```
 {
@@ -389,7 +389,7 @@ This can be donw by adding the following policy document.
 
 ### 6.x -> 7.x
 
-`v7` changes how the module references storage from using terraform's `count` to always creating a "defaultBucket" which can be overidden latter or but providing some initial bucket.
+`v7` changes how the module references storage from using terraform's `count` to always creating a "defaultBucket" which can be overridden later or by providing some initial bucket.
 
 We are considering this a major change because of the terraform `moved` block which migrates the resource. After moving to a `v7` applying an earlier version of the module may result in terraform deleting your bucket.
 

main.tf

@@ -113,7 +113,7 @@ locals {
   fqdn = var.subdomain == null ? var.domain_name : "${var.subdomain}.${var.domain_name}"
 }
 
-#Create SSL Ceritifcation if applicable
+#Create SSL Certification if applicable
 module "acm" {
   source  = "terraform-aws-modules/acm/aws"
   version = "~> 3.0"

modules/app_eks/variables.tf

@@ -133,12 +133,12 @@ variable "k8s_namespace" {
 }
 
 variable "network_id" {
-  description = "(Required) The identity of the VPC in which the security group attached to the MySQL Aurora instances will be deployed."
+  description = "(Required) The identity of the VPC in which the security group attached to the EKS cluster will be deployed."
   type        = string
 }
 
 variable "network_private_subnets" {
-  description = "(Required) A list of the identities of the private subnetworks in which the MySQL Aurora instances will be deployed."
+  description = "(Required) A list of the identities of the private subnetworks in which the EKS worker nodes will be deployed."
   type        = list(string)
 }
 

modules/app_lb/variables.tf

@@ -23,7 +23,7 @@ variable "allowed_inbound_ipv6_cidr" {
 }
 
 variable "network_id" {
-  description = "(Required) The identity of the VPC in which the security group attached to the MySQL Aurora instances will be deployed."
+  description = "(Required) The identity of the VPC in which the security group attached to the ALB will be deployed."
   type        = string
 }
 

modules/database/variables.tf

@@ -4,7 +4,7 @@ variable "kms_key_arn" {
 }
 
 variable "performance_insights_kms_key_arn" {
-  description = "Specifies an existing KMS key ARN to encrypt the performance insights data if performance_insights_enabled is was enabled out of band"
+  description = "Specifies an existing KMS key ARN to encrypt the performance insights data if performance_insights_enabled was enabled out of band"
   type        = string
 }
 
@@ -19,13 +19,13 @@ variable "vpc_id" {
 }
 
 variable "engine_version" {
-  description = "Version for MySQL Auora to use -- major version only"
+  description = "Version for MySQL Aurora to use -- major version only"
   type        = string
   default     = "8.0"
 }
 
 variable "create_db_subnet_group" {
-  description = "Determines whether to create the databae subnet group or use existing"
+  description = "Determines whether to create the database subnet group or use existing"
   type        = string
   default     = true
 }
@@ -114,7 +114,7 @@ variable "innodb_lru_scan_depth" {
   default     = 128
 }
 
-# Cluster parametes
+# Cluster parameters
 variable "binlog_row_image" {
   description = "Value for binlog_row_image"
   type        = string

modules/file_storage/main.tf

@@ -94,7 +94,7 @@ resource "aws_s3_bucket_server_side_encryption_configuration" "file_storage" {
 }
 
 # Give the bucket permission to send messages onto the queue. Looks like we
-# overide this value.
+# override this value.
 resource "aws_sqs_queue_policy" "file_storage" {
   count = var.create_queue && var.create_queue_policy ? 1 : 0
 

modules/file_storage/variables.tf

@@ -16,7 +16,7 @@ variable "kms_key_arn" {
 }
 
 variable "deletion_protection" {
-  description = "If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to `true`."
+  description = "If the S3 bucket should have deletion protection enabled. The bucket can't be deleted when this value is set to `true`."
   type        = bool
   default     = true
 }

modules/networking/main.tf

@@ -48,7 +48,7 @@ resource "aws_vpc_endpoint" "clickhouse" {
   private_dns_enabled = true
 }
 
-# VPC FLow Logs
+# VPC Flow Logs
 resource "aws_flow_log" "vpc_flow_logs" {
   count = var.create_vpc && var.enable_flow_log ? 1 : 0
 

modules/networking/outputs.tf

@@ -1,6 +1,6 @@
 output "vpc_id" {
   value       = module.vpc.vpc_id
-  description = "The identity of the VPC in which resources will be delpoyed."
+  description = "The identity of the VPC in which resources will be deployed."
 }
 
 output "vgw_id" {

modules/redis/variables.tf

@@ -17,7 +17,7 @@ variable "redis_subnets" {
 
 variable "redis_create_subnet_group" {
   default     = false
-  description = "Whether to create a new subnet group atop subnets provided via `redis_subnets`. If we bringing our own VPC this will not be created via the `network` module, and we must generate it."
+  description = "Whether to create a new subnet group atop subnets provided via `redis_subnets`. If we are bringing our own VPC this will not be created via the `network` module, and we must generate it."
   type        = bool
 }
 

variables.tf

@@ -91,7 +91,7 @@ variable "database_master_username" {
 
 variable "database_performance_insights_kms_key_arn" {
   default     = ""
-  description = "Specifies an existing KMS key ARN to encrypt the performance insights data if performance_insights_enabled is was enabled out of band"
+  description = "Specifies an existing KMS key ARN to encrypt the performance insights data if performance_insights_enabled was enabled out of band"
   nullable    = true
   type        = string
 }
@@ -110,7 +110,7 @@ variable "database_kms_key_arn" {
 variable "public_access" {
   type        = bool
   default     = false
-  description = "Is this instance accessable a public domain."
+  description = "Is this instance accessible via a public domain."
 }
 
 variable "external_dns" {
@@ -125,8 +125,8 @@ variable "custom_domain_filter" {
   default     = null
 }
 
-# Sometimes domain name and zone name dont match, so lets explicitly ask for
-# both. Also is just life easier to have both even though in most cause it may
+# Sometimes domain name and zone name don't match, so let's explicitly ask for
+# both. Also it's just easier to have both even though in most cases it may
 # be redundant info.
 # https://github.com/hashicorp/terraform-aws-terraform-enterprise/pull/41#issuecomment-563501858
 variable "zone_id" {
@@ -142,7 +142,7 @@ variable "domain_name" {
 variable "subdomain" {
   type        = string
   default     = null
-  description = "Subdomain for accessing the Weights & Biases UI. Default creates record at Route53 Route."
+  description = "Subdomain for accessing the Weights & Biases UI. Default creates record at Route53 zone apex."
 }
 
 variable "extra_fqdn" {
@@ -264,7 +264,7 @@ variable "network_cidr" {
 
 variable "network_public_subnet_cidrs" {
   type        = list(string)
-  description = "List of private subnet CIDR ranges to create in VPC."
+  description = "List of public subnet CIDR ranges to create in VPC."
   default     = ["10.10.0.0/24", "10.10.1.0/24"]
 }
 
@@ -328,7 +328,7 @@ variable "kubernetes_alb_internet_facing" {
 
 variable "kubernetes_alb_subnets" {
   type        = list(string)
-  description = "List of subnet ID's the ALB will use for ingress traffic."
+  description = "List of subnet IDs the ALB will use for ingress traffic."
   default     = []
 }
 
@@ -457,7 +457,7 @@ variable "eks_addon_kube_proxy_version" {
 }
 
 variable "eks_addon_vpc_cni_version" {
-  description = "The version of the VPC CNI addon to install. Check the docs for more information about the compatibility https://docs.aws.amazon.com/eks/latest/userguide/vpc-add-on-update.html.s"
+  description = "The version of the VPC CNI addon to install. Check the docs for more information about the compatibility https://docs.aws.amazon.com/eks/latest/userguide/vpc-add-on-update.html."
   type        = string
   default     = "v1.18.3-eksbuild.3"
 }
@@ -482,7 +482,7 @@ variable "enable_s3_https_only" {
 ##########################################
 # External Bucket                        #
 ##########################################
-# Most users will not need these settings. They are ment for users who want a
+# Most users will not need these settings. They are meant for users who want a
 # bucket and sqs that are in a different account.
 variable "bucket_name" {
   type    = string