Deploying Quick Service - Adaptive Applications - BlueCat Gateway - 25.3.0

Quick Service Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
25.3.0

To deploy Quick Service, do the following:

Note: Ensure that your host machine can reach the BlueCat Address Manager (BAM) server.
  1. Log in to the BlueCat Gateway instance as root:

    ssh root@your-ip

    In the above command, your-ip is the IP address of your Gateway instance.

  2. Pull the latest Quick Service image from Quay:

    docker pull quay.io/bluecat/quick_service:<version>

  3. Create a named docker volume:

    docker volume create qs_database

  4. Set the permissions of the /root/gwdata/ directory on the host to allow a user from a container to write to the directory:

    mkdir -p /root/gwdata/ && chmod -R 775 /root/gwdata/

  5. Run the docker container, replacing the indicated fields with appropriate values:

    # Run docker container
    docker run -d \
      -v /var/log/gateway/:/logs \
      -v /root/gwdata/:/bluecat_gateway/ \
      -v qs_database:/portal/builtin/workflows/quick_service/api/database/ \
      -e BAM_IP=<enter-data> \
      -e BAM_API_VERSION=2 \
      -p 80:8000 \
      -p 443:44300 \
      --name quick-service-app \
      <image-name>:<image-tag>

    In the above command, BAM_IP is the IP address or URL of the BlueCat Address Manager server instance to which you want to connect. Quick Service Administrators can add additional Address Manager IPs after deployment, in addition to editing, or removing Address Manager IPs, by using the general configuration in BlueCat Gateway.

  6. Run database migration to apply the latest changes:

    # SSH inside the running container
    docker exec -it <container_id> bash
    
    # Change the directory
    cd /portal/builtin/workflows/quick_service/ && export FLASK_APP=api
    
    # Run Database upgrade
    flask db upgrade