Skip to content

Commit 70e31e5

Browse files
committed
fix: add missing readme files and regenerate metadata
1 parent 6e5e388 commit 70e31e5

File tree

15 files changed

+2314
-1694
lines changed

15 files changed

+2314
-1694
lines changed

metadata.yaml

+366-405
Large diffs are not rendered by default.

modules/app_engine/README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# App Engine
2+
3+
This module allows the creation of a [google billing budget](https://www.terraform.io/docs/providers/google/r/billing_budget.html) tied to a specific `project_id`
4+
5+
## Usage
6+
7+
Basic usage of this module is as follows:
8+
9+
```hcl
10+
module "project_myproject" {
11+
source = "terraform-google-modules/project-factory/google//modules/budget"
12+
billing_account = "ABCD-1234-ABCD-1234"
13+
projects = ["my-project-id"]
14+
amount = "100"
15+
}
16+
```
17+
18+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
19+
## Inputs
20+
21+
| Name | Description | Type | Default | Required |
22+
|------|-------------|------|---------|:--------:|
23+
| auth\_domain | The domain to authenticate users with when using App Engine's User API. | `string` | `""` | no |
24+
| feature\_settings | A list of maps of optional settings to configure specific App Engine features. | `list(object({ split_health_checks = bool }))` | <pre>[<br> {<br> "split_health_checks": true<br> }<br>]</pre> | no |
25+
| location\_id | The location to serve the app from. | `string` | `""` | no |
26+
| project\_id | The project to enable app engine on. | `string` | n/a | yes |
27+
| serving\_status | The serving status of the app. | `string` | `"SERVING"` | no |
28+
29+
## Outputs
30+
31+
| Name | Description |
32+
|------|-------------|
33+
| code\_bucket | The GCS bucket code is being stored in for this app. |
34+
| default\_bucket | The GCS bucket content is being stored in for this app. |
35+
| default\_hostname | The default hostname for this app. |
36+
| location\_id | The location app engine is serving from |
37+
| name | Unique name of the app, usually apps/{PROJECT\_ID}. |
38+
| url\_dispatch\_rule | A list of dispatch rule blocks. Each block has a domain, path, and service field. |
39+
40+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

modules/app_engine/metadata.yaml

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Copyright 2024 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
apiVersion: blueprints.cloud.google.com/v1alpha1
16+
kind: BlueprintMetadata
17+
metadata:
18+
name: terraform-google-project-factory-app-engine
19+
annotations:
20+
config.kubernetes.io/local-config: "true"
21+
spec:
22+
info:
23+
title: App Engine
24+
source:
25+
repo: https://github.com/terraform-google-modules/terraform-google-project-factory.git
26+
sourceType: git
27+
dir: /modules/app_engine
28+
actuationTool:
29+
flavor: Terraform
30+
version: ">= 0.13"
31+
description: {}
32+
content:
33+
examples:
34+
- name: app_engine
35+
location: examples/app_engine
36+
- name: budget_project
37+
location: examples/budget_project
38+
- name: essential_contacts
39+
location: examples/essential_contacts
40+
- name: fabric_project
41+
location: examples/fabric_project
42+
- name: gke_shared_vpc
43+
location: examples/gke_shared_vpc
44+
- name: group_project
45+
location: examples/group_project
46+
- name: project-hierarchy
47+
location: examples/project-hierarchy
48+
- name: project_services
49+
location: examples/project_services
50+
- name: quota_project
51+
location: examples/quota_project
52+
- name: shared_vpc
53+
location: examples/shared_vpc
54+
- name: simple_project
55+
location: examples/simple_project
56+
- name: tags_project
57+
location: examples/tags_project
58+
interfaces:
59+
variables:
60+
- name: auth_domain
61+
description: The domain to authenticate users with when using App Engine's User API.
62+
varType: string
63+
defaultValue: ""
64+
- name: feature_settings
65+
description: A list of maps of optional settings to configure specific App Engine features.
66+
varType: list(object({ split_health_checks = bool }))
67+
defaultValue:
68+
- split_health_checks: true
69+
- name: location_id
70+
description: The location to serve the app from.
71+
varType: string
72+
defaultValue: ""
73+
- name: project_id
74+
description: The project to enable app engine on.
75+
varType: string
76+
required: true
77+
- name: serving_status
78+
description: The serving status of the app.
79+
varType: string
80+
defaultValue: SERVING
81+
outputs:
82+
- name: code_bucket
83+
description: The GCS bucket code is being stored in for this app.
84+
- name: default_bucket
85+
description: The GCS bucket content is being stored in for this app.
86+
- name: default_hostname
87+
description: The default hostname for this app.
88+
- name: location_id
89+
description: The location app engine is serving from
90+
- name: name
91+
description: Unique name of the app, usually apps/{PROJECT_ID}.
92+
- name: url_dispatch_rule
93+
description: A list of dispatch rule blocks. Each block has a domain, path, and service field.
94+
requirements:
95+
roles:
96+
- level: Project
97+
roles:
98+
- roles/owner
99+
- roles/compute.admin
100+
- roles/iam.serviceAccountAdmin
101+
- roles/resourcemanager.projectIamAdmin
102+
- roles/storage.admin
103+
- roles/iam.serviceAccountUser
104+
- roles/billing.projectManager
105+
- level: Project
106+
roles:
107+
- roles/owner
108+
- roles/resourcemanager.projectCreator
109+
- roles/resourcemanager.folderAdmin
110+
- roles/resourcemanager.folderIamAdmin
111+
- roles/billing.projectManager
112+
- roles/compute.xpnAdmin
113+
- level: Project
114+
roles:
115+
- roles/accesscontextmanager.policyAdmin
116+
- roles/resourcemanager.organizationViewer
117+
- roles/resourcemanager.tagAdmin
118+
- roles/resourcemanager.tagUser
119+
services:
120+
- admin.googleapis.com
121+
- appengine.googleapis.com
122+
- cloudbilling.googleapis.com
123+
- cloudresourcemanager.googleapis.com
124+
- compute.googleapis.com
125+
- iam.googleapis.com
126+
- iamcredentials.googleapis.com
127+
- oslogin.googleapis.com
128+
- serviceusage.googleapis.com
129+
- billingbudgets.googleapis.com
130+
- pubsub.googleapis.com
131+
- accesscontextmanager.googleapis.com
132+
- essentialcontacts.googleapis.com
133+
- serviceconsumermanagement.googleapis.com

0 commit comments

Comments
 (0)