Update READMEs for various modules and examples (#10)

hashicorp · Oct 13, 2021 · ec395e6 · ec395e6
1 parent 28681f9
commit ec395e6
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ To support these examples, a few submodules are provided as useful utilities.
 
 - [hcp-ec2-client](https://github.com/hashicorp/terraform-aws-hcp-consul/tree/main/modules/hcp-ec2-client) - installs Consul and runs Consul clients with EC2 virtual machines.
 - [hcp-eks-client](https://github.com/hashicorp/terraform-aws-hcp-consul/tree/main/modules/hcp-eks-client) - installs the [Consul Helm chart](https://www.consul.io/docs/k8s/helm) on the provided Kubernetes cluster.
+- [k8s-demo-app](https://github.com/hashicorp/terraform-aws-hcp-consul/tree/main/modules/k8s-demo-app) - installs a demo application onto the Kubernetes cluster, using the Consul service mesh.
 
 ## License
 

diff --git a/examples/hcp-ec2-demo/README.md b/examples/hcp-ec2-demo/README.md
@@ -14,11 +14,25 @@ export HCP_CLIENT_SECRET=...
 
 2. Export your AWS Account credentials, as defined by the AWS Terraform provider
 
-3. Initialize and apply the Terraform configuration
+### Deployment
+
+1. Initialize and apply the Terraform configuration
 
 ```
 terraform init && terraform apply
 ```
 
-4. The provisioned Consul cluster can be accessed via the outputs `consul_url`
-   and `consul_root_token`
+### Accessing the Deployment
+
+#### HCP Consul
+
+The HCP Consul cluster can be accessed via the outputs `consul_url` and
+`consul_root_token`.
+
+#### EC2 instances
+
+**Warning**: These instances, by default, are publicly accessible on port 8080,
+make sure to delete them when done.
+
+The EC2 applications be accessed via the `clients` output, providing URLs to the
+two demo services, as well as the AWS instance IDs.
diff --git a/modules/hcp-eks-client/README.md b/modules/hcp-eks-client/README.md
@@ -0,0 +1,5 @@
+## hcp-eks-client
+
+A Terraform module used to install the Consul Helm chart onto a Kubernetes
+cluster.
+
diff --git a/modules/k8s-demo-app/README.md b/modules/k8s-demo-app/README.md
@@ -0,0 +1,7 @@
+## k8s-demo-app
+
+A Terraform module used to install a demo application for HCP Consul.
+
+This module will install two services, `dashboard` and `counting`, along with
+their associated deployments, service accounts, etc. Alongside, it will use
+Consul CRDs to configure an ingress gateway to expose the `dashboard` service.