Skip to content

massdriver-cloud/gcp-pubsub-subscription

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Massdriver

gcp-pubsub-subscription

Release Contributors Forks Stargazers Issues MIT License

GCP subscription to a PubSub Topic


Design

For detailed information, check out our Operator Guide 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 platform.

What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in Massdriver. Read more here.

Bundle

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

  • ack_deadline_seconds (integer): This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Minimum: 10. Maximum: 600. Default: 20.
  • enable_message_ordering (boolean): Ensures that messages are delivered in the same order they are received. Default: False.
  • message_retention_duration_seconds (integer): How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. Minimum: 600. Maximum: 604800. Default: 600.
  • minimum_backoff_seconds (integer): The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Minimum: 0. Maximum: 600. Default: 10.
  • monitoring_configuration (object): Enable and configure monitoring for your PubSub subscription.
    • backlog_bytes_above (integer): Minimum: 0. Maximum: 1000000. Default: 1000.
  • retain_acked_messages (boolean): Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. Default: False.

Examples

{
    "__name": "Development",
    "ack_deadline_seconds": 10,
    "enable_message_ordering": false
}
{
    "__name": "Production",
    "ack_deadline_seconds": 30,
    "enable_message_ordering": true,
    "message_retention_duration_seconds": 800,
    "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:

        "https://example.com/some/path"
        "https://massdriver.cloud"
      • auth_uri (string): Auth URI. Default: https://accounts.google.com/o/oauth2/auth.

        Examples:

        "https://example.com/some/path"
        "https://massdriver.cloud"
      • client_email (string): Service Account Email.

        Examples:

        "jimmy@massdriver.cloud"
        "service-account-y@gmail.com"
      • client_id (string): .

      • client_x509_cert_url (string): Client x509 Certificate URL.

        Examples:

        "https://example.com/some/path"
        "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:

        "https://example.com/some/path"
        "https://massdriver.cloud"
      • type (string): . Default: service_account.

    • specs (object)
      • gcp (object): .
        • project (string)

        • region (string): The GCP region to provision resources in.

          Examples:

          "us-east1"
          "us-east4"
          "us-west1"
          "us-west2"
          "us-west3"
          "us-west4"
          "us-central1"
  • subnetwork (object): A region-bound network for deploying GCP resources. Cannot contain additional properties.

    • data (object)

      • infrastructure (object)
        • cidr (string)

          Examples:

          "10.100.0.0/16"
          "192.24.12.0/22"
        • gcp_global_network_grn (string): GCP Resource Name (GRN).

          Examples:

          "projects/my-project/global/networks/my-global-network"
          "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
          "projects/my-project/topics/my-pubsub-topic"
          "projects/my-project/subscriptions/my-pubsub-subscription"
          "projects/my-project/locations/us-west2/instances/my-redis-instance"
          "projects/my-project/locations/us-west2/clusters/my-gke-cluster"
        • grn (string): GCP Resource Name (GRN).

          Examples:

          "projects/my-project/global/networks/my-global-network"
          "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
          "projects/my-project/topics/my-pubsub-topic"
          "projects/my-project/subscriptions/my-pubsub-subscription"
          "projects/my-project/locations/us-west2/instances/my-redis-instance"
          "projects/my-project/locations/us-west2/clusters/my-gke-cluster"
        • vpc_access_connector (string): GCP Resource Name (GRN).

          Examples:

          "projects/my-project/global/networks/my-global-network"
          "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
          "projects/my-project/topics/my-pubsub-topic"
          "projects/my-project/subscriptions/my-pubsub-subscription"
          "projects/my-project/locations/us-west2/instances/my-redis-instance"
          "projects/my-project/locations/us-west2/clusters/my-gke-cluster"
    • specs (object)

      • gcp (object): .
        • project (string)

        • region (string): The GCP region to provision resources in.

          Examples:

          "us-east1"
          "us-east4"
          "us-west1"
          "us-west2"
          "us-west3"
          "us-west4"
          "us-central1"
  • 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:

          "projects/my-project/global/networks/my-global-network"
          "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
          "projects/my-project/topics/my-pubsub-topic"
          "projects/my-project/subscriptions/my-pubsub-subscription"
          "projects/my-project/locations/us-west2/instances/my-redis-instance"
          "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:

              "roles/owner"
              "roles/redis.editor"
              "roles/storage.objectCreator"
              "roles/storage.legacyObjectReader"
    • specs (object)

      • topic (object): . Cannot contain additional properties.
        • distribution (string): Must be one of: ['pubsub'].

Artifacts

Resources created by this bundle that can be connected to other bundles.

View

Properties

  • subscription (object): GCP PubSub Subscription. Cannot contain additional properties.
    • data (object): Cannot contain additional properties.

      • infrastructure (object): PubSub subscription configuration. Cannot contain additional properties.

        • grn (string): GCP Resource Name (GRN).

          Examples:

          "projects/my-project/global/networks/my-global-network"
          "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
          "projects/my-project/topics/my-pubsub-topic"
          "projects/my-project/subscriptions/my-pubsub-subscription"
          "projects/my-project/locations/us-west2/instances/my-redis-instance"
          "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:

              "roles/owner"
              "roles/redis.editor"
              "roles/storage.objectCreator"
              "roles/storage.legacyObjectReader"
    • specs (object)

      • subscription (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 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 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.

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!

Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!

Email GitHub LinkedIn Twitter YouTube Reddit