mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-07-03 08:42:39 +00:00
Adding description of Cloud Functions to website (#958)
* Adding description of Cloud Functions to website * docs changes
This commit is contained in:
sarunask
Dana Hoffman
parent
b68dc6e984
commit
da5c5e8b7c
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
layout: "google"
|
||||
page_title: "Google: google_cloudfunctions_function"
|
||||
sidebar_current: "docs-google-datasource-cloudfunctions-function"
|
||||
description: |-
|
||||
Get information about a Google Cloud Function.
|
||||
---
|
||||
|
||||
# google\_cloudfunctions\_function
|
||||
|
||||
Get information about a Google Cloud Function. For more information see
|
||||
the [official documentation](https://cloud.google.com/functions/docs/)
|
||||
and [API](https://cloud.google.com/functions/docs/apis).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```hcl
|
||||
data "google_cloudfunctions_function" "my-function" {
|
||||
name = "function"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of a Cloud Function.
|
||||
|
||||
- - -
|
||||
|
||||
* `project` - (Optional) The project in which the resource belongs. If it
|
||||
is not provided, the provider project is used.
|
||||
|
||||
* `region` - (Optional) The region in which the resource belongs. If it
|
||||
is not provided, the provider region is used.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
In addition to the arguments listed above, the following computed attributes are
|
||||
exported:
|
||||
|
||||
* `name` - The name of the Cloud Function.
|
||||
* `source_archive_bucket` - The GCS bucket containing the zip archive which contains the function.
|
||||
* `source_archive_object` - The source archive object (file) in archive bucket.
|
||||
* `description` - Description of the function.
|
||||
* `available_memory_mb` - Available memory (in MB) to the function.
|
||||
* `timeout` - Function execution timeout (in seconds).
|
||||
* `entry_point` - Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
|
||||
* `trigger_http` - If function is triggered by HTTP, this boolean is set.
|
||||
* `trigger_bucket` - If function is triggered by bucket, bucket name is set here.
|
||||
* `trigger_topic` - If function is triggered by Pub/Sub topic, name of topic is set here.
|
||||
* `https_trigger_url` - If function is triggered by HTTP, trigger URL is set here.
|
||||
* `labels` - A map of labels applied to this function.
|
||||
89
website/docs/r/cloudfunctions_function.html.markdown
Normal file
89
website/docs/r/cloudfunctions_function.html.markdown
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
---
|
||||
layout: "google"
|
||||
page_title: "Google: google_cloudfunctions_function"
|
||||
sidebar_current: "docs-google-cloudfunctions-function"
|
||||
description: |-
|
||||
Creates a new Cloud Function.
|
||||
---
|
||||
|
||||
# google\_cloudfunctions\_function
|
||||
|
||||
Creates a new Cloud Function. For more information see
|
||||
[the official documentation](https://cloud.google.com/functions/docs/)
|
||||
and
|
||||
[API](https://cloud.google.com/functions/docs/apis).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```hcl
|
||||
resource "google_storage_bucket" "bucket" {
|
||||
name = "test-bucket"
|
||||
}
|
||||
|
||||
resource "google_storage_bucket_object" "archive" {
|
||||
name = "index.zip"
|
||||
bucket = "${google_storage_bucket.bucket.name}"
|
||||
source = "./path/to/zip/file/which/contains/code"
|
||||
}
|
||||
|
||||
resource "google_cloudfunctions_function" "function" {
|
||||
name = "function-test"
|
||||
description = "My function"
|
||||
available_memory_mb = 128
|
||||
source_archive_bucket = "${google_storage_bucket.bucket.name}"
|
||||
source_archive_object = "${google_storage_bucket_object.archive.name}"
|
||||
trigger_http = true
|
||||
timeout = 60
|
||||
entry_point = "helloGET"
|
||||
labels {
|
||||
my-label = "my-label-value"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) A user-defined name of the function. Function names must be unique globally.
|
||||
|
||||
* `source_archive_bucket` - (Required) The GCS bucket containing the zip archive which contains the function.
|
||||
|
||||
* `source_archive_object` - (Required) The source archive object (file) in archive bucket.
|
||||
|
||||
- - -
|
||||
|
||||
* `description` - (Optional) Description of the function.
|
||||
|
||||
* `available_memory_mb` - (Optional) Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.
|
||||
|
||||
* `timeout` - (Optional) Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
|
||||
|
||||
* `entry_point` - (Optional) Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
|
||||
|
||||
* `trigger_http` - (Optional) Boolean variable. Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as `https_trigger_url`. Cannot be used with `trigger_bucket` and `trigger_topic`.
|
||||
|
||||
* `trigger_bucket` - (Optional) Google Cloud Storage bucket name. Every change in files in this bucket will trigger function execution. Cannot be used with `trigger_http` and `trigger_topic`.
|
||||
|
||||
* `trigger_topic` - (Optional) Name of Pub/Sub topic. Every message published in this topic will trigger function execution with message contents passed as input data. Cannot be used with `trigger_http` and `trigger_bucket`.
|
||||
|
||||
* `labels` - (Optional) A set of key/value label pairs to assign to the function.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
In addition to the arguments listed above, the following computed attributes are
|
||||
exported:
|
||||
|
||||
* `https_trigger_url` - URL which triggers function execution. Returned only if `trigger_http` is used.
|
||||
|
||||
* `project` - Project of the function. If it is not provided, the provider project is used.
|
||||
|
||||
* `region` - Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.
|
||||
|
||||
## Import
|
||||
|
||||
Functions can be imported using the `name`, e.g.
|
||||
|
||||
```
|
||||
$ terraform import google_cloudfunctions_function.default function-test
|
||||
```
|
||||
|
|
@ -19,6 +19,9 @@
|
|||
<li<%= sidebar_current("docs-google-datasource-client-config") %>>
|
||||
<a href="/docs/providers/google/d/datasource_client_config.html">google_client_config</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-google-datasource-cloudfunctions-function") %>>
|
||||
<a href="/docs/providers/google/d/datasource_cloudfunctions_function.html">google_cloudfunctions_function</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-google-datasource-compute-address") %>>
|
||||
<a href="/docs/providers/google/d/datasource_compute_address.html">google_compute_address</a>
|
||||
</li>
|
||||
|
|
@ -101,6 +104,15 @@
|
|||
</ul>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-google-cloudfunctions") %>>
|
||||
<a href="#">Google Cloud Functions Resources</a>
|
||||
<ul class="nav nav-visible">
|
||||
<li<%= sidebar_current("docs-google-cloudfunctions-function") %>>
|
||||
<a href="/docs/providers/google/r/cloudfunctions_function.html">google_cloudfunctions_function</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-google-(project|service)") %>>
|
||||
<a href="#">Google Cloud Platform Resources</a>
|
||||
<ul class="nav nav-visible">
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user