Installing the custom Gateway image - Adaptive Applications - BlueCat Gateway - 20.8.1

BlueCat Overlay for Microsoft

prodname
BlueCat Gateway
version_custom
20.8.1
Before you begin, you must download the latest custom BlueCat Gateway image that contains the BlueCat Overlay for Microsoft Adaptive Application.
Prerequisites:
  • You must have an Address Manager server configured with the BlueCatGateway UDF and a BlueCat Gateway user. For more information, refer to the 'Configuring BlueCat Gateway' section of the BlueCat Gateway Installation Guide.
  • You must have purchased the BlueCat Overlay for Microsoft Adaptive Application from BlueCat.
  • You must have permissions to import and load the BlueCat Gateway instance.
  • You must have a Quay account.

    For more information on setting up your Quay account, refer to the information that was provided when you purchased the BlueCat Overlay for Microsoft Adaptive Application from BlueCat.

  • You must have a Docker CLI password.

    You can create one by clicking Generate Encrypted Password under Docker CLI Password on the Account Settings page in Quay.

To download from BlueCat Customer Care and install the custom Gateway image:
  1. Download the adaptive_applications_overlay_20_8_1.tar.gz file from BlueCat Customer Care.
  2. Copy the adaptive_applications_overlay_20_8_1.tar.gz file to the VM that will be running the BlueCat Gateway instance.
  3. Run the following command to load the BlueCat Gateway instance:
    docker load -i <path_to_image>/adaptive_applications_overlay_20_8_1.tar.gz
  4. Review the ports used on the host machine that is installing the Gateway instance using the following command:
    sudo docker ps -a
    In the following example output, ports 80 and 443 are used:
    STATUS          PORTS                                         NAMES
    Up 34 minutes   0.0.0.0:80->8000/tcp, 0.0.0.0:443->44300/tcp  gateway_20_3_1
  5. Run the custom Gateway image using the following command:
    docker run -d \
    -p <http_port>:8000 \
    -p <https_port>:44300 \
    -v <path_to_mapped_log_directory_for_system_logs>:/logs/ \
    -v <path_to_mapped_log_directory_for_application_logs>:/app_logs/ \
    -v <path_to_mapped_data_directory_for_application_data>:/app_data/ \
    -e BAM_IP=<your_bam_ip_address>  \
    --restart unless-stopped \
    --name <gateway_container_name> \
    quay.io/bluecat/overlay_microsoft:20.8.1

    Where <http_port> and <https_port> represent different ports than those used by the Gateway instance. For example, you can set port 81 as the <http_port> and port 444 as the <https_port> values.

    Tip: BlueCat advises all customers to map Docker volumes for their respective workspace and logs directory to save data from BlueCat Gateway. Volumes are completely managed by Docker and you do not need to set permissions manually when using Docker volumes. This is also the recommended practice for Docker containers. However, if you prefer to mount data and log volumes to your local machine, you must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not map data or log volumes to your local machine during installation, BlueCat Gateway will write all the data to the container by default. If you then stop or restart the container, all this data will be lost.
    To set permissions to external volumes, run the following command:
    chmod -R o=rwx <mapped volume>
To download from Quay and install the custom Gateway image:
  1. Log in to the console of the VM will be running the BlueCat Overlay for Microsoft Adaptive Application.
  2. Log in to Quay from the console using the following command:
    docker login quay.io
  3. At the prompt, enter your Quay user name and password obtained when generating the encrypted password.
  4. Download the updated BlueCat Overlay for Microsoft Adaptive Application from Quay using the following command:
    docker pull quay.io/bluecat/overlay_microsoft:20.8.1
  5. Run the custom Gateway image using the following command:
    docker run -d \
    -p <http_port>:8000 \
    -p <https_port>:44300 \
    -v <path_to_mapped_log_directory_for_system_logs>:/logs/ \
    -v <path_to_mapped_log_directory_for_application_logs>:/app_logs/ \
    -v <path_to_mapped_data_directory_for_application_data>:/app_data/ \
    -e BAM_IP=<your_bam_ip_address>  \
    --restart unless-stopped \
    --name <gateway_container_name> \
    quay.io/bluecat/overlay_microsoft:20.8.1

    Where <http_port> and <https_port> represent different ports than those used by the Gateway instance. For example, you can set port 81 as the <http_port> and port 444 as the <https_port> values.

    Tip: BlueCat advises all customers to map Docker volumes for their respective workspace and logs directory to save data from BlueCat Gateway. Volumes are completely managed by Docker and you do not need to set permissions manually when using Docker volumes. This is also the recommended practice for Docker containers. However, if you prefer to mount data and log volumes to your local machine, you must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not map data or log volumes to your local machine during installation, BlueCat Gateway will write all the data to the container by default. If you then stop or restart the container, all this data will be lost.
    To set permissions to external volumes, run the following command:
    chmod -R o=rwx <mapped volume>

Once you have downloaded and installed the custom Gateway image, you can configure the BlueCat Overlay for Microsoft Adaptive Application workflow permissions.