update example n readme (#260)

Author: atulsingh0

README.md

@@ -17,15 +17,15 @@ repository] support and pinning a fixed reference. For example, you might
 consume the AWS Nomad client module as follows:
 
 ```terraform
-module "my-aws-nomad-clients" {
-  # Pin release to 4.1.0 (for example) and use /nomad-aws subdirectory
-  source = "git::https://github.com/CircleCI-Public/server-terraform.git//nomad-aws?ref=4.1.0"
+module "nomad" {
+  # Pin release to 4.9.0 (for example) and use /nomad-aws subdirectory
+  source = "git::https://github.com/CircleCI-Public/server-terraform.git//nomad-aws?ref=4.9.0"
 
   # Other variables here...
 }
 ```
 
-> Note the use of `ref=4.1.0` to select a specific git tag and
+> Note the use of `ref=4.9.0` to select a specific git tag and
 > `//nomad-aws` to select the `nomad-aws` module.
 
 [generic git repository]: https://www.terraform.io/docs/language/modules/sources.html#generic-git-repository

nomad-aws/README.md

@@ -23,9 +23,9 @@ provider "aws" {
   region = "us-west-1"
 }
 
-module "nomad_clients" {
+module "nomad" {
   # We strongly recommend pinning the version using ref=<<release tag>> as is done here
-  source = "git::https://github.com/CircleCI-Public/server-terraform.git//nomad-aws?ref=4.0.0"
+  source = "git::https://github.com/CircleCI-Public/server-terraform.git//nomad-aws?ref=4.9.0"
 
   # Number of nomad clients to run
   nodes = 4
@@ -57,14 +57,15 @@ module "nomad_clients" {
 }
 
 output "nomad" {
-  value     = module.nomad_clients
+  value     = module.nomad
   sensitive = true
 }
 ```
 
 There are more examples in the [examples](./examples/) directory.
 - [Basic example](./examples/basic/main.tf)
 - [IRSA example](./examples/irsa/main.tf)
+- [External Nomad Server example](./examples/nomad-server/main.tf)
 
 ---
 

nomad-aws/examples/basic/main.tf

@@ -27,7 +27,7 @@ module "vpc" {
   enable_dns_hostnames = true
 }
 
-module "nomad-aws" {
+module "nomad" {
   source = "../.."
 
   # Number of nomad clients to run
@@ -57,5 +57,5 @@ module "nomad-aws" {
 }
 
 output "nomad_module" {
-  value = module.nomad-aws
+  value = module.nomad
 }

…mples/externalized-nomad-servers/main.tf nomad-aws/examples/nomad-server/main.tfnomad-aws/examples/externalized-nomad-servers/main.tf renamed to nomad-aws/examples/nomad-server/main.tf nomad-aws/examples/externalized-nomad-servers/main.tf renamed to nomad-aws/examples/nomad-server/main.tf

@@ -57,13 +57,14 @@ module "nomad-aws" {
 
   # Externalized Nomad Servers
   deploy_nomad_server_instances = true
-  server_public_ip              = true
+  server_public_ip              = true # if false, the servers will use the private IP address
   allow_ssh                     = true
   ssh_key                       = "<your-public-key>"
   server_machine_type           = "t3a.micro"
   max_server_instances          = 7
   desired_server_instances      = 3
   aws_region                    = "us-east-1"
+  client_public_ip              = true # if false, the clients will use the private IP address
 }
 
 output "nomad_module" {

nomad-gcp/README.md

@@ -14,7 +14,7 @@ provider "google-beta" {
   zone    = "<< GCP compute zone to deploy nomad clients >>""
 }
 
-module "nomad_clients" {
+module "nomad" {
   # We strongly recommend pinning the version using ref=<<release tag>> as is done here
   source = "git::https://github.com/CircleCI-Public/server-terraform.git//nomad-gcp?ref=4.9.0"
 
@@ -26,7 +26,7 @@ module "nomad_clients" {
 }
 
 output "module" {
-  value = module.nomad_clients
+  value = module.nomad
 }
 ```