Merge pull request #1 from Dabble-of-DevOps-BioHub/feature/readme

update readme
dabble-of-devops-bioanalyze · Jul 15, 2021 · 382d598 · 382d598
2 parents 2621872 + 0c51686
commit 382d598
Show file tree

Hide file tree

Showing 10 changed files with 189 additions and 112 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -13,7 +13,7 @@
 # Cloud Posse must review any changes to GitHub actions
 .github/*     @cloudposse/engineering
 
-# Cloud Posse must review any changes to standard context definition,
+# Cloud Posse must eview any changes to standard context definition,
 # but some changes can be rubber-stamped.
 **/*.tf       @cloudposse/engineering @cloudposse/approvers
 README.yaml   @cloudposse/engineering @cloudposse/approvers

diff --git a/.github/workflows/auto-format.yml b/.github/workflows/auto-format.yml
@@ -29,7 +29,9 @@ jobs:
     - name: Auto Format
       if: github.event.pull_request.state == 'open'
       shell: bash
-      run: make BUILD_HARNESS_PATH=/build-harness PACKAGES_PREFER_HOST=true -f /build-harness/templates/Makefile.build-harness pr/auto-format/host
+      run: |
+        make BUILD_HARNESS_PATH=/build-harness PACKAGES_PREFER_HOST=true -f /build-harness/templates/Makefile.build-harness pr/auto-format/host
+        make BUILD_HARNESS_PATH=/build-harness PACKAGES_PREFER_HOST=true -f /build-harness/templates/Makefile.build-harness readme 
 
     # Commit changes (if any) to the PR branch
     - name: Commit changes to the PR branch

diff --git a/.github/workflows/validate-codeowners.yml b/.github/workflows/validate-codeowners.yml
@@ -1,25 +1,25 @@
-name: Validate Codeowners
-on:
-  pull_request:
+# name: Validate Codeowners
+# on:
+#   pull_request:
 
-jobs:
-  validate-codeowners:
-    runs-on: ubuntu-latest
-    steps:
-    - name: "Checkout source code at current commit"
-      uses: actions/checkout@v2
-    - uses: mszostok/codeowners-validator@v0.5.0
-      if: github.event.pull_request.head.repo.full_name == github.repository
-      name: "Full check of CODEOWNERS"
-      with:
-        # For now, remove "files" check to allow CODEOWNERS to specify non-existent
-        # files so we can use the same CODEOWNERS file for Terraform and non-Terraform repos
-        #   checks: "files,syntax,owners,duppatterns"
-        checks: "syntax,owners,duppatterns"
-        # GitHub access token is required only if the `owners` check is enabled
-        github_access_token: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
-    - uses: mszostok/codeowners-validator@v0.5.0
-      if: github.event.pull_request.head.repo.full_name != github.repository
-      name: "Syntax check of CODEOWNERS"
-      with:
-        checks: "syntax,duppatterns"
+# jobs:
+#   validate-codeowners:
+#     runs-on: ubuntu-latest
+#     steps:
+#     - name: "Checkout source code at current commit"
+#       uses: actions/checkout@v2
+#     - uses: mszostok/codeowners-validator@v0.5.0
+#       if: github.event.pull_request.head.repo.full_name == github.repository
+#       name: "Full check of CODEOWNERS"
+#       with:
+#         # For now, remove "files" check to allow CODEOWNERS to specify non-existent
+#         # files so we can use the same CODEOWNERS file for Terraform and non-Terraform repos
+#         #   checks: "files,syntax,owners,duppatterns"
+#         checks: "syntax,owners,duppatterns"
+#         # GitHub access token is required only if the `owners` check is enabled
+#         github_access_token: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
+#     - uses: mszostok/codeowners-validator@v0.5.0
+#       if: github.event.pull_request.head.repo.full_name != github.repository
+#       name: "Syntax check of CODEOWNERS"
+#       with:
+#         checks: "syntax,duppatterns"
diff --git a/README.md b/README.md
diff --git a/README.yaml b/README.yaml
@@ -110,8 +110,16 @@ usage: |-
 
   ```hcl
   module "example" {
-    source = "https://github.com/cloudposse/terraform-example-module.git?ref=master"
-    example = "Hello world!"
+    source = "Dabble-of-DevOps-BioHub/terraform-aws-eks-autoscaling"
+
+    region = var.region
+    vpc_id = var.vpc_id
+    subnet_ids = var.subnet_ids
+
+    oidc_provider_enabled = true
+    cluster_encryption_config_enabled = true
+    
+    context = module.this.context
   }
   ```
 

diff --git a/docs/terraform.md b/docs/terraform.md
@@ -12,8 +12,8 @@
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.49.0 |
-| <a name="provider_null"></a> [null](#provider\_null) | 3.1.0 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.0 |
+| <a name="provider_null"></a> [null](#provider\_null) | n/a |
 
 ## Modules
 

diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -5,12 +5,12 @@ provider "aws" {
 module "example" {
   source = "../.."
 
-  region = var.region
-  vpc_id = var.vpc_id
+  region     = var.region
+  vpc_id     = var.vpc_id
   subnet_ids = var.subnet_ids
 
-  oidc_provider_enabled = true
+  oidc_provider_enabled             = true
   cluster_encryption_config_enabled = true
-  
+
   context = module.this.context
 }
diff --git a/main.tf b/main.tf
@@ -72,7 +72,7 @@ module "eks_workers" {
   # version = "0.19.0"
 
   # for_each = tomap(var.eks_worker_groups)
-  for_each       = { for eks_worker_group in var.eks_worker_groups : eks_worker_group.name => eks_worker_group }
+  for_each = { for eks_worker_group in var.eks_worker_groups : eks_worker_group.name => eks_worker_group }
 
   vpc_id     = var.vpc_id
   subnet_ids = var.subnet_ids

diff --git a/outputs.tf b/outputs.tf
@@ -36,5 +36,5 @@ output "eks_cluster_workers" {
 
 output "get_kubectl" {
   description = "Get your kubectl "
-  value = "aws eks get-token --cluster-name ${module.eks_cluster.eks_cluster_id}"
+  value       = "aws eks get-token --cluster-name ${module.eks_cluster.eks_cluster_id}"
 }
diff --git a/variables.tf b/variables.tf
@@ -1,7 +1,7 @@
 variable "region" {
   type        = string
   description = "AWS Region"
-  default = "us-east-1"
+  default     = "us-east-1"
 }
 
 # variable "availability_zones" {