Update README.md with instructions for local environment setup

cloudera-labs · Sep 19, 2023 · edeb3e9 · edeb3e9
1 parent ed56746
commit edeb3e9
Showing 1 changed file with 87 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,93 @@ If you no longer need the infrastructure that’s provisioned by the Terraform m
 terraform destroy
 ```
 
+## Set up a Local Development Environment
+
+As mentioned in the Usage section of this readme, the [cdp-tf-quickstarts](https://github.com/cloudera-labs/cdp-tf-quickstarts) repository demonstrates how to deploy CDP end-to-end in a simplified way, using the modules in this repository. If you would like to customize your setup however, you may want to change some of the module code. To make sure you can test your changes locally and create customized deployments, we recommend the following setup:
+
+1. Create a directory called `tf` and clone the Quickstart module repository
+```bash
+mkdir tf
+cd tf
+git clone https://github.com/cloudera-labs/cdp-tf-quickstarts.git
+```
+This will result in the directory structure below:
+```bash
+tree -L 4
+.
+└── tf
+    └── cdp-tf-quickstarts
+        ├── LICENSE
+        ├── README.md
+        ├── aws
+        │   ├── main.tf
+        │   ├── terraform.tfvars.template
+        │   └── variables.tf
+        └── azure
+            ├── main.tf
+            ├── terraform.tfvars.template
+            └── variables.tf
+``` 
+The cdp-tf-quickstarts module consists of these few files only. This is achieved by loading the required submodules dynamically in the `main.tf` file:
+```bash
+module "cdp_aws_prereqs" {
+  source = "git::https://github.com/cloudera-labs/terraform-cdp-modules.git//modules/terraform-cdp-aws-pre-reqs?ref=v0.1.0"
+  …
+}
+```
+
+2. For a local development environment these modules should be present locally. Make sure we are in the same project folder as earlier and clone this repository
+```bash
+cd ~/tf 
+git clone https://github.com/cloudera-labs/terraform-cdp-modules.git
+```
+This will result in the following directory structure with the two cloned repositories:
+```bash
+cd ~
+tree -L 4
+.
+└── tf
+    ├── cdp-tf-quickstarts
+    │   ├── LICENSE
+    │   ├── README.md
+    │   ├── aws
+    │   │   ├── main.tf
+    │   │   ├── terraform.tfvars.template
+    │   │   └── variables.tf
+    │   └── azure
+    │       ├── main.tf
+    │       ├── terraform.tfvars.template
+    │       └── variables.tf
+    └── terraform-cdp-modules
+        ├── LICENSE
+        ├── README.md
+        └── modules
+            ├── terraform-cdp-aws-pre-reqs
+            ├── terraform-cdp-azure-pre-reqs
+            └── terraform-cdp-deploy
+```
+
+3. The last step for setting up the local cdependencies is to link the two modules. To do this, simply edit the two main.tf files of the cdp-tf-quickstarts module.
+
+#### AWS
+```bash
+vi ~/tf/cdp-tf-quickstarts/aws/main.tf
+
+# Change the first line of code in both “module” blocks:
+
+# from 
+source = "git::https://github.com/cloudera-labs/terraform-cdp-modules.git//modules/terraform-cdp-aws-pre-reqs?ref=v0.2.0"
+# to 
+source = "../../terraform-cdp-modules/modules/terraform-cdp-aws-pre-reqs"
+# and from
+source = "git::https://github.com/cloudera-labs/terraform-cdp-modules.git//modules/terraform-cdp-deploy?ref=v0.2.0"
+# to
+source = "../../terraform-cdp-modules/modules/terraform-cdp-deploy"
+```
+
+#### Azure
+Same as above, just change the first module’s source to `source = "../../terraform-cdp-modules/modules/terraform-cdp-azure-pre-reqs"`
+
 ## Dependencies
 
 To set up CDP via deployment automation using this guide, the following dependencies must be installed in your local environment: