SaaS Sign-up and Reverse Proxy for Deployments

How to Sign up

SaaS Sign-up Process and the Reverse Proxy

When you signed up to use DeployHub SaaS, you were asked for basic information. Your UserID/Password, Company and Project names. Your UserID/Password and Company name are unique. Your Project will be a Subdomain under your Company Domain.

Note: If another user signs up with the same Company name, they will be informed that they must contact the Administrator for access to the DeployHub account. The Administrator is the first person who signed up to DeployHub with that Company name.

DeployHub is accessible through the following url:

https://console.deployhub.com/dmadminweb/Home

Login using the UserID and Password you used when you signed up for DeployHub.

Take a Test Drive of the Online Store Company - Hipster Store Tutorial

The Hipster Store Tutorial is provided to give you a review of Domains, Components, and Applications and will help you understand DeployHub basic concepts. See Hipster Store Tutorial for more information.

Installing the Reverse Proxy for Managing Deployments using DeployHub

DeployHub includes a deployment engine that can be used to deploy your Applications. Alternatively you can push deployment information to DeployHub using the Command Line Interface. You will not need the Reverse Proxy if your are pushing deployment results with the CLI.

To start using DeployHub to deploy your Applications and Components, you will first need to install a Reverse Proxy inside your firewall. This contacts DeployHub in our SaaS environment to receive deployment requests. The Reverse Proxy is required for deploying into your environment.

A Reverse Proxy queries the DeployHub SaaS every minute to determine if a deployment is needed. For SaaS users, it provides a security layer, preventing you from opening a port to the outside world. It uses standard HTTPS requests to communicate to the DeployHub SaaS on the Google GKE environment. Nothing from the external Google side of the firewall is pushed to the local DeployHub Reverse Proxy.

Once the Reverse Proxy determines that a deployment is needed, it executes the deployment using all files on the inside of the firewall. The one-way communication initiates the deployment but all work is done local to your network. On completion of the deployment, the logs are pushed back up to the DeployHub SaaS for viewing and audit.

DeployHub Architecture

Reverse Proxy Installation

The Reverse Proxy runs as docker container. In order to install it, you need to install Docker.

Docker Installation Guides

Test your Docker Install

See the Docker Install Test instructions

Installing Your DeployHub Reverse Proxy Docker Image

The DeployHub Reverse Proxy Docker Image is found on the Redhat Quay Docker Registry. Follow the steps below to install the Reverse Proxy into your Docker installation.

Step 1 - Set your CLIENTID as environment variable

Use your Client ID that you received in your “Welcome” sign up email from DeployHub. It will be a hexadecimal number such as:

Your CLIENTID is 6d961c2d-69a4-4660-8a4a-aaea11276864

Run:

export CLIENTID="Your ID"

For example:

export CLIENTID=6d961c2d-69a4-4660-8a4a-aaea11276864

Step 2 - Pull Reverse Proxy from Redhat Quay Registry

Run:

docker pull quay.io/deployhub/deployhub-rproxy:latest

Step 3 - Find your image SHA

Run:

docker images | grep deployhub-rproxy | grep latest

Find the image SHA from the third column in the output.

quay.io/deployhub/deployhub-rproxy      v9.0.0          0114088b0b44        6 days ago          3.32GB

The SHA in the above example is 0114088b0b44.

Step 4 - Start the container for Linux and OS/X

Use the image SHA from Step 3 as the last parameter to the docker run.

docker run -d --hostname `hostname` -e CLIENTID=$CLIENTID -v ~/.ssh:/keys:Z 0114088b0b44

Step 5 - Access DeployHub from your browser

DeployHub is accessible through the following url:

https://console.deployhub.com/dmadminweb/Home

Login using the UserID and Password you used when you Signed-up for DeployHub

Step 6 - Confirm Your Reverse Proxy is Running

In the upper right hand corner you will see a message that should say “2 out of 2 Reverse Proxy Running.” There is a default proxy used to deploy into the DeployHub environment for the Hipster Store Tutorial.


Last modified November 30, 2022: updates for CLI and new install process. (7abfec5)