Skip to content

Commit

Permalink
Adds public source/version in sub-modules
Browse files Browse the repository at this point in the history
  • Loading branch information
amandakarina committed Jul 17, 2023
1 parent 185b7ef commit 4839dfc
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
3 changes: 2 additions & 1 deletion modules/secure-cloud-function-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The resources/services/activations/deletions that this module will create/trigge
```hcl
module "secure_cloud_function_core" {
source = "GoogleCloudPlatform/cloud-functions/google//modules/secure-cloud-function-core"
version = "~> 0.3"
function_name = <FUNCTION-NAME>
function_description = <FUNCTION-DESCRIPTION>
Expand Down Expand Up @@ -50,7 +51,7 @@ module "secure_cloud_function_core" {

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| bucket\_cors | Configuration of CORS for bucket with structure as defined in https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket#cors. | `any` | <pre>[<br> {<br> "max_age_seconds": 0,<br> "method": [<br> "GET"<br> ],<br> "origin": [<br> "https://*.cloud.google.com",<br> "https://*.corp.google.com",<br> "https://*.corp.google.com:*",<br> "https://*.cloud.google",<br> "https://*.byoid.goog"<br> ],<br> "response_header": []<br> }<br>]</pre> | no |
| bucket\_cors | Configuration of CORS for bucket with structure as defined in <https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket#cors>. | `any` | <pre>[<br> {<br> "max_age_seconds": 0,<br> "method": [<br> "GET"<br> ],<br> "origin": [<br> "https://*.cloud.google.com",<br> "https://*.corp.google.com",<br> "https://*.corp.google.com:*",<br> "https://*.cloud.google",<br> "https://*.byoid.goog"<br> ],<br> "response_header": []<br> }<br>]</pre> | no |
| bucket\_lifecycle\_rules | The bucket's Lifecycle Rules configuration. | <pre>list(object({<br> # Object with keys:<br> # - type - The type of the action of this Lifecycle Rule. Supported values: Delete and SetStorageClass.<br> # - storage_class - (Required if action type is SetStorageClass) The target Storage Class of objects affected by this Lifecycle Rule.<br> action = any<br><br> # Object with keys:<br> # - age - (Optional) Minimum age of an object in days to satisfy this condition.<br> # - created_before - (Optional) Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.<br> # - with_state - (Optional) Match to live and/or archived objects. Supported values include: "LIVE", "ARCHIVED", "ANY".<br> # - matches_storage_class - (Optional) Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.<br> # - matches_prefix - (Optional) One or more matching name prefixes to satisfy this condition.<br> # - matches_suffix - (Optional) One or more matching name suffixes to satisfy this condition<br> # - num_newer_versions - (Optional) Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.<br> condition = any<br> }))</pre> | <pre>[<br> {<br> "action": {<br> "type": "Delete"<br> },<br> "condition": {<br> "age": 0,<br> "days_since_custom_time": 0,<br> "days_since_noncurrent_time": 0,<br> "num_newer_versions": 3,<br> "with_state": "ARCHIVED"<br> }<br> }<br>]</pre> | no |
| build\_environment\_variables | A set of key/value environment variable pairs to be used when building the Function. | `map(string)` | `{}` | no |
| encryption\_key | The KMS Key to Encrypt Event Arc, source Bucket, docker repository. | `string` | n/a | yes |
Expand Down
3 changes: 2 additions & 1 deletion modules/secure-cloud-function-security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ to be used by Cloud Function (2nd Gen).

```hcl
module "cloud_function_security" {
source = "../secure-cloud-function-security"
source = "GoogleCloudPlatform/cloud-functions/google//modules/secure-cloud-serverless-security"
version = "~> 0.3"
kms_project_id = <KMS PROJECT ID>
location = <KMS LOCATION>
Expand Down
7 changes: 4 additions & 3 deletions modules/secure-cloud-function/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ The resources/services/activations/deletions that this module will create/trigge
Basic usage of this module is as follows:

```hcl
module "secure_cloud_run" {
source = "../../modules/secure-cloud-function"
module "secure_cloud_function" {
source = "GoogleCloudPlatform/cloud-functions/google//modules/secure-cloud-function"
version = "~> 0.3"
function_name = <FUNCTION-NAME>
function_description = <FUNCTION-DESCRIPTION>
Expand Down Expand Up @@ -94,7 +95,7 @@ module "secure_cloud_run" {
|------|-------------|------|---------|:--------:|
| all\_traffic\_on\_latest\_revision | Timeout for each request. | `bool` | `true` | no |
| available\_memory\_mb | The amount of memory in megabytes allotted for the function to use. | `string` | `"256Mi"` | no |
| bucket\_cors | Configuration of CORS for bucket with structure as defined in https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket#cors. | `any` | <pre>[<br> {<br> "max_age_seconds": 0,<br> "method": [<br> "GET"<br> ],<br> "origin": [<br> "https://*.cloud.google.com",<br> "https://*.corp.google.com",<br> "https://*.corp.google.com:*",<br> "https://*.cloud.google",<br> "https://*.byoid.goog"<br> ],<br> "response_header": []<br> }<br>]</pre> | no |
| bucket\_cors | Configuration of CORS for bucket with structure as defined in <https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket#cors>. | `any` | <pre>[<br> {<br> "max_age_seconds": 0,<br> "method": [<br> "GET"<br> ],<br> "origin": [<br> "https://_.cloud.google.com",<br> "https://_.corp.google.com",<br> "https://_.corp.google.com:_",<br> "https://_.cloud.google",<br> "https://_.byoid.goog"<br> ],<br> "response_header": []<br> }<br>]</pre> | no |
| bucket\_lifecycle\_rules | The bucket's Lifecycle Rules configuration. | <pre>list(object({<br> # Object with keys:<br> # - type - The type of the action of this Lifecycle Rule. Supported values: Delete and SetStorageClass.<br> # - storage_class - (Required if action type is SetStorageClass) The target Storage Class of objects affected by this Lifecycle Rule.<br> action = any<br><br> # Object with keys:<br> # - age - (Optional) Minimum age of an object in days to satisfy this condition.<br> # - created_before - (Optional) Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.<br> # - with_state - (Optional) Match to live and/or archived objects. Supported values include: "LIVE", "ARCHIVED", "ANY".<br> # - matches_storage_class - (Optional) Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.<br> # - matches_prefix - (Optional) One or more matching name prefixes to satisfy this condition.<br> # - matches_suffix - (Optional) One or more matching name suffixes to satisfy this condition<br> # - num_newer_versions - (Optional) Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.<br> condition = any<br> }))</pre> | <pre>[<br> {<br> "action": {<br> "type": "Delete"<br> },<br> "condition": {<br> "age": 0,<br> "days_since_custom_time": 0,<br> "days_since_noncurrent_time": 0,<br> "num_newer_versions": 3,<br> "with_state": "ARCHIVED"<br> }<br> }<br>]</pre> | no |
| build\_environment\_variables | A set of key/value environment variable pairs to be used when building the Function. | `map(string)` | `{}` | no |
| connector\_name | The name for the connector to be created. | `string` | `"serverless-vpc-connector"` | no |
Expand Down

0 comments on commit 4839dfc

Please sign in to comment.