Merge pull request #26 from omazin/existing-cloud-scheduler-1

Add ability to use existing Cloud Scheduler

Author: aaron-lane

README.md

@@ -53,12 +53,13 @@ Then perform the following commands on the root folder:
 | function\_source\_dependent\_files | A list of any terraform created `local_file`s that the module will wait for before creating the archive. | object | `<list>` | no |
 | function\_source\_directory | The contents of this directory will be archived and used as the function source. | string | n/a | yes |
 | function\_timeout\_s | The amount of time in seconds allotted for the execution of the function. | number | `"60"` | no |
-| job\_description | Addition text to describet the job | string | `""` | no |
-| job\_name | The name of the scheduled job to run | string | n/a | yes |
+| job\_description | Addition text to describe the job | string | `""` | no |
+| job\_name | The name of the scheduled job to run | string | `"null"` | no |
 | job\_schedule | The job frequency, in cron syntax | string | `"*/2 * * * *"` | no |
 | message\_data | The data to send in the topic message. | string | `"dGVzdA=="` | no |
 | project\_id | The ID of the project where the resources will be created | string | n/a | yes |
 | region | The region in which resources will be applied. | string | n/a | yes |
+| scheduler\_job | An existing Cloud Scheduler job instance | object | `"null"` | no |
 | time\_zone | The timezone to use in scheduler | string | `"Etc/UTC"` | no |
 | topic\_name | Name of pubsub topic connecting the scheduled job and the function | string | `"test-topic"` | no |
 
@@ -67,6 +68,8 @@ Then perform the following commands on the root folder:
 | Name | Description |
 |------|-------------|
 | name | The name of the job created |
+| pubsub\_topic\_name | PubSub topic name |
+| scheduler\_job | The Cloud Scheduler job instance |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

examples/pubsub_scheduled_multiple/README.md

