Skip to content

Commit

Permalink
fix: add missing readme files and regenerate metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
gajdaw committed Jun 13, 2024
1 parent 6e5e388 commit 70e31e5
Show file tree
Hide file tree
Showing 15 changed files with 2,314 additions and 1,694 deletions.
771 changes: 366 additions & 405 deletions metadata.yaml

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions modules/app_engine/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# App Engine

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`

## Usage

Basic usage of this module is as follows:

```hcl
module "project_myproject" {
source = "terraform-google-modules/project-factory/google//modules/budget"
billing_account = "ABCD-1234-ABCD-1234"
projects = ["my-project-id"]
amount = "100"
}
```

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| auth\_domain | The domain to authenticate users with when using App Engine's User API. | `string` | `""` | no |
| 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 |
| location\_id | The location to serve the app from. | `string` | `""` | no |
| project\_id | The project to enable app engine on. | `string` | n/a | yes |
| serving\_status | The serving status of the app. | `string` | `"SERVING"` | no |

## Outputs

| Name | Description |
|------|-------------|
| code\_bucket | The GCS bucket code is being stored in for this app. |
| default\_bucket | The GCS bucket content is being stored in for this app. |
| default\_hostname | The default hostname for this app. |
| location\_id | The location app engine is serving from |
| name | Unique name of the app, usually apps/{PROJECT\_ID}. |
| url\_dispatch\_rule | A list of dispatch rule blocks. Each block has a domain, path, and service field. |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
133 changes: 133 additions & 0 deletions modules/app_engine/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintMetadata
metadata:
name: terraform-google-project-factory-app-engine
annotations:
config.kubernetes.io/local-config: "true"
spec:
info:
title: App Engine
source:
repo: https://github.com/terraform-google-modules/terraform-google-project-factory.git
sourceType: git
dir: /modules/app_engine
actuationTool:
flavor: Terraform
version: ">= 0.13"
description: {}
content:
examples:
- name: app_engine
location: examples/app_engine
- name: budget_project
location: examples/budget_project
- name: essential_contacts
location: examples/essential_contacts
- name: fabric_project
location: examples/fabric_project
- name: gke_shared_vpc
location: examples/gke_shared_vpc
- name: group_project
location: examples/group_project
- name: project-hierarchy
location: examples/project-hierarchy
- name: project_services
location: examples/project_services
- name: quota_project
location: examples/quota_project
- name: shared_vpc
location: examples/shared_vpc
- name: simple_project
location: examples/simple_project
- name: tags_project
location: examples/tags_project
interfaces:
variables:
- name: auth_domain
description: The domain to authenticate users with when using App Engine's User API.
varType: string
defaultValue: ""
- name: feature_settings
description: A list of maps of optional settings to configure specific App Engine features.
varType: list(object({ split_health_checks = bool }))
defaultValue:
- split_health_checks: true
- name: location_id
description: The location to serve the app from.
varType: string
defaultValue: ""
- name: project_id
description: The project to enable app engine on.
varType: string
required: true
- name: serving_status
description: The serving status of the app.
varType: string
defaultValue: SERVING
outputs:
- name: code_bucket
description: The GCS bucket code is being stored in for this app.
- name: default_bucket
description: The GCS bucket content is being stored in for this app.
- name: default_hostname
description: The default hostname for this app.
- name: location_id
description: The location app engine is serving from
- name: name
description: Unique name of the app, usually apps/{PROJECT_ID}.
- name: url_dispatch_rule
description: A list of dispatch rule blocks. Each block has a domain, path, and service field.
requirements:
roles:
- level: Project
roles:
- roles/owner
- roles/compute.admin
- roles/iam.serviceAccountAdmin
- roles/resourcemanager.projectIamAdmin
- roles/storage.admin
- roles/iam.serviceAccountUser
- roles/billing.projectManager
- level: Project
roles:
- roles/owner
- roles/resourcemanager.projectCreator
- roles/resourcemanager.folderAdmin
- roles/resourcemanager.folderIamAdmin
- roles/billing.projectManager
- roles/compute.xpnAdmin
- level: Project
roles:
- roles/accesscontextmanager.policyAdmin
- roles/resourcemanager.organizationViewer
- roles/resourcemanager.tagAdmin
- roles/resourcemanager.tagUser
services:
- admin.googleapis.com
- appengine.googleapis.com
- cloudbilling.googleapis.com
- cloudresourcemanager.googleapis.com
- compute.googleapis.com
- iam.googleapis.com
- iamcredentials.googleapis.com
- oslogin.googleapis.com
- serviceusage.googleapis.com
- billingbudgets.googleapis.com
- pubsub.googleapis.com
- accesscontextmanager.googleapis.com
- essentialcontacts.googleapis.com
- serviceconsumermanagement.googleapis.com
Loading

0 comments on commit 70e31e5

Please sign in to comment.