Skip to content

Commit

Permalink
Fix documentation, remove obsolete variables, and correct outputs
Browse files Browse the repository at this point in the history
  • Loading branch information
thefirstofthe300 committed Feb 22, 2019
1 parent 57083df commit 5217b36
Show file tree
Hide file tree
Showing 15 changed files with 33 additions and 76 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,12 @@ The roles granted are specifically:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| activate_apis | The list of apis to activate within the project | list | `<list>` | no |
| app_engine_auth_domain | The domain to authenticate users with when using App Engine's User API. | string | `` | no |
| app_engine_enabled | Enable App Engine on the project. | string | `false` | no |
| app_engine_feature_settings | A block of optional settings to configure specific App Engine features. | string | `<list>` | no |
| app_engine_location_id | The location to serve the app from. | string | `` | no |
| app_engine_serving_status | The serving status of the App Engine application. | string | `SERVING` | no |
| auto_create_network | Create the default network | string | `false` | no |
| billing_account | The ID of the billing account to associate this project with | string | - | yes |
| bucket_name | A name for a GCS bucket to create (in the bucket_project project), useful for Terraform state (optional) | string | `` | no |
Expand All @@ -124,12 +120,6 @@ The roles granted are specifically:

| Name | Description |
|------|-------------|
| app_engine_code_bucket | The GCS bucket code is being stored in for this app. |
| app_engine_default_bucket | The GCS bucket content is being stored in for this app. |
| app_engine_default_hostname | The default hostname for this app. |
| app_engine_gcr_domain | The GCR domain used for storing managed Docker images for this app. |
| app_engine_name | Unique name of the app, usually apps/{PROJECT_ID}. |
| app_engine_url_dispatch_rule | A list of dispatch rule blocks. Each block has a domain, path, and service field. |
| domain | The organization's domain |
| group_email | The email of the GSuite group with group_name |
| project_bucket_self_link | Project's bucket selfLink |
Expand Down Expand Up @@ -380,4 +370,4 @@ versions][release-new-version].
[terraform-provider-google-beta]: https://github.com/terraform-providers/terraform-provider-google-beta
[terraform-provider-gsuite]: https://github.com/DeviaVir/terraform-provider-gsuite
[glossary]: /docs/GLOSSARY.md
[release-new-version]: https://www.terraform.io/docs/registry/modules/publish.html#releasing-new-versions
[release-new-version]: https://www.terraform.io/docs/registry/modules/publish.html#releasing-new-versions
3 changes: 3 additions & 0 deletions docs/upgrading_to_project_factory_v2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ The new version of project factory uses a new module named `app_engine`. It acce
/// @file main.tf
module "app-engine" {
source = "terraform-google-modules/project-factory/google//modules/app_engine"
version = "~> 2.0"
project = "${var.project_id}
location_id = "${var.region}"
auth_domain = "${var.domain}"
Expand Down
3 changes: 2 additions & 1 deletion examples/app_engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Expected variables:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -30,4 +31,4 @@ Expected variables:
| domain_example | The organization's domain |
| project_info_example | The ID of the created project |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion examples/gke_shared_vpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ More information about GKE with Shared VPC can be found here: https://cloud.goog

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -35,4 +36,4 @@ More information about GKE with Shared VPC can be found here: https://cloud.goog
| shared_vpc | The ID of the host project which hosts the shared VPC | string | - | yes |
| shared_vpc_subnets | List of subnets fully qualified subnet IDs (ie. projects/$PROJECT_ID/regions/$REGION/subnetworks/$SUBNET_ID) | list | `<list>` | no |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion examples/group_project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Expected variables:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -35,4 +36,4 @@ Expected variables:
| group_email_example | The email of the created GSuite group |
| project_info_example | The ID of the created project |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion examples/project-hierarchy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Expected variables:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -39,4 +40,4 @@ Expected variables:
| project_info_example | The ID of the created prod_gke project |
| project_info_factory_example | The ID of the created factory project |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion examples/simple_project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Expected variables:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -25,4 +26,4 @@ Expected variables:
| domain_example | The organization's domain |
| project_info_example | The ID of the created project |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
12 changes: 6 additions & 6 deletions modules/app_engine/outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,30 @@

output "name" {
description = "Unique name of the app, usually apps/{PROJECT_ID}."
value = "${google_app_engine_application.app.0.name}"
value = "${google_app_engine_application.app.name}"
}

output "url_dispatch_rule" {
description = "A list of dispatch rule blocks. Each block has a domain, path, and service field."
value = "${google_app_engine_application.app.0.url_dispatch_rule}"
value = "${google_app_engine_application.app.url_dispatch_rule}"
}

output "code_bucket" {
description = "The GCS bucket code is being stored in for this app."
value = "${google_app_engine_application.app.0.code_bucket}"
value = "${google_app_engine_application.app.code_bucket}"
}

output "default_hostname" {
description = "The default hostname for this app."
value = "${google_app_engine_application.app.0.default_hostname}"
value = "${google_app_engine_application.app.default_hostname}"
}

output "default_bucket" {
description = "The GCS bucket content is being stored in for this app."
value = "${google_app_engine_application.app.0.default_bucket}"
value = "${google_app_engine_application.app.default_bucket}"
}

output "gcr_domain" {
description = "The GCR domain used for storing managed Docker images for this app."
value = "${google_app_engine_application.app.0.gcr_domain}"
value = "${google_app_engine_application.app.gcr_domain}"
}
14 changes: 2 additions & 12 deletions modules/core_project_factory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| activate_apis | The list of apis to activate within the project | list | `<list>` | no |
| app_engine_auth_domain | The domain to authenticate users with when using App Engine's User API. | string | `` | no |
| app_engine_enabled | Enable App Engine on the project. | string | `false` | no |
| app_engine_feature_settings | A block of optional settings to configure specific App Engine features. | string | `<list>` | no |
| app_engine_location_id | The location to serve the app from. | string | `` | no |
| app_engine_serving_status | The serving status of the App Engine application. | string | `SERVING` | no |
| auto_create_network | Create the default network | string | `false` | no |
| billing_account | The ID of the billing account to associate this project with | string | - | yes |
| bucket_name | A name for a GCS bucket to create (in the bucket_project project), useful for Terraform state (optional) | string | `` | no |
Expand Down Expand Up @@ -39,12 +35,6 @@
|------|-------------|
| api_s_account | API service account email |
| api_s_account_fmt | API service account email formatted for terraform use |
| app_engine_code_bucket | The GCS bucket code is being stored in for this app. |
| app_engine_default_bucket | The GCS bucket content is being stored in for this app. |
| app_engine_default_hostname | The default hostname for this app. |
| app_engine_gcr_domain | The GCR domain used for storing managed Docker images for this app. |
| app_engine_name | Unique name of the app, usually apps/{PROJECT_ID}. |
| app_engine_url_dispatch_rule | A list of dispatch rule blocks. Each block has a domain, path, and service field. |
| project_bucket_name | The name of the projec's bucket |
| project_bucket_self_link | Project's bucket selfLink |
| project_bucket_url | Project's bucket url |
Expand All @@ -56,4 +46,4 @@
| service_account_name | The fully-qualified name of the default service account |
| service_account_unique_id | The unique id of the default service account |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
25 changes: 0 additions & 25 deletions modules/core_project_factory/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -118,28 +118,3 @@ variable "disable_services_on_destroy" {
default = "true"
type = "string"
}

variable "app_engine_enabled" {
description = "Enable App Engine on the project."
default = false
}

variable "app_engine_location_id" {
description = "The location to serve the app from."
default = ""
}

variable "app_engine_auth_domain" {
description = "The domain to authenticate users with when using App Engine's User API."
default = ""
}

variable "app_engine_serving_status" {
description = "The serving status of the App Engine application."
default = "SERVING"
}

variable "app_engine_feature_settings" {
description = "A block of optional settings to configure specific App Engine features."
default = []
}
14 changes: 2 additions & 12 deletions modules/gsuite_enabled/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,13 @@ The roles granted are specifically:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| activate_apis | The list of apis to activate within the project | list | `<list>` | no |
| api_sa_group | A GSuite group to place the Google APIs Service Account for the project in | string | `` | no |
| app_engine_auth_domain | The domain to authenticate users with when using App Engine's User API. | string | `` | no |
| app_engine_enabled | Enable App Engine on the project. | string | `false` | no |
| app_engine_feature_settings | A block of optional settings to configure specific App Engine features. | string | `<list>` | no |
| app_engine_location_id | The location to serve the app from. | string | `` | no |
| app_engine_serving_status | The serving status of the App Engine application. | string | `SERVING` | no |
| auto_create_network | Create the default network | string | `false` | no |
| billing_account | The ID of the billing account to associate this project with | string | - | yes |
| bucket_name | A name for a GCS bucket to create (in the bucket_project project), useful for Terraform state (optional) | string | `` | no |
Expand Down Expand Up @@ -93,12 +89,6 @@ The roles granted are specifically:

| Name | Description |
|------|-------------|
| app_engine_code_bucket | The GCS bucket code is being stored in for this app. |
| app_engine_default_bucket | The GCS bucket content is being stored in for this app. |
| app_engine_default_hostname | The default hostname for this app. |
| app_engine_gcr_domain | The GCR domain used for storing managed Docker images for this app. |
| app_engine_name | Unique name of the app, usually apps/{PROJECT_ID}. |
| app_engine_url_dispatch_rule | A list of dispatch rule blocks. Each block has a domain, path, and service field. |
| domain | The organization's domain |
| group_email | The email of the created GSuite group with group_name |
| project_bucket_self_link | Project's bucket selfLink |
Expand All @@ -114,4 +104,4 @@ The roles granted are specifically:
[^]: (autogen_docs_end)

[examples]: ../../examples/
[root-module]: ../../README.md
[root-module]: ../../README.md
3 changes: 2 additions & 1 deletion modules/gsuite_group/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -18,4 +19,4 @@
| domain | The domain of the group's organization. |
| email | The email address of the group. |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion modules/project_services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ See [examples/project_services](./examples/project_services) for an example.

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand All @@ -38,4 +39,4 @@ See [examples/project_services](./examples/project_services) for an example.
|------|-------------|
| project_id | The GCP project you want to enable APIs on |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion test/fixtures/full/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand Down Expand Up @@ -41,4 +42,4 @@
| usage_bucket_name | |
| usage_bucket_prefix | |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)
3 changes: 2 additions & 1 deletion test/fixtures/minimal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
Expand Down Expand Up @@ -40,4 +41,4 @@
| usage_bucket_name | |
| usage_bucket_prefix | |

[^]: (autogen_docs_end)
[^]: (autogen_docs_end)

0 comments on commit 5217b36

Please sign in to comment.