@@ -0,0 +1,24 @@
+# Multiple Cloud Functions sharing the same Cloud Scheduler
+
+This example module schedules a job to publish a message to a Pub/Sub topic every 5 minutes, which will trigger a CloudFunctions function.
+
+Running this module requires an App Engine app in the specified project/region, which is not handled by this example.
+More information is in the [root readme](../../README.md#app-engine).
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| project\_id | The project ID to host the network in | string | `"flask-app-254610"` | no |
+| region | The region the project is in (App Engine specific) | string | `"us-central1"` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| name | The name of the job created |
+| project\_id | The project ID |
+| scheduler\_job | An existing Cloud Scheduler job instance |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/pubsub_scheduled_multiple/function_source/index.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2019 Google Inc.
+ *
+ * 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.
+ */
+
+
+/**
+ * Triggered from a message on a Cloud Pub/Sub topic.
+ *
+ * @param {!Object} event Event payload and metadata.
+ * @param {!Function} callback Callback function to signal completion.
+ */
+exports.doSomething = (event) => {
+  console.log("Received event 1");
+  console.log(event);
+};

examples/pubsub_scheduled_multiple/function_source_2/index.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2019 Google Inc.
+ *
+ * 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.
+ */
+
+
+/**
+ * Triggered from a message on a Cloud Pub/Sub topic.
+ *
+ * @param {!Object} event Event payload and metadata.
+ * @param {!Function} callback Callback function to signal completion.
+ */
+exports.doSomething2 = (event) => {
+  console.log("Received event 2");
+  console.log(event);
+};

examples/pubsub_scheduled_multiple/main.tf

@@ -0,0 +1,48 @@
+/**
+ * Copyright 2019 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.
+ */
+
+terraform {
+  required_version = ">= 0.12"
+}
+
+provider "google-beta" {
+  version = "~> 2.5"
+  project = var.project_id
+  region  = var.region
+}
+
+module "pubsub_scheduled_1" {
+  source                    = "../../"
+  project_id                = var.project_id
+  job_name                  = "pubsub-example"
+  job_schedule              = "*/5 * * * *"
+  function_entry_point      = "doSomething"
+  function_source_directory = "${path.module}/function_source"
+  function_name             = "testfunction-1"
+  region                    = var.region
+  topic_name                = "pubsub-1"
+}
+
+module "pubsub_scheduled_2" {
+  source                    = "../../"
+  project_id                = var.project_id
+  function_entry_point      = "doSomething2"
+  function_source_directory = "${path.module}/function_source_2"
+  function_name             = "testfunction-2"
+  region                    = var.region
+  topic_name                = module.pubsub_scheduled_1.pubsub_topic_name
+  scheduler_job             = module.pubsub_scheduled_1.scheduler_job
+}

examples/pubsub_scheduled_multiple/outputs.tf

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2019 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.
+ */
+
+output "name" {
+  value       = module.pubsub_scheduled_1.name
+  description = "The name of the job created"
+}
+
+output "project_id" {
+  value       = var.project_id
+  description = "The project ID"
+}
+
+output "scheduler_job" {
+  value       = module.pubsub_scheduled_1.scheduler_job
+  description = "An existing Cloud Scheduler job instance"
+}
+

examples/pubsub_scheduled_multiple/variables.tf

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2019 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.
+ */
+
+variable "project_id" {
+  type        = string
+  description = "The project ID to host the network in"
+  default     = "flask-app-254610"
+}
+
+variable "region" {
+  type        = string
+  description = "The region the project is in (App Engine specific)"
+  default     = "us-central1"
+}

main.tf

@@ -19,6 +19,8 @@
  *****************************************/
 
 resource "google_cloud_scheduler_job" "job" {
+  count = var.scheduler_job == null ? 1 : 0
+
   name        = var.job_name
   project     = var.project_id
   region      = var.region
@@ -37,10 +39,11 @@ resource "google_cloud_scheduler_job" "job" {
  *****************************************/
 
 module "pubsub_topic" {
-  source     = "terraform-google-modules/pubsub/google"
-  version    = "~> 1.0"
-  topic      = var.topic_name
-  project_id = var.project_id
+  source       = "terraform-google-modules/pubsub/google"
+  version      = "~> 1.0"
+  topic        = var.topic_name
+  project_id   = var.project_id
+  create_topic = var.scheduler_job == null ? true : false
 }
 
 /******************************************
@@ -54,7 +57,7 @@ module "main" {
   entry_point = var.function_entry_point
   event_trigger = {
     event_type = "google.pubsub.topic.publish"
-    resource   = module.pubsub_topic.topic
+    resource   = var.scheduler_job == null ? module.pubsub_topic.topic : var.topic_name
   }
   name             = var.function_name
   project_id       = var.project_id

outputs.tf

@@ -15,6 +15,16 @@
  */
 
 output "name" {
-  value       = google_cloud_scheduler_job.job.name
+  value       = var.scheduler_job == null ? google_cloud_scheduler_job.job.0.name : var.scheduler_job.name
   description = "The name of the job created"
 }
+
+output "scheduler_job" {
+  value       = var.scheduler_job == null ? google_cloud_scheduler_job.job : var.scheduler_job
+  description = "The Cloud Scheduler job instance"
+}
+
+output "pubsub_topic_name" {
+  value       = var.scheduler_job == null ? module.pubsub_topic.topic : var.topic_name
+  description = "PubSub topic name"
+}

variables.tf

@@ -22,11 +22,12 @@ variable "project_id" {
 variable "job_name" {
   type        = string
   description = "The name of the scheduled job to run"
+  default     = null
 }
 
 variable "job_description" {
   type        = string
-  description = "Addition text to describet the job"
+  description = "Addition text to describe the job"
   default     = ""
 }
 
@@ -148,3 +149,9 @@ variable "time_zone" {
   description = "The timezone to use in scheduler"
   default     = "Etc/UTC"
 }
+
+variable "scheduler_job" {
+  type        = object({ name = string })
+  description = "An existing Cloud Scheduler job instance"
+  default     = null
+}