Deploying Quick Service - Adaptive Applications - BlueCat Gateway - 24.4

Quick Service Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
24.4
To deploy Quick Service v24.x, you can choose one of the following methods:

To deploy Quick Service via the Address Manager GUI:

  1. Log in to the BAM application.

  2. From the configuration drop down list in the BAM GUI, select a configuration.

  3. Click the Servers tab.

  4. Under Servers, click the name of a BDDS. The Details tab for the server opens.

  5. Click the Server Name menu and select Service Configuration.The Server Name page appears.

  6. Under Service Type, select BlueCat Gateway.

  7. Under the Repository, enter the repository address (for example, quay.io/bluecat/quick_service) and version (for example, 24.4.0).

  8. Click Update.

To deploy Quick Service manually:

  1. Log in to 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. 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/

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

    docker run -d \
                        -v /var/log/gateway/:/logs \
                        -v /root/gwdata/:/bluecat_gateway/ \
                        -e BAM_IP=<enter-data>\
                        -e BAM_VERSION=<enter-data> \
                        -e BAM_AUX_API=true \
                        --name bluecat-gateway-app \
                        <image-name>:<image-tag>
    In the above command:
    • The environment variable 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.

    • The environment variable BAM_VERSION is the version of BlueCat Address Manager that is used to deploy Quick Service. You must enter the version in the major-version.minor-version format. For example, 9.5

      Ensure that you do not include the patch version. For example, 9.5.2

    • Only versions with same minor version can be added without redeploying Quick Service. If an Administrator wants to change the minor version of the BlueCat Address Manager used, the Administrator must change the environment variableBAM_VERSION manually.

    • The environment variable BAM_AUX_API must be set to true.