https://github.com/massdriver-cloud/gcp-pubsub-topic
https://github.com/massdriver-cloud/gcp-pubsub-topic
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/gcp-pubsub-topic
- Owner: massdriver-cloud
- License: mit
- Created: 2022-06-02T23:51:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-19T23:26:59.000Z (10 months ago)
- Last Synced: 2025-08-20T01:21:27.073Z (10 months ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 43.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# gcp-pubsub-topic
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
GCP Pub/Sub Topic
---
## Design
For detailed information, check out our [Operator Guide](operator.md) for this bundle.
## Usage
Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`message_retention_duration_seconds`** *(integer)*: The minimum duration (in seconds) to retain a message after it is published to the topic. Minimum: `600`. Maximum: `604800`. Default: `86600`.
- **`monitoring_configuration`** *(object)*: Configure monitoring for your PubSub subscription.
- **`retained_bytes_above`** *(integer)*: The threshold (in bytes) of messages in the queue to alarm on. Minimum: `0`. Maximum: `10000000000`. Default: `100000`.
- **`region`** *(string)*: GCP region to create the pubsub in.
Examples:
```json
"us-east1"
```
```json
"us-east4"
```
```json
"us-west1"
```
```json
"us-west2"
```
```json
"us-west3"
```
```json
"us-west4"
```
```json
"us-central1"
```
## Examples
```json
{
"__name": "Development",
"message_retention_duration_seconds": 600
}
```
```json
{
"__name": "Production",
"message_retention_duration_seconds": 86600,
"monitoring_configuration": {
"enabled": true
}
}
```
### Connections
Connections from other bundles that this bundle depends on.
View
## Properties
- **`gcp_authentication`** *(object)*: GCP Service Account. Cannot contain additional properties.
- **`data`** *(object)*
- **`auth_provider_x509_cert_url`** *(string)*: Auth Provider x509 Certificate URL. Default: `https://www.googleapis.com/oauth2/v1/certs`.
Examples:
```json
"https://example.com/some/path"
```
```json
"https://massdriver.cloud"
```
- **`auth_uri`** *(string)*: Auth URI. Default: `https://accounts.google.com/o/oauth2/auth`.
Examples:
```json
"https://example.com/some/path"
```
```json
"https://massdriver.cloud"
```
- **`client_email`** *(string)*: Service Account Email.
Examples:
```json
"jimmy@massdriver.cloud"
```
```json
"service-account-y@gmail.com"
```
- **`client_id`** *(string)*: .
- **`client_x509_cert_url`** *(string)*: Client x509 Certificate URL.
Examples:
```json
"https://example.com/some/path"
```
```json
"https://massdriver.cloud"
```
- **`private_key`** *(string)*: .
- **`private_key_id`** *(string)*: .
- **`project_id`** *(string)*: .
- **`token_uri`** *(string)*: Token URI. Default: `https://oauth2.googleapis.com/token`.
Examples:
```json
"https://example.com/some/path"
```
```json
"https://massdriver.cloud"
```
- **`type`** *(string)*: . Default: `service_account`.
- **`specs`** *(object)*
- **`gcp`** *(object)*: .
- **`project`** *(string)*
- **`region`** *(string)*: The GCP region to provision resources in.
Examples:
```json
"us-east1"
```
```json
"us-east4"
```
```json
"us-west1"
```
```json
"us-west2"
```
```json
"us-west3"
```
```json
"us-west4"
```
```json
"us-central1"
```
### Artifacts
Resources created by this bundle that can be connected to other bundles.
View
## Properties
- **`topic`** *(object)*: GCP PubSub Topic. Cannot contain additional properties.
- **`data`** *(object)*: Cannot contain additional properties.
- **`infrastructure`** *(object)*: PubSub topic configuration. Cannot contain additional properties.
- **`grn`** *(string)*: GCP Resource Name (GRN).
Examples:
```json
"projects/my-project/global/networks/my-global-network"
```
```json
"projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
```
```json
"projects/my-project/topics/my-pubsub-topic"
```
```json
"projects/my-project/subscriptions/my-pubsub-subscription"
```
```json
"projects/my-project/locations/us-west2/instances/my-redis-instance"
```
```json
"projects/my-project/locations/us-west2/clusters/my-gke-cluster"
```
- **`security`** *(object)*: GCP Security Configuration. Cannot contain additional properties.
- **`iam`** *(object)*: IAM Roles And Conditions. Cannot contain additional properties.
- **`^[a-z]+[a-z_]*[a-z]$`** *(object)*
- **`condition`** *(string)*: GCP IAM Condition.
- **`role`**: GCP Role.
Examples:
```json
"roles/owner"
```
```json
"roles/redis.editor"
```
```json
"roles/storage.objectCreator"
```
```json
"roles/storage.legacyObjectReader"
```
- **`specs`** *(object)*
- **`topic`** *(object)*: . Cannot contain additional properties.
- **`distribution`** *(string)*: Must be one of: `['pubsub']`.
## Contributing
### Bug Reports & Feature Requests
Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/gcp-pubsub-topic/issues) to report any bugs or request additional features.
### Developing
**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.
Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).
### Fix or Fork
If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/gcp-pubsub-topic.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/gcp-pubsub-topic/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/gcp-pubsub-topic.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/gcp-pubsub-topic/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/gcp-pubsub-topic.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/gcp-pubsub-topic/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/gcp-pubsub-topic.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/gcp-pubsub-topic/issues
[release_url]: https://github.com/massdriver-cloud/gcp-pubsub-topic/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/gcp-pubsub-topic.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/gcp-pubsub-topic.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/gcp-pubsub-topic/blob/main/LICENSE
[email_url]: mailto:support@massdriver.cloud
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:support@massdriver.cloud
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=gcp-pubsub-topic&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500