Pub/Sub UI

Pub/Sub UI is graphical user interface for managing Google Cloud Pub/Sub.

Overview

This application provides the following features:

• Switching between multiple GCP projects
• Browsing all Pub/Sub topics created within a GCP project
• Subscribing to a topic and receiving messages as they come in
• Publishing messages to a topic
• Using pre-defined message payload for publishing
• Creating new topics
• Creating new subscriptions

Configuration

The following configuration is supported:

Environment variable	Flag	Usage	Default
PUBSUBUI_HOST	-host	Listening HTTP host	0.0.0.0
PUBSUBUI_PORT	-port	Listening HTTP port	8080
PUBSUBUI_CONFIG	-config	Config file path (see below)	none`
GOOGLE_CLOUD_PROJECTS (plural!)	-projects	Comma-separated list of GCP project IDs	none
GOOGLE_APPLICATION_CREDENTIALS	n/a	Path to Google Cloud Platform JSON credentials file	none
PUBSUB_EMULATOR_HOST	n/a	Address of the Pub/Sub emulator (see below)	none

• Environment variables take precedence over flags.
• At least one GCP project needs to be configured through either the environment variable GOOGLE_CLOUD_PROJECTS, the flag -projects or by adding a topic to a config YAML file (see below) and providing its path through the environment variable PUBSUBUI_CONFIG or the flag -config.
• The PUBSUB_EMULATOR_HOST is optional and functions as described here: https://cloud.google.com/pubsub/docs/emulator#manually_setting_the_variables
• If PUBSUB_EMULATOR_HOST is not set the application will attempt to connect to the actual GCP projects. In this case the GOOGLE_APPLICATION_CREDENTIALS will have to be set, otherwise authentication will fail.

The config.yaml file

The application can be configured to automatically create topics and their subscriptions, as well as pre-defined message payloads to send to these topics. This is done within a YAML file, an example can be found below.

topics:
- name: my-topic             # required
  project: my-gcp-project    # required
  subscriptions:             # optional
  - my-first-subscription
  - my-second-subscription 
- name: my-other-topic
  project: other-gcp-project 
  subscriptions:
  - my-other-subscription
  payloads:                  # optional
  - name: hello
    payload: |
      {
        "hello": "world"
      }
  - name: hello-again
    payload: |
      {
        "hello": "world again"
      }
- name: my-last-topic

• All topics specified will be automatically created.
• All subscriptions will be automatically created on the topic they are defined under.
• Configured payloads will be presented in the UI for the topic they are defined under.
• All project IDs will be extracted and be made selectable within the UI.

Usage

Using a binary

Download the latest release for your OS from the releases page and make it available on your $PATH.

Then, when running with the emulator:

PUBSUB_EMULATOR_HOST=localhost:8085 \
pubsubui \
  -host localhost \
  -port 8080 \
  -config "/path/to/config.yaml" \
  -projects "my-first-gcp-project,my-second-gcp-project"

Or, when targeting the actual cloud service:

GOOGLE_APPLICATION_CREDENTIALS="/path/to/application_default_credentials.json" \
pubsubui \
  -host localhost \
  -port 8080 \
  -config "/path/to/config.yaml" \
  -projects "my-first-gcp-project,my-second-gcp-project"

Then open http://localhost:8080.

Using a Docker image

When running with the emulator:

docker pull dennisvis/pubsubui

docker run \
  --name="pubsubui" \
  -p 8080:8080 \
  -v $(pwd)/config.yaml:/config/config.yaml \
  -e PUBSUBUI_CONFIG=/config/config.yaml \
  -e PUBSUB_EMULATOR_HOST=host.docker.internal:8085 \
  -e GOOGLE_CLOUD_PROJECTS="my-first-gcp-project,my-second-gcp-project" \
  dennisvis/pubsubui

When targeting the actual cloud service:

docker pull dennisvis/pubsubui

docker run \
  --name="pubsubui" \
  -p 8080:8080 \
  -v $(pwd)/config.yaml:/config/config.yaml \
  -e PUBSUBUI_CONFIG=/config/config.yaml \
  -e GOOGLE_CLOUD_PROJECTS="my-first-gcp-project,my-second-gcp-project" \
  -v /path/to/application_default_credentials.json:/config/application_default_credentials.json \
  -e GOOGLE_APPLICATION_CREDENTIALS="/config/application_default_credentials.json" \
  dennisvis/pubsubui

Then open http://localhost:8080.

Running on Kubernetes

The application exposes both a /healthy and a /ready endpoint which should be used for a liveness and readiness probe respectively in your Kubernetes manifest.

containers:
- name: pubsubui
  ...
  livenessProbe:
    httpGet:
      port: 8080
      path: /healthy
  readinessProbe:
    httpGet:
      port: 8080
      path: /ready

Building

Binaries

make

Linux, MacOS (Darwin) and Windows binaries will be available under the bin/ directory.

Docker image

make build_docker

Credits

This project was forked from- and based on ClickAndMortar/GoPubSub.