{"id":16024500,"url":"https://github.com/stephenlb/pubnub-terraform-module","last_synced_at":"2026-01-27T17:33:25.734Z","repository":{"id":253974135,"uuid":"845104192","full_name":"stephenlb/pubnub-terraform-module","owner":"stephenlb","description":"PubNub Terraform Module","archived":false,"fork":false,"pushed_at":"2025-05-07T23:32:25.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-02T12:16:12.546Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stephenlb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-20T15:32:51.000Z","updated_at":"2025-04-30T01:20:29.000Z","dependencies_parsed_at":"2024-08-20T17:57:54.914Z","dependency_job_id":"fabd63e1-c301-46f4-ab13-a33147e9abaa","html_url":"https://github.com/stephenlb/pubnub-terraform-module","commit_stats":null,"previous_names":["stephenlb/pubnub-terraform-module"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stephenlb/pubnub-terraform-module","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlb%2Fpubnub-terraform-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlb%2Fpubnub-terraform-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlb%2Fpubnub-terraform-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlb%2Fpubnub-terraform-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephenlb","download_url":"https://codeload.github.com/stephenlb/pubnub-terraform-module/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlb%2Fpubnub-terraform-module/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28816942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T12:25:15.069Z","status":"ssl_error","status_checked_at":"2026-01-27T12:25:05.297Z","response_time":168,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-08T19:21:19.039Z","updated_at":"2026-01-27T17:33:25.729Z","avatar_url":"https://github.com/stephenlb.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PubNub Terraform Module with Illuminate Integration\n\nThis Terraform module provisions a new PubNub App, an associated API Key, and sets up an Illuminate Business Object and Dashboard in an idempotent way.\n\n## Step-by-Step Guid\n\nSee the [GUIDE.md](GUIDE.md) file for details.\n\n## Table of Contents\n\n- [PubNub Terraform Module with Illuminate Integration](#pubnub-terraform-module-with-illuminate-integration)\n  - [Table of Contents](#table-of-contents)\n  - [Usage](#usage)\n  - [Inputs](#inputs)\n  - [Outputs](#outputs)\n  - [Example Configuration](#example-configuration)\n  - [Dependencies](#dependencies)\n  - [Authors](#authors)\n  - [License](#license)\n\n## Usage\n\nTo use this module, include it in your Terraform configuration and provide the necessary input variables:\n\n```hcl\nmodule \"pubnub\" {\n  source = \"./pubnub\"  # path to your module\n\n  email                        = var.pubnub_email\n  password                     = var.pubnub_password\n  account_id                   = var.pubnub_account_id\n  app_name                     = \"My Awesome PubNub App\"\n  key_name                     = \"Primary API Key\"\n  app_type                     = 1\n  key_type                     = 1\n  history                      = 1\n  message_storage_ttl          = 30\n  lms                          = 0\n  max_message_size             = 1800\n  multiplexing                 = 1\n  apns                         = 0\n  uls                          = 0\n  objects                      = 0\n  illuminate_base_url          = \"admin.pubnub.com\"\n  business_object_name         = \"My Business Object\"\n  business_object_description  = \"Description of my business object\"\n  business_object_fields       = [\n    {\n      name           = \"Field1\"\n      jsonFieldType  = \"TEXT\"\n      isKeyset       = false\n      source         = \"JSONPATH\"\n      jsonPath       = \"$.message.body.field1\"\n    }\n  ]\n  dashboard_name               = \"My Dashboard\"\n  dashboard_date_range         = \"30 minutes\"\n  dashboard_charts             = [\n    {\n      name           = \"Chart1\"\n      metricId       = \"\"\n      metric         = {\n        name            = \"Metric1\"\n        measureId       = \"measureId1\"\n        businessObjectId = \"businessObjectId1\"\n        function        = \"AVG\"\n        dimensionIds    = [\"dimensionId1\"]\n        evaluationWindow= 60\n      }\n      viewType       = \"STACKED\"\n      size           = \"HALF\"\n      dimensionIds   = [\"dimensionId1\"]\n    }\n  ]\n}\n\noutput \"app_id\" {\n  value = module.pubnub.app_id\n}\n\noutput \"key_id\" {\n  value = module.pubnub.key_id\n}\n\noutput \"business_object_id\" {\n  value = module.pubnub.business_object_id\n}\n\noutput \"dashboard_id\" {\n  value = module.pubnub.dashboard_id\n}\n```\n\n## Inputs\n\n| Name                        | Description                                | Type    | Default | Required |\n| --------------------------- | ------------------------------------------ | ------- | ------- | -------- |\n| `email`                     | Email for PubNub authentication            | `string`| n/a     | yes      |\n| `password`                  | Password for PubNub authentication         | `string`| n/a     | yes      |\n| `account_id`                | PubNub Account ID                          | `number`| n/a     | yes      |\n| `app_name`                  | Name of the new PubNub App                 | `string`| n/a     | yes      |\n| `app_type`                  | Type of the PubNub App. 1 for default, 2 for chat | `number` | `1`     | no       |\n| `key_name`                  | Name of the new PubNub API Key             | `string`| n/a     | yes      |\n| `key_type`                  | Type of the PubNub Key. 1 for production, 0 for testing | `number` | `1`     | no       |\n| `history`                   | Enable/Disable History                     | `number`| `1`     | no       |\n| `message_storage_ttl`       | TTL for message storage                    | `number`| `30`    | no       |\n| `lms`                       | Enable/Disable Large Message Support       | `number`| `0`     | no       |\n| `max_message_size`          | Max message size                           | `number`| `1800`  | no       |\n| `multiplexing`              | Enable/Disable Multiplexing                | `number`| `1`     | no       |\n| `apns`                      | Enable/Disable APNs                        | `number`| `0`     | no       |\n| `uls`                       | Enable/Disable ULS                         | `number`| `0`     | no       |\n| `objects`                   | Enable/Disable Objects                     | `number`| `0`     | no       |\n| `actions`                   | List of PubNub Actions to create via Events \u0026 Actions API | `list(object({ name=string, type=string, url=string, headers=map(string), body=string }))` | `[]` | no |\n| `events`                    | List of PubNub Events to create via Events \u0026 Actions API  | `list(object({ name=string, status=string, filter=string, action_ids=list(string) }))` | `[]` | no |\n| `illuminate_base_url`       | Base URL for Illuminate API                | `string`| n/a     | yes      |\n| `business_object_name`      | Name of the Illuminate Business Object     | `string`| n/a     | yes      |\n| `business_object_description`| Description of the Illuminate Business Object | `string`| n/a     | yes   |\n| `business_object_fields`    | Fields for the Illuminate Business Object  | `list(object({ name = string, jsonFieldType = string, isKeyset = bool, source = string, jsonPath = string }))` | n/a | yes |\n| `dashboard_name`            | Name of the Illuminate Dashboard           | `string`| n/a     | yes      |\n| `dashboard_date_range`      | Date range for the Illuminate Dashboard    | `string`| `30 minutes` | no    |\n| `dashboard_charts`          | Charts for the Illuminate Dashboard        | `list(object({ name = string, metricId = string, metric = object({ name = string, measureId = string, businessObjectId = string, function = string, dimensionIds = list(string), evaluationWindow = number }), viewType = string, size = string, dimensionIds = list(string) }))` | n/a | yes |\n\n## Outputs\n\n| Name                   | Description                                       |\n| ---------------------- | ------------------------------------------------- |\n| `app_id`               | The ID of the created PubNub App                  |\n| `key_id`               | The ID of the created PubNub API Key              |\n| `business_object_id`   | The ID of the created Illuminate Business Object  |\n| `dashboard_id`         | The ID of the created Illuminate Dashboard        |\n| `action_ids`           | IDs of the created PubNub Actions                  |\n| `event_ids`            | IDs of the created PubNub Events                   |\n\n## Example Configuration\n\nBelow is an example of how to use this module:\n\n```hcl\nprovider \"http\" {}\n\nmodule \"pubnub\" {\n  source = \"./pubnub\"\n\n  email                        = \"your-email@example.com\"\n  password                     = \"your-password\"\n  account_id                   = 123456\n  app_name                     = \"My Awesome PubNub App\"\n  key_name                     = \"Primary API Key\"\n  app_type                     = 1\n  key_type                     = 1\n  history                      = 1\n  message_storage_ttl          = 30\n  lms                          = 0\n  max_message_size             = 1800\n  multiplexing                 = 1\n  apns                         = 0\n  uls                          = 0\n  objects                      = 0\n  illuminate_base_url          = \"admin.pubnub.com\"\n  business_object_name         = \"My Business Object\"\n  business_object_description  = \"Description of my business object\"\n  business_object_fields       = [\n    {\n      name           = \"Field1\"\n      jsonFieldType  = \"TEXT\"\n      isKeyset       = false\n      source         = \"JSONPATH\"\n      jsonPath       = \"$.message.body.field1\"\n    }\n  ]\n  dashboard_name               = \"My Dashboard\"\n  dashboard_date_range         = \"30 minutes\"\n  dashboard_charts             = [\n    {\n      name           = \"Chart1\"\n      metricId       = \"\"\n      metric         = {\n        name            = \"Metric1\"\n        measureId       = \"measureId1\"\n        businessObjectId = \"businessObjectId1\"\n        function        = \"AVG\"\n        dimensionIds    = [\"dimensionId1\"]\n        evaluationWindow= 60\n      }\n      viewType       = \"STACKED\"\n      size           = \"HALF\"\n      dimensionIds   = [\"dimensionId1\"]\n    }\n  ]\n}\n\noutput \"app_id\" {\n  value = module.pubnub.app_id\n}\n\noutput \"key_id\" {\n  value = module.pubnub.key_id\n}\n\noutput \"business_object_id\" {\n  value = module.pubnub.business_object_id\n}\n\noutput \"dashboard_id\" {\n  value = module.pubnub.dashboard_id\n}\n```\n\n## Dependencies\n\nThis module requires the following:\n\n- `jq` - Command-line JSON processor\n- `curl` - Command-line tool for transferring data with URLs\n\nMake sure `jq` and `curl` are installed on your system.\n\n## Authors\n\n- [Stephen Blum](https://github.com/stephenlb)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenlb%2Fpubnub-terraform-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephenlb%2Fpubnub-terraform-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenlb%2Fpubnub-terraform-module/lists"}