small fixes for lint and documentation

GoogleCloudPlatform · Jul 2, 2024 · f614399 · f614399
1 parent 0259623
commit f614399
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 19 deletions.
diff --git a/2-environments/README.md b/2-environments/README.md
@@ -196,7 +196,7 @@ You will be doing this procedure for each environment (`development`, `non-produ
     Make sure your git is checked out to the development branch by running `git checkout development` on `GCP_ENVIRONMENTS_PATH`.
 
     ```bash
-    (cd $GCP_ENVIRONMENTS_PATH && git checkout development)
+    (cd $GCP_ENVIRONMENTS_PATH && git checkout development && cd $GCP_ENVIRONMENTS_PATH/envs/development && terraform init)
     ```
 
 2. Retrieve the bucket name and project id from terraform outputs.
@@ -244,7 +244,7 @@ You will be doing this procedure for each environment (`development`, `non-produ
     Make sure your git is checked out to the `non-production` branch by running `git checkout non-production` on `GCP_ENVIRONMENTS_PATH`.
 
     ```bash
-    (cd $GCP_ENVIRONMENTS_PATH && git checkout non-production)
+    (cd $GCP_ENVIRONMENTS_PATH && git checkout non-production && cd $GCP_ENVIRONMENTS_PATH/envs/non-production && terraform init)
     ```
 
 2. Retrieve the bucket name and project id from terraform outputs.
@@ -292,7 +292,7 @@ You will be doing this procedure for each environment (`development`, `non-produ
     Make sure your git is checked out to the `production` branch by running `git checkout production` on `GCP_ENVIRONMENTS_PATH`.
 
     ```bash
-    (cd $GCP_ENVIRONMENTS_PATH && git checkout production)
+    (cd $GCP_ENVIRONMENTS_PATH && git checkout production && cd $GCP_ENVIRONMENTS_PATH/envs/production && terraform init)
     ```
 
 2. Retrieve the bucket name and project id from terraform outputs.

diff --git a/5-app-infra/projects/artifact-publish/ml_business_unit/shared/README.md b/5-app-infra/projects/artifact-publish/ml_business_unit/shared/README.md
@@ -4,7 +4,6 @@
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | instance\_region | The region where compute instance will be created. A subnetwork must exists in the instance region. | `string` | n/a | yes |
-| log\_bucket | Log bucket to be used by Service Catalog Bucket | `string` | n/a | yes |
 | remote\_state\_bucket | Backend bucket to load remote state information from previous steps. | `string` | n/a | yes |
 
 ## Outputs

diff --git a/5-app-infra/projects/service-catalog/ml_business_unit/shared/README.md b/5-app-infra/projects/service-catalog/ml_business_unit/shared/README.md
@@ -4,6 +4,7 @@
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | instance\_region | The region where compute instance will be created. A subnetwork must exists in the instance region. | `string` | n/a | yes |
+| log\_bucket | Log bucket to be used by Service Catalog Bucket | `string` | n/a | yes |
 | remote\_state\_bucket | Backend bucket to load remote state information from previous steps. | `string` | n/a | yes |
 
 ## Outputs

diff --git a/examples/machine-learning-pipeline/ml_business_unit/development/README.md b/examples/machine-learning-pipeline/ml_business_unit/development/README.md
@@ -7,6 +7,8 @@
 | github\_remote\_uri | The remote uri of your github repository | `string` | n/a | yes |
 | instance\_region | The region where notebook instance will be created. A subnetwork must exists in the instance region. | `string` | n/a | yes |
 | remote\_state\_bucket | Backend bucket to load remote state information from previous steps. | `string` | n/a | yes |
+| repository\_id | Common artifacts repository id | `string` | `"c-publish-artifacts"` | no |
+| seed\_state\_bucket | Remote state bucket from 0-bootstrap | `string` | n/a | yes |
 
 ## Outputs
 

diff --git a/examples/machine-learning-pipeline/ml_business_unit/development/variables.tf b/examples/machine-learning-pipeline/ml_business_unit/development/variables.tf
@@ -41,6 +41,6 @@ variable "seed_state_bucket" {
 
 variable "repository_id" {
   description = "Common artifacts repository id"
-  type = string
-  default = "c-publish-artifacts"
+  type        = string
+  default     = "c-publish-artifacts"
 }
diff --git a/examples/machine-learning-pipeline/ml_business_unit/non-production/README.md b/examples/machine-learning-pipeline/ml_business_unit/non-production/README.md
@@ -7,6 +7,8 @@
 | github\_remote\_uri | The remote uri of your github repository | `string` | n/a | yes |
 | instance\_region | The region where notebook instance will be created. A subnetwork must exists in the instance region. | `string` | n/a | yes |
 | remote\_state\_bucket | Backend bucket to load remote state information from previous steps. | `string` | n/a | yes |
+| repository\_id | Common artifacts repository id | `string` | `"c-publish-artifacts"` | no |
+| seed\_state\_bucket | Remote state bucket from 0-bootstrap | `string` | n/a | yes |
 
 ## Outputs
 

diff --git a/examples/machine-learning-pipeline/ml_business_unit/non-production/locals.tf b/examples/machine-learning-pipeline/ml_business_unit/non-production/locals.tf
@@ -15,10 +15,10 @@
  */
 
 locals {
-  business_unit    = "ml_business_unit"
-  business_code    = "ml"
-  env              = "non-production"
-  environment_code = "n"
+  business_unit      = "ml_business_unit"
+  business_code      = "ml"
+  env                = "non-production"
+  environment_code   = "n"
   region_kms_keyring = [for i in local.env_keyrings : i if split("/", i)[3] == var.instance_region]
 }
 
diff --git a/examples/machine-learning-pipeline/ml_business_unit/non-production/variables.tf b/examples/machine-learning-pipeline/ml_business_unit/non-production/variables.tf
@@ -41,6 +41,6 @@ variable "seed_state_bucket" {
 
 variable "repository_id" {
   description = "Common artifacts repository id"
-  type = string
-  default = "c-publish-artifacts"
+  type        = string
+  default     = "c-publish-artifacts"
 }
diff --git a/examples/machine-learning-pipeline/ml_business_unit/production/README.md b/examples/machine-learning-pipeline/ml_business_unit/production/README.md
@@ -7,6 +7,8 @@
 | github\_remote\_uri | The remote uri of your github repository | `string` | n/a | yes |
 | instance\_region | The region where notebook instance will be created. A subnetwork must exists in the instance region. | `string` | n/a | yes |
 | remote\_state\_bucket | Backend bucket to load remote state information from previous steps. | `string` | n/a | yes |
+| repository\_id | Common artifacts repository id | `string` | `"c-publish-artifacts"` | no |
+| seed\_state\_bucket | Remote state bucket from 0-bootstrap | `string` | n/a | yes |
 
 ## Outputs
 

diff --git a/examples/machine-learning-pipeline/ml_business_unit/production/locals.tf b/examples/machine-learning-pipeline/ml_business_unit/production/locals.tf
@@ -15,10 +15,10 @@
  */
 
 locals {
-  business_unit    = "ml_business_unit"
-  business_code    = "ml"
-  env              = "production"
-  environment_code = "p"
+  business_unit      = "ml_business_unit"
+  business_code      = "ml"
+  env                = "production"
+  environment_code   = "p"
   region_kms_keyring = [for i in local.env_keyrings : i if split("/", i)[3] == var.instance_region]
 }
 
diff --git a/examples/machine-learning-pipeline/ml_business_unit/production/variables.tf b/examples/machine-learning-pipeline/ml_business_unit/production/variables.tf
@@ -41,6 +41,6 @@ variable "seed_state_bucket" {
 
 variable "repository_id" {
   description = "Common artifacts repository id"
-  type = string
-  default = "c-publish-artifacts"
+  type        = string
+  default     = "c-publish-artifacts"
 }
diff --git a/examples/machine-learning-pipeline/modules/base_env/main.tf b/examples/machine-learning-pipeline/modules/base_env/main.tf
@@ -67,7 +67,7 @@ module "big_query" {
 #      Metadata        #
 ########################
 
-module "metadata" {  
+module "metadata" {
   source = "git::https://source.developers.google.com/p/SERVICE_CATALOG_PROJECT_ID/r/service-catalog//modules/metadata?ref=main"
 
   project_id = var.project_